payments
Create a Payment
Creates a transaction from a user or a payment customer to the app. User the /users/{user_id}/payout-methods
route to get a user’s stored payment methods.
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
user_id
string
requiredcustomer_id
string
amount
integer
requiredplatform
enum<string>
requiredAvailable options:
ach
ach_info
object
Specifies the bank account to draw the payment from. This can be used as an alternative to a stored account ID.
account_id
string
The user's ACH account ID.
metadata
any
Response
201 - 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.