Upload a payment file
Use payment files to create payment orders in bulk in the dashboard
In addition to the API and manual payment order creation in the dashboard, Numeral enables you to create payment orders by uploading a payment file in the dashboard. To upload a payment file, go to Payments > Payment orders > Upload payment file.
1. Uploading a payment file
By default, the payment file upload feature supports two formats:
- Standard ISO 20022 pain.001 XML files
- Numeral CSV template
If you have a custom file format that you would like to use, please contact us at [email protected]..
After you upload a payment file, the corresponding payment orders will be created asynchronously. You can close or refresh the page. After they have been created, payment orders will be visible on the Payment orders page.
2. Processing time
Number payments | Processing time |
---|---|
Up to 1,000 | <60 seconds |
Up to 10,000 | ~5 minutes |
Up to 25,000 | ~25 minutes |
3. Numeral CSV template
Columns | Description | Authorised values | Mandatory |
---|---|---|---|
id | The ID of the payment. If filled, Numeral will check for duplicates before creating the payment | Recommended unique values like UUID-v4 | Recommended |
type | The type of the payment | sepa , sepa_instant , sepa_urgent , fps , bacs , swift , treasury , or target2 | ✅ |
treasury_option | The type of treasury payments | local , international , relocated , or safeguarding | |
confidentiality_option | Used in case of a confidential payment | payroll | |
fee_option | Network payment fee preference. Only applicable to Swift payments | shared , originator , or receiver | |
direction | The direction of the payment | credit or debit | ✅ |
amount | The amount of the payment, with decimals | Amount with decimals, e.g 149.99 | ✅ |
currency | The currency of the payment | ISO 4217 currency codes, e.g. EUR or GBP | ✅ |
reference | The message that will appear on the origin and destination account statements, with a maximum of 140 characters | String, up to 140 characters | ✅ |
purpose | Reserved, not used at the moment | ||
requested_execution_date | The requested execution date of the payment order. Only available for SEPA direct debit for now. | Date format, yyyy-mm-dd, e.g., 2024-06-22 | |
receiving_account_holder _name | The account holder name of the receiving account | ✅ | |
receiving_account_account _number | The account number of the receiving account | IBAN or local account number format | ✅ |
receiving_account_bank _code | The bank code of the receiving account | BIC / Swift code or local format (sort code) | ✅ |
receiving_account_country | The country of the receiving account | ISO 3166 country codes | Recommended |
receiving_account_city | The city of the receiving account | Recommended | |
receiving_account_building _number | The building number of the receiving account | ||
receiving_account_street _name | The street name of the receiving account | ||
receiving_account_zip _code | The zip code of the receiving account | ||
receiving_account_region _state | The region or state of the receiving account | ||
direct_debit_mandate _reference | The unique mandate reference. Only applicable in the case of direct debit payments | Mandatory for direct debit payments | |
direct_debit_mandate _type | The mandate type. Only applicable in the case of direct debit payments | sepa_core , sepa_b2b , or bacs_debit | Mandatory for direct debit payments |
direct_debit_mandate _sequence | The mandate sequence. Only applicable to SEPA direct debit payments | one_off , first , recurring , orlast | Mandatory for direct debit payments |
direct_debit_mandate _signature_date | The mandate type. Only applicable to SEPA direct debit payments | Date format, yyyy-mm-dd, e.g., 2024-06-22 | Mandatory for direct debit payments |
originating_account_holder _name | The holder name of the receiving account. Only applicable to SEPA indirect payments | Mandatory for SEPA indirect or agency banking payments | |
originating_account_account _number | The account number of the receiving account. Only applicable to SEPA indirect payments | IBAN or local account numberformat | Mandatory for SEPA indirect or agency banking payments |
originating_account_bank _code | The bank code of the receiving account. Only applicable to SEPA indirect payments | BIC / Swift code or local format (UK sort code) | Mandatory for SEPA indirect or agency banking payments |
originating_account_creditor _identifier | The creditor identifier of the receiving account. Only applicable to indirect participants for direct debit payments | SEPA Creditor Identifier (SCI) or UK Service User Number (SUN) | Mandatory for direct debit SEPA indirect or agency banking payments |
originating_account_country | The country of the receiving account. Only applicable to SEPA indirect payments | ISO 3166 country codes | Mandatory for SEPA indirect or agency banking payments |
originating_account_city | The city of the receiving account. Only applicable to SEPA indirect payments | Recommended for SEPA indirect or agency banking payments | |
originating_account_building _number | The building number of the receiving account. Only applicable to SEPA indirect payments | ||
originating_account_street _name | The street name of the receiving account. Only applicable to SEPA indirect payments | ||
originating_account_zip _code | The zip code of the receiving account. Only applicable to SEPA indirect payments | ||
originating_account_region _state | The region or state of the receiving account. Only applicable to SEPA indirect payments | ||
ultimate_originator_holder _name | The holder name of the ultimate originating account, for regulation purposes | ||
ultimate_originator_organization _identification_bank_code | The BIC code of the ultimate originating account, for regulation purposes | ||
ultimate_originator_organization _identification_other | The identification or registration number of the ultimate originating account, for regulation purposes | ||
metadata | Technical metadata related to this payment. See metadata | metadata_key1 =value1 | metadata_key2 =value2 |
custom_fields | Custom field values related to the payment. See custom fields | custom_field_key_1 =value1 | custom_field_key2 =value2 |
Updated 5 days ago