Account Statements
Overview
Orum enables you to personalize the bank account statements of your end users by using two optional fields in the API:
- Statement Display Name
- Account Statement Descriptor
Statement Display Name
- There are two
statement_display_name
fields in the API request body: one nested under the “source” object and one nested under the “destination” object. - The purpose of these fields is to help end users understand who is pulling or pushing money to their accounts. You can pass your name, your customer’s name or anything that helps your end users recognize the payment.
- The
statement_display_name
fields accept up to 16 alphanumeric characters (including spaces) for ACH transfers and up to 140 alphanumeric characters for RTP transfers. - For RTP transfers, “Orum” will be appended to the
statement_display_name
that you pass in your request. For example, "Orum-{statement_display_name}" - This field maps to “Company Name” in the NACHA file.
How does Statement Display Name Work?
When determining what information, if any, to pass in each optional field, we recommend asking yourself these two questions:
- Statement Display Name under the source object: What name do you want to show up on the bank statement of the source (the party being debited) to ensure that they know who pulled money from their account?
- Statement Display Name under the destination object: What name do you want to show up on the bank statement of the destination (the party being credited) to ensure that they know who pushed money to their account?
Example
Account Statement Descriptor
- The purpose of this field is to provide information about the reason for a payment. If statement_display_name explains who initiated a debit or credit, the account_statement_descriptor can explain why the transfer was made.
- The account_statement_descriptor field can accept 10 alphanumeric characters for ACH and 140 characters for RTP.
- This field is available for ACH, Same Day ACH, and RTP. It is not available for Wires
- This field maps to “Company Entry Description” in the NACHA file. The NACHA file formats include a Company Entry Description (CED) in the Batch Header record, which intends to describe the purpose or intent of a transaction.
How Does Account Statement Descriptor Work?
There is one optional account_statement_descriptor
field in the API request body, and the value that you pass will appear on the bank account statement of both the source and destination account. When determining what information, if any, to pass we recommend asking yourself this question:
- What descriptive information would help the party being debited and the party being credited, understand the reason for the payment?
Example
Example API Request
{
"currency": "USD",
"source": {
"account_reference_id": "string",
"customer_reference_id": "string",
"statement_display_name": "test name 1"
},
"destination": {
"account_reference_id": "string",
"customer_reference_id": "string",
"statement_display_name": "test name 2"
},
"transfer_reference_id": "string",
"amount": 111,
"account_statement_descriptor": "test description"
}
Updated 8 months ago