get https://staging.api.decentro.tech/v3/banking/account/statement
This API can be used by platforms to fetch the statement of a virtual account.
Overview
The GET Statement API allows users to retrieve statement details along with transaction records for a specified virtual account within a defined date range.
Flow
Below is the flow to get statement API
- Create a virtual account and use it for any virtual account-based collections.
- Next, pass either virtual_account_number, custom_va_number, or customer_va_identifier in the Get Statement API request to fetch the statement of the virtual account.
- Use the statement to tally, reconcile, or record your account transactions.
Managing family of virtual accounts
Clients can easily manage fetching statements of their virtual accounts by selecting from either a single virtual account, a family of virtual accounts, or all virtual accounts associated with a consumer.
To effectively identify the relevant virtual accounts, clients can use one of the following identifiers::
Identifier | Results |
---|---|
virtual_account_number | The API will respond with the statement of the specific virtual_account_number in question. |
custom_va_number | The API will respond with the statement of all virtual account numbers across various banks linked to the specified custom VA number. |
customer_va_identifier | The API will respond with the statement of all virtual account numbers across different banks associated with the given customer VA identifier. |
consumer_urn | The API will respond with the statement of all virtual accounts across banks created for the consumer. |
API Endpoints
Environment | Endpoint |
---|---|
Staging / Sandbox | https://staging.api.decentro.tech/v3/banking/account/statement |
Production | https://api.decentro.tech/v3/banking/account/statement |
Response keys
Response Key | Message |
---|---|
success_account_statement_fetched | Account statement fetched successfully. |
error_invalid_from | The provided 'from' date is invalid. Please pass a valid value. Hint: from(%Y-%m-%d %H:%M:%S). |
error_empty_from | From' date cannot be empty. Please pass a valid timestamp value. Hint: from(%Y-%m-%d %H:%M:%S). |
error_invalid_to | The provided 'to' date is invalid. Please pass a valid value. Hint: from(%Y-%m-%d %H:%M:%S). |
error_empty_to | To' date cannot be empty. Please pass a valid timestamp value. Hint: to(%Y-%m-%d %H:%M:%S). |
error_invalid_consumer_urn | Consumer URN does not exist. Please retry with a valid consumer_urn. Hint: consumer_urn (string) |
error_null_consumer_urn | The consumer URN cannot be null. Hint: consumer_urn (string) |
error_empty_consumer_urn | Consumer URN cannot be empty. Hint: consumer_urn (string) |
error_invalid_virtual_account_number | The provided virtual account number is invalid. Hint: virtual_account_number (string) |
error_null_virtual_account_number | The virtual account number cannot be null. Hint: virtual_account_number (string) |
error_empty_virtual_account_number | The virtual account number cannot be empty. Hint: virtual_account_number (string) |
error_invalid_custom_va_number | The provided custom VA number is invalid. Hint: custom_va_number (string) |
error_null_custom_va_number | The custom VA number cannot be null. Hint: custom_va_number (string) |
error_empty_custom_va_number | The custom VA number cannot be empty. Hint: custom_va_number (string) |
error_invalid_customer_va_identifier | The provided customer VA identifier is invalid. Hint: customer_va_identifier (string) |
error_null_customer_va_identifier | The customer VA identifier cannot be null. Hint: customer_va_identifier (string) |
error_empty_customer_va_identifier | The customer VA identifier cannot be empty. Hint: customer_va_identifier (string) |
error_invalid_page | The provided page number is invalid. Hint page(int). |
error_null_page | The page number cannot be null. Hint page(int). |
error_empty_page | The page number cannot be empty. Hint page(int). |
error_to_should_be_greater_than_from | The 'to' datetime should be greater than the 'from' datetime. |
error_to_equals_from | The 'to' datetime is same as the 'from' datetime. |
error_no_record_found | No virtual account found with the given values. Please provide a valid value for either the virtual_account_number, custom_va_number, or customer_va_identifier, and try again. |