PayIn

OMNO API Documentation (2.0.0)

Download OpenAPI description
openapi_final_casefixed.json
openapi_final_casefixed.yaml
Overview
E-mail support@omno.com
Languages
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

Create payin

Request

Creates pay-in transaction for the given request

Bodyapplication/jsonrequired

Create PayIn Request

orderIdstringrequired

Unique identifier for payin session

Example: "example_orderid"
amountnumberrequired

PayIn transaction amount

Example: 0
currencystringrequired

PayIn 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 payin.

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"
previousTransactionCountinteger(int32)required

Number of previous transactions in different payment system.

Example: 0
returnUrlsobject(ReturnUrls)required
returnUrls.​successstringrequired

Url where user will be redirected after successful transaction.

Example: "example_success"
returnUrls.​failurestringrequired

Url where user will be redirected after failed transaction.

Example: "example_failure"
curl -i -X POST \
  https://omno-api.redocly.app/_mock/openapi_final_casefixed/public/payin \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderId": "example_orderid",
    "amount": 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"
      }
    },
    "previousTransactionCount": 0,
    "returnUrls": {
      "success": "example_success",
      "failure": "example_failure"
    }
  }'

Responses

PayIn 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"
  }
}

Fetch payin transaction

Request

Get pay-in Transaction Details for the given ID

Path
payinIdstringrequired

Payment Transaction ID

curl -i -X GET \
  'https://omno-api.redocly.app/_mock/openapi_final_casefixed/public/payin/{payinId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Payment Transaction Details

Bodyapplication/json
idstringrequired
Example: "example_id"
amountnumberrequired
Example: 0
merchantIdstringrequired
Example: "example_merchantid"
customerIdstringrequired
Example: "example_customerid"
orderIdstringrequired
Example: "example_orderid"
currencystringrequired
Example: "example_currency"
statusstringrequired
Enum"CREATED""PENDING""PENDING_3DS""SUCCESS""REFUNDED""PARTIALLY_REFUNDED""DECLINED""FAILED""TIMEOUT"
Example: "SUCCESS"
initialAmountnumberrequired
Example: 0
initialCurrencystringrequired
Example: "example_initialcurrency"
routerIdstring
Example: "example_routerid"
returnUrlsobject(ReturnUrls)required
returnUrls.​successstringrequired

Url where user will be redirected after successful transaction.

Example: "example_success"
returnUrls.​failurestringrequired

Url where user will be redirected after failed transaction.

Example: "example_failure"
cardIdstring
Example: "example_cardid"
cardMaskstring
Example: "example_cardmask"
cardBrandstring
Example: "example_cardbrand"
cardHashstring
Example: "example_cardhash"
merchantPspIdstring
Example: "example_merchantpspid"
pspTransactionIdstring
Example: "example_psptransactionid"
statusReasonobject(PayInStatusWithReason)
previousTransactionCountinteger(int32)
Example: 0
metadataobject(TransactionMetadata)
transactionTypestring
Enum"CARD""BANK""WALLET""CASH""CRYPTO""OTHER"
Example: "CARD"
createdAtstring(date-time)required
Example: "example_createdat"
updatedAtstring(date-time)required
Example: "example_updatedat"
Response
application/json
{
  "id": "example_id",
  "amount": 0,
  "merchantId": "example_merchantid",
  "customerId": "example_customerid",
  "orderId": "example_orderid",
  "currency": "example_currency",
  "status": "SUCCESS",
  "initialAmount": 0,
  "initialCurrency": "example_initialcurrency",
  "routerId": "example_routerid",
  "returnUrls": {
    "success": "example_success",
    "failure": "example_failure"
  },
  "cardId": "example_cardid",
  "cardMask": "example_cardmask",
  "cardBrand": "example_cardbrand",
  "cardHash": "example_cardhash",
  "merchantPspId": "example_merchantpspid",
  "pspTransactionId": "example_psptransactionid",
  "statusReason": {
    "reason": "example_reason",
    "detailedStatus": "INSUFFICIENT_FUNDS",
    "status": "SUCCESS"
  },
  "previousTransactionCount": 0,
  "metadata": {
    "ipAddress": "example_ipaddress"
  },
  "transactionType": "CARD",
  "createdAt": "example_createdat",
  "updatedAt": "example_updatedat"
}

Payout

Payout API

Operations