transfers
Create a Transfer
Create a transfer.
Authorizations
Authorization
string
headerrequiredBasic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
application/json
amount
integer
requiredThe amount in cents to transfer. Negative amount transfers money from the app
to the user
.
user_id
string
requiredThe user's id.
tax_exempt
boolean | null
Transfers marked as tax_exempt
will not be counted towards the 1099 threshold.
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.
Response
200 - application/json
id
string
created
string
user_id
string
status
enum<string>
Available options:
created
, pending
, failed
, completed
, reversed
, canceled
, flagged
type
enum<string>
Available options:
refill
, payout
, balance
amount
number
external_data
object
transactions
object[]
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.