Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Content-Type must be set to application/json
Path Parameters
The UUID of the business to fetch vendor refund payments for.
Query Parameters
Filter vendor refund payments by external ID (unique idempotency key). This will always yield zero or one result.
Filter vendor refund payments by completion date. Payments completed on or after this date will be included. ISO 8601 date format.
Filter vendor refund payments by completion date. Payments completed on or before this date will be included. ISO 8601 date format.
Filter vendor refund payments by payment method. Supported values are CASH
, CHECK
, CREDIT_CARD
, ACH
, CREDIT_BALANCE
, OTHER
.
Filter vendor refund payments by payment processor (e.g. STRIPE, etc.).
Filter vendor refund payments by minimum amount. Only payments with amounts greater than or equal to this value will be included. Must be a positive integer.
x >= 0
Filter vendor refund payments by maximum amount. Only payments with amounts less than or equal to this value will be included. Must be a positive integer.
x >= 0
Filter vendor refund payments by memo content. Returns payments where the memo contains this string (case-sensitive).
Filter vendor refund payments by exact memo match. Returns payments where the memo exactly matches this string.
Comma-separated list of reference numbers to filter vendor refund payments by. Only vendor refund payments with reference numbers matching any value in this list will be returned.
Filter vendor refund payments by whether they are included in a vendor payout. Set to true
to show only payments that are part of a payout, false
to show only payments not in any payout.
Filter vendor refund payments by match status. If true, only matched payments will be returned. If false, only unmatched payments will be returned. Vendor refund payments are considered matched if they are matched directly, or if they are included in a vendor payout that is matched.
Response
List of vendor refund payments
Unique identifier for the payment.
Unique ID of the payment in your system for linking purposes. Idempotency key.
"payment-456"
Amount refunded to the business in cents.
Fee charged for the refund processing in cents.
Time when the payment was completed.
Method of the payment.
"ACH"
Processor used for the payment.
"STRIPE"
The the ledger account to use for the payment (overrides the default determined by the payment method), if specified.
Memo for any text you would like to associate with the vendor refund payment (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 10KB
{
"custom_field": "value",
"any valid json": "below 10kb",
"nested": { "meaning of life": 42, "array": [] }
}
Any (typically user-visible) identifier you would like to associate with the vendor refund payment. Can be used to filter when listing vendor refund payments.