Statement Management
At cycle closure date raw statement data is prepared and can be exported at statement issuing date.
- Either per contract, if all cards within this contract are repaid by the same payer
- Or per card account, if each card is repaid by its cardholder
Each statement contains:
- Cycle information
- Minimum Payment amount
- Payment due date
- Direct debit amount (except if customer is self-payer)
- List of distinct operations (scheme financial transactions, fees, debit interest, insurance fee, credit instalment repayments, etc) – grouped per card account (if several ones)
List Statements For An Account
The API is used to get the list of statements generated for an account and optionally a requested period.
It is also possible to get reprint information of a statement.
The input parameters are:
- the involved account: it can be provided by using the account reference or the issuer external account reference
- the search period (start date date/ end date)
- the embed field "reprint-history" if needed
The API returns:
- in the consumer cards context, the list of statements of the paying account
- in the commercial cards context, the list of statements of the employee account whether it is paid by another account or not.
API links
Below an example of request for the account: 12343037952407582600
GET /api/v2/issuers/1234/accounts/12343037952407582600/statements?embed=reprintHistory
Response data
{
"data":" "[
" "{
" ""issuerId":" ""1234",
" ""accountIdentifier":" "{
" ""accountReference":" ""12343037952407582600"" "
},
" ""cycleClosureDate":" ""2022-11-29T23:00:00.000+00:00",
" ""creationDate":" ""2022-12-21T09:52:00.000+00:00",
" ""paymentDueDate":" ""2022-11-29T23:00:00.000+00:00",
" ""directDebitAmount":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""theoricDirectDebitAmount":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""cycleBalance":" "{
" ""value": -40946,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleBalance":" "{
" ""value": -41031,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""totalOfPayment":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleClosureDate":" ""2022-10-27T22:00:00.000+00:00",
" ""nextCycleClosureDate":" ""2022-12-29T23:00:00.000+00:00",
" ""amountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialPastAmountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialRemainingAmountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}" "
},
" "{
" ""issuerId":" ""1234",
" ""accountIdentifier":" "{
" ""accountReference":" ""12343037952407582600"" "
},
" ""cycleClosureDate":" ""2022-10-27T22:00:00.000+00:00",
" ""creationDate":" ""2022-10-28T14:50:04.000+00:00",
" ""paymentDueDate":" ""2022-10-27T22:00:00.000+00:00",
" ""theoricDirectDebitAmount":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""cycleBalance":" "{
" ""value": -41031,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleBalance":" "{
" ""value": -41031,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""totalOfPayment":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleClosureDate":" ""2022-09-29T22:00:00.000+00:00",
" ""nextCycleClosureDate":" ""2022-11-29T23:00:00.000+00:00",
" ""amountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialPastAmountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialRemainingAmountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}" "
},
" "{
" ""issuerId":" ""1234",
" ""accountIdentifier":" "{
" ""accountReference":" ""12343037952407582600"" "
},
" ""cycleClosureDate":" ""2022-09-29T22:00:00.000+00:00",
" ""paymentDueDate":" ""2022-09-29T22:00:00.000+00:00",
" ""theoricDirectDebitAmount":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""cycleBalance":" "{
" ""value": -41031,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleBalance":" "{
" ""value": -41031,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""totalOfPayment":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleClosureDate":" ""2022-08-29T22:00:00.000+00:00",
" ""nextCycleClosureDate":" ""2022-10-27T22:00:00.000+00:00",
" ""amountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialPastAmountDue":" "{
" ""value": 5000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialRemainingAmountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}" "
},
" "{
" ""issuerId":" ""1234",
" ""accountIdentifier":" "{
" ""accountReference":" ""12343037952407582600"" "
},
" ""cycleClosureDate":" ""2022-08-29T22:00:00.000+00:00",
" ""paymentDueDate":" ""2022-08-29T22:00:00.000+00:00",
" ""theoricDirectDebitAmount":" "{
" ""value": 5000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""cycleBalance":" "{
" ""value": -41031,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleBalance":" "{
" ""value": 55465,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""totalOfPayment":" "{
" ""value": 46500,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleClosureDate":" ""2022-07-28T22:00:00.000+00:00",
" ""nextCycleClosureDate":" ""2022-09-29T22:00:00.000+00:00",
" ""amountDue":" "{
" ""value": 5000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialPastAmountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialRemainingAmountDue":" "{
" ""value": 5000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}" "
},
" "{
" ""issuerId":" ""1234",
" ""accountIdentifier":" "{
" ""accountReference":" ""12343037952407582600"" "
},
" ""cycleClosureDate":" ""2022-07-28T22:00:00.000+00:00",
" ""paymentDueDate":" ""2022-07-28T22:00:00.000+00:00",
" ""theoricDirectDebitAmount":" "{
" ""value": 27733,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""cycleBalance":" "{
" ""value": 55465,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleBalance":" "{
" ""value": 60000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""totalOfPayment":" "{
" ""value": 30000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleClosureDate":" ""2022-06-29T22:00:00.000+00:00",
" ""nextCycleClosureDate":" ""2022-08-29T22:00:00.000+00:00",
" ""amountDue":" "{
" ""value": 5000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialPastAmountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialRemainingAmountDue":" "{
" ""value": 5000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}" "
},
" "{
" ""issuerId":" ""1234",
" ""accountIdentifier":" "{
" ""accountReference":" ""12343037952407582600"" "
},
" ""cycleClosureDate":" ""2022-06-29T22:00:00.000+00:00",
" ""creationDate":" ""2022-07-08T16:10:18.000+00:00",
" ""paymentDueDate":" ""2022-06-29T22:00:00.000+00:00",
" ""directDebitAmount":" "{
" ""value": 30000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""theoricDirectDebitAmount":" "{
" ""value": 30000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""cycleBalance":" "{
" ""value": 60000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleBalance":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""totalOfPayment":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""nextCycleClosureDate":" ""2022-07-28T22:00:00.000+00:00",
" ""amountDue":" "{
" ""value": 5000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialRemainingAmountDue":" "{
" ""value": 5000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}" "
}" "
]
}Retrieve Last Statement For An Account
The API is used to get the financial information of the last statement generated for an account such as: previous cycle balance (start balance), end cycle balance, due amount, total of payments, ...
It is also possible to get reprint information of the statement.
The input parameters are:
- the involved account: it can be provided by using the account reference or the issuer external account reference
- the embed field "reprint-history" if needed
The API returns:
- in the consumer cards context, the list of statements of the paying account
- in the commercial cards context, the list of statements of the employee account whether it is paid by another account or not.
API links
Below an example of request for the:
- account: 12343037952407582600
- Issuer: 1234
GET /1234/accounts/12343037952407582600/statements/last
Response data
{
"data":" "{
" ""issuerId":" ""1234",
" ""accountIdentifier":" "{
" ""accountReference":" ""12343037952407582600"" "
},
" ""cycleClosureDate":" ""2022-11-29T23:00:00.000+00:00",
" ""creationDate":" ""2022-12-21T09:52:00.000+00:00",
" ""paymentDueDate":" ""2022-11-29T23:00:00.000+00:00",
" ""directDebitAmount":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""theoricDirectDebitAmount":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""cycleBalance":" "{
" ""value": -40946,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleBalance":" "{
" ""value": -41031,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""totalOfPayment":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleClosureDate":" ""2022-10-27T22:00:00.000+00:00",
" ""nextCycleClosureDate":" ""2022-12-29T23:00:00.000+00:00",
" ""amountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialPastAmountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialRemainingAmountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}" "
}
}List Operations For The Last Statement Of An Account
The API is used to get the list of operations of the last statement generated for an account.
The input account can be provided by using:
- the account reference
- or the issuer external account reference
Below an example of request for the:
- account: 12343037952407582600
- Issuer: 1234
In the response, there is only one operation: a statement fee.
GET /api/v2/issuers/1234/accounts/12343037952407582600/statements/last/operations
Response data
{
" ""data":" "[
" "{
" ""issuerId":" ""1234",
" ""operationIdentifier":" "{
" ""operationId":" ""1000000000370386"" "
},
" ""description":" ""Portoersatz KK-Abrechnung",
" ""externalOperationCode":" ""2033",
" ""feeType":" ""STATEMENT_FEE",
" ""operationKind":" ""FEE",
" ""postingDate":" ""2022-12-21T09:48:36.489+00:00",
" ""referenceAmount":" "{
" ""value": 85,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""reversal":" false",
" ""subFeeType":" ""STATEMENT",
" ""transactionAmount":" "{
" ""value": 85,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""valueDate":" ""2022-11-29T23:00:00.000+00:00",
" ""externalOperationDate":" ""2022-12-21T09:48:36.473+00:00",
" ""externalOperationReference":" ""5f5395a439ea4915836ff4a874f52af3",
" ""externalOperationServicePoster":" ""WLP-CAS"" "
}" "
]
}Reprint Last Statement For An Account
The API is used to request the reprint of the last statement for an account.
The input account can be provided by using:
- the account reference
- or the issuer external account reference
As a result, the statement data is extracted again and pushed to the output management module.
API links
Below an example of request for:
- the account 12343037952407582600
- the issuer 1234
POST /api/v2/issuers/1234/accounts/12343037952407582600/statements/last/reprint
Response data
{
" ""responseMetadata":" "{
" ""correlationId":" ""df9b036c-d8d3-4445-bb3f-c80d8cd8fe12",
" ""statusMessage":" ""Executed successfully",
" ""statusCode": 200,
" ""responseDateTime":" ""2022-12-21T11:56:41.712+0100",
" ""timeTakenMs": 77
},
" ""data":" "{
" ""accountIdentifier":" "{
" ""accountReference":" ""12343037952407582600"" "
},
" ""requestedDate":" ""2022-12-21T10:56:41.681+00:00"" "
}
}List Operations For Next Account Statement
The API is used to get the list of operations generated for an account since the last cycle closure date. Those operations will be part of the next statement.
The input account can be provided by using:
- the account reference
- or the issuer external account reference
API links
Below is an example where the request retrieves the operations of the next statement for:
- Account reference : 12343037952407582600
- Issuer : 1234
GET /api/v2/issuers/1234/accounts/12343037952407582600/statements/next/operations
Response data
{
" ""data":" "[
" "{
" ""issuerId":" ""1234",
" ""operationIdentifier":" "{
" ""operationId":" ""1000000000370512"" "
},
" ""acquirerReferenceData":" ""74198812354221219180000",
" ""cardAcceptorCity":" ""44131447816",
" ""cardAcceptorCountry":" ""276",
" ""cardAcceptorName":" ""WEB ANNONCE",
" ""description":" ""WEB ANNONCE 44131447816 276",
" ""externalOperationCode":" ""1035",
" ""maskedPan":" ""424201******0010",
" ""merchantCategoryCode":" ""5712",
" ""operationCode":" ""NORMAL_PURCHASE",
" ""operationKind":" ""TRN",
" ""postingDate":" ""2022-12-21T11:02:42.646+00:00",
" ""reconciliationAmount":" "{
" ""value": 74825,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""referenceAmount":" "{
" ""value": 74825,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""reversal":" false",
" ""transactionAmount":" "{
" ""value": 74825,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""transactionDate":" ""2022-12-18T23:00:00.000+00:00",
" ""valueDate":" ""2022-12-19T23:00:00.000+00:00",
" ""cardIdentifier":" "{
" ""cardReference":" ""2000000000248652"" "
},
" ""externalOperationDate":" ""2022-12-21T11:02:42.155+00:00",
" ""externalOperationReference":" ""10000000000273000",
" ""externalOperationServicePoster":" ""ITP",
" ""pan":" ""4242010796210010",
" ""acquisitionMaterial":" ""INTERNET",
" ""cardAcceptorIdCode":" ""208043134881626",
" ""entryMode":" ""UNKNOWN",
" ""approvalCode":" ""120239",
" ""pointOfSaleEnvironment":" "" ",
" ""mailPhoneEcommerceAndPaymentIndicator":" ""7"" "
}" "
]
}Retrieve Statement With A Given Cyclic Closure Date
The API is used to get the financial information for an account statement such as: previous cycle balance (start balance), end cycle balance, due amount, total of payments, ...
The input account can be provided by using:
- the account reference
- or the issuer external account reference
The statement involved by the request has to be provided by giving the cycle closure date.
The API returns:
- in the consumer cards context, the list of statements of the paying account
- in the commercial cards context, the list of statements of the employee account whether it is paid by another account or not.
API links
Below is an example where the request retrieves the financial information of the statement for:
- Account reference : 12343037952407582600
- Issuer : 1234
- Cycle closure date: 2022-07-28T22:00:00Z
GET /api/v2/issuers/1234/accounts/12343037952407582600/statements/2022-07-28T22:00:00Z
Response data
{
" ""responseMetadata":" "{
" ""correlationId":" ""6ca2edae-559d-400b-a224-8d28d5aa156d",
" ""statusMessage":" ""Executed successfully",
" ""statusCode": 200,
" ""responseDateTime":" ""2022-12-21T12:13:17.940+0100",
" ""timeTakenMs": 29
},
" ""data":" "{
" ""issuerId":" ""1234",
" ""accountIdentifier":" "{
" ""accountReference":" ""12343037952407582600"" "
},
" ""cycleClosureDate":" ""2022-07-28T22:00:00.000+00:00",
" ""paymentDueDate":" ""2022-07-28T22:00:00.000+00:00",
" ""theoricDirectDebitAmount":" "{
" ""value": 27733,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""cycleBalance":" "{
" ""value": 55465,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleBalance":" "{
" ""value": 60000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""totalOfPayment":" "{
" ""value": 30000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""previousCycleClosureDate":" ""2022-06-29T22:00:00.000+00:00",
" ""nextCycleClosureDate":" ""2022-08-29T22:00:00.000+00:00",
" ""amountDue":" "{
" ""value": 5000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialPastAmountDue":" "{
" ""value": 0,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""initialRemainingAmountDue":" "{
" ""value": 5000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}" "
}
}List Operations From A Statement With A Given Cyclic Closure Date
The API is used to get the list of operations posted to an account included in a statement.
The input account can be provided by using:
- the account reference
- or the issuer external account reference
The statement involved by the request has to be provided by giving the cycle closure date.
API links
Below is an example where the request retrieves the operations of the statement for:
- Account reference : 12343037952407582600
- Issuer : 1234
- Cycle closure date: 2022-07-28T22:00:00Z
GET /api/v2/issuers/1234/accounts/12343037952407582600/statements/2022-07-28T22:00:00Z /operations
Response data
{
"data":[
{
"issuerId":"1234",
"operationIdentifier":{
"operationId":"1000000000268017"
},
"description":"Ausgleich Kreditkartenabrechnung",
"externalOperationCode":"1067",
"operationKind":"PAY",
"postingDate":"2022-07-18T13:13:03.749+00:00",
"referenceAmount":{
"value":-30000,
"exponent":2,
"isoCode":"EUR"
},
"reversal":false,
"transactionAmount":{
"value":-30000,
"exponent":2,
"isoCode":"EUR"
},
"valueDate":"2022-07-17T22:00:00.000+00:00",
"externalOperationDate":"2022-07-18T13:13:03.748+00:00",
"externalOperationReference":"b6a8551f1ee8498b98c0f6d22529a8d6",
"externalOperationServicePoster":"WLP-CAS"
},
{
"issuerId":"1234",
"operationIdentifier":{
"operationId":"1000000000268018"
},
"description":"Sub PAY operation (apportionment) - Ausgleich Kreditkartenabrechnung",
"operationKind":"SUBPAYOP",
"postingDate":"2022-07-18T13:13:03.759+00:00",
"referenceAmount":{
"value":-5000,
"exponent":2,
"isoCode":"EUR"
},
"reversal":false,
"transactionAmount":{
"value":-5000,
"exponent":2,
"isoCode":"EUR"
},
"valueDate":"2022-07-17T22:00:00.000+00:00",
"externalOperationDate":"2022-07-18T13:13:03.748+00:00",
"externalOperationReference":"0b4edad851194b7f9056cbfa8fd6a843",
"externalOperationServicePoster":"WLP-CAS"
},
{
"issuerId":"1234",
"operationIdentifier":{
"operationId":"1000000000280040"
},
"description":"Finanzierungsgebühren",
"externalOperationCode":"1201",
"operationKind":"INT",
"postingDate":"2022-08-17T11:26:36.553+00:00",
"referenceAmount":{
"value":465,
"exponent":2,
"isoCode":"EUR"
},
"reversal":false,
"transactionAmount":{
"value":465,
"exponent":2,
"isoCode":"EUR"
},
"valueDate":"2022-08-16T22:00:00.000+00:00",
"externalOperationDate":"2022-08-17T11:26:36.551+00:00",
"externalOperationReference":"01f6ab9128fb4d94a64d67c2071cd4d0",
"externalOperationServicePoster":"WLP-CAS"
}
]
}Reprint A Statement Identified By Its Cyclic Closure Date
The API is used to request the reprint of a statement for an account.
The input account can be provided by using:
- the account reference
- or the issuer external account reference
The statement involved by the request has to be provided by giving the cycle closure date. As a result, the statement data is extracted again and pushed to the output management module.
API links
Below an example of request for:
- the issuer: 1234
- the account: 12343037952407582600
- the cycle closure date: 2022-10-28T00:00:00Z
POST /api/v2/issuers/1234/accounts/12343037952407582600/statements/2022-10-28T00:00:00Z/reprint
Response data
{
" ""responseMetadata":" "{
" ""correlationId":" ""cc04a0d7-6dfc-4eb0-9e70-782ef93cb6d1",
" ""statusMessage":" ""Executed successfully",
" ""statusCode": 200,
" ""responseDateTime":" ""2022-12-21T12:52:44.616+0100",
" ""timeTakenMs": 127
},
" ""data":" "{
" ""accountIdentifier":" "{
" ""accountReference":" ""12343037952407582600"" "
},
" ""requestedDate":" ""2022-12-21T11:52:44.581+00:00"" "
}
}Retrieve Next Statement For An Account
The API is used to get the financial information based on the last statement generated for an account such as: current cycle balance, cycle closure date, payment due date, next cycle closure date (end cycle balance, due amount, total of payments are not yet known).
The input parameters are:
- The issuer Id
- the involved account: it can be provided by using the account reference or the issuer external account reference
The API returns:
- in the consumer cards context, the list of statements of the paying account
- in the commercial cards context, the list of statements of the employee account whether it is paid by another account or not.
API links
