API Reference
Fiat Gateway
Fiat operations for fiat vaults: let a client deposit money with a payment link, look up fiat accounts and transactions, refund deposits, and pay out your collected balance to your company bank account.
Each fiat client has a fiat account (a virtual IBAN, VIBAN). Deposits create fiat transactions (type DEPOSIT); refunds and payouts create transactions of type REFUND and PAYOUT. Transaction statuses: PENDING, PROCESSING, SUCCESS, FAILED. Follow them with the fiat_transaction_created, fiat_transaction_completed, fiat_transaction_failed and fiat_refund_created webhooks.
Currency: currently SAR only.
Endpoints
POSTGenerate Payment LinkCreates a hosted payment page where one of your fiat clients can deposit money (card or bank transfer). The client must have a name.GETGet Fiat Transaction DetailsReturns one fiat transaction: type, status, amount, fees, bank references and processing date.GETGet Fiat Account DetailsReturns one fiat account of this vault: its VIBAN, currency, status, owner and totals.POSTRefund Fiat TransactionRefunds a deposit, fully or partly, to the IBAN stored for the client. Only deposits from clients with an IBAN can be refunded. The refund is processed asynchronously: you get the new refund transaction id now, and the fiat_refund_created webhook.GETGet Vault Fiat CurrencyReturns the vault's settings for a fiat currency.GETEstimate Fiat Payout FeesEstimates the fee of a payout of your collected balance to your company bank account.POSTTrigger Fiat PayoutPays out your collected balance (or the given amount) to your company bank account now, instead of waiting for the automatic payout.
Was this page helpful?