qatch/withdraw

Pushes QAR from your VoPay account to a beneficiary's Qatar IBAN over QATCH / Tahweel, Qatar's batch payment system (direct credit). Batches run on Qatar business days (Sunday to Thursday); ExecutionDate requests a particular cycle.

If a ClientAccountID is provided, the client account's name and default bank account (its IBAN) are used for the transaction.

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

Beneficiary's first name. Required with LastName unless CompanyName is given.

string

Beneficiary's last name. Required with FirstName unless CompanyName is given.

string

Beneficiary's company name, for a business beneficiary.

string
required

Beneficiary's Qatar IBAN (29 characters, starts with QA). Not needed with Token.

string

Requested batch execution date, YYYY-MM-DD, today or later, on a Qatar business day (Sunday to Thursday). Defaults to the next cycle.

string

Optional purpose text (up to 100 characters).

string

Optional sub-purpose text (up to 100 characters).

string

Client Account ID. The client account's default bank account (its IBAN) is used unless the account allows third-party banking details.

string

The ID of the contact to use for this transaction. The contact's payment method associated with this transaction type will be used.

number
required

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

string

An iQ11 token for a bank account that carries a Qatar IBAN. Replaces IBAN.

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