Payments
Create a Payment
Create an ACH Payment.
POST
/
v2
/
payments
Authorization
Body
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payments \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 0,
"platform": "<platform>"
}'
{
"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
Option 1
Option 2
account_id
string | null
The user's ACH account ID.
ach_info
object
Specifies the bank account to draw the payment from. This can be used as an alternative to a stored account ID.
amountrequired
integer
customer_id
string
metadata
any
platformrequired
enum<string>
Available options:
ach
user_idrequired
string
Response
201 - 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
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payments \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 0,
"platform": "<platform>"
}'
{
"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"
}