🔒Get payment data

Fetch payment by ID

get

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

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuth

AuthorizationstringRequired

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

Path parameters

paymentIdstring · uuidRequired

The payment ID to search by.

Responses

200

Returns the payment with the specified ID.

application/json

get

/api/v1/payments/{paymentId}

HTTPcURLJavaScriptPython

GET /api/v1/payments/{paymentId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

Returns the payment with the specified ID.

{
  "paymentId": "1ede8457-ef97-432b-9f35-ec56ad7a5483",
  "clientPaymentId": "payment-id-11-27",
  "businessId": "407710f4-de33-454b-a47f-dda792e272c8",
  "locale": "en-US",
  "status": "DEPOSITED",
  "rateType": "FIXED",
  "type": "ONE_TIME",
  "url": "https://example.com/deposit/1ede8457-ef97-432b-9f35-ec56ad7a5483?theme=skilling&locale=en-US&sessionToken=eyJhbGciOiJIUzUxMiJ9.eyJidXNpbmVzc0lkIjoiNDA3NzEwZjQtZGUzMy00NTRiLWE0N2YtZGRhNzkyZTI3MmM4Iiwib3JnYW5pc2F0aW9uSWQiOiJjZjFlNjdkMC00NmY2LTRhMDAtODM3MC0wOTBhNTA4N2M4MGYiLCJpYXQiOjE3MDEwNzg3ODcsInBheW1lbnRJZCI6IjFlZGU4NDU3LWVmOTctNDMyYi05ZjM1LWVjNTZhZDdhNTQ4MyJ9.jSFhewoOVOB5tkTAL-UaeQZvt4XtxbRYi0BYMkprDLwwrvMNTW7K7M7g80PJtPVXqM4eGAIyUKaILWdMLsM6Ug",
  "overpaymentPolicy": "PROCESS",
  "refundFollowUpDepositsForOneTimePayments": false,
  "walletAddress": "bc1qse8f5fn4r06kae0q8umrcg587cjjsvpqjcjr3a",
  "displayCurrency": "EUR",
  "expectedDisplayAmount": "45.00",
  "expectedDisplayDistributedUserServiceFee": "0.00",
  "actualDisplayAmount": "45.00",
  "depositCurrency": "BTC",
  "expectedNetwork": "BTC",
  "expectedDepositAmount": "0.00132076",
  "expectedDepositDistributedUserServiceFee": "0.00000000",
  "actualDepositAmount": "0.00132076",
  "expectedUniformAmount": "45.00",
  "userServiceFeeDistributionPercentage": "0.00",
  "expirationMinutes": 30,
  "paymentRequestedAt": 1701078868,
  "paymentInitiatedAt": 1701078787,
  "deposits": [
    {
      "id": "ace94de0-caae-47cb-b292-44669fd4c633",
      "transactionId": "a20d743f945ad99f602a7b56f6f0f7f038704afd72a7ecb75b653b7afb865da4",
      "status": "CONFIRMED",
      "fromAddress": "bc1qe5m4h2ldcfn9ma833c0skw23ryx38x43c2ykx8",
      "toAddress": "bc1qse8f5fn4r06kae0q8umrcg587cjjsvpqjcjr3a",
      "depositCurrency": "BTC",
      "network": "BTC",
      "depositAmount": "0.00132076",
      "onChainFee": "0.00009644",
      "displayCurrency": "EUR",
      "displayAmount": "45.00",
      "userServiceFeeDistributionPercentage": "0.00"
      "depositReceivedAt": 1701079084
    }
  ]
}