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 refunds for.
The UUID of the vendor refund to fetch.
Response
Vendor refund details
A vendor refund represents a transaction where a vendor returns value to a business. A specific bill can be refunded or a general refund can be applied to a vendor.
Unique identifier for the vendor refund.
Unique ID of the vendor refund in your system for linking purposes. Idempotency key.
"vendor-refund-123"
Amount refunded to the business in cents.
Status of the vendor refund.
"PAID"
Time when the vendor refund was completed.
Allocations associated with this vendor refund.
Payments associated with this vendor refund.
Memo for any text you would like to associate with the vendor refund (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}
Any (typically user-visible) identifier you would like to associate with the vendor refund. Can be used to filter when listing vendor refunds.