Skip to main content
POST
/
v1
/
internal_transfer
Create an asynchronous Internal Transfer
curl --request POST \
  --url https://api.sandbox.lead.bank/v1/internal_transfer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 5000,
  "currency_code": "USD",
  "sender_account_number_id": "account_number_xyz123",
  "receiver_account_number_id": "account_number_xyz123",
  "description": "Internal treasury transfer",
  "metadata": {}
}
'
{
  "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": "processing",
  "description": "string",
  "metadata": {
    "additionalProp": "string"
  },
  "created_at": "2022-06-27T11:22:33Z",
  "updated_at": "2022-06-27T11:22:33Z"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string
required

Idempotency key

Required string length: 5 - 255

Body

application/json
​
amount
integer<int64>
required

The amount of the internal transfer transaction in cents.

Required range: 1 <= x <= 9900000000
Example:

5000

​
currency_code
enum<string>
required

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

Available options:
USD
Example:

"USD"

​
sender_account_number_id
string
required

The ID of the Lead Bank Account Number object.

Pattern: ^account_number_\w+$
Example:

"account_number_xyz123"

​
receiver_account_number_id
string
required

The ID of the Lead Bank Account Number object.

Pattern: ^account_number_\w+$
Example:

"account_number_xyz123"

​
description
string
required

Statement descriptor for the Internal Transfer

Required string length: 5 - 34
Example:

"Internal treasury transfer"

​
metadata
object

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

Response

Successful response

​
id
string
required

The ID of the Internal Transfer object.

Pattern: ^internal_transfer_\w+$
Example:

"internal_transfer_xyz123"

​
amount
integer<int64>
required

The amount of the transaction in cents.

Required range: 0 <= x <= 9900000000
Example:

5000

​
currency_code
enum<string>
required

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

Available options:
USD
Example:

"USD"

​
sender_account_id
string
required

The ID of the Account object.

Pattern: ^account_\w+$
Example:

"account_xyz123"

​
sender_account_number_id
string
required

The ID of the Lead Bank Account Number object.

Pattern: ^account_number_\w+$
Example:

"account_number_xyz123"

​
receiver_account_id
string
required

The ID of the Account object.

Pattern: ^account_\w+$
Example:

"account_xyz123"

​
receiver_account_number_id
string
required

The ID of the Lead Bank Account Number object.

Pattern: ^account_number_\w+$
Example:

"account_number_xyz123"

​
status
enum<string>
required

The current status of the InternalTransfer object.

Available options:
processing,
posted,
rejected
Example:

"posted"

​
description
string
required

Memo string for the transfer

​
metadata
object
required

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

​
created_at
string<date-time>
required

The RFC3339 timestamp at which the InternalTransfer object was created.

Example:

"2022-06-27T11:22:33Z"

​
updated_at
string<date-time>
required

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

Example:

"2022-06-27T11:22:33Z"

​
rejection
object