WAwafeq
Payment Requests

Retrieve payment request

Changed on

Endpoint for retrieving a single payment request.

get/payment_requests/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/payment_requests/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Query parameters

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: attachments, bank_account, bank_account.account, bills, bills.attachments, bills.branch, bills.contact, bills.journal, bills.line_items, bills.project, contact, contact.persons, cost_center. Nested relations are joined with a dot.

Response

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

Party responsible for bank transfer charges.

View the enum reference

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

An ISO 4217 currency code.

View the enum reference

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.

status'DELETED' | 'DRAFT' | 'ERROR' | 'FETCHING_STATUS' | 'NOT_FOUND' | 'PENDING_APPROVAL' | 'PENDING_RELEASE' | 'PROCESSED' | 'PROCESSING' | 'QUEUED' | 'REJECTED' | 'RELEASED' | 'VALIDATED' required

The current processing status of a payment request.

View the enum reference

swiftstring required

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

Changes