API Reference
Fiat Payment Orders
Accept bank and card payments in fiat (currently SAR). Available in fiat payment vaults.
Flow: create the order; RoxCustody opens a dedicated virtual account for it and returns a hosted checkout link (paymentLink). Send the customer to that link. When the payment arrives, the order becomes PAID and you receive the fiat_payment_vault_order_paid webhook. If you stored the customer's IBAN, the order can be refunded (REFUNDED, webhook fiat_payment_vault_order_refunded).
Statuses: INITIALIZING, PENDING, PAID, EXPIRED, CANCELLED, REFUNDED.
Endpoints
POSTCreate Fiat Payment OrderCreates a fiat payment order and its checkout link. Give the customer's IBAN if you may need to refund them, and returnUrl to bring them back to your site after paying.GETGet Fiat Payment OrdersLists this vault's fiat payment orders, newest first by default.GETGet Fiat Payment Order DetailsReturns one fiat payment order with its checkout link and status.POSTCancel Fiat Payment OrderCancels a PENDING fiat payment order.PATCHUpdate Fiat Payment OrderChanges the itemName of a fiat payment order.
Was this page helpful?