πŸ”’
Request crypto payment
This is an authenticated endpoint
post
https://payments.finrax.com/
api/v1/payments
Initiate a payment request

Response schema

Parameter
Type
Description
paymentInfo
object [required]
Object with payment details
actualDepositAmount
string [required]
The actual deposit amount in cryptocurrency
actualDisplayAmount
string [required]
The actual display amount upon receiving the cryptocurrency
expectedDepositAmount
string [optional]
The expected amount in Cryptocurrency
expectedDisplayAmount
string [optional]
The expected amount in Fiat currency
businessId
string [required]
Finrax business ID UUID
clientPaymentId
string [required]
Unique payment identifier provided in the request
deposits
array [required]
Array with all the transactions that happened for this payment
expirationMinutes
number [required]
The timeframe in which the deposit should happen
locale
string [required]
Language localisation abbreviation.
paymentId
string [required]
Unique payment identifier within Finrax system UUID
paymentInitiatedAt
number [required]
Timestamp when the payment got created UNIX
status
string [required]
Status of the payment
processorType
string [required]
Type of the payment. Can be one of [BLOCKCHAIN, CARD]. For crypto payments it's BLOCKCHAIN
redirectUrl
string [optional]
A specific URL the customer will be redirected to upon payment completion
​
overpaymentPolicy
string [optional]
Payment configuration for overpayments. Can be one of: EXCESS_REFUND or PROCESS
refundFollowUpDepositsForOneTimePayments
boolean [optional]
Payment configuration if follow-up deposits should be refunded.
rateType
string [required]
Can be one of [FIXED, FLOATING]
type
string [required]
Can be one of [ONE_TIME, REUSABLE]
​
More information regarding FIXED/FLOATING rate types here​
More information on ONE_TIME/REUSABLE payment links here​