Create a Transfer

{
  "amount": 123,
  "created": "2023-11-07T05:31:56Z",
  "external_data": {
    "account_id": "<string>",
    "external_id": "<string>",
    "platform": "ach"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<string>",
  "status": "created",
  "transactions": [
    {
      "amount": 123,
      "created": "2023-11-07T05:31:56Z",
      "destination_name": "<string>",
      "id": 123,
      "metadata": "<string>",
      "source_name": "<string>",
      "type": "balance"
    }
  ],
  "type": "refill",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization

string

headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

amount

integer

required

The amount in cents to transfer. Negative amount transfers money from the app to the user.

idempotency_key

string | null

UUID that will be used to idempotently handle requests. Transfers with existing idempotency keys will be rejected.

metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

tax_exempt

boolean | null

Transfers marked as tax_exempt will not be counted towards the 1099 threshold.

user_id

string

required

The user's id.

Response

200 - application/json

amount

number

created

string

external_data

object

string

metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

status

enum<string>

Available options:

created,

pending,

failed,

completed,

flagged

transactions

object[]

type

enum<string>

Available options:

refill,

payout,

balance

user_id

string

Transfers Overview Retrieve a Transfer

{
  "amount": 123,
  "created": "2023-11-07T05:31:56Z",
  "external_data": {
    "account_id": "<string>",
    "external_id": "<string>",
    "platform": "ach"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<string>",
  "status": "created",
  "transactions": [
    {
      "amount": 123,
      "created": "2023-11-07T05:31:56Z",
      "destination_name": "<string>",
      "id": 123,
      "metadata": "<string>",
      "source_name": "<string>",
      "type": "balance"
    }
  ],
  "type": "refill",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}