Get accounts data.
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 Balance API, unless you are using client certificate authenticating with SSL/TLS.
WP-Api-Version Header
WP-Api-Version: 2025-01-01
We use the WP-Api-Version header to identify which version of our API you are using. You must use the WP-Api-Version header for any request you send.
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/
https://try.access.worldpay.com/accounts/{accountNumber}
https://access.worldpay.com/accounts/{accountNumber}
No request payload
OK response
Collection of the account details
The ISO 4217 currency codes of the account.
{ "entity": "Test", "accounts": [ { "accountNumber": "01012145214562214", "accountName": "TestDisplayName", "currency": "GBP", "clearedBalance": 36, "unclearedBalance": 2, "balance": 38, "accountStatus": "Active" } ] }
Unique ID given during the on-boarding process.
The ISO 4217 currency codes of the account.
Your reference for this party, must be unique within an entity. Allowed values string 3 to 64 characters a-z, A-Z, 0-9, spaces and hyphens.
Positive whole number indicating which page of the account to return.
https://try.access.worldpay.com/accounts
https://access.worldpay.com/accounts
No request payload
{ "entity": "Test", "accounts": [ { "accountNumber": "01012145214562214", "accountName": "TestDisplayName", "currency": "GBP", "clearedBalance": 36, "unclearedBalance": 2, "balance": 38, "accountStatus": "Active" } ], "pagination": { "pageNumber": 1, "recordsPerPage": 10, "totalPages": 1, "totalNumberOfRecords": 1 } }