🔒Add payment details

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

Submit deposit data

PATCH https://payments.finrax.com/api/v1/payments/:paymentId

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 i.e. the cryptocurrency they want to deposit in. Once the request is submitted, the end-user will be supplied with a walletAddress and the expectedDepositAmount calculated using the most recent exchange rate.

Request Body

{
  "depositCurrency": "BCH",
  "network": "BCH",
  "displayCurrency": "AED",
  "displayAmount": "string"
}

Path Parameters

Name	Type	Description
paymentId*	number	Unique payment identifier provided as a response of POST /payments

Request Body

Name	Type	Description
depositCurrency*	string	Cryptocurrency that should be used for the deposit
network	string	Add a specific network that will be used for the deposit. The list of available currencies and network pairs can be found here. For example if you wish to create a deposit for USDC, the value for the network field can be set to either ETH, BSC or SOL
displayCurrency	string	Fiat currency code, if not provided in the previous POST /payments request.
displayAmount	number	Amount in display currency the user wants to deposit, if not provided in the previous POST /payments request.

200 Payment data submitted successfully

{
    "paymentInfo": {
        "expectedUniformAmount": "100.00",
        "expectedDepositAmount": "0.00205966",
        "actualUniformAmount": "0.00",
        "locale": "en-US",
        "expectedDisplayAmount": "100.00",
        "expectedNetwork": "BTC",
        "paymentInitiatedAt": 1634142279,
        "paymentRequestedAt": 1634142316,
        "actualDepositAmount": "0.00000000",
        "depositCurrency": "BTC",
        "actualDisplayAmount": "0.00",
        "expirationMinutes": 30,
        "paymentId": "5f6a3367-37b3-42cd-a870-8c74476961ac",
        "walletAddress": "33nntiQTBoM9hKZtKiWCb2NHYQuPQYa9cr",
        "processorType": "BLOCKCHAIN",
        "displayCurrency": "EUR",
        "businessId": "dab81a7a-2502-4784-ad34-87e04e5129f0",
        "deposits": [],
        "rateType": "FLOATING",
        "status": "PENDING",
        "refundFollowUpDepositsForOneTimePayments": true,
        "type": "ONE_TIME",
        "overpaymentPolicy": "EXCESS_REFUND",
        "clientPaymentId": "test_payment_1"
    }
}

Response schema

Parameter	Type	Description
paymentInfo	object	Contains all payment relevant data
actualDepositAmount	string [required]	Actual amount deposited in cryptocurrency
actualUniformAmount	string [optional]	Actual amount deposited in EUR
actualDisplayAmount	string [required]	Actual amount deposited in display currency
rateType	string [required]	Can be one of: FIXED or FLOATING
type	string [required]	Can be one of: REUSABLE or ONE_TIME
businessId	string [required]	Unique business identifier UUID
clientPaymentId	string [required]	Unique payment identifier provided in the request body of POST /payments
depositCurrency	string [required]	The selected cryptocurrency for this payment
expectedNetwork	string [required]	The expected network on which this deposit should occur
deposits	array [required]	Array with all transactions for this payment
displayCurrency	string [required]	The fiat currency chosen for display purposes
expectedDepositAmount	string [optional]	Amount in cryptocurrency to be deposited to fulfill the required amount in displayCurrency
expectedUniformAmount	string [required]	Expected deposit amount in EUR
expectedDisplayAmount	string [optional]	Amount in displayCurrency requested for this payment
expirationMinutes	number [required]	Timeframe in which the deposit should succeed
locale	string [required]	Language localisation abbreviation
refundFollowUpDepositsForOneTimePayments	boolean [optional]	Payment configuration if follow-up deposits should be refunded.
overpaymentPolicy	string [optional]	Payment configuration for overpayments. Can be one of: EXCESS_REFUND or PROCESS
paymentId	string [required]	Unique Finrax payment identifier UUID
paymentInitiatedAt	number [required]	Timestamp when the payment was initiated UNIX
paymentRequestedAt	number [required]	Timestamp when the payment was requested UNIX
status	string [required]	Defines the status of the payment
redirectUrl	string [optional]	Custom URL where the user should get redirected after payment completion.
destinationTag	string [optional]	Applicable for XRP and XLM
walletAddress	string [required]	Unique wallet address generated by Finrax for this payment where the cryptocurrency amount should be deposited