v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB

Internal Transfer

Create an asynchronous Internal Transfer

Creates an asynchronous Internal Transfer.

post/v1/internal_transfer

Headers

Idempotency-Keystring required

Idempotency key

Request body

amountinteger required

The amount of the internal transfer transaction in cents.

currency_code'USD' required

A three-letter currency code as defined in ISO 4217.

sender_account_number_idstring required

The ID of the Lead Bank Account Number object.

receiver_account_number_idstring required

The ID of the Lead Bank Account Number object.

descriptionstring required

Statement descriptor for the Internal Transfer

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

Example request

{
  "amount": 5000,
  "currency_code": "USD",
  "sender_account_number_id": "account_number_xyz123",
  "receiver_account_number_id": "account_number_xyz123",
  "description": "Internal treasury transfer"
}

Response

Successful response

idstring required

The ID of the Internal Transfer object.

amountinteger required

The amount of the transaction in cents.

currency_code'USD' required

A three-letter currency code as defined in ISO 4217.

sender_account_idstring required

The ID of the Account object.

sender_account_number_idstring required

The ID of the Lead Bank Account Number object.

receiver_account_idstring required

The ID of the Account object.

receiver_account_number_idstring required

The ID of the Lead Bank Account Number object.

status'processing' | 'posted' | 'rejected' required

The current status of the InternalTransfer object.

descriptionstring required

Memo string for the transfer

metadataMetadata required

A set of key-value pairs that can be used to store additional information related to this object.

created_atstring date-time required

The RFC3339 timestamp at which the InternalTransfer object was created.

updated_atstring date-time required

The RFC3339 timestamp at which the InternalTransfer object was last updated.

Example response

{
  "id": "internal_transfer_xyz123",
  "amount": 5000,
  "currency_code": "USD",
  "sender_account_id": "account_xyz123",
  "sender_account_number_id": "account_number_xyz123",
  "receiver_account_id": "account_xyz123",
  "receiver_account_number_id": "account_number_xyz123",
  "status": "posted",
  "rejection": {
    "reason": "account_number_not_active",
    "details": "Account number account_123 is inactive."
  },
  "created_at": "2022-06-27T11:22:33Z",
  "updated_at": "2022-06-27T11:22:33Z"
}