🔒Request crypto payment

This is an authenticated endpoint

Initiate a payment request

Request crypto payment

An endpoint for initiating a crypto payment request. Upon success, a unique paymentUrl is provided in the response which can be served within an iframe.

Alternatively, you can redirect to the payment URL and if you have supplied a redirectUrl in the request, we will navigate the end-user back to your website upon payment completion (when we have received a deposit against this payment request). There is also a button which the end-user can use if they wish to get redirected back sooner.

POST/api/v1/payments

Authorization

ApiKeyAuth

Body

application/json

clientPaymentId*string

Payment identifier provided in the request.

businessId*string (uuid)

typeenum

ONE_TIMEREUSABLE

displayCurrencyenum

Fiat currency. You should provide this or depositCurrency.

AEDARSAUDBDTBGNBRLCADCHFCLPCNYCZKDKKEURGBPHKDHRKHUFIDRILSINRISKJPYKESKRWMXNMYRNGNNOKNZDPENPHPPLNQARRONRUBSEKSGDTHBTRYUSDVNDZAR

displayAmountstring

Amount in displayCurrency that the user wants to deposit. Required if displayCurrency is provided.

depositCurrencyenum

Cryptocurrency. You should provide this or displayCurrency.

BCHBNBBTCETHLINKLTCSOLTRXUSDCXLMXRP

depositAmountstring

Amount in depositCurrency that the user wants to deposit. Required if depositCurrency is provided.

networkenum

Cryptocurrency network. Required if depositCurrency is provided.

BCHBTCLTCXLMXRPETHBSCSOLTRX

rateTypeenum

• ONE_TIME payments: FIXED or FLOATING.
• REUSABLE payments: You can omit this parameter. Reusable payments are set to FLOATING.

FIXEDFLOATING

expirationMinutesinteger (int64)

• ONE_TIME payments: Indicates the timeframe in which the deposit should happen. A value of 0 will set the payment expiry to 7 days. Defaults to 30 min.
• REUSABLE payments: You can omit this parameter. Reusable payments are set to non-expiry.

locale*string

Language localisation abbreviation (ISO 639-1), e.g. 'en-US', 'fr-FR'. Alternatively, the locale string can be submitted with an '_' instead of '-', e.g. 'en_US' or 'fr_FR'.

redirectUrlstring

Custom URL where the user will be redirected after payment completion.

Response

200

Returns the created payment.

Body

application/json

paymentInfoDetailedPaymentResponse (object)

paymentUrlstring (url)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/payments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clientPaymentId": "test-payment-15-09-23-1",
      "locale": "en-US",
      "type": "ONE_TIME",
      "displayCurrency": "EUR",
      "displayAmount": 50,
      "rateType": "FIXED",
      "expirationMinutes": 10080,
      "businessId": "407710f4-de33-454b-a47f-dda792e272c8",
      "redirectUrl": "https://my-business.com/account?id=3423"
    }),
});
const data = await response.json();

Response

200

{
  "paymentInfo": {
    "paymentId": "123e4567-e89b-12d3-a456-426614174000",
    "clientPaymentId": "text",
    "businessId": "123e4567-e89b-12d3-a456-426614174000",
    "locale": "text",
    "status": "NEW",
    "rateType": "FIXED",
    "type": "ONE_TIME",
    "url": "text",
    "overpaymentPolicy": "PROCESS",
    "refundFollowUpDepositsForOneTimePayments": false,
    "processorType": "BLOCKCHAIN",
    "walletAddress": "text",
    "destinationTag": "text",
    "displayCurrency": "AED",
    "expectedDisplayAmount": "text",
    "expectedDisplayDistributedUserServiceFee": "text",
    "actualDisplayAmount": "text",
    "actualDisplayDistributedUserServiceFee": "text",
    "depositCurrency": "BCH",
    "expectedNetwork": "BCH",
    "expectedDepositAmount": "text",
    "expectedDepositDistributedUserServiceFee": "text",
    "actualDepositAmount": "text",
    "actualDepositDistributedUserServiceFee": "text",
    "expectedUniformAmount": "text",
    "actualUniformAmount": "text",
    "userServiceFeeDistributionPercentage": "text",
    "redirectUrl": "text",
    "deposits": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "transactionId": "text",
        "status": "PENDING_AML",
        "fromAddress": "text",
        "toAddress": "text",
        "riskScore": "text",
        "addressRiskAssessment": {
          "addressOwner": {
            "name": "text",
            "category": "text"
          },
          "sourceRiskEntities": [
            {
              "name": "text",
              "category": "text"
            }
          ],
          "destinationRiskEntities": [
            {
              "name": "text",
              "category": "text"
            }
          ]
        },
        "depositCurrency": "BCH",
        "network": "BCH",
        "depositAmount": "text",
        "depositDistributedUserServiceFee": "text",
        "onChainFee": "text",
        "displayCurrency": "AED",
        "displayAmount": "text",
        "displayPayableAmount": "text",
        "displayServiceFee": "text",
        "displayDistributedUserServiceFee": "text",
        "settlementCurrency": "BTC",
        "settlementPayableAmount": "text",
        "settlementServiceFee": "text",
        "settlementDistributedUserServiceFee": "text",
        "uniformCurrency": "text",
        "uniformPayableAmount": "text",
        "uniformServiceFee": "text",
        "uniformDistributedUserServiceFee": "text",
        "userServiceFeeDistributionPercentage": "text",
        "refund": {
          "type": "PARTIAL",
          "status": "PENDING",
          "reason": "OVERPAYMENT",
          "depositCurrency": "BCH",
          "network": "BCH",
          "amount": "text",
          "fee": "text",
          "displayCurrency": "AED",
          "displayAmount": "text",
          "displayFee": "text",
          "transactionId": "text"
        }
      }
    ]
  },
  "paymentUrl": "text"
}

More information regarding FIXED/FLOATING rate types here

More information on ONE_TIME/REUSABLE payment links here