Skip to navigation
Gift ProcessingDeposit Addresses

Create a Deposit Address

Provisions a new deposit address on your account. Chariot mints the underlying account and routing numbers and returns them on the response.

An address is unique per (source_id, type). Provisioning a second address for the same source and rail returns 409 Conflict.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Idempotency-KeystringOptional
The idempotency key for the request.

Request

The request to provision a new deposit address.
typeenumRequired
The rail this address should receive money over.
Allowed values:
source_idstringRequired

The identifier of the Source this address belongs to.

Response headers

LocationstringOptional
The URI of the created object
Idempotency-KeystringOptional
Idempotency key for the request

Response

The deposit address was created.
idstringRead-only
The unique identifier for the deposit address.
typeenumRead-only

The rail this address receives money over. Determines which per-rail subobject is populated on the response.

Allowed values:
source_idstringRead-only

The identifier of the Source this address belongs to.

created_atdatetimeRead-only
When this deposit address was provisioned.
updated_atdatetimeRead-only
When this deposit address was last modified.
achobjectOptional

ACH account details. Populated when type is ach.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error