v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB

Payment Requests

Create payment request

Endpoint for creating a new payment request.

post/payment_requests/

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

amountnumber double nullable required

The amount to transfer to the beneficiary. Must be a non-negative value.

attachmentsstring[]

The attachments linked to this payment request.

bank_accountstring required

The bank account associated with this payment request.

beneficiarystring required

The beneficiary associated with this payment request.

beneficiary_addressstring required

The full address of the beneficiary.

beneficiary_namestring required

The full name of the beneficiary.

billsstring[]

The bills associated with this payment request. Only one bill can be assigned.

charge_type'OUR' | 'BEN' | 'SHA' required

OUR - Ours
BEN - Beneficiary
SHA - Shared

Full information for ChargeTypeEnum

contactstring required

The contact associated with this payment request.

cost_centerstring nullable

The cost center associated with this payment request.

created_tsstring date-time required

The timestamp in UTC when the payment request was created

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW' required

AED - AED ⃱
SAR - SAR ⃁
USD - USD $
EUR - EUR €
CAD - CAD $
AFN - AFN ؋
ALL - ALL Lek
AMD - AMD դր.
ARS - ARS $
AUD - AUD $
...

Full information for CurrencyEnum

datestring date required

The date when the Payment Request was created. Automatically set and read-only.

details_of_paymentstring required

The details of the payment to be displayed. Provide a clear description of the payment purpose.

ibanstring required

The International Bank Account Number (IBAN) for the transfer.

idstring required

The unique identifier of the payment request.

legacy_idstring required

[Deprecated] The legacy identifier of the payment request.

modified_tsstring date-time required

The timestamp in UTC when the payment request was last modified

referencestring required

The unique reference of the payment request. Used for tracking and identification.

send_payment_adviceboolean required

Boolean indicating whether to send a payment advice by email or not.

DELETED - Deleted
DRAFT - Draft
ERROR - Error
FETCHING_STATUS - Fetching status
NOT_FOUND - Not found
PENDING_APPROVAL - Pending approval
PENDING_RELEASE - Pending release
PROCESSED - Processed
PROCESSING - Processing
QUEUED - Queued
...

Full information for PaymentRequestStatusEnum

swiftstring required

SWIFT/BIC code of the destination bank account for international transfers.

Response