Multicurrency Statements
Overview
Your multicurrency bank statement is an official summary of financial transactions that have occurred for all multicurrency accounts within a calendar month.
Statements can either be generated for all accounts associated with your institution or a specific real account associated with your institution.
Request a statement for all accounts associated with your institution
post/mccy/v1/StatementRequestsThis endpoint is used to request a statement for all accounts associated with your institution (as per the specified currency).
Parameters
Request Payload (application/json)
- year integer, Required
Year for which to generate the statement, specified using the Four Digit Year format (e.g., 2021). Cannot be for more than 24 months in the past.
- Minimum
- 2019
- month integer, Required
Month for which to generate the statement, specified using the 1–12 format (e.g., 1 for January and 12 for December). Statement for the previous month can only be generated on or after the 5th day of the current month.
- Minimum
- 1
- Maximum
- 12
- format string, Required
Format in which to generate the statement. Valid option includes csv only.
- Minimum length
- 3
- Maximum length
- 3
- Pattern
- csv
- currency string, Required
Three-letter ISO currency code for the currency of the account(s).
- Minimum length
- 3
- Maximum length
- 3
request
{"year": 2019,"month": 1,"format": "str","currency": "str"}
Response (application/json)
- 202 Success
- 400 Bad Request
- 403 Forbidden
- 404 Not Found
- 422 Client Error
- 500 Server Error
Bad Request
{"type": "string","title": "string","status": 0,"detail": "string","instance": "string","property1": null,"property2": null}
Forbidden
{"type": "string","title": "string","status": 0,"detail": "string","instance": "string","property1": null,"property2": null}
Not Found
{"type": "string","title": "string","status": 0,"detail": "string","instance": "string","property1": null,"property2": null}
Client Error
{"type": "string","title": "string","status": 0,"detail": "string","instance": "string","property1": null,"property2": null}
Associated Webhooks
Request a statement for a specific account associated with your institution
post/mccy/v1/StatementRequests/account/{iban}This endpoint is used to request a statement for a specific account associated with your institution (as per the specified currency), excluding virtual accounts.
Parameters
- iban string, path, Required
The unique International Bank Account number.
Request Payload (application/json)
- year integer, Required
Year for which to generate the statement, specified using the Four Digit Year format (e.g., 2021). Cannot be for more than 24 months in the past.
- Minimum
- 2019
- month integer, Required
Month for which to generate the statement, specified using the 1–12 format (e.g., 1 for January and 12 for December). Statement for the previous month can only be generated on or after the 5th day of the current month.
- Minimum
- 1
- Maximum
- 12
- format string, Required
Format in which to generate the statement. Valid option includes csv only.
- Minimum length
- 3
- Maximum length
- 3
- Pattern
- csv
- currency string, Required
Three-letter ISO currency code for the currency of the account(s).
- Minimum length
- 3
- Maximum length
- 3
request
{"year": 2019,"month": 1,"format": "str","currency": "str"}
Response (application/json)
- 202 Success
- 400 Bad Request
- 403 Forbidden
- 404 Not Found
- 422 Client Error
- 500 Server Error
Bad Request
{"type": "string","title": "string","status": 0,"detail": "string","instance": "string","property1": null,"property2": null}
Forbidden
{"type": "string","title": "string","status": 0,"detail": "string","instance": "string","property1": null,"property2": null}
Not Found
{"type": "string","title": "string","status": 0,"detail": "string","instance": "string","property1": null,"property2": null}
Client Error
{"type": "string","title": "string","status": 0,"detail": "string","instance": "string","property1": null,"property2": null}