OMNO API Documentation (2.0.0)

Download OpenAPI description

openapi_final_casefixed.json

openapi_final_casefixed.yaml

Overview

E-mail support@omno.com

Servers

Mock server

https://omno-api.redocly.app/_mock/openapi_final_casefixed/

Production

https://api.omno.com/

Sandbox

https://api.stagingsseu.com/

Cashier

Cashier API

Operations

PayIn

PayIn API

Operations

Payout

Payout API

Operations

Reject payout transaction

Request

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

Path

payoutIdstringrequired

Payout ID. Returned by createPayout method

curl -i -X PUT \
  'https://omno-api.redocly.app/_mock/openapi_final_casefixed/public/payout/{payoutId}/reject' \
  -H 'Authorization: YOUR_API_KEY_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.

Path

payoutIdstringrequired

Payout ID. Returned by createPayout method

curl -i -X PUT \
  'https://omno-api.redocly.app/_mock/openapi_final_casefixed/public/payout/{payoutId}/confirm' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Payout transaction confirmed

Bodyapplication/json

object(Unit)

Response

application/json

{}

Create payout

Request

Creates payout transaction for the given request

Bodyapplication/jsonrequired

Create Payout Request

orderIdstringrequired

Unique identifier for checkout session

Example: "example_orderid"

valuenumberrequired

Payout transaction amount

Example: 0

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: "example_currency"

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: true

customerobject(CustomerRequest)required

Customer information

customer.externalUserIdstringrequired

Your defined unique identifier for this customer.

Example: "example_externaluserid"

customer.firstNamestringrequired

Customer first name

Example: "example_firstname"

customer.lastNamestringrequired

Customer last name

Example: "example_lastname"

customer.emailstringrequired

Customer email

Example: "example_email"

customer.phoneNumberstringrequired

Customer phone number

Example: "example_phonenumber"

customer.dateOfBirthstring(date)required

Customer date of birth

Example: "example_dateofbirth"

customer.billingobject(CustomerBilling)required

Customer billing information

customer.billing.addressstringrequired

Customer billing address

Example: "example_address"

customer.billing.citystringrequired

Customer billing city

Example: "example_city"

customer.billing.statestringrequired

Customer billing state

Example: "example_state"

customer.billing.countryCodestringrequired

Customer billing country code (ISO 3166-1 alpha-2). Ex: GE for Georgia

Example: "example_countrycode"

customer.billing.postalCodestringrequired

Customer billing postal code

Example: "example_postalcode"

curl -i -X POST \
  https://omno-api.redocly.app/_mock/openapi_final_casefixed/public/payout \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderId": "example_orderid",
    "value": 0,
    "currency": "example_currency",
    "kycVerified": true,
    "customer": {
      "externalUserId": "example_externaluserid",
      "firstName": "example_firstname",
      "lastName": "example_lastname",
      "email": "example_email",
      "phoneNumber": "example_phonenumber",
      "dateOfBirth": "example_dateofbirth",
      "billing": {
        "address": "example_address",
        "city": "example_city",
        "state": "example_state",
        "countryCode": "example_countrycode",
        "postalCode": "example_postalcode"
      }
    }
  }'

Responses

Payout transaction created

Bodyapplication/json

payoutIdstringrequired

Payout ID

Example: "example_payoutid"

statusstringrequired

Payout status

Enum"CREATED""WAITING_FOR_CONFIRMATION""PENDING""PROCESSED""REJECTED""FAILED"

Example: "PROCESSED"

iframeUrlsobject(IframeUrls)required

Payout Iframe URLs

iframeUrls.cardstringrequired

Card IFrame URL

Example: "example_card"

iframeUrls.apmstringrequired

Alternate Payment Method IFrame URL

Example: "example_apm"

Response

application/json

{
  "payoutId": "example_payoutid",
  "status": "PROCESSED",
  "iframeUrls": {
    "card": "example_card",
    "apm": "example_apm"
  }
}