Get data about your merchant accounts
See an overview of all the merchant accounts you own with an API call.
To retrieve data for all of your merchant accounts, make a GET request to the /v3/merchant-accounts
endpoint.
If you want to see the data for a single merchant account only, add the merchant account id
as a path parameter to the merchant-accounts
endpoint.
You will see these details for each merchant account in the response:
- The merchant account ID
- The currency the account is in
- The sort code and account number (SCAN) if the account is in GBP
- The IBAN
- The account holder name
- The current and available balances, in the smallest possible unit of currency
A successful response looks like this:
{
"items": [
{
"id": "AB8FA060-3F1B-4AE8-9692-4AA3131020D0",
"currency": "GBP",
"account_identifiers": [
{
"type": "sort_code_account_number",
"sort_code": 560029,
"account_number": 26207729
},
{
"type": "iban",
"iban": "FR7630006000011234567890189"
}
],
"available_balance_in_minor": 0,
"current_balance_in_minor": 0,
"account_holder_name": "string"
},
{
"id": "eb8d82a6-0ce9-4e91-ba99-d895649633f0",
"currency": "EUR",
"account_identifiers": [
{
"type": "iban",
"iban": "GB86CLRB04066800015805"
}
],
"available_balance_in_minor": 0,
"current_balance_in_minor": 0,
"account_holder_name": "string"
}
]
}
See transactions for a merchant account
To see all of the transactions for a merchant account, you can either:
- Go to your [merchant account dashboard] in Console.
- Make a request to
/v3/merchant-accounts/{id}/transactions
Retrieve payment sources for a merchant account
You can use the /v3/merchant-accounts/{id}/payment-sources
endpoint to retrieve all of the payment sources that have paid into a merchant account.
In the response, this endpoint returns the following information for each payment source:
- The payment source
id
, which you can use to initiate a closed-loop payout. - The name of the account holder.
- The account identifier, or payment details, used for the payment.
Updated 5 months ago