GET /transfers/{id}.json

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- achPayment boolean | null
  
  Ach payment
- additionalAmount number | null Required
  
  Additional amount
  
  Default value is 0.
- amount number Required
  
  Amount
  
  Default value is 0.
- createdAt string(date-time)
  
  Created at
- dropshipProviderId integer(int32) Required
  
  Dropship provider
- externalId string | null
  
  External
- fee number | null Required
  
  Fee
  
  Default value is 0.
- id integer(int32)
  
  Id
- managedAccount boolean | null
  
  Managed account
- message string | null
  
  Message
- name string | null
  
  Name
- notes string | null
  
  Notes
- problem object | null | array | boolean | integer | number | string
  
  Problem
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- resendExternalIds array[string] | null Required
  
  Resend external ids
  
  Default value is [] (empty).
- resends integer(int32) | null Required
  
  Resends
  
  Default value is 0.
- 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, or transferwise. Default value is other.
- status string | null Required
  
  Status
  
  Values are pending, complete, error, or cancelled. Default value is pending.
- stripePayout string | null Required
  
  Stripe payout
  
  Values are jetti or retailer. Default value is retailer.
- total object | null | array | boolean | integer | number | string
  
  Total
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- trigger string | null Required
  
  Trigger
  
  Values are automated, manual, or other. Default value is other.
- updatedAt string(date-time)
  
  Updated at

curl \
 --request GET 'http://api.example.com/v1/transfers/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "achPayment": true,
  "additionalAmount": 0,
  "amount": 0,
  "createdAt": "2025-05-04T09:42:00Z",
  "dropshipProviderId": 42,
  "externalId": "string",
  "fee": 0,
  "id": 42,
  "managedAccount": true,
  "message": "string",
  "name": "string",
  "notes": "string",
  "problem": {},
  "resendExternalIds": [],
  "resends": 0,
  "sendAttempts": 0,
  "source": "other",
  "status": "pending",
  "stripePayout": "retailer",
  "total": {},
  "trigger": "other",
  "updatedAt": "2025-05-04T09:42:00Z"
}

Path parameters

Responses

problem object | null | array | boolean | integer | number | string

total object | null | array | boolean | integer | number | string