PayIn

Create payin transaction

Creates pay-in transaction for the given request

post/public/payin

Request

  • Base URL: https://api.omno.com
  • URL: https://api.omno.com/public/payin
  • Auth: none declared

Request body

orderIdstring required

Unique identifier for payin session

amountnumber required

PayIn transaction amount

currencystring required

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.

kycVerifiedboolean required

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

previousTransactionCountinteger required

Number of previous transactions in different payment system.

routerIdstring

Specific router ID to process transaction with.

directRouteIdstring

Direct link route ID to process transaction with.

merchantAdditionalDataobject

Additional data for the transaction

Example request

{
  "orderId": "944732c4608c441aa91379478b91f76e",
  "amount": 100,
  "currency": "USD",
  "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"
    },
    "userName": "john123"
  },
  "previousTransactionCount": 1,
  "returnUrls": {
    "success": "https://example.com/success",
    "failure": "https://example.com/failure"
  },
  "routerId": "944732c4608c441aa91379478b91f76e",
  "directRouteId": "944732c4608c441aa91379478b91f76e"
}

Response

Payin transaction created

paymentIdstring required

Payment ID

status'CREATED' | 'PENDING' | 'PENDING_3DS' | 'SUCCESS' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'DECLINED' | 'FAILED' | 'TIMEOUT' | 'REFUND_FAILED' | 'REFUND_PENDING' | 'MISSING_CUSTOMER_DATA' required

Payment status

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.