> ## Documentation Index > Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt > Use this file to discover all available pages before exploring further. # List payment batch payments > Retrieve paginated list of all payments for given payment batch. ## OpenAPI ````yaml /autogenerated/openapi/payment-batch.openapi.json get /payment-batches/{paymentBatchId}/payments openapi: 3.1.0 info: title: Payment Batch API version: 2.0.0 description: Version 2 license: name: UNLICENSED url: https://docs.equalsmoney.com servers: - url: https://api.equalsmoney.com/v2 description: Production - url: https://api-sandbox.equalsmoney.com/v2 description: Sandbox security: [] paths: /payment-batches/{paymentBatchId}/payments: get: tags: - Payment Batches summary: List payment batch payments description: Retrieve paginated list of all payments for given payment batch. operationId: findAllPaymentBatchPayments parameters: - name: paymentBatchId in: path required: true schema: type: - string maxLength: 36 format: uuid description: The unique ID of the Payment Batch. - name: accountId in: query schema: description: The ID of the account to work with. type: - string example: F50091 required: true - name: sort in: query schema: description: >- Determines whether the page of items are sorted in ascending or descending order. default: desc type: - string enum: - asc - desc - name: offset in: query schema: description: The number of items to skip before returning results. default: 0 type: - integer example: 100 - name: limit in: query schema: description: The maximum number of results to return. default: 100 type: - integer minimum: 1 maximum: 1000 example: 200 - name: search in: query schema: type: - string - name: statuses in: query schema: oneOf: - type: - string - type: - array items: type: - string enum: - created - validated - confirmed - started - completed - failed description: The status of the Payment. enum: - created - validated - confirmed - started - completed - failed - name: include in: query schema: oneOf: - type: - string - type: - array items: type: - string enum: - alertErrors - alertWarnings enum: - alertErrors - alertWarnings - name: orderIds in: query schema: oneOf: - type: - string - type: - array items: type: - string - name: budgetIds in: query schema: oneOf: - type: - string - type: - array items: type: - string format: uuid - name: currencies in: query schema: oneOf: - type: - string - type: - array items: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD responses: '200': description: OK content: application/json: schema: type: - object properties: limit: description: The maximum number of results to return. default: 100 type: - integer minimum: 1 maximum: 1000 example: 200 offset: description: The number of items to skip before returning results. default: 0 type: - integer example: 100 count: type: - integer description: >- The total amount of records matching the querying when "limit" is ignored. example: 67 rows: type: - array items: type: - object properties: id: type: - string maxLength: 36 description: The unique ID of the Payment. paymentBatchId: type: - string maxLength: 36 format: uuid description: The unique ID of the Payment Batch. orderId: type: - string maxLength: 36 description: The unique ID of the Order. status: type: - string enum: - created - validated - confirmed - started - completed - failed description: The status of the Payment. amount: type: - string pattern: ^(0|[1-9]\d{0,10})(\.\d{1,4})?$ fundingBudgetId: type: - string maxLength: 36 format: uuid description: The unique ID of the funding budget. purposeCode: type: - string - 'null' pattern: ^[A-Z0-9]{3,13}$ description: The purpose code of the payment. purpose: type: - string - 'null' maxLength: 256 description: The purpose of the payment. reference: type: - string - 'null' maxLength: 140 description: The reference of the payment. example: Invoice INV-12345 for Q1 consulting services currencyCode: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD riskCheckedAt: type: - string - 'null' format: date-time fees: type: - string - 'null' pattern: ^(0|[1-9]\d{0,10})(\.\d{1,4})?$ charges: type: - string - 'null' enum: - SHA - OUR - BEN createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. inputIndex: type: - integer externalId: type: - string - 'null' minLength: 1 maxLength: 64 description: >- A unique customer-defined identifier for the payment. Can be used to match payment requests with webhook notifications. example: cust-ref-9f3b recipient: type: - object properties: id: type: - string - 'null' minLength: 5 maxLength: 32 description: The unique ID of the Recipient. defaultReference: type: - string - 'null' maxLength: 128 description: >- The default reference used for payments to this recipient. type: type: - string enum: - individual - business - charity description: The type of recipient. name: type: - string maxLength: 128 description: The name of the recipient. displayName: type: - string - 'null' maxLength: 128 description: >- An optional name for the recipient. This is used only for display purposes.. subscribedEmails: type: - array - 'null' items: type: - object properties: name: type: - string email: type: - string format: email required: - name - email description: >- When payments are made to this recipient, the email address will be used to send a notification. minItems: 1 maxItems: 1 accountIdentifier: type: - string maxLength: 34 description: >- Identifier of the account, could be iban or account number. bankIdentifier: type: - string maxLength: 20 description: >- Identifier of the bank, could be BIC or local identifier. Such as a sort code. secondaryBankIdentifier: type: - string - 'null' maxLength: 34 description: >- The secondary bank identifier, such as Canadian routing number or Australian BSB. intermediaryBankIdentifier: type: - string - 'null' maxLength: 11 description: The BIC of the intermediary bank. paymentNetwork: type: - string enum: - SWIFT - SEPA.INSTANT - SEPA.CREDITTRANSFER - CHAPS - UKFPS - ACH - WIRETRANSFER - OFF_PLATFORM - NIP description: >- The preferred payment network for payments to this recipient. address: type: - object properties: addressType: type: - string enum: - ADDR - PBOX - HOME - BIZZ - MLTO - DLVY streetName: type: - string - 'null' maxLength: 70 buildingNumber: type: - string - 'null' maxLength: 16 buildingName: type: - string - 'null' maxLength: 35 postcode: type: - string - 'null' maxLength: 16 city: type: - string - 'null' maxLength: 35 region: type: - string - 'null' maxLength: 35 countryCode: type: - string enum: - 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 - XK - YE - YT - ZA - ZM - ZW example: GB required: - addressType - streetName - buildingNumber - buildingName - postcode - city - region - countryCode bankAddress: type: - object properties: bankName: type: - string - 'null' branch: type: - string - 'null' buildingName: type: - string - 'null' maxLength: 35 buildingNumber: type: - string - 'null' maxLength: 16 streetName: type: - string - 'null' maxLength: 70 city: type: - string - 'null' maxLength: 35 region: type: - string - 'null' maxLength: 35 postcode: type: - string - 'null' maxLength: 16 countryCode: type: - string enum: - 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 - XK - YE - YT - ZA - ZM - ZW example: GB required: - bankName - branch - buildingName - buildingNumber - streetName - city - region - postcode - countryCode validation: type: - object - 'null' properties: nameMatch: type: - boolean description: Whether the name matches the expected name. reason: type: - string - 'null' maxLength: 256 description: The reason for the validation result. reasonCode: type: - string enum: - N000 - N100 - N101 - N102 - N103 - N104 - N200 - N201 - N202 - N203 - N204 - N205 - N206 - N207 - N300 - N400 - N500 description: The reason code for the validation result. actualName: type: - string - 'null' maxLength: 256 description: The actual name of the recipient. required: - nameMatch - reason - reasonCode - actualName required: - id - defaultReference - type - name - displayName - subscribedEmails - accountIdentifier - bankIdentifier - secondaryBankIdentifier - intermediaryBankIdentifier - paymentNetwork - address - bankAddress - validation alerts: type: - array items: type: - object properties: inputIndex: type: - integer timestamp: type: - string format: date-time type: type: - string enum: - Error - Warning code: type: - string message: type: - string - 'null' required: - inputIndex - timestamp - type - code - message required: - id - paymentBatchId - orderId - status - amount - fundingBudgetId - purposeCode - purpose - reference - currencyCode - riskCheckedAt - fees - charges - createdAt - updatedAt - inputIndex - externalId - recipient description: Array of all matching payment batch payments. required: - count - rows example: limit: 200 offset: 100 count: 67 rows: - id: string paymentBatchId: 1bce4e75-abe0-4ebf-b151-fbdb0b7d5ed9 orderId: string status: created amount: string fundingBudgetId: 6ee672f6-226f-4a72-8592-0f8dc5284ab1 purposeCode: string purpose: string reference: Invoice INV-12345 for Q1 consulting services currencyCode: USD riskCheckedAt: '2019-08-24T14:15:22Z' fees: string charges: SHA createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' inputIndex: 0 externalId: cust-ref-9f3b recipient: id: string defaultReference: string type: individual name: string displayName: string subscribedEmails: - name: string email: user@example.com accountIdentifier: string bankIdentifier: string secondaryBankIdentifier: string intermediaryBankIdentifier: string paymentNetwork: SWIFT address: addressType: ADDR streetName: string buildingNumber: string buildingName: string postcode: string city: string region: string countryCode: GB bankAddress: bankName: string branch: string buildingName: string buildingNumber: string streetName: string city: string region: string postcode: string countryCode: GB validation: nameMatch: true reason: string reasonCode: N000 actualName: string alerts: - inputIndex: 0 timestamp: '2019-08-24T14:15:22Z' type: Error code: string message: string security: - CommonAuth: - payment-batches:read:any - payment-batches:read:own x-codeSamples: - lang: Shell label: cURL source: |- curl --request GET \ --url 'https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/payments?accountId={{accountId}}' \ --header 'Authorization: ' components: securitySchemes: CommonAuth: type: apiKey in: header name: Authorization ````