Retrieve your account statement and see individual entries for all credits and debits. Specify a date range and other optional filter values.
Authentication Header
Authorization: {your_credentials}
Replace {your_credentials}
with your base64-encoded Basic Auth username and password given to you by your Implementation Manager.
You must use the Authorization
header for any request you send to our Account APIs, unless you are using client certificate authenticating with SSL/TLS.
Accept Header
Accept: application/vnd.worldpay.accounts.statements-v1+json
We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Account APIs.
DNS Whitelisting
Whitelist the following URLs:
https://try.access.worldpay.com/
https://access.worldpay.com/
Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.
https://try.access.worldpay.com/
https://access.worldpay.com/
The account number.
An ISO 8601 date-time string. From date and time. Timespan between 'startDate' and 'endDate' shouldn't exceed 30 days. This should not be a date in the future.
An ISO 8601 date-time string. To date and time. Timespan between 'startDate' and 'endDate' shouldn't exceed 30 days. This should not be a date in the future.
The page number of the results. Default is 1 if no value is provided. This value specifies the exact page of each list of statements that you want to retrieve.
Exact number of records per page to be shown. Max 500 items/rows. Value must be between 1-500. Default is 1 if no value is provided.
Credit or debit operation. Value can be credit
or debit
. If no value is passed, the statement includes both credits and debits.
Type of the transaction used to filter out statement entries. Alphanumeric only. Special characters are restricted.
Your unique reference for the payment request. This can be a "like" search (exact or partial match). Special characters are allowed. For the list, please see our formatting guide
https://try.access.worldpay.com/accounts/statements
https://access.worldpay.com/accounts/statements
No request payload
OK response if the request is valid
The currency, determined by the first item in the list. The currency is the same for all items.
A collection of account statement items.
For statement items (debits/credits) with no FX conversion involved, originalCurrency value will be null.
In case an FX conversion is involved, then:
The page number. Default is 1 if no value is provided. This value specifies the exact page of each list of statements that you want to retrieve.
The exact number of records per page to be shown. Max 500 items/rows. Value must be between 1-500. Default is 1 if no value is provided.
{ "accountNumber": "string", "currency": "string", "accountStatementItems": [ { "transactionReference": "string", "transferType": "string", "amount": 0.1, "timestamp": "2019-08-24T14:15:22Z", "fundingType": "string", "rate": 0.1, "cleared": "string", "description": "string", "statementItemId": "d6c0f922-d6e3-428e-9fb6-217f68c41961", "balance": 0.1, "statementNumber": 0, "narrative": "string", "countryCode": "string", "originalCurrency": "string", "originalAmount": 0.1 } ], "pageNumber": 0, "pageSize": 0, "pageCount": 0, "totalNumberOfRecords": 0 }