WAwafeq
Beneficiaries

List beneficiaries

Changed on

Endpoint for retrieving a list of beneficiaries.

get/beneficiaries/

Request

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

Query parameters

charge_type'BEN' | 'OUR' | 'SHA' | '__null__'
  • BEN - BEN
  • OUR - OUR
  • SHA - SHA
  • __null__ - null
  • OUR - Ours
  • BEN - Beneficiary
  • SHA - Shared
contactstring
country'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | '__null__'
  • AD - AD
  • AE - AE
  • AF - AF
  • AG - AG
  • AI - AI
  • AL - AL
  • AM - AM
  • AO - AO
  • AQ - AQ
  • AR - AR
  • AS - AS
  • AT - AT
  • AU - AU
  • AW - AW
  • AX - AX
  • AZ - AZ
  • BA - BA
  • BB - BB
  • BD - BD
  • BE - BE
  • BF - BF
  • BG - BG
  • BH - BH
  • BI - BI
  • BJ - BJ
  • BL - BL
  • BM - BM
  • BN - BN
  • BO - BO
  • BQ - BQ
  • BR - BR
  • BS - BS
  • BT - BT
  • BV - BV
  • BW - BW
  • BY - BY
  • BZ - BZ
  • CA - CA
  • CC - CC
  • CD - CD
  • CF - CF
  • CG - CG
  • CH - CH
  • CI - CI
  • CK - CK
  • CL - CL
  • CM - CM
  • CN - CN
  • CO - CO
  • CR - CR
  • CU - CU
  • CV - CV
  • CW - CW
  • CX - CX
  • CY - CY
  • CZ - CZ
  • DE - DE
  • DJ - DJ
  • DK - DK
  • DM - DM
  • DO - DO
  • DZ - DZ
  • EC - EC
  • EE - EE
  • EG - EG
  • EH - EH
  • ER - ER
  • ES - ES
  • ET - ET
  • FI - FI
  • FJ - FJ
  • FK - FK
  • FM - FM
  • FO - FO
  • FR - FR
  • GA - GA
  • GB - GB
  • GD - GD
  • GE - GE
  • GF - GF
  • GG - GG
  • GH - GH
  • GI - GI
  • GL - GL
  • GM - GM
  • GN - GN
  • GP - GP
  • GQ - GQ
  • GR - GR
  • GS - GS
  • GT - GT
  • GU - GU
  • GW - GW
  • GY - GY
  • HK - HK
  • HM - HM
  • HN - HN
  • HR - HR
  • HT - HT
  • HU - HU
  • ID - ID
  • IE - IE
  • IL - IL
  • IM - IM
  • IN - IN
  • IO - IO
  • IQ - IQ
  • IR - IR
  • IS - IS
  • IT - IT
  • JE - JE
  • JM - JM
  • JO - JO
  • JP - JP
  • KE - KE
  • KG - KG
  • KH - KH
  • KI - KI
  • KM - KM
  • KN - KN
  • KP - KP
  • KR - KR
  • KW - KW
  • KY - KY
  • KZ - KZ
  • LA - LA
  • LB - LB
  • LC - LC
  • LI - LI
  • LK - LK
  • LR - LR
  • LS - LS
  • LT - LT
  • LU - LU
  • LV - LV
  • LY - LY
  • MA - MA
  • MC - MC
  • MD - MD
  • ME - ME
  • MF - MF
  • MG - MG
  • MH - MH
  • MK - MK
  • ML - ML
  • MM - MM
  • MN - MN
  • MO - MO
  • MP - MP
  • MQ - MQ
  • MR - MR
  • MS - MS
  • MT - MT
  • MU - MU
  • MV - MV
  • MW - MW
  • MX - MX
  • MY - MY
  • MZ - MZ
  • NA - NA
  • NC - NC
  • NE - NE
  • NF - NF
  • NG - NG
  • NI - NI
  • NL - NL
  • NO - NO
  • NP - NP
  • NR - NR
  • NU - NU
  • NZ - NZ
  • OM - OM
  • PA - PA
  • PE - PE
  • PF - PF
  • PG - PG
  • PH - PH
  • PK - PK
  • PL - PL
  • PM - PM
  • PN - PN
  • PR - PR
  • PS - PS
  • PT - PT
  • PW - PW
  • PY - PY
  • QA - QA
  • RE - RE
  • RO - RO
  • RS - RS
  • RU - RU
  • RW - RW
  • SA - SA
  • SB - SB
  • SC - SC
  • SD - SD
  • SE - SE
  • SG - SG
  • SH - SH
  • SI - SI
  • SJ - SJ
  • SK - SK
  • SL - SL
  • SM - SM
  • SN - SN
  • SO - SO
  • SR - SR
  • SS - SS
  • ST - ST
  • SV - SV
  • SX - SX
  • SY - SY
  • SZ - SZ
  • TC - TC
  • TD - TD
  • TF - TF
  • TG - TG
  • TH - TH
  • TJ - TJ
  • TK - TK
  • TL - TL
  • TM - TM
  • TN - TN
  • TO - TO
  • TR - TR
  • TT - TT
  • TV - TV
  • TW - TW
  • TZ - TZ
  • UA - UA
  • UG - UG
  • UM - UM
  • US - US
  • UY - UY
  • UZ - UZ
  • VA - VA
  • VC - VC
  • VE - VE
  • VG - VG
  • VI - VI
  • VN - VN
  • VU - VU
  • WF - WF
  • WS - WS
  • YE - YE
  • YT - YT
  • ZA - ZA
  • ZM - ZM
  • ZW - ZW
  • __null__ - null
  • SA - Kingdom of Saudi Arabia
  • AE - United Arab Emirates
  • QA - Qatar
  • BH - Bahrain
  • KW - Kuwait
  • OM - Oman
  • EG - Egypt
  • US - United States of America
  • AF - Afghanistan
  • AX - Åland Islands
  • AL - Albania
  • DZ - Algeria
  • AS - American Samoa
  • AD - Andorra
  • AO - Angola
  • AI - Anguilla
  • AQ - Antarctica
  • AG - Antigua and Barbuda
  • AR - Argentina
  • AM - Armenia
  • AW - Aruba
  • AU - Australia
  • AT - Austria
  • AZ - Azerbaijan
  • BS - Bahamas (The)
  • BD - Bangladesh
  • BB - Barbados
  • BY - Belarus
  • BE - Belgium
  • BZ - Belize
  • BJ - Benin
  • BM - Bermuda
  • BT - Bhutan
  • BO - Bolivia
  • BQ - Bonaire, Sint Eustatius and Saba
  • BA - Bosnia and Herzegovina
  • BW - Botswana
  • BV - Bouvet Island
  • BR - Brazil
  • IO - British Indian Ocean Territory
  • BN - Brunei
  • BG - Bulgaria
  • BF - Burkina Faso
  • BI - Burundi
  • CV - Cabo Verde
  • KH - Cambodia
  • CM - Cameroon
  • CA - Canada
  • KY - Cayman Islands
  • CF - Central African Republic
  • TD - Chad
  • CL - Chile
  • CN - China
  • CX - Christmas Island
  • CC - Cocos (Keeling) Islands
  • CO - Colombia
  • KM - Comoros
  • CG - Congo
  • CK - Cook Islands
  • CR - Costa Rica
  • CI - Côte d'Ivoire
  • HR - Croatia
  • CU - Cuba
  • CW - Curaçao
  • CY - Cyprus
  • CZ - Czechia
  • CD - Democratic Republic of the Congo
  • DK - Denmark
  • DJ - Djibouti
  • DM - Dominica
  • DO - Dominican Republic
  • EC - Ecuador
  • SV - El Salvador
  • GQ - Equatorial Guinea
  • ER - Eritrea
  • EE - Estonia
  • SZ - Eswatini
  • ET - Ethiopia
  • FK - Falkland Islands (Malvinas)
  • FO - Faroe Islands
  • FJ - Fiji
  • FI - Finland
  • FR - France
  • GF - French Guiana
  • PF - French Polynesia
  • TF - French Southern Territories
  • GA - Gabon
  • GM - Gambia
  • GE - Georgia
  • DE - Germany
  • GH - Ghana
  • GI - Gibraltar
  • GR - Greece
  • GL - Greenland
  • GD - Grenada
  • GP - Guadeloupe
  • GU - Guam
  • GT - Guatemala
  • GG - Guernsey
  • GN - Guinea
  • GW - Guinea-Bissau
  • GY - Guyana
  • HT - Haiti
  • HM - Heard Island and McDonald Islands
  • HN - Honduras
  • HK - Hong Kong
  • HU - Hungary
  • IS - Iceland
  • IN - India
  • ID - Indonesia
  • IR - Iran
  • IQ - Iraq
  • IE - Ireland
  • IM - Isle of Man
  • IL - Israel
  • IT - Italy
  • JM - Jamaica
  • JP - Japan
  • JE - Jersey
  • JO - Jordan
  • KZ - Kazakhstan
  • KE - Kenya
  • KI - Kiribati
  • KG - Kyrgyzstan
  • LA - Laos
  • LV - Latvia
  • LB - Lebanon
  • LS - Lesotho
  • LR - Liberia
  • LY - Libya
  • LI - Liechtenstein
  • LT - Lithuania
  • LU - Luxembourg
  • MO - Macao
  • MG - Madagascar
  • MW - Malawi
  • MY - Malaysia
  • MV - Maldives
  • ML - Mali
  • MT - Malta
  • MH - Marshall Islands
  • MQ - Martinique
  • MR - Mauritania
  • MU - Mauritius
  • YT - Mayotte
  • MX - Mexico
  • FM - Micronesia
  • MD - Moldova
  • MC - Monaco
  • MN - Mongolia
  • ME - Montenegro
  • MS - Montserrat
  • MA - Morocco
  • MZ - Mozambique
  • MM - Myanmar
  • NA - Namibia
  • NR - Naoero
  • NP - Nepal
  • NL - Netherlands
  • NC - New Caledonia
  • NZ - New Zealand
  • NI - Nicaragua
  • NE - Niger
  • NG - Nigeria
  • NU - Niue
  • NF - Norfolk Island
  • KP - North Korea
  • MK - North Macedonia
  • MP - Northern Mariana Islands
  • NO - Norway
  • PK - Pakistan
  • PW - Palau
  • PS - Palestine
  • PA - Panama
  • PG - Papua New Guinea
  • PY - Paraguay
  • PE - Peru
  • PH - Philippines
  • PN - Pitcairn
  • PL - Poland
  • PT - Portugal
  • PR - Puerto Rico
  • RE - Réunion
  • RO - Romania
  • RU - Russia
  • RW - Rwanda
  • BL - Saint Barthélemy
  • SH - Saint Helena
  • KN - Saint Kitts and Nevis
  • LC - Saint Lucia
  • MF - Saint Martin (French part)
  • PM - Saint Pierre and Miquelon
  • VC - Saint Vincent and the Grenadines
  • WS - Samoa
  • SM - San Marino
  • ST - Sao Tome and Principe
  • SN - Senegal
  • RS - Serbia
  • SC - Seychelles
  • SL - Sierra Leone
  • SG - Singapore
  • SX - Sint Maarten (Dutch part)
  • SK - Slovakia
  • SI - Slovenia
  • SB - Solomon Islands
  • SO - Somalia
  • ZA - South Africa
  • GS - South Georgia
  • KR - South Korea
  • SS - South Sudan
  • ES - Spain
  • LK - Sri Lanka
  • SD - Sudan
  • SR - Suriname
  • SJ - Svalbard and Jan Mayen
  • SE - Sweden
  • CH - Switzerland
  • SY - Syria
  • TW - Taiwan
  • TJ - Tajikistan
  • TZ - Tanzania
  • TH - Thailand
  • TL - Timor-Leste
  • TG - Togo
  • TK - Tokelau
  • TO - Tonga
  • TT - Trinidad and Tobago
  • TN - Tunisia
  • TR - Türkiye
  • TM - Turkmenistan
  • TC - Turks and Caicos Islands
  • TV - Tuvalu
  • UG - Uganda
  • UA - Ukraine
  • GB - United Kingdom
  • UM - United States Minor Outlying Islands
  • UY - Uruguay
  • UZ - Uzbekistan
  • VU - Vanuatu
  • VA - Vatican City
  • VE - Venezuela
  • VN - Vietnam
  • VG - Virgin Islands (British)
  • VI - Virgin Islands (U.S.)
  • WF - Wallis and Futuna
  • EH - Western Sahara
  • YE - Yemen
  • ZM - Zambia
  • ZW - Zimbabwe
created_ts_afterstring date-time

The timestamp in UTC when the beneficiary bank account was created

created_ts_beforestring date-time

The timestamp in UTC when the beneficiary bank account 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
  • 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
expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: contacts, contacts.persons. Nested relations are joined with a dot.

keywordstring

A search term.

modified_ts_afterstring date-time

The timestamp in UTC when the beneficiary bank account was last modified

modified_ts_beforestring date-time

The timestamp in UTC when the beneficiary bank account was last modified

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

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

  • b8f5e10134b4Revision changes
    • breaking

      the response property // became optional for the status

    • info

      added the new optional query request parameter expand