Create External Account

POST /v0/customers/{customer_id}/external-accounts

Description Creates an external account and returns account information.

Path parameters

• customer_id (string, required) The unique identifier of the customer.

Header parameters

• Authorization (string, required) Token for authentication.

• Idempotency-Key (string, required) Unique key to prevent duplicate requests.

Request body Content-Type: application/json

External account details for bank transfers. Can be either IBAN-based or US-based account.

One of:

• IBANAccountDetails (object, optional) Use this option for European and other IBAN-supported bank accounts.

• USAccountDetails (object, optional) Use this option for US-based bank accounts using routing and account numbers.

• InternationalWireAccountDetails (object, optional) Use this option for international wire (SWIFT) transfers using account number, routing number, and BIC.

Example request

request.txt

POST /v0/customers/{customer_id}/external-accounts HTTP/1.1
Host: gateway.noxxo.com
Authorization: text
Idempotency-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 389

{
  "bank_name": "text",
  "account_holder_type": "individual",
  "account_holder_first_name": "text",
  "account_holder_last_name": "text",
  "account_holder_business_name": "text",
  "account_holder_address": {
    "country": "US",
    "city": "San Francisco",
    "street_line_1": "580 Howard, Suite PH San Francisco",
    "postal_code": "94105"
  },
  "account_type": "iban",
  "iban": {
    "bic": "DEUTDEFF",
    "iban_number": "DE89370400440532013000"
  }
}

Responses

201 Created Successful external account creation response. Content-Type: application/json

Possible response bodies (one of):

• IBANAccountDetails (object)

• USAccountDetails (object)

• InternationalWireAccountDetails (object)

Example response (201)

response.json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2023-01-01T00:00:00Z",
  "bank_name": "text",
  "account_holder_type": "individual",
  "account_holder_first_name": "text",
  "account_holder_last_name": "text",
  "account_holder_business_name": "text",
  "account_holder_address": {
    "country": "US",
    "city": "San Francisco",
    "street_line_1": "580 Howard, Suite PH San Francisco",
    "postal_code": "94105"
  },
  "account_type": "iban",
  "iban": {
    "iban_number": "text",
    "bic": "text"
  }
}

Last updated 2 months ago