/payment-orders/fiatCreate Fiat Payment Order
Outcome - Creates 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.
Body Parameters
amountInFiatnumberrequiredmin(1)max(100,000,000)Amount to be paid in fiat currency
clientNamestringrequiredmax(255)Name of the client making the payment
currencyCodestringrequiredSupported fiat currency code (e.g., SAR)
IBANstringSaudi IBANClient Saudi IBAN (used for processing refunds)
returnUrlstringhttps URLHTTPS URL to redirect customer after payment completion
idstringmax(42)Custom order ID (if omitted, a ULID is automatically generated)
itemNamestringmax(255)Name of the item or service being purchased
emailstringemail formatCustomer email address for receipts and notifications
Responses
Response attributes
messagestringSuccess message
dataobjectCreated fiat payment vault order object
Show child attributes (16)
idstringUnique order ID
vaultIdnumberVault ID
clientNamestringName of the client making payment
itemNamestringName of the purchased item or service
amountInDollarstringUSD equivalent calculated via real-time exchange rates
amountInFiatstringOrder amount in fiat currency
emailstringCustomer email address for notifications
expirationstringExpiration timestamp in ISO 8601 format
IBANstringCustomer Saudi IBAN used for automated refunds
fiatAccountIdstringProvisioned virtual fiat account ID
fiatAccountobjectDedicated virtual fiat account provisioned with the integrated banking provider
Show child attributes (13)
idstringVirtual fiat account ID
typenumberAccount type identifier (e.g. 2 for ORDER)
targetIdnumberInternal referential order ID
vaultIdnumberVault ID owning the account
currencyIdnumberFiat currency ID
currencyCodestringFiat currency code (e.g. SAR)
providernumberBanking provider identifier (e.g. 1)
providerDataobjectProvider-specific account metadata
totalDepositsstringTotal cumulative deposits credited
totalRefundsstringTotal cumulative refunds issued
statusnumberAccount status (e.g. 1 for ACTIVE)
createdAtstringCreation timestamp in ISO 8601 format
updatedAtstringLast update timestamp in ISO 8601 format
paymentLinkstringHosted checkout payment URL for the customer
createdAtstringOrder creation date and time
updatedAtstringOrder last update date and time
globalIdstringUnique global order ULID
statusstringOrder status (PENDING, PAID, EXPIRED, CANCELLED, REFUNDED)
statusnumberHTTP status code
Was this page helpful?