WAwafeq
Payment Requests

List payment requests

Changed on

Endpoint for retrieving a list of payment requests.

get/payment_requests/

Request

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

Query parameters

amount_maxnumber double nullable

Amount

amount_minnumber double nullable

Amount

created_ts_afterstring date-time

The timestamp in UTC when the payment request was created

created_ts_beforestring date-time

The timestamp in UTC when the payment request was created

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

Currency

  • AED - AED ⃱
  • SAR - SAR ⃁
  • USD - USD $
  • EUR - EUR €
  • CAD - CAD $
  • AFN - AFN ؋
  • ALL - ALL Lek
  • AMD - AMD դր.
  • ARS - ARS $
  • AUD - AUD $
  • AZN - AZN ман.
  • BAM - BAM KM
  • BDT - BDT ৳
  • BGN - BGN лв.
  • BHD - BHD د.ب.‏
  • BIF - BIF FBu
  • BND - BND $
  • BOB - BOB Bs
  • BRL - BRL R$
  • BWP - BWP P
  • BYN - BYN BYN
  • BZD - BZD $
  • CDF - CDF FrCD
  • CHF - CHF CHF
  • CLP - CLP $
  • CNY - CNY CN¥
  • COP - COP $
  • CRC - CRC ₡
  • CVE - CVE CV$
  • CZK - CZK Kč
  • DJF - DJF Fdj
  • DKK - DKK kr
  • DOP - DOP RD$
  • DZD - DZD د.ج.‏
  • EGP - EGP ج.م.‏
  • ERN - ERN Nfk
  • ETB - ETB Br
  • GBP - GBP £
  • GEL - GEL GEL
  • GHS - GHS GH₵
  • GNF - GNF FG
  • GTQ - GTQ Q
  • HKD - HKD $
  • HNL - HNL L
  • HRK - HRK kn
  • HUF - HUF Ft
  • IDR - IDR Rp
  • ILS - ILS ₪
  • INR - INR ₹
  • IQD - IQD د.ع.‏
  • IRR - IRR ﷼
  • ISK - ISK kr
  • JMD - JMD $
  • JOD - JOD د.أ.‏
  • JPY - JPY ￥
  • KES - KES Ksh
  • KHR - KHR ៛
  • KMF - KMF FC
  • KRW - KRW ₩
  • KWD - KWD د.ك.‏
  • KZT - KZT тңг.
  • LBP - LBP ل.ل.‏
  • LKR - LKR SL Re
  • LYD - LYD د.ل.‏
  • MAD - MAD د.م.‏
  • MDL - MDL MDL
  • MGA - MGA MGA
  • MKD - MKD MKD
  • MMK - MMK K
  • MOP - MOP MOP$
  • MUR - MUR MURs
  • MXN - MXN $
  • MYR - MYR RM
  • MZN - MZN MTn
  • NAD - NAD N$
  • NGN - NGN ₦
  • NIO - NIO C$
  • NOK - NOK kr
  • NPR - NPR नेरू
  • NZD - NZD $
  • OMR - OMR ر.ع.‏
  • PAB - PAB B/.
  • PEN - PEN S/.
  • PHP - PHP ₱
  • PKR - PKR ₨
  • PLN - PLN zł
  • PYG - PYG ₲
  • QAR - QAR ر.ق.‏
  • RON - RON RON
  • RSD - RSD дин.
  • RUB - RUB руб.
  • RWF - RWF FR
  • SDG - SDG SDG
  • SEK - SEK kr
  • SGD - SGD $
  • SOS - SOS Ssh
  • SYP - SYP ل.س.‏
  • THB - THB ฿
  • TND - TND د.ت.‏
  • TOP - TOP T$
  • TRY - TRY TL
  • TTD - TTD $
  • TWD - TWD NT$
  • TZS - TZS TSh
  • UAH - UAH ₴
  • UGX - UGX USh
  • UYU - UYU $
  • UZS - UZS UZS
  • VES - VES Bs.S.
  • VND - VND ₫
  • XAF - XAF FCFA
  • XOF - XOF CFA
  • YER - YER ر.ي.‏
  • ZAR - ZAR R
  • ZMW - ZMW ZK
date_afterstring date

Date

date_beforestring date

Date

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.

modified_ts_afterstring date-time

The timestamp in UTC when the payment request was last modified

modified_ts_beforestring date-time

The timestamp in UTC when the payment request was last modified

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

status'DELETED' | 'DRAFT' | 'ERROR' | 'FETCHING_STATUS' | 'NOT_FOUND' | 'PENDING_APPROVAL' | 'PENDING_RELEASE' | 'PROCESSED' | 'PROCESSING' | 'QUEUED' | 'REJECTED' | 'RELEASED' | 'VALIDATED' | '__null__'
  • 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
  • REJECTED - REJECTED
  • RELEASED - RELEASED
  • VALIDATED - VALIDATED
  • __null__ - null

Status

  • 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
  • REJECTED - Rejected
  • RELEASED - Released
  • VALIDATED - Validated

Response

countinteger required

The total number of results across all pages.

nextstring uri nullable

The URL of the next page of results, or null on the last page.

previousstring uri nullable

The URL of the previous page of results, or null on the first page.

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes