POST /transfers.json
POST
/transfers.json
Body Required
-
achPayment boolean | null
Ach payment
-
additionalAmount number | null Required
Additional amount
Default value is
0
. -
amount number Required
Amount
Default value is
0
. -
dropshipProviderId integer(int32) Required
Dropship provider
-
externalId string | null
External
-
fee number | null Required
Fee
Default value is
0
. -
managedAccount boolean | null
Managed account
-
message string | null
Message
-
name string | null
Name
-
notes string | null
Notes
-
sendAttempts integer(int32) | null Required
Send attempts
Default value is
0
. -
source string Required
Source
Values are
stripe
,stripe_managed
,paypal
,bacs
,check
,other
,ost
, ortransferwise
. Default value isother
. -
status string | null Required
Status
Values are
pending
,complete
,error
, orcancelled
. Default value ispending
. -
stripePayout string | null Required
Stripe payout
Values are
jetti
orretailer
. Default value isretailer
. -
trigger string | null Required
Trigger
Values are
automated
,manual
, orother
. Default value isother
.
POST /transfers.json
curl \
-X POST http://api.example.com/v1/transfers.json \
-H "Content-Type: application/json" \
-d '{"achPayment":true,"additionalAmount":0,"amount":0,"dropshipProviderId":42,"externalId":"string","fee":0,"managedAccount":true,"message":"string","name":"string","notes":"string","problem":{},"sendAttempts":0,"source":"other","status":"pending","stripePayout":"retailer","total":{},"trigger":"other"}'
Request example
{
"achPayment": true,
"additionalAmount": 0,
"amount": 0,
"dropshipProviderId": 42,
"externalId": "string",
"fee": 0,
"managedAccount": true,
"message": "string",
"name": "string",
"notes": "string",
"problem": {},
"sendAttempts": 0,
"source": "other",
"status": "pending",
"stripePayout": "retailer",
"total": {},
"trigger": "other"
}
Response examples (200)
{
"achPayment": true,
"additionalAmount": 0,
"amount": 0,
"createdAt": "2023-05-04T09:42:00+00:00",
"dropshipProviderId": 42,
"externalId": "string",
"fee": 0,
"id": 42,
"managedAccount": true,
"message": "string",
"name": "string",
"notes": "string",
"problem": {},
"sendAttempts": 0,
"source": "other",
"status": "pending",
"stripePayout": "retailer",
"total": {},
"trigger": "other",
"updatedAt": "2023-05-04T09:42:00+00:00"
}