Request your account details for a single account or all accounts under an entity.
Authentication Header
Authorization: {your_credentials}
Replace {your_credentials}
with your base64-encoded Basic Auth username and password given to your 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.
Accept Header
Accept: application/vnd.worldpay.accounts.balance-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 Balance API.
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.
https://try.access.worldpay.com/
https://access.worldpay.com/
https://try.access.worldpay.com/accounts/balance/{accountNumber}
https://access.worldpay.com/accounts/balance/{accountNumber}
No request payload
OK response
Your unique 6-digit ID given to you during the onboarding process.
Collection of account details.
The name of the account. (This is given to you during onboarding and typically consist of your merchant name followed by currency code.)
{ "entity": "111155", "accounts": [ { "accountNumber": "1111557890987654", "accountName": "Etsy GBP", "currency": "GBP", "clearedBalance": 142.5, "unclearedBalance": 100.8, "balance": 243.5, "accountStatus": "ACTIVE" } ] }
https://try.access.worldpay.com/accounts/balance
https://access.worldpay.com/accounts/balance
No request payload
OK response
Your unique 6-digit ID given to you during the onboarding process.
Collection of account details.
The name of the account. (This is given to you during onboarding and typically consist of your merchant name followed by currency code.)
{ "entity": "111155", "accounts": [ { "accountNumber": "1111557890987654", "accountName": "Etsy GBP", "currency": "GBP", "clearedBalance": 142.5, "unclearedBalance": 100.8, "balance": 243.5, "accountStatus": "ACTIVE" } ] }