🔒Request crypto payment

This is an authenticated endpoint

Request crypto payment

post

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuth

AuthorizationstringRequired

^FRX-API api-key=[^,]+,signature=[^,]+,timestamp=[\d]+$

Body

application/json

clientPaymentIdstringRequired

Payment identifier provided in the request.

businessIdstring · uuidRequired

typestring · enumOptionalPossible values:

displayCurrencystring · enumOptional

Fiat currency. You should provide this or depositCurrency.

Possible values:

displayAmountstringOptional

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

depositCurrencystring · enumOptional

Cryptocurrency. You should provide this or displayCurrency.

Possible values:

depositAmountstringOptional

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

networkstring · enumOptional

Cryptocurrency network. Required if depositCurrency is provided.

Possible values:

rateTypestring · enumOptional

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

Possible values:

expirationMinutesinteger · int64Optional

• 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)

redirectUrlstringOptional

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

redirectModestring · enumOptional

Specifies how to open the redirect URL

• PARENT (default): Opens the redirect URL in the parent browsing context. Refers to HTML anchor target attribute value _top.
• SELF: Opens the redirect URL in the current browsing context. Refers to HTML anchor target attribute value _self.

Possible values:

Responses

200

Returns the created payment.

application/json

post

/api/v1/payments

HTTPcURLJavaScriptPython

POST /api/v1/payments HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 276

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

Returns the created payment.

{
  "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,
    "initiatedBy": "[email protected]",
    "paymentInitiatedAt": 1702906899,
    "deposits": []
  },
  "paymentUrl": "https://example.com/deposit/2fcd3399-49d4-45e0-b995-7c489f43fe08?theme=skilling&locale=en-US&sessionToken=eyJhbGciOiJIUzUxMiJ9.eyJidXNpbmVzc0lkIjoiNDA3NzEwZjQtZGUzMy00NTRiLWE0N2YtZGRhNzkyZTI3MmM4Iiwib3JnYW5pc2F0aW9uSWQiOiJjZjFlNjdkMC00NmY2LTRhMDAtODM3MC0wOTBhNTA4N2M4MGYiLCJpYXQiOjE3MDI5MDY4OTksInBheW1lbnRJZCI6IjJmY2QzMzk5LTQ5ZDQtNDVlMC1iOTk1LTdjNDg5ZjQzZmUwOCJ9.LUnvFdCySVS03SX2ym4eJdUDlQfTe2un_DZ3tbYAoc7c9ABj71Po43tVxLTGP7VknrSftjB5ItvEuxF9EGn84Q"
}