🔒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

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.

PATCH/api/v1/payments/{paymentId}

Authorization

ApiKeyAuth

Path parameters

paymentId*string (uuid)

ID of the payment to submit.

Body

application/json

depositCurrency*enum

Cryptocurrency that should be used for the deposit.

BCHBNBBTCETHLINKLTCSOLTRXUSDCXLMXRP

networkenum

Cryptocurrency network on which the deposit will be received. Defaults to the native network for depositCurrency.

BCHBTCLTCXLMXRPETHBSCSOLTRX

displayCurrencyenum

Fiat currency, if not provided on payment creation.

AEDARSAUDBDTBGNBRLCADCHFCLPCNYCZKDKKEURGBPHKDHRKHUFIDRILSINRISKJPYKESKRWMXNMYRNGNNOKNZDPENPHPPLNQARRONRUBSEKSGDTHBTRYUSDVNDZAR

displayAmountstring

Amount in displayCurrency, if not provided on payment creation.

Response

200

Returns the submitted payment.

Body

application/json

paymentInfoDetailedPaymentResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/payments/{paymentId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "displayCurrency": "EUR",
      "displayAmount": 50,
      "depositCurrency": "USDC",
      "network": "ETH"
    }),
});
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",
    "expirationMinutes": 0,
    "paymentInitiatedAt": 0,
    "paymentRequestedAt": 0,
    "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",
        "depositReceivedAt": 0,
        "refund": {
          "type": "PARTIAL",
          "status": "PENDING",
          "reason": "OVERPAYMENT",
          "depositCurrency": "BCH",
          "network": "BCH",
          "amount": "text",
          "fee": "text",
          "displayCurrency": "AED",
          "displayAmount": "text",
          "displayFee": "text",
          "transactionId": "text",
          "confirmedAt": 0
        }
      }
    ]
  }
}