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

Authorizations

Body

clientPaymentIdstringrequired

Payment identifier provided in the request.

businessIdstring · uuidrequired

displayAmountstring

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

depositAmountstring

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

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.

localestringrequired

IETF BCP 47 language tag, e.g. 'en-US', 'fr-FR'. Alternatively, the locale string can be submitted with an '_' instead of '-', e.g. 'en_US' or 'fr_FR' or as an ISO 639-1 language code, e.g. 'en' or 'fr'. Supported languages:

Arabic (ar)
Bulgarian (bg)
Chinese (zh)
English (en)
French (fr)
German (de)
Japanese (ja)
Lithuanian (lt)
Portuguese (pt)
Russian (ru)
Spanish (es)
Turkish (tr)

redirectUrlstring

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

typestring · enum

Options: ONE_TIME, REUSABLE

displayCurrencystring · enum

Fiat currency. You should provide this or depositCurrency.

Options: AED, ARS, AUD, BDT, BGN, BRL, CAD, CHF, CLP, CNY, CZK, DKK, EUR, GBP, HKD, HRK, HUF, IDR, ILS, INR, ISK, JPY, KES, KRW, MXN, MYR, NGN, NOK, NZD, PEN, PHP, PLN, QAR, RON, RUB, SEK, SGD, THB, TRY, USD, VND, ZAR

depositCurrencystring · enum

Cryptocurrency. You should provide this or displayCurrency.

Options: BCH, BTC, ETH, LINK, LTC, SOL, USDC, XLM, XRP

networkstring · enum

Cryptocurrency network. Required if depositCurrency is provided.

Options: BCH, BTC, LTC, XLM, XRP, ETH, BSC, SOL, TRX

rateTypestring · enum

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

Options: FIXED, FLOATING

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/payments' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

200

{
  "paymentUrl": "https://example.com/deposit/2fcd3399-49d4-45e0-b995-7c489f43fe08?theme=skilling&locale=en-US&sessionToken=eyJhbGciOiJIUzUxMiJ9.eyJidXNpbmVzc0lkIjoiNDA3NzEwZjQtZGUzMy00NTRiLWE0N2YtZGRhNzkyZTI3MmM4Iiwib3JnYW5pc2F0aW9uSWQiOiJjZjFlNjdkMC00NmY2LTRhMDAtODM3MC0wOTBhNTA4N2M4MGYiLCJpYXQiOjE3MDI5MDY4OTksInBheW1lbnRJZCI6IjJmY2QzMzk5LTQ5ZDQtNDVlMC1iOTk1LTdjNDg5ZjQzZmUwOCJ9.LUnvFdCySVS03SX2ym4eJdUDlQfTe2un_DZ3tbYAoc7c9ABj71Po43tVxLTGP7VknrSftjB5ItvEuxF9EGn84Q",
  "paymentInfo": {
    "paymentId": "2fcd3399-49d4-45e0-b995-7c489f43fe08",
    "clientPaymentId": "test-payment-15-09-23-1",
    "businessId": "407710f4-de33-454b-a47f-dda792e272c8",
    "locale": "en-US",
    "status": "NEW",
    "rateType": "FIXED",
    "type": "ONE_TIME",
    "url": "https://example.com/deposit/2fcd3399-49d4-45e0-b995-7c489f43fe08?theme=skilling&locale=en-US&sessionToken=eyJhbGciOiJIUzUxMiJ9.eyJidXNpbmVzc0lkIjoiNDA3NzEwZjQtZGUzMy00NTRiLWE0N2YtZGRhNzkyZTI3MmM4Iiwib3JnYW5pc2F0aW9uSWQiOiJjZjFlNjdkMC00NmY2LTRhMDAtODM3MC0wOTBhNTA4N2M4MGYiLCJpYXQiOjE3MDI5MDY4OTksInBheW1lbnRJZCI6IjJmY2QzMzk5LTQ5ZDQtNDVlMC1iOTk1LTdjNDg5ZjQzZmUwOCJ9.LUnvFdCySVS03SX2ym4eJdUDlQfTe2un_DZ3tbYAoc7c9ABj71Po43tVxLTGP7VknrSftjB5ItvEuxF9EGn84Q",
    "overpaymentPolicy": "PROCESS",
    "refundFollowUpDepositsForOneTimePayments": false,
    "processorType": "BLOCKCHAIN",
    "displayCurrency": "EUR",
    "expectedDisplayAmount": "50.00",
    "actualDisplayAmount": "0.00",
    "actualDisplayDistributedUserServiceFee": "0.00",
    "actualDepositAmount": "0",
    "actualDepositDistributedUserServiceFee": "0",
    "actualUniformAmount": "0.00",
    "userServiceFeeDistributionPercentage": "0.00",
    "redirectUrl": "https://my-business.com/account?id=3423",
    "expirationMinutes": 10080,
    "paymentInitiatedAt": 1702906899,
    "deposits": []
  }
}

Returns the created payment.

Request crypto payment

Initiate a payment request

Initiate a payment request

Request crypto payment