Skip to content
Payments API
/
PayIn
/
processCard

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

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

processCard

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
cardDataobject(CardData)required
cardData.​cardNumberstringrequired
cardData.​expirationMonthstringrequired
cardData.​expirationYearstringrequired
cardData.​cvvstringrequired
cardData.​cardholderNamestringrequired
saveCardbooleanrequired
curl -i -X POST \
  'https://api.omno.com/public/payin/{payinId}/process/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"
    },
    "cardData": {
      "cardNumber": "string",
      "expirationMonth": "string",
      "expirationYear": "string",
      "cvv": "string",
      "cardholderName": "string"
    },
    "saveCard": true
  }'

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

Fetch payin transaction

Request

Get payin transaction Details for the given ID

Security
bearerAuth
Path
payinIdstringrequired

Payment transaction ID

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

Responses

Payment transaction details

Bodyapplication/json
idstringrequired

Unique identifier for payin transaction

Example: "944732c4608c441aa91379478b91f76e"
amountnumberrequired

PayIn transaction amount

Example: 100
merchantIdstringrequired

Unique identifier current merchant

Example: "944732c4608c441aa91379478b91f76e"
customerIdstringrequired

Unique identifier for create/updated customer

Example: "944732c4608c441aa91379478b91f76e"
orderIdstringrequired

Merchant specified order identifier

Example: "944732c4608c441aa91379478b91f76e"
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.

statusstringrequired

PayIn transaction status

Enum"CREATED""PENDING""PENDING_3DS""SUCCESS""REFUNDED""PARTIALLY_REFUNDED""DECLINED""FAILED""TIMEOUT""REFUND_FAILED"
Example: "CREATED"
initialAmountnumberrequired

Transaction initial amount

Example: 100
initialCurrencystringrequired

Transaction initial currency

Example: "USD"
routerIdstring

Router id in which transaction was processed

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"
cardIdstring

Unique identifier for card if card was saved

Example: "944732c4608c441aa91379478b91f76e"
cardMaskstring

Card mask if card was used during transaction

Example: "1234 56** **** 1234"
cardBrandstring

Card brand if card was used during transaction

Example: "VISA"
cardHashstring

Card hash if card was used during transaction

Example: "7094c34678b3a4e29bcb5149266d1c811de2b6fc9370be9d5acdd7a334d8852b"
merchantPspIdstring

Merchant specified PSP id

Example: "944732c4-608c-441a-a913-79478b91f76e"
pspTransactionIdstring

Last psp transaction id

Example: "944732c4-608c-441a-a913-79478b91f76e"
statusReasonobject(PayInStatusWithReason)

PayIn transaction status with reason

previousTransactionCountinteger(int32)

Number of previous transactions in different payment system.

metadataobject(TransactionMetadata)

Transaction metadata

transactionTypestring

Transaction type

Enum"CARD""BANK""WALLET""CASH""CRYPTO""OTHER"
Example: "CARD"
additionalDataobject

User provided additional data for Alternative Payment Methods

pspAdditionalDataobject

Additional data obtained from Payment Service Provider during transaction processing

createdAtstring(date-time)required

Transaction creation time in UTC

updatedAtstring(date-time)required

Transaction last update time in UTC

Response
application/json
{
  "id": "944732c4608c441aa91379478b91f76e",
  "amount": 100,
  "merchantId": "944732c4608c441aa91379478b91f76e",
  "customerId": "944732c4608c441aa91379478b91f76e",
  "orderId": "944732c4608c441aa91379478b91f76e",
  "currency": "string",
  "status": "CREATED",
  "initialAmount": 100,
  "initialCurrency": "USD",
  "routerId": "string",
  "returnUrls": {
    "success": "https://example.com/success",
    "failure": "https://example.com/failure"
  },
  "cardId": "944732c4608c441aa91379478b91f76e",
  "cardMask": "1234 56** **** 1234",
  "cardBrand": "VISA",
  "cardHash": "7094c34678b3a4e29bcb5149266d1c811de2b6fc9370be9d5acdd7a334d8852b",
  "merchantPspId": "944732c4-608c-441a-a913-79478b91f76e",
  "pspTransactionId": "944732c4-608c-441a-a913-79478b91f76e",
  "statusReason": {
    "reason": "string",
    "detailedStatus": "GENERAL_DECLINE",
    "status": "CREATED"
  },
  "previousTransactionCount": 0,
  "metadata": {
    "ipAddress": "string",
    "ipInfo": { … },
    "deviceType": "MOBILE",
    "proxyDetection": { … },
    "emailValidation": { … },
    "phoneValidation": { … }
  },
  "transactionType": "CARD",
  "additionalData": {
    "property1": {},
    "property2": {}
  },
  "pspAdditionalData": {
    "property1": {},
    "property2": {}
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Payout

Payout API

Operations