Create External Account

Creates an external account and returns account information.

Path parameters

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

Header parameters

circle-info

Include the following headers in the request.

  • 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, US-based, or for international wire (SWIFT) transfers.

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

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)