🔒Get payment data

Fetch payment by ID

Fetch payment by ID. The payment ID is provided in the response of POST /payments.

GET/api/v1/payments/{paymentId}

Authorization

ApiKeyAuth

Path parameters

paymentId*string (uuid)

The payment ID to search by.

Response

200

Returns the payment with the specified ID.

Body

application/json

paymentId*string (uuid)

clientPaymentId*string

Payment identifier provided by the merchant in the request body of POST /payments.

businessId*string (uuid)

locale*string

Locale code.

status*enum

NEWPENDINGAWAITINGDEPOSITEDEXPIREDBLOCKEDOVERPAIDUNPROCESSABLE

rateType*enum

FIXEDFLOATING

type*enum

ONE_TIMEREUSABLE

url*string (url)

Checkout link.

overpaymentPolicyenum

PROCESSEXCESS_REFUND

refundFollowUpDepositsForOneTimePaymentsboolean

walletAddressstring

Wallet address where the cryptocurrency amount should be deposited.

destinationTagstring

XLM/XRP destination tag.

displayCurrencyenum

Fiat currency.

AEDARSAUDBDTBGNBRLCADCHFCLPCNYCZKDKKEURGBPHKDHRKHUFIDRILSINRISKJPYKESKRWMXNMYRNGNNOKNZDPENPHPPLNQARRONRUBSEKSGDTHBTRYUSDVNDZAR

expectedDisplayAmountstring

Amount in displayCurrency requested for this payment.

expectedDisplayDistributedUserServiceFeestring

Distributed service fee amount in displayCurrency requested for this payment.

actualDisplayAmount*string

Actual amount deposited in displayCurrency.

depositCurrencyenum

The selected cryptocurrency.

BCHBNBBTCETHLINKLTCSOLTRXUSDCXLMXRP

expectedNetworkenum

The selected network.

BCHBTCLTCXLMXRPETHBSCSOLTRX

expectedDepositAmountstring

Amount in depositCurrency to be deposited to fulfill the required amount in displayCurrency.

expectedDepositDistributedUserServiceFeestring

Distributed service fee amount in depositCurrency requested for this payment.

actualDepositAmountstring

Actual amount deposited in depositCurrency by the end user.

expectedUniformAmountstring

Expected deposit amount in EUR.

actualUniformAmountstring

Actual deposit amount in EUR.

userServiceFeeDistributionPercentage*string

Percentage of the service fee covered by the user.

redirectUrlstring

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

expirationMinutes*integer (int64)

Timeframe in which the deposit should succeed.

paymentRequestedAtinteger (int64)

UNIX seconds at which the payment was requested.

paymentInitiatedAt*integer (int64)

UNIX seconds at which the payment was initiated.

deposits*array of BasicDepositResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/payments/{paymentId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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,
  "walletAddress": "text",
  "destinationTag": "text",
  "displayCurrency": "AED",
  "expectedDisplayAmount": "text",
  "expectedDisplayDistributedUserServiceFee": "text",
  "actualDisplayAmount": "text",
  "depositCurrency": "BCH",
  "expectedNetwork": "BCH",
  "expectedDepositAmount": "text",
  "expectedDepositDistributedUserServiceFee": "text",
  "actualDepositAmount": "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",
      "onChainFee": "text",
      "depositCurrency": "BCH",
      "network": "BCH",
      "depositAmount": "text",
      "displayCurrency": "AED",
      "displayAmount": "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"
      }
    }
  ]
}