Account details

Update the alias of an account details

Change the alias of the referred account details. Only dedicated accounts can be patched, trying to patch a pooled account will return an error.

patch/account-details/{account_details_id}

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/account-details/{account_details_id}
  • Auth: API key in header x-api-key

Path parameters

account_details_idstring required

Unique ID of account details

Query parameters

client_idstring required

ID of the client that owns the account

Headers

Authorizationstring required

The access token

Request body

aliasstring required

New alias for the account details

Response

Account details updated

account_idstring uuid required

Unique ID of the account these details belong to. Can be null for pooled accounts.

account_details_idstring uuid required

Unique ID of the account details

account_details_type'dedicated' | 'pooled' required

Type of account details

aliasstring nullable

User-friendly alias for the account details. Only present (and mandatory) for dedicated accounts.

countrystring nullable required

Country of the account details (ISO Code 2)

currencystring nullable required

Currency of the account details

financial_institution_namestring nullable

Name of the underlying financial institution

financial_institution_addressstring nullable

Address of the underlying financial institution

account_holder_namestring nullable

Name of the holder of the account details

account_holder_addressstring nullable

Address of the holder of the account details

primaryboolean

Primary (default) account. Only present (and mandatory) for dedicated accounts.

status'pending' | 'confirmed' | 'failed' required

Status of the account details

createdstring nullable

Datetime of creation. Only on dedicated account details.

modifiedstring nullable

Datetime of last modification. Only on dedicated account details.

Example response

{
  "country": "GB",
  "currency": "GBP",
  "domestic": {
    "bank_identifier_type": "USABA"
  },
  "international": {
    "bank_identifier_type": "USABA"
  }
}

Changes

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