TRtruelayer
Merchant accounts

Get merchant account

Get the details of a single merchant account.

get/v3/merchant-accounts/{id}

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/v3/merchant-accounts/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.truelayer.com/connect/token scopes: payments

Path parameters

idstring uuid required

Unique ID for the Merchant Account

Example:AB8FA060-3F1B-4AE8-9692-4AA3131020D0

ID of the merchant account to be returned

Response

Merchant account.

idstring uuid required

Unique ID for the Merchant Account

currency'GBP' | 'EUR' | 'PLN' required

The ISO 4217 code of the currency associated with the merchant account.

Merchant accounts can only hold funds in a single currency.

available_balance_in_minorinteger required

The balance immediately available to perform payouts and transfers, expressed in the smallest denomination of the account's currency.

The available balance does also take into consideration transactions that are not yet in a final state.

current_balance_in_minorinteger required

The current balance, expressed in the smallest denomination of the account's currency.

The current balance does not take into consideration transactions that are not yet in a final state.

account_holder_namestring required

The name of the account holder.

It must match your organisation's legal name.

Example response

{
  "id": "AB8FA060-3F1B-4AE8-9692-4AA3131020D0",
  "account_identifiers": [
    {
      "sort_code": "560029",
      "account_number": "26207729"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.