Skip to content
Payments API
/
PayIn
/
Create payin 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

Create payin transaction

Request

Creates pay-in transaction for the given request

Security
bearerAuth
Bodyapplication/jsonrequired

Create payin transaction request

orderIdstringrequired

Unique identifier for payin session

Example: "944732c4608c441aa91379478b91f76e"
amountnumberrequired

PayIn transaction amount

Example: 100
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: "USD"
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: 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

previousTransactionCountinteger(int32)required

Number of previous transactions in different payment system.

Example: 1
returnUrlsobject(ReturnUrls)required

Return URLs after transaction is finished.

returnUrls.​successstringrequired

Url where user will be redirected after successful transaction.

Example: "https://example.com/success"
returnUrls.​failurestringrequired

Url where user will be redirected after failed transaction.

Example: "https://example.com/failure"
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/payin \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderId": "944732c4608c441aa91379478b91f76e",
    "amount": 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"
      }
    },
    "previousTransactionCount": 1,
    "returnUrls": {
      "success": "https://example.com/success",
      "failure": "https://example.com/failure"
    },
    "routerId": "944732c4608c441aa91379478b91f76e",
    "directRouteId": "944732c4608c441aa91379478b91f76e",
    "merchantAdditionalData": {
      "property1": {},
      "property2": {}
    }
  }'

Responses

Payin transaction created

Bodyapplication/json
paymentIdstringrequired

Payment ID

Example: "944732c4608c441aa91379478b91f76e"
statusstringrequired

Payment status

Enum"CREATED""PENDING""PENDING_3DS""SUCCESS""REFUNDED""PARTIALLY_REFUNDED""DECLINED""FAILED""TIMEOUT""REFUND_FAILED"
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
{
  "paymentId": "944732c4608c441aa91379478b91f76e",
  "status": "CREATED",
  "iframeUrls": {
    "card": "https://checkout.omno.com/payments/<transactionType>/<paymentId>/card",
    "apm": "https://checkout.omno.com/payments/<transactionType>/<paymentId>/apm"
  }
}

processSavedCard

Request

Security
bearerAuth
Path
payinIdstringrequired
Bodyapplication/jsonrequired
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
savedCardDataobject(SavedCardData)required
savedCardData.​cardIdstringrequired
savedCardData.​cvvstringrequired
curl -i -X POST \
  'https://api.omno.com/public/payin/{payinId}/process/saved-card' \
  -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"
    },
    "savedCardData": {
      "cardId": "string",
      "cvv": "string"
    }
  }'

Responses

OK

Bodyapplication/json
paymentIdstringrequired
statusstringrequired
Enum"CREATED""PENDING""PENDING_3DS""SUCCESS""REFUNDED""PARTIALLY_REFUNDED""DECLINED""FAILED""TIMEOUT""REFUND_FAILED"
Response
application/json
{
  "paymentId": "string",
  "status": "CREATED"
}

Start direct link payin processing

Request

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

Security
bearerAuth
Path
payinIdstringrequired

Payin ID. Returned by createPayIn method

Example: 944732c4608c441aa91379478b91f76e
Bodyapplication/jsonrequired

Start direct link payin 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/payin/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

Payin processing started response

Bodyapplication/json
paymentIdstringrequired
statusstringrequired
Enum"CREATED""PENDING""PENDING_3DS""SUCCESS""REFUNDED""PARTIALLY_REFUNDED""DECLINED""FAILED""TIMEOUT""REFUND_FAILED"
redirectUrlstring
Response
application/json
{
  "paymentId": "string",
  "status": "CREATED",
  "redirectUrl": "string"
}

Payout

Payout API

Operations