Transfer Routes
Create Transfer
Create a transfer.
POST
/
v2
/
transfers
Authorization
Body
{
"amount": "number",
"created": "string",
"external_data": {
"account_id": "string",
"external_id": "string",
"platform": "ach"
},
"id": "string",
"metadata": [
"string",
"object",
"null"
],
"status": "created",
"transactions": [
{
"amount": "number",
"created": "string",
"destination_name": "string",
"id": "integer",
"metadata": [
"string",
"object",
"null"
],
"source_name": "string"
}
],
"type": "refill",
"user_id": "string"
}
Authorizations
Authorizationheaderrequired
string
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
application/json
amountrequired
integer
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_idrequired
string
The user's id.
Response
200 - application/json
amount
number
created
string
external_data
object
id
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
{
"amount": "number",
"created": "string",
"external_data": {
"account_id": "string",
"external_id": "string",
"platform": "ach"
},
"id": "string",
"metadata": [
"string",
"object",
"null"
],
"status": "created",
"transactions": [
{
"amount": "number",
"created": "string",
"destination_name": "string",
"id": "integer",
"metadata": [
"string",
"object",
"null"
],
"source_name": "string"
}
],
"type": "refill",
"user_id": "string"
}