HomeAPI ReferenceFiat Payment OrdersCreate Fiat Payment Order
POST/payment-orders/fiat

Create 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

currencyCodestringrequired

Supported fiat currency code (e.g., SAR)

IBANstringSaudi IBAN

Client Saudi IBAN (used for processing refunds)

returnUrlstringhttps URL

HTTPS 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 format

Customer email address for receipts and notifications

Responses

Response attributes

messagestring

Success message

dataobject

Created fiat payment vault order object

Show child attributes (16)
idstring

Unique order ID

vaultIdnumber

Vault ID

clientNamestring

Name of the client making payment

itemNamestring

Name of the purchased item or service

amountInDollarstring

USD equivalent calculated via real-time exchange rates

amountInFiatstring

Order amount in fiat currency

emailstring

Customer email address for notifications

expirationstring

Expiration timestamp in ISO 8601 format

IBANstring

Customer Saudi IBAN used for automated refunds

fiatAccountIdstring

Provisioned virtual fiat account ID

fiatAccountobject

Dedicated virtual fiat account provisioned with the integrated banking provider

Show child attributes (13)
idstring

Virtual fiat account ID

typenumber

Account type identifier (e.g. 2 for ORDER)

targetIdnumber

Internal referential order ID

vaultIdnumber

Vault ID owning the account

currencyIdnumber

Fiat currency ID

currencyCodestring

Fiat currency code (e.g. SAR)

providernumber

Banking provider identifier (e.g. 1)

providerDataobject

Provider-specific account metadata

totalDepositsstring

Total cumulative deposits credited

totalRefundsstring

Total cumulative refunds issued

statusnumber

Account status (e.g. 1 for ACTIVE)

createdAtstring

Creation timestamp in ISO 8601 format

updatedAtstring

Last update timestamp in ISO 8601 format

paymentLinkstring

Hosted checkout payment URL for the customer

createdAtstring

Order creation date and time

updatedAtstring

Order last update date and time

globalIdstring

Unique global order ULID

statusstring

Order status (PENDING, PAID, EXPIRED, CANCELLED, REFUNDED)

statusnumber

HTTP status code

Was this page helpful?