Skip to main content
POST
/
customers
/
{customerId}
/
bankaccounts
Create Customer Bank Account
curl --request POST \
  --url https://api.jtl-cloud.com/erp/customers/{customerId}/bankaccounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "AccountHolder": "<string>",
  "BankName": "<string>",
  "AccountNumber": "<string>",
  "BankCode": "<string>",
  "IBAN": "<string>",
  "BIC": "<string>"
}
'
{
  "Id": 123,
  "AccountHolder": "<string>",
  "BankName": "<string>",
  "AccountNumber": "<string>",
  "BankCode": "<string>",
  "IBAN": "<string>",
  "BIC": "<string>"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

api-version
string

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionId
string<uuid>

The id of a session in which the call will be executed.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

customerId
integer<int32>
required

The id of the customer that the bank accounts belong to. Represents a unique key for identifying a customer in the JTL system.

Body

application/json

The bank account of the customer to create.

Model Class: CreateCustomerBankAccount

AccountHolder
string
required

Name of the account holder of the customer's bank account.

Maximum string length: 255
BankName
string

Name of the bank.

AccountNumber
string

Account number of the customer's bank account.

BankCode
string

Bank code of the customer bank's account.

IBAN
string

International bank account number of the customer's bank account.

BIC
string

Bank identification code of the customer's bank account.

Response

The created bank account of the customer.

Model Class: CustomerBankAccount

Id
integer<int32>
required

The unique ID to identify a customer's bank account.

AccountHolder
string
required

Name of the account holder of the customer's bank account.

BankName
string
required

Name of the bank.

AccountNumber
string
required

Account number of the customer's bank account.

BankCode
string
required

Bank code of the customer bank's account.

IBAN
string
required

International bank account number of the customer's bank account.

BIC
string
required

Bank identification code of the customer's bank account.