v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB

Internal Transfer

List all Internal Transfers

List all Internal Transfers.

get/v1/internal_transfer

Query parameters

sender_account_number_idstring

The sender account number ID.

receiver_account_number_idstring

The receiver account number ID.

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

The current status of the InternalTransfer object.

Example:posted

afterstring date-time

Return objects where the created_at timestamp is after the entered timestamp.

on_or_afterstring date-time

Return objects where the created_at timestamp is the same as or after the entered timestamp.

beforestring date-time

Return objects where the created_at timestamp is before the entered timestamp.

on_or_beforestring date-time

Return objects where the created_at timestamp is the same as or before the entered timestamp.

A set of filters on the list using the object’s field created_at.

limitinteger

Maximum number of objects to be returned.

starting_afterstring

A cursor for use in pagination; this is an ID that defines your place in the list.

ending_beforestring

A cursor for use in pagination; this is an ID that defines your place in the list.

Response

List of Internal Transfer objects

has_moreboolean required

Indicates whether more results are available.

Example response

{
  "objects": [
    {
      "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"
    }
  ]
}