Generate Payment Link

Outcome - Generates a unique payment link for a specific client to deposit fiat funds into their account.

clientIdstringrequired

The external ID of the client making the deposit

amountnumberrequiredpositive

Amount to deposit

currencyCodestringrequired

Fiat currency code (e.g., SAR)

returnUrlstring

The URL to redirect the user to after payment

IBANstring

Client IBAN (Saudi Arabia format)

returnUrlstring

HTTPS URL to redirect the user after payment

paymentExpiredInMinutesnumber

Payment link expiration in minutes (default 60, max 1440)

Response attributes

messagestring

Success message

dataobject

Payment link details

Show child attributes (1)

paymentLinkstring

URL to redirect the user for payment

statusnumber

HTTP status code

Was this page helpful?

Base URL

Production

https://YOUR-SUBDOMAIN.api.roxcustody.com/api/integration

Sandbox

https://YOUR-SUBDOMAIN.api-sandbox.roxcustody.com/api/integration

Language Box

POST/fiat-payments/payment-link/client

1	curl --request POST \
2	--url 'https://YOUR-SUBDOMAIN.api.roxcustody.com/api/integration/fiat-payments/payment-link/client' \
3	--header 'Content-Type: application/json' \
4	--header 'X-ACCESS-TOKEN: YOUR-ACCESS-TOKEN' \
5	--data '{
6	"clientId": "client123",
7	"amount": 376.88,
8	"currencyCode": "SAR",
9	"IBAN": "SA1234567890",
10	"returnUrl": "https://example.com/callback",
11	"paymentExpiredInMinutes": 60
12	}'

Response

Payment Link Generated Successfully

{

"message": "Payment link generated successfully.",

"data": {

"paymentLink": "",

"url": "https://dhamendemo.elm.sa/pay1/c8fd935c881953e91422bdc0033da12627f9e9142a0eef46e04688ccb9b93893"

}