Finrax API
HomeChangelogIntegration GuideResources
HomeChangelogIntegration GuideResources
  1. Crypto Payments
  • Getting Started
    • Introduction
    • Environments
    • Errors
    • Authorization
      • API Key Management
      • Signature
      • Code Snippets
  • Payments and Withdrawals
    • Crypto Payments
      • Fetch payment by ID
        GET
      • 🔒Fetch payments
        GET
      • Submit crypto payment
        PATCH
      • Request crypto payment
        POST
    • Fetch withdrawals
      GET
    • Fetch withdrawal metadata
      GET
    • Request crypto withdrawal
      POST
    • Fetch whitelisted addresses
      GET
    • Whitelist an address
      POST
    • Fetch crypto withdrawal approval by ID
      GET
    • Fetch business by ID
      GET
    • Fetch business balance
      GET
    • Unwhitelist an address
      DELETE
  • Callbacks
    • Deposit received notification
    • Withdrawal broadcast notification
    • Withdrawal approved/rejected notification
  • Address validation
    • Validate address
      GET
    • Validate address and destination tag
      GET
  • Rates and metadata
    • Fetch market rates
      GET
    • Fetch fiat rates
      GET
    • Fetch deposit rates
      GET
    • Fetch all currencies
      GET
  1. Crypto Payments

Fetch payment by ID

GET
/api/v1/payments/{paymentId}
Fetch payment by ID. The payment ID is provided in the response of POST /payments.

Request

Authorization
Add parameter in header
FRX-API
Example:
FRX-API: ********************
Path Params
paymentId
string <uuid>
required
The payment ID to search by.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://payments.finrax.com/api/v1/payments/' \
--header 'FRX-API;'

Responses

🟢200Returns the payment with the specified ID.
application/json
Body
paymentId
string <uuid>
required
clientPaymentId
string 
required
Payment identifier provided by the merchant in the request body of POST /payments.
businessId
string <uuid>
required
locale
string 
required
Locale code.
status
enum<string> 
required
Allowed values:
NEWPENDINGAWAITINGDEPOSITEDEXPIREDBLOCKEDOVERPAID
rateType
enum<string> 
required
Allowed values:
FIXEDFLOATING
type
enum<string> 
required
Allowed values:
ONE_TIMEREUSABLE
url
string <url>
required
Checkout link.
overpaymentPolicy
enum<string> 
optional
Allowed values:
PROCESSEXCESS_REFUND
refundFollowUpDepositsForOneTimePayments
boolean 
optional
walletAddress
string 
optional
Wallet address where the cryptocurrency amount should be deposited.
destinationTag
string 
optional
XLM/XRP destination tag.
displayCurrency
enum<string> 
optional
Fiat currency.
Allowed values:
AEDARSAUDBDTBGNBRLCADCHFCLPCNYCZKDKKEURGBPHKDHRKHUFIDRILSINRISKJPYKESKRWMXNMYRNGNNOKNZDPENPHPPLNQARRONRUBSEKSGDTHBTRYUSDVNDZAR
expectedDisplayAmount
string 
optional
Amount in displayCurrency requested for this payment.
expectedDisplayDistributedUserServiceFee
string 
optional
Distributed service fee amount in displayCurrency requested for this payment.
actualDisplayAmount
string 
required
Actual amount deposited in displayCurrency.
depositCurrency
enum<string> 
optional
The selected cryptocurrency.
Allowed values:
BCHBNBBTCETHLINKLTCSOLTRXUSDCUSDTXLMXRP
expectedNetwork
enum<string> 
optional
The selected network.
Allowed values:
BCHBTCLTCXLMXRPETHBSCSOLTRX
expectedDepositAmount
string 
optional
Amount in depositCurrency to be deposited to fulfill the required amount in displayCurrency.
expectedDepositDistributedUserServiceFee
string 
optional
Distributed service fee amount in depositCurrency requested for this payment.
actualDepositAmount
string 
optional
Actual amount deposited in depositCurrency by the end user.
expectedUniformAmount
string 
optional
Expected deposit amount in EUR.
actualUniformAmount
string 
optional
Actual deposit amount in EUR.
userServiceFeeDistributionPercentage
string 
required
Percentage of the service fee covered by the user.
redirectUrl
string 
optional
Custom URL where the user will be redirected after payment completion.
expirationMinutes
integer <int64>
required
Timeframe in which the deposit should succeed.
>= 0
paymentRequestedAt
integer <int64>
optional
UNIX seconds at which the payment was requested.
paymentInitiatedAt
integer <int64>
required
UNIX seconds at which the payment was initiated.
deposits
array[object (BasicDepositResponse) {14}] 
required
id
string <uuid>
required
Deposit UUID.
transactionId
string 
required
Blockchain transaction hash for the deposit.
status
enum<string> 
required
Status for this deposit only (not to be confused with the status for the entire payment).
Allowed values:
PENDING_AMLCOMPLIANCE_REVIEWUNCONFIRMEDCONFIRMEDBLOCKED
fromAddress
string 
required
Sending address of the transaction.
toAddress
string 
required
Receiving address of the transaction.
onChainFee
string 
required
Blockchain fee in depositCurrency, paid by the end user.
depositCurrency
enum<string> 
required
Cryptocurrency that has been deposited.
Allowed values:
BCHBNBBTCETHLINKLTCSOLTRXUSDCUSDTXLMXRP
network
enum<string> 
required
Network on which the deposit was made.
Allowed values:
BCHBTCLTCXLMXRPETHBSCSOLTRX
depositAmount
string 
required
Amount deposited in depositCurrency.
displayCurrency
enum<string> 
required
Fiat currency.
Allowed values:
AEDARSAUDBDTBGNBRLCADCHFCLPCNYCZKDKKEURGBPHKDHRKHUFIDRILSINRISKJPYKESKRWMXNMYRNGNNOKNZDPENPHPPLNQARRONRUBSEKSGDTHBTRYUSDVNDZAR
displayAmount
string 
required
Amount deposited in displayCurrency.
userServiceFeeDistributionPercentage
string 
required
Percentage of the service fee covered by the user.
depositReceivedAt
integer <int64>
required
UNIX seconds at which the deposit was received.
refund
object (RefundResponse) 
optional
Example
{
  "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
    }
  ]
}
Modified at 2024-07-24 14:04:47
Previous
Crypto Payments
Next
🔒Fetch payments
Built with