Create FPS bank account

curl -X POST "https://api.cryptomate.me/management/clients/client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d/banks/fps" \
  -H "x-api-key: $CRYPTOMATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "bank_name": "Barclays",
    "account_alias": "Primary UK Account",
    "bank_holder_first_name": "John",
    "bank_holder_last_name": "Smith",
    "sort_code": "123456",
    "account_number": "12345678",
    "address": {
      "streetLine1": "Great Russell Street",
      "city": "London",
      "postal_code": "WC1B 3DG",
      "state": "GBR-CMD",
      "country": "GBR"
    }
  }'

{
  "id": "ba_mno345",
  "company_id": "comp_6f1e2a30-4a3c-4b2e-9a1d-5e8c9b7a1f23",
  "client_id": "client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "bank_name": "Barclays",
  "bank_holder_name": "John Smith",
  "account_alias": "Primary UK Account",
  "type": "FPS",
  "currency": "GBP",
  "sort_code": "123456",
  "account_number": "12345678"
}

{
  "code": "VAL",
  "message": "Must provide either (bankHolderFirstName + bankHolderLastName) for individual or businessName for business"
}

{
  "code": "NOT_FOUND",
  "message": "Client does not have a customer ID for provider BRIDGE"
}

POST

management

clients

{clientId}

banks

fps

curl -X POST "https://api.cryptomate.me/management/clients/client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d/banks/fps" \
  -H "x-api-key: $CRYPTOMATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "bank_name": "Barclays",
    "account_alias": "Primary UK Account",
    "bank_holder_first_name": "John",
    "bank_holder_last_name": "Smith",
    "sort_code": "123456",
    "account_number": "12345678",
    "address": {
      "streetLine1": "Great Russell Street",
      "city": "London",
      "postal_code": "WC1B 3DG",
      "state": "GBR-CMD",
      "country": "GBR"
    }
  }'

{
  "id": "ba_mno345",
  "company_id": "comp_6f1e2a30-4a3c-4b2e-9a1d-5e8c9b7a1f23",
  "client_id": "client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "bank_name": "Barclays",
  "bank_holder_name": "John Smith",
  "account_alias": "Primary UK Account",
  "type": "FPS",
  "currency": "GBP",
  "sort_code": "123456",
  "account_number": "12345678"
}

{
  "code": "VAL",
  "message": "Must provide either (bankHolderFirstName + bankHolderLastName) for individual or businessName for business"
}

{
  "code": "NOT_FOUND",
  "message": "Client does not have a customer ID for provider BRIDGE"
}

Deprecated. This endpoint is no longer available in the public API and is kept for reference only.

Creates a new UK Faster Payments (FPS) bank account for the specified client. Supports both individual and business clients via mutually exclusive holder name fields. Requires an API key with access level 3 or higher.

Path parameters

string

required

Unique identifier of the client.

Body

string

Name of the bank.

string

User-friendly alias for the account.

string

Account holder’s first name. Required for individual clients; mutually exclusive with business_name.

string

Account holder’s last name. Required for individual clients; mutually exclusive with business_name.

string

Business name. Required for business clients; mutually exclusive with bank_holder_first_name + bank_holder_last_name.

string

UK bank sort code (6 digits).

string

UK bank account number (8 digits).

object

Account holder’s address with street_line_1, street_line_2, city, postal_code, state, country.state uses ISO 3166-2 codes that identify country subdivisions in the format {COUNTRY}-{SUBDIVISION} (e.g., USA-CA for California).

Response

string

Bank account identifier.

string

Company identifier.

string

Client identifier.

string

Bank name.

string

Account holder full name. For individual clients this is bank_holder_first_name + bank_holder_last_name; for business clients this is business_name.

string

Business name. Only present for business bank accounts.

string

User-friendly alias.

string

Payment rail. FPS for UK accounts.

string

Account currency. GBP for FPS accounts.

string

UK sort code.

string

UK account number.

curl -X POST "https://api.cryptomate.me/management/clients/client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d/banks/fps" \
  -H "x-api-key: $CRYPTOMATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "bank_name": "Barclays",
    "account_alias": "Primary UK Account",
    "bank_holder_first_name": "John",
    "bank_holder_last_name": "Smith",
    "sort_code": "123456",
    "account_number": "12345678",
    "address": {
      "streetLine1": "Great Russell Street",
      "city": "London",
      "postal_code": "WC1B 3DG",
      "state": "GBR-CMD",
      "country": "GBR"
    }
  }'

{
  "id": "ba_mno345",
  "company_id": "comp_6f1e2a30-4a3c-4b2e-9a1d-5e8c9b7a1f23",
  "client_id": "client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "bank_name": "Barclays",
  "bank_holder_name": "John Smith",
  "account_alias": "Primary UK Account",
  "type": "FPS",
  "currency": "GBP",
  "sort_code": "123456",
  "account_number": "12345678"
}

{
  "code": "VAL",
  "message": "Must provide either (bankHolderFirstName + bankHolderLastName) for individual or businessName for business"
}

{
  "code": "NOT_FOUND",
  "message": "Client does not have a customer ID for provider BRIDGE"
}

Company

Individual Clients

Bank Accounts

Operations

Blockchains

Contracted Products

Create FPS bank account

Path parameters

Body

Response

​Path parameters

​Body

​Response

Path parameters

Body

Response