Citi API | Statements › The Statements Initiation API Allows You To Retrieve Your Payment Account Statements

Citi API

API Reference

Overview

Balances

Notifications

Payments

Statements

The Statements Initiation API allows you to retrieve your payment account statements.

Retrieve the account details for a specific account.

Virtual Cards

Statements

statements

Methods

The Statements Initiation API Allows You To Retrieve Your Payment Account Statements -> { statementId, xmlns, xmlns:soapenv }

post/v1/statement/initiation

The Statements Initiation API allows you to retrieve your payment account statements. The Statement ID can be retrieved by passing the parameters in the 'Statement Initiation' API request ? Format Name, Date Range and Account Number or can pass the Template Name (which was created on File Export UI). This request and response will follow custom XML format with Statement ID.

Content-Type : Supports ?application/xml?.
Authorization : The OAuth Token prefixed with ?Bearer? and space in between.

Security

Body parameters

accountNumber: Array<string>

Account number(s) for which account statement has to be retrieved. If no value is sent by Partner, then the CitiConnect API will send a reject response with the error message to the Partner user. The user can specify multiple accounts as well. Partners can do this using multiple account tags.

formatName: "SWIFT_MT940" | "CAMT_053_001_02" | "SWIFT MT942" | 1 more...

Specifies format of statement to be generated. The valid values are SWIFT_MT940 or CAMT_053_001_02 or SWIFT MT942 or CAMT_052_001_02.

fromDate: string

Specifies the 'from' date for the statement enquiry. Absolute values with From Date are sent in YYYY-MM-DD format.

toDate: string

Specifies the 'to' date for the statement enquiry. Absolute values with To Date are sent in YYYY-MM-DD format.

strLibrayName?: string

Client to send the STR Library name, if itemization data is required.

Response fields

statementId: string

Unique ID for newly generated statement. This will be used to retrieve the statement file in Statement Retrieval API.

xmlns?: string

xmlns:soapenv?: string

Request example

curl https://$(catalog.host)/cards/vca/v2/v1/statement/initiation \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ACCESS_TOKEN" \
    -d '{
      "accountNumber": [
        "string"
      ],
      "formatName": "SWIFT_MT940",
      "fromDate": "2017-04-01",
      "toDate": "2017-04-03"
    }'

200Example

{
  "statementId": "86756565",
  "xmlns": "http://com.citi.citiconnect/services/types/inquiries/statement/v1",
  "xmlns:soapenv": "http://schemas.xmlsoap.org/soap/envelope/"
}

Retrieve The Account Details For A Specific Account -> { statementStream, attachmentDecryptionKey, fileCheckSum, 4 more... }

post/v1/statement/retrieval

This API call will generate an account statement by using statement initiation StatementId. The request will follow a custom XML format, and the response will contain the Account Statement file in ISO XML camt.053.001.02 or SWIFT MT940 format or camt.052.001.02 or SWIFT MT942 format.

Content-Type : Supports ?application/xml?.
Authorization : The OAuth Token prefixed with ?Bearer? and space in between.