Skip to content
Payments API
/
Payout
/
Fetch payout transaction

OMNO API Documentation (2.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
E-mail

support@omno.com

Languages
Servers
Production

https://api.omno.com/

Sandbox

https://api.omno.dev/

Cashier

Cashier API

Operations

PayIn

PayIn API

Operations

Payout

Payout API

Operations

Start direct link payout processing

Request

Start direct link payout processing for the given ID and after this transaction will start processing.

Security
bearerAuth
Path
payoutIdstringrequired

Payout ID. Returned by createPayout method

Example: 944732c4608c441aa91379478b91f76e
Bodyapplication/jsonrequired

Start direct link payout processing request

browserobject(Browser)required
browser.​acceptHeaderstring
browser.​userAgentstring
browser.​languagestring
browser.​timeZoneOffsetinteger(int32)
browser.​timeZonestring
browser.​colorDepthinteger(int32)
browser.​screenHeightinteger(int32)
browser.​screenWidthinteger(int32)
browser.​windowHeightinteger(int32)
browser.​windowWidthinteger(int32)
browser.​javaEnabledboolean
browser.​javascriptEnabledboolean
browser.​customerIpstring
additionalDataobjectrequired
additionalData.​property name*objectadditional property
curl -i -X POST \
  https://api.omno.com/public/payout/944732c4608c441aa91379478b91f76e/process/direct-link \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "browser": {
      "acceptHeader": "string",
      "userAgent": "string",
      "language": "string",
      "timeZoneOffset": 0,
      "timeZone": "string",
      "colorDepth": 0,
      "screenHeight": 0,
      "screenWidth": 0,
      "windowHeight": 0,
      "windowWidth": 0,
      "javaEnabled": true,
      "javascriptEnabled": true,
      "customerIp": "string"
    },
    "additionalData": {
      "property1": {},
      "property2": {}
    }
  }'

Responses

Payout processing started response

Bodyapplication/json
payoutIdstringrequired
statusstringrequired
Enum"CREATED""WAITING_FOR_CONFIRMATION""PENDING""PROCESSED""REJECTED""FAILED""TIMEOUT"
redirectUrlstring
messagestring
Response
application/json
{
  "payoutId": "string",
  "status": "CREATED",
  "redirectUrl": "string",
  "message": "string"
}

Fetch payout transaction

Request

Fetch payout transaction for the given ID

Security
bearerAuth
Path
payoutIdstringrequired

Payout ID. Returned by createPayout method

Example: 944732c4608c441aa91379478b91f76e
curl -i -X GET \
  https://api.omno.com/public/payout/944732c4608c441aa91379478b91f76e \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Payout transaction

Bodyapplication/json
idstringrequired
amountnumberrequired
merchantIdstringrequired
customerIdstringrequired
orderIdstringrequired
currencystringrequired
statusstringrequired
Enum"CREATED""WAITING_FOR_CONFIRMATION""PENDING""PROCESSED""REJECTED""FAILED""TIMEOUT"
initialAmountnumberrequired
initialCurrencystringrequired
routerIdstring
cardIdstring
cardMaskstring
cardBrandstring
cardHashstring
predictedPspIdstring
processorPspIdstring
pspTransactionIdstring
previousTransactionCountinteger(int32)
statusReasonobject(PayoutStatusWithReason)
metadataobject(TransactionMetadata)

Transaction metadata

transactionTypestring
Enum"CARD""BANK""WALLET""CASH""CRYPTO""OTHER"
browserobject(Browser)
additionalDataobject
pspAdditionalDataobject
createdAtstring(date-time)required
updatedAtstring(date-time)required
Response
application/json
{
  "id": "string",
  "amount": 0,
  "merchantId": "string",
  "customerId": "string",
  "orderId": "string",
  "currency": "string",
  "status": "CREATED",
  "initialAmount": 0,
  "initialCurrency": "string",
  "routerId": "string",
  "cardId": "string",
  "cardMask": "string",
  "cardBrand": "string",
  "cardHash": "string",
  "predictedPspId": "string",
  "processorPspId": "string",
  "pspTransactionId": "string",
  "previousTransactionCount": 0,
  "statusReason": {
    "reason": "string",
    "detailedStatus": "NO_PROVIDER_AVAILABLE",
    "status": "CREATED"
  },
  "metadata": {
    "ipAddress": "string",
    "ipInfo": { … },
    "deviceType": "MOBILE",
    "proxyDetection": { … },
    "emailValidation": { … },
    "phoneValidation": { … }
  },
  "transactionType": "CARD",
  "browser": {
    "acceptHeader": "string",
    "userAgent": "string",
    "language": "string",
    "timeZoneOffset": 0,
    "timeZone": "string",
    "colorDepth": 0,
    "screenHeight": 0,
    "screenWidth": 0,
    "windowHeight": 0,
    "windowWidth": 0,
    "javaEnabled": true,
    "javascriptEnabled": true,
    "customerIp": "string"
  },
  "additionalData": {
    "property1": {},
    "property2": {}
  },
  "pspAdditionalData": {
    "property1": {},
    "property2": {}
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}