Create Payment Account Statements
The Statement endpoint follows XML and JSON format. The response from this endpoint returns a statementId. This identifier must then be used to map the statement received as part of push notification.
Note: Statement generation may require some time to be processed. The time needed to produce statements depends on the size of the statement file. This process may take anywhere from 15 seconds to a few minutes before the statement is generated. Once generated, the statement will be shared through a push notification and can be mapped with a statementId.
Content-Type: Supports “application/XML” and “application/JSON”.
Authorization: The OAuth Token prefixed with “Bearer“ and space in between.
Authentication
All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token.
Headers
Request
This endpoint validates your request and responds with HTTP status 202 (accepted) after successful validation. If validation fails, the endpoint synchronously responds with error (HTTP status 4XX / 5XX), indicating Citi couldn’t accept your statement initiation request.
The account number(s) for which the account statement is to be retrieved. You can specify multiple accounts by using multiple account objects.
If no value is sent the Statements API will send a reject response with an error message.
Specifies the format of the statement(s) to be generated. The types of statements available to request are -
* SWIFT_MT940 - End of day account statement in Standard SWIFT proprietary format.
* CAMT_053_001_02 - End of day account statement in ISO20022 Standard XML format.
* SWIFT_MT942 - Intraday account statement in Standard SWIFT proprietary format.
* CAMT_052_001_02 - Intraday account statement in ISO20022 Standard XML format.
Note: formatName will be ignored if templateName is supplied, but formatName is still required for completeness.
Specifies the beginning date and time for the statement generation request. fromDate uses YYYY-MM-DDTHH:MM:SS.sssZ format.
Specifies the ending date for the statement generation request. toDate uses YYYY-MM-DDTHH:MM:SS.sssZ format.
The template name, as defined in CitiDirect BE File Services (STR Library Number). Before you make your first statement API request, make sure that the correct template (also known as an ‘export profile’) has been set up using CitiDirect BE. For help setting up a template contact your Citi representative.
The template contains the following:
* the format standard
* the list of transaction codes and descriptions
* the display of itemized entries for bulk debits
* the list of the date and time stamps
You can choose between:
* Detailed itemized entries - list all transactions on the statement. If you would like an itemized Statement Retrieval (STR), please contact your Citi representative to perform the setup on your behalf. You must then use the STR library Name in your statement initiation request.
* A single consolidated debit entry - one debit entry that can contain several smaller transactions. These are also known as bulk debit transactions.
When creating the template, the time zone where the template is initially set up will be used when generating the account statement as well as the frequency and interval specified.