Skip to content
/Payout

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

Reject payout transaction

Request

Reject payout transaction for the given ID and after this transaction will not be sent to PSP for processing.

Security
bearerAuth
Path
payoutIdstringrequired

Payout ID. Returned by createPayout method

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

Responses

Payout transaction rejected

Bodyapplication/json
object(Unit)
Response
application/json
{}

Confirm payout transaction

Request

Confirm payout transaction for the given ID and after this confirmation transaction will start processing.

Security
bearerAuth
Path
payoutIdstringrequired

Payout ID. Returned by createPayout method

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

Responses

Payout transaction confirmed

Bodyapplication/json
object(Unit)
Response
application/json
{}

Create payout transaction

Request

Creates payout transaction for the given request

Security
bearerAuth
Bodyapplication/jsonrequired

Create Payout Request

orderIdstringrequired

Unique identifier for checkout session

Example: "944732c4608c441aa91379478b91f76e"
valuenumberrequired

Payout transaction amount

Example: 100
currencystringrequired

Payout transaction currency. If processor psp doesn't allow this currency but if this currency is enabled it will be automatically converted to PSP currency and final transaction currency will be set respectively.

Example: "USD"
kycVerifiedbooleanrequired

Whether or not this customer is KYC verified in your system. This flag is required to determine right PSP to process this payout.

Example: false
customerobject(CustomerRequest)required

Customer information

customer.​externalUserIdstringrequired

Your defined unique identifier for this customer.

Example: "123456789"
customer.​firstNamestringrequired

Customer first name

Example: "John"
customer.​lastNamestringrequired

Customer last name

Example: "Doe"
customer.​emailstringrequired

Customer email

Example: "john.doe@example.com"
customer.​phoneNumberstringrequired

Customer phone number

Example: "1 1234567890"
customer.​dateOfBirthstring(date)required

Customer date of birth

Example: "1990-12-01"
customer.​billingobject(CustomerBilling)required

Customer billing information

customer.​billing.​addressstringrequired

Customer billing address

Example: "123 Main St"
customer.​billing.​citystringrequired

Customer billing city

Example: "Atlanta"
customer.​billing.​statestringrequired

Customer billing state

Example: "GA"
customer.​billing.​countryCodestringrequired

Customer billing country code (ISO 3166-1 alpha-2)

Example: "US"
customer.​billing.​postalCodestringrequired

Customer billing postal code

Example: "30308"
customer.​kycobject(CustomerKyc)

Customer KYC information

routerIdstring

Specific router ID to process transaction with.

Example: "944732c4608c441aa91379478b91f76e"
directRouteIdstring

Direct link route ID to process transaction with.

Example: "944732c4608c441aa91379478b91f76e"
merchantAdditionalDataobject

Additional data for the transaction

curl -i -X POST \
  https://api.omno.com/public/payout \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderId": "944732c4608c441aa91379478b91f76e",
    "value": 100,
    "currency": "USD",
    "kycVerified": false,
    "customer": {
      "externalUserId": "123456789",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phoneNumber": "1 1234567890",
      "dateOfBirth": "1990-12-01",
      "billing": {
        "address": "123 Main St",
        "city": "Atlanta",
        "state": "GA",
        "countryCode": "US",
        "postalCode": "30308"
      },
      "kyc": {
        "idType": "string",
        "idNumber": "string",
        "idCountry": "string",
        "idExpirationDate": "2019-08-24",
        "nationality": "string",
        "countryOfBirth": "string"
      }
    },
    "routerId": "944732c4608c441aa91379478b91f76e",
    "directRouteId": "944732c4608c441aa91379478b91f76e",
    "merchantAdditionalData": {
      "property1": {},
      "property2": {}
    }
  }'

Responses

Payout transaction created

Bodyapplication/json
payoutIdstringrequired

Payout ID

Example: "944732c4608c441aa91379478b91f76e"
statusstringrequired

Payout status

Enum"CREATED""WAITING_FOR_CONFIRMATION""PENDING""PROCESSED""REJECTED""FAILED""TIMEOUT"
Example: "CREATED"
iframeUrlsobject(IframeUrls)required

Payment Iframe URLs

iframeUrls.​cardstringrequired

Card IFrame URL

Example: "https://checkout.omno.com/payments/<transactionType>/<paymentId>/card"
iframeUrls.​apmstringrequired

Alternate Payment Method IFrame URL

Example: "https://checkout.omno.com/payments/<transactionType>/<paymentId>/apm"
Response
application/json
{
  "payoutId": "944732c4608c441aa91379478b91f76e",
  "status": "CREATED",
  "iframeUrls": {
    "card": "https://checkout.omno.com/payments/<transactionType>/<paymentId>/card",
    "apm": "https://checkout.omno.com/payments/<transactionType>/<paymentId>/apm"
  }
}