🔒Request crypto payment
This is an authenticated endpoint
Initiate a payment request
More information regarding FIXED/FLOATING rate types here
More information on ONE_TIME/REUSABLE payment links here
Last updated
An endpoint for initiating a crypto payment request. Upon success, a unique paymentUrl
is provided in the response which can be served within an iframe.
Alternatively, you can redirect to the payment URL and if you have supplied a redirectUrl
in the request, we will navigate the end-user back to your website upon payment completion (when we have received a deposit against this payment request). There is also a button which the end-user can use if they wish to get redirected back sooner.
Payment identifier provided in the request.
Fiat currency. You should provide this or depositCurrency
.
Amount in displayCurrency
that the user wants to deposit. Required if displayCurrency
is provided.
Cryptocurrency. You should provide this or displayCurrency
.
Amount in depositCurrency
that the user wants to deposit. Required if depositCurrency
is provided.
Cryptocurrency network. Required if depositCurrency
is provided.
ONE_TIME
payments: FIXED
or FLOATING
.REUSABLE
payments: You can omit this parameter. Reusable payments are set to FLOATING
.ONE_TIME
payments: Indicates the timeframe in which the deposit should happen. A value of 0 will set the payment expiry to 7 days. Defaults to 30 min.REUSABLE
payments: You can omit this parameter. Reusable payments are set to non-expiry.Language localisation abbreviation (ISO 639-1), e.g. 'en-US', 'fr-FR'. Alternatively, the locale string can be submitted with an '_' instead of '-', e.g. 'en_US' or 'fr_FR'.
Custom URL where the user will be redirected after payment completion.
Returns the created payment.