CIciti
Statement Services v1

Statement Initiation Request

The Statement Initiation endpoint follows a custom XML format. The response from this endpoint returns a statementId. This identifier must then be used in the retrieval request.

Note: Statement initiation requires some time to be processed to allow successful retrieval. It will depend on the statement size – best practice is to set the retrieval interval every 15 seconds until you receive a 200 successful response. It may take from 15 seconds to a few minutes before the statement is generated.

post/statement/initiation

Request

Query parameters

client_idstring required

This is your unique identifier shared during your CitiConnect API onboarding. This is the same client_id used for oauth token generation

Headers

Content-Typestring required

Supports XML.

Timezonestring

Time zone used to generate the statement. If not provided, the default timezone is applied. Examples include 'EST', 'EDT', 'IST'.

Attachment-Encodingstring

Specifies the preferred content encoding for the response. To enable gZip compression for the statement file, set this header value to gzip. Using compression is highly recommended for large statement files, as it can significantly reduce the download size and help prevent API failures related to gateway file size limits. If this header is sent, the API will return the statement file in a compressed format. The client application is responsible for decompressing the file.

Request body application/xml

accountNumberstring[] required

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.

formatName'SWIFT_MT940' | 'CAMT_053_001_02' | 'SWIFT MT942' | 'CAMT_052_001_02' required

Specifies the format of the statement(s) to be generated. Valid values include:

  • SWIFT_MT940
  • CAMT_053_001_02
  • SWIFT MT942
  • CAMT_052_001_02

Note: formatName will be ignored if templateName is supplied, but formatName is still required for completeness.

fromDatestring YYYY-MM-DD required

Specifies the beginning date for the statement request. fromDate uses YYYY-MM-DD format.

toDatestring YYYY-MM-DD required

Specifies the ending date for the statement request. fromDate uses YYYY-MM-DD format.

templateNamestring

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.

strLibrayNamestring

Specifies the STR Library name created as part of STR profile by the Citi representative, if itemization data is required.

baiCodestring

Transaction classification code indicating the type of financial transaction.

Example request

{
  "accountNumber": [
    "12345"
  ],
  "formatName": "CAMT_053_001_02",
  "fromDate": "2017-04-01",
  "toDate": "2017-04-03",
  "strLibrayName": "APISTR",
  "baiCode": "SWIFT4"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.