🔒Add payment details

In case you'd like to spin off your own UI, this endpoint allows you to submit the details from the end-user for the initiated deposit request. The end-user will be required to choose a depositCurrency

Submit crypto payment

patch

If you are using our payment URL supplied as a response of "Request payment" request, you'll not need to run this request. It will be handled by our hosted checkout application.

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuth

AuthorizationstringRequired

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

Path parameters

paymentIdstring · uuidRequired

ID of the payment to submit.

Body

application/json

depositCurrencystring · enumRequired

Cryptocurrency that should be used for the deposit.

Possible values:

networkstring · enumRequired

Cryptocurrency network on which the deposit will be received.

Possible values:

displayCurrencystring · enumOptional

Fiat currency, if not provided on payment creation.

Possible values:

displayAmountstringOptional

Amount in displayCurrency, if not provided on payment creation.

Responses

200

Returns the submitted payment.

application/json

patch

/api/v1/payments/{paymentId}

HTTPcURLJavaScriptPython

PATCH /api/v1/payments/{paymentId} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "displayCurrency": "EUR",
  "displayAmount": 50,
  "depositCurrency": "USDT",
  "network": "ETH"
}

200

Returns the submitted payment.

{
  "paymentInfo": {
    "paymentId": "2fcd3399-49d4-45e0-b995-7c489f43fe08",
    "clientPaymentId": "test-payment-23-12-18-1",
    "businessId": "407710f4-de33-454b-a47f-dda792e272c8",
    "locale": "en-US",
    "status": "PENDING",
    "rateType": "FLOATING",
    "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",
    "walletAddress": "0x356c19d41921eb88C03308F31700C3F08cbD36D4",
    "displayCurrency": "EUR",
    "expectedDisplayAmount": "50.00",
    "expectedDisplayDistributedUserServiceFee": "0.00",
    "actualDisplayAmount": "0.00",
    "actualDisplayDistributedUserServiceFee": "0.00",
    "depositCurrency": "USDT",
    "expectedNetwork": "ETH",
    "expectedDepositAmount": "54.759355",
    "expectedDepositDistributedUserServiceFee": "0.000000",
    "actualDepositAmount": "0",
    "actualDepositDistributedUserServiceFee": "0",
    "expectedUniformAmount": "50.00",
    "actualUniformAmount": "0.00",
    "userServiceFeeDistributionPercentage": "0.00",
    "redirectUrl": "https://my-business.com/account?id=3423",
    "expirationMinutes": 10080,
    "initiatedBy": "[email protected]",
    "paymentRequestedAt": 1702909646,
    "paymentInitiatedAt": 1702906899,
    "deposits": []
  }
}