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 create a vendor refund for.
Body
Simple vendor refund creation parameters. The system will automatically calculate the refund amount based on the specified target (bill, line item, or payment). At least one target identifier must be provided.
The time the vendor refund was completed.
The payment method used for the refund.
CASH
, CHECK
, CREDIT_CARD
, ACH
, CREDIT_BALANCE
, OTHER
An external identifier for the vendor refund transaction.
The ID of the bill to refund.
The external ID of the bill to refund.
The ID of the bill line item to refund.
The external ID of the bill line item to refund.
The ID of the bill payment to refund.
The external ID of the bill payment to refund.
The fee charged to the business for processing the refund in cents.
The payment processor used to process the refund.
"STRIPE"
Tags to associate with the 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 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. Can be used to filter when listing vendor refunds.
Response
Vendor refund has been successfully updated or unchanged.
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 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. Can be used to filter when listing vendor refunds.