fawran/withdraw

Sends QAR from your VoPay account to a recipient over Fawran, Qatar's instant payment system. The payee is a saved Fawran recipient: a tokenized alias, like a Zelle or PayPal recipient. Name it one of three ways: FawranToken for a recipient saved earlier (by a previous payout, /fawran/link-recipient or /qa/contacts/add-fawran-recipient); a ClientAccountID / ContactID alone, which pays that client account's default Fawran recipient (see /fawran/set-my-recipient); or RecipientName with an IBAN or an AliasType + AliasValue (a mobile number or alias name for an individual; an IBAN, Commercial Registration number, Establishment ID or License number for a corporate), which saves the recipient for reuse and returns its FawranToken. Purpose and SubPurpose are required and must come from the individual or corporate Fawran classification list.

The transaction is created pending (or pending approval under an approval workflow) and is submitted by the Fawran processor integration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

string
required

Recipient's full name (3 to 140 characters, Arabic or Latin). Required unless FawranToken or ClientAccountID / ContactID is given.

string

individual (default) or corporate. Decides the allowed AliasType values and the purpose list.

string

Recipient's Qatar IBAN (29 characters, starts with QA). Saved as an AliasType iban recipient. Required unless FawranToken, ClientAccountID / ContactID or AliasType/AliasValue is given.

string

How the recipient is addressed instead of an IBAN. Individual: mobile, alias, iban. Corporate: iban, cr_number, establishment_id, license_number.

string

The alias value: the mobile number, alias name, CR number, Establishment ID or License number.

string
required

Fawran purpose classification, from the individual or corporate list (for example Goods and Services, Personal and Family Expenses, Operational Expenses).

string
required

Fawran sub-purpose classification; must belong to the Purpose (for example Online orders, Rent, Family and friends payments).

string

Free-text remarks for the recipient (up to 255 characters).

string

Client Account ID. The client account's default Fawran recipient is paid unless the account allows third-party client account transactions and names another recipient.

string

The ID of the contact to use for this transaction. The contact's default Fawran recipient is paid.

number
required

The amount in QAR, with at most 2 decimal places.

string

Token of a saved Fawran recipient (from a previous payout, /fawran/recipients or /fawran/link-recipient). When supplied, RecipientName, RecipientType, IBAN, AliasType and AliasValue must be omitted: the recipient details are taken from the saved recipient.

string

An optional reference number to associate with the transaction.

string

An optional note to associate with the transaction.

string

A unique key which the server can use to recognize and reject subsequent retries of the same request.

string

An optional unique identification general ledger code.

string

CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes.

string

The parent transaction the withdrawal is linked to; the withdrawal waits for the parent's funds to be released.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json