--- title: "Make a batch payment" method: POST path: "/batchpayments" tags: ["Payments"] --- # Make a batch payment `POST /batchpayments` As well as supporting individual payment requests, the Modulr payment platform can also handle multiple payment objects in the same request. This endpoint allows you to make a new batch payment. ## Request body - PaymentBatchPaymentOutRequest — Details of Batch request - `externalReference` string — Your reference for this Batch of payments - `strictProcessing` boolean — Flag to control if the entire batch fails for any individual payment validation failure - `submissionType` 'BATCH' | 'BULK' — BATCH restricts operations to batch level. BULK (default) allows payment level operations such as approval - `payments` PaymentPaymentOutRequest[], required — List of payments. - `sourceAccountId` string, required — Identifier for the sending Account. - `destination` PaymentDestination - `type` 'BENEFICIARY' | 'ACCOUNT' | 'IBAN' | 'SCAN' | 'INTL' | 'ANBRN' | 'AN', required — Indicates the type of destination. IBAN type is required for international payments. - `id` string — Identifier for the Payment destination if using ACCOUNT or BENEFICIARY type. Can be either: a) Beneficiary id for an external Payment, b) Account id for a transfer to another Account - `iban` string — International Bank Account Number (IBAN). To be used as the destination identifier when sending ‘IBAN’ type payments - `accountNumber` string — Account Number of destination account if using SCAN type. - `sortCode` string — Sort Code of destination account if using SCAN type. - `name` string — Name to use if a new beneficiary is created, and for using as the payee name if SCAN or IBAN types are specified for the destination - `address` PaymentAddressRequest - `addressLine1` string, required - `addressLine2` string - `postTown` string, required - `postCode` string - `country` string — Mandatory for international payments. - `countrySubDivision` string - `birthdate` string, date — The destination beneficiary's date of birth. Format: yyyy-MM-dd - `emailAddress` string — The destination beneficiary's email address - `phoneNumber` string — The destination beneficiary's phone number - `bic` string — The destination beneficiary's SWIFT BIC (Bank Identifier Code). Only to be used for international payments. - `countrySpecificDetails` PaymentDestinationCountrySpecificDetails - `bankName` string — The name of the destination bank. - `bankAddress` string — The address of the destination bank. - `bankCity` string — The city in which the destination bank resides. - `bankBranchName` string — The name of the destination bank's branch. - `bankBranchCode` string — The code of the destination bank's branch. - `bankCode` string — The code identifying the target bank on its respective national network. This is not the BIC/SWIFT code. This is known as the 'ABA code' in the U.S., 'ISFC' in India, 'routing number' in Canada, and so on. - `chineseId` string — The 18 digit identification code of the beneficiary. Applies to Chinese beneficiaries only. - `province` string — The province in which the beneficiary resides. Applies only to beneficiaries residing in China. - `abaRoutingNumber` string — The 9 digit identification code of the beneficiary. Applies to US beneficiaries only. - `business` boolean — The type of the beneficiary. 'true' for businesses, 'false' otherwise. - `bankCodeType` 'ABA' | 'CHIPS' — The code type identifying the target bank on its respective national network. This is known as the 'ABA code' in the U.S., 'ISFC' in India, 'routing number' in Canada, and so on. - `bankCountry` 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'GR' | 'HR' | 'HU' | 'IS' | 'IE' | 'IT' | 'LV' | 'LI' | 'LT' | 'LU' | 'MT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'GB' | 'MQ' | 'YT' | 'GP' | 'GF' | 'RE' | 'MF' | 'GI' | 'GG' | 'IM' | 'JE' | 'MC' | 'CH' | 'AD' | 'SM' | 'VA' | 'AX' | 'PM' | 'BL' | 'AL' | 'MD' | 'ME' | 'MK' | 'RS' | 'AF' | 'DZ' | 'AS' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'VG' | 'BN' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CU' | 'CW' | 'CD' | 'DJ' | 'DM' | 'DO' | 'TL' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'GH' | 'GL' | 'GD' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'HN' | 'HK' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IL' | 'CI' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LB' | 'LS' | 'LR' | 'LY' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MH' | 'MR' | 'MU' | 'MX' | 'FM' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PR' | 'QA' | 'CG' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'VC' | 'WS' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SX' | 'SB' | 'SO' | 'ZA' | 'KR' | 'GS' | 'SS' | 'LK' | 'SD' | 'SR' | 'SY' | 'SJ' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — The country in which the destination bank resides. Mandatory for international payments. - `legalEntityIdentifier` string — The destination beneficiary's Legal entity Identifier - `currency` 'GBP' | 'EUR' | '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' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | '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' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'SHP' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' — Currency of the account in ISO 4217 format. Default is GBP - `amount` number — Amount of the payment in Major Current Units - '1' = 1.00 GBP - `reference` string — Reference to be used for the Payment. This will appear on the Account statement/the recipient's bank account. Min 6 to max 18 characters that are not all the same (up to 140 characters for currencies other than GBP). Can contain alphanumeric, '-', '.', '&', '/' and space. - `externalReference` string — Your reference for this payment - `endToEndReference` string — Optional end to end reference. For international payments, Modulr payment ID will be used as end-to-end reference. - `regulatoryReporting` PaymentRegulatoryReporting - `type` 'CRED' | 'DEBT' | 'BOTH' — Regulatory Reporting Type - `regulatoryAuthority` PaymentRegulatoryAuthority - `authorityName` string — Authority name. Maximum of 70 characters. - `authorityCountry` 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'GR' | 'HR' | 'HU' | 'IS' | 'IE' | 'IT' | 'LV' | 'LI' | 'LT' | 'LU' | 'MT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'GB' | 'MQ' | 'YT' | 'GP' | 'GF' | 'RE' | 'MF' | 'GI' | 'GG' | 'IM' | 'JE' | 'MC' | 'CH' | 'AD' | 'SM' | 'VA' | 'AX' | 'PM' | 'BL' | 'AL' | 'MD' | 'ME' | 'MK' | 'RS' | 'AF' | 'DZ' | 'AS' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'VG' | 'BN' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CU' | 'CW' | 'CD' | 'DJ' | 'DM' | 'DO' | 'TL' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'GH' | 'GL' | 'GD' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'HN' | 'HK' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IL' | 'CI' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LB' | 'LS' | 'LR' | 'LY' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MH' | 'MR' | 'MU' | 'MX' | 'FM' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PR' | 'QA' | 'CG' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'VC' | 'WS' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SX' | 'SB' | 'SO' | 'ZA' | 'KR' | 'GS' | 'SS' | 'LK' | 'SD' | 'SR' | 'SY' | 'SJ' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — ISO 3166 country code of the ultimate payers address - `structuredRegulatoryReporting` PaymentStructuredRegulatoryReporting - `code` string - `amount` number — Amount of the payment in Major Current Units - '1' = 1.00 GBP - `currencyCode` 'GBP' | 'EUR' | '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' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | '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' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'SHP' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' — Currency of the account in ISO 4217 format. Default is GBP - `information` string - `paymentDate` string — The future date on which to make the payment. Date format 'yyyy-MM-dd'. Not applicable for international payments which will be submitted on date of submission or next working day, in line with cut-offs. - `overseasPaymentDetail` PaymentPOODetails - `ultimatePayer` PaymentUltimatePayer - `name` string, required — Name of the ultimate payer - `address` PaymentAddress, required - `addressLine1` string — First line of the ultimate payers address - `addressLine2` string — Second line of the ultimate payers address - `postTown` string — Postal town of the ultimate payers address - `postCode` string — Post code of the ultimate payers address - `country` string, required — ISO 3166 country code of the ultimate payers address - `birthDetails` PaymentBirthDetails - `dateOfBirth` string — Date of birth in ISO 8601 format of the ultimate payer - `cityOfBirth` string — City of birth of the ultimate payer - `countryOfBirth` string — ISO 3166 country code of the ultimate payers country of birth - `officialIdentification` PaymentOfficialIdDetails - `drivingLicenceNumber` string — Driving licence number - `customerNumber` string — Customer number - `socialSecurityNumber` string — Social security number or equivalent - `passportNumber` string — Passport number - `idCardNumber` string — National ID card number - `otherIdNumber` string — Other ID number - `officialIdDetailOrgs` PaymentOfficialOrganisationIdentity - `bankPartyIdentification` string — Bank party identification - `centralBankIdNumber` string — Central bank identification number - `clearingIdNumber` string — Clearing identification Number - `certificateOfIncorporationNumber` string — Certification of the incorporation number - `countryIdCode` string — Country identification code - `customerNumber` string — Customer number - `dataUniversalNumberingSystem` string — Data universal numbering system - `employerIdNumber` string — Employer identification number - `gs1glnIdentifier` string — GS1GLN identifier - `sirenCode` string — SIREN code - `siretCode` string — SIRET code - `taxIdNumber` string — Tax identification number - `bicIdentifier` string — BICI identification - `ibeiIdentifier` string — IBEI identification - `beiIdentifier` string — BEI identification - `eanglnIdentifier` string — EANGLN identification - `chipsUniversalIdentifier` string — CHIPS universal identification - `genericIdentification3` string — Generic identification 3 - `genericIdentificationIssr` string — Generic identification issr - `overseasAccountIdentifier` PaymentOverseasAccountIdentifier - `iban` string — International Bank Account Number (IBAN) - `bban` string — Basic Bank Account Number (BBAN) - `upic` string — Universal Payment Identification Code (UPIC) - `otherAccountNumber` string — Other Account ID - `bic` string — Destination beneficiary's BIC/Swift Code. - `originalPaymentDetails` PaymentPaymentDetails - `amount` number, required — Amount of currency that the payment is in - `exchangeRate` number, required — Exchange rate - `currency` 'GBP' | 'EUR' | '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' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | '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' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'SHP' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required — ISO 4217 currency code that the amount is in - `chargeDetails` PaymentCharge - `bearer` 'CRED' | 'DEBT' | 'SHAR', required — Information about bearer of the charges. Its can be Creditor, Debtor or shared between both - `amount` number, required — Amount of the charges. Max allowed is 999999999999.99 - `currency` 'GBP' | 'EUR' | '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' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | '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' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'SHP' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency of charge. Should be ISO Standard currency - `additionalRemittanceInformation` string - `purposeOfPayment` 'BKFE' | 'BKIP' | 'BKPP' | 'CBLK' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'EXTD' | 'OTCD' | 'REPO' | 'SBSC' | 'SLEB' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDSV' | 'GSCB' | 'LICF' | 'ROYA' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'ECPR' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'TRFD' | 'FORW' | 'FXNT' | 'BLDM' | 'BNET' | 'CDBL' | 'CORT' | 'CPKC' | 'EDUC' | 'FAND' | 'FEES' | 'GIFT' | 'GOVT' | 'INSM' | 'IVPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'TCSC' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'SAVG' | 'SECU' | 'TREA' | 'FNET' | 'FUTR' | 'DNTS' | 'HLTI' | 'LTCF' | 'MDCS' | 'VIEW' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'ALMY' | 'BECH' | 'BENE' | 'BONU' | 'COMM' | 'HREC' | 'PEFC' | 'PENS' | 'SALA' | 'SSBE' | 'LREB' | 'LREV' | 'ESTX' | 'HSTX' | 'INTX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'CBTV' | 'ELEC' | 'GASB' | 'PHON' | 'UBIL' | 'WTER' | 'GAMB' | 'LOTT' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' — A code from the UK Recommended Purpose Code list that indicates the type of Payment. This is optional for most payment types but recommended to be completed where possible; where it is required for certain purposes of CHAPS payment if not supplied a default value will be used - `categoryOfPayment` 'BONU' | 'CASH' | 'CBLK' | 'CCRD' | 'CORT' | 'DCRD' | 'DIVI' | 'DVPM' | 'FCOL' | 'GP2P' | 'GOVT' | 'HEDG' | 'INTC' | 'INTE' | 'LOAN' | 'MP2P' | 'OTHR' | 'PENS' | 'RRCT' | 'SALA' | 'SECU' | 'SSBE' | 'SUPP' | 'TAXS' | 'TRAD' | 'TREA' | 'VATX' | 'WHLD' — A category code from the UK Recommended Purpose Code list that indicates the general category of the Payment. This is optional for all types of payment, and defaults to 'OTHR' on schemes that accept category - `permittedScheme` 'SEPA_CREDIT_TRANSFER' — Attempt to process the payment using only the specified scheme - `nameCheck` PaymentNameCheck - `id` string, required — Identifier of name check result - `source` 'MODULR' | 'EXTERNAL' — Origin of the name check result, could be MODULR or EXTERNAL - `fx` PaymentFxDetails - `quoteId` string, required — Quote Id for foreign exchange trade - `destinationId` string - `destinationType` 'BENEFICIARY' | 'ACCOUNT' | 'IBAN' | 'SCAN' | 'INTL' | 'ANBRN' | 'AN' ## Response `201` BatchPaymentReference - PaymentBatchPaymentDetailsResponse - `id` string — Unique id for the Batch Payment. 10 characters long - `externalReference` string — External reference, if provided - `status` 'ACCEPTED' | 'REJECTED' | 'SUBMITTED' | 'CANCELLED' — Current status of batch. - `totalPayments` integer — Total count of payments in this batch - `currentUserCanApprove` boolean — Whether the user is allowed to approve this batch, based on their approval limits, and applicable configuration - `paymentDetails` object — Summary of payments and approvals, per currency (as a 3-alpha currency code) - `approvals` PaymentPaymentApproval[] — List of batch-level approvals - `approvedBy` string — ID of user who approved this batch payment request - `approvedOn` string, date — Date this approval was applied - `currentUserCanCancel` boolean — Whether the user is allowed and currently able to cancel at least one of the payments in this batch - `createdDate` string, date-time — Datetime when the batch payment was created. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000 - `createdBy` string — ID of the user that created the payment - `processingDateFrom` string, date — Earliest processing date in the batch file or the batch creation date if the file does not have any dates. Date format 'yyyy-MM-dd' - `processingDateTo` string, date — Last processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000' - `earliestScheduledPaymentDate` string, date — Earliest processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000' - `requiredApprovalCount` integer — The number of required approvals for the batch. Applicable to batch payments of submissionType BATCH - `batchSummary` PaymentBatchSummary - `total` integer — Total count of payment requests in this batch - `inprogress` integer — Count of payment requests in progress - `invalid` integer — Count of invalid payment requests - `errors` integer — Count of failed payment requests - `cancelled` integer — Count of cancelled payment requests - `completed` integer — Count of completed payments - `info` string — Additional information or error message regarding this batch payment request - `strict` boolean — Strict processing flag. Whether the entire batch should fail on any individual payment validation failure - `summary` PaymentBatchPaymentSummary - `total` integer — Total count of payment requests in this batch - `invalid` integer — Count of invalid payment requests - `inprogress` integer — Count of payment requests in progress - `completed` integer — Count of completed payments - `errors` integer — Count of failed payment requests - `cancelled` integer — Count of cancelled payment requests - `info` string — Additional information or error message regarding this batch payment request - `strict` boolean ## Other responses - `400` — Validation errors --- [API](https://skmtc.net/modulrfinance/apis/modulr-api.md) · [All operations](https://skmtc.net/modulrfinance/apis/modulr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modulrfinance/modulr-api/revisions/cbd52524c8ef/schema)