Skip to main content
POST
/
payment
/
api
/
v1
/
accounts
/
register
Register Destination Account
curl --request POST \
  --url https://api.carbnconnect.com/payment/api/v1/accounts/register \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "user_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "account_type": "bank_account",
  "account_details": {
    "iban": "DE89370400440532013000",
    "bic": "COBADEFFXXX",
    "account_holder_name": "John Doe",
    "bank_name": "Example Bank",
    "card_number": "XXXXXXXXXXXXXXXX",
    "card_holder_name": "John Doe",
    "expiry_month": 12,
    "expiry_year": 2025
  },
  "currency": "EUR",
  "nickname": "My Account Name"
}'

Authorizations

x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Body

application/json
user_id
string<uuid>
required

The unique identifier of the user

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

account_type
enum<string>
required

Type of destination account

Available options:
bank_account,
card
Example:

"bank_account"

account_details
object
required
currency
string

Primary currency for this account (ISO 4217)

Example:

"EUR"

nickname
string

Optional nickname for the account

Example:

"My Account Name"

Response

Destination account registered successfully