Create refund
Creates a new refund for a business or updates existing refund. This endpoint is idempotent using the external_id field as the idempotency key, so subsequent requests with the same external_id will update or no-op.
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 refund for.
Body
An external identifier for the refund transaction.
The amount of the refund in cents. This value must be positive.
The time the refund was completed.
Payments that have been made towards the balance of the refund.
Allocations that have been made towards the balance of the refund.
The fee associated with the refund in cents. This value must be positive.
The method used to refund the payment.
CASH, CHECK, CREDIT_CARD, ACH, STORE_CREDIT, OTHER The payment processor used to refund the payment.
The ID of the invoice to refund.
Response
A refund represents a transaction that returns value to from a business to a customer. A specific payment can be refunded or a general refund can be applied to an invoice.
Unique identifier for the refund.
Unique ID of the refund in your system for linking purposes. Idempotency key.
Amount refunded to the customer in cents.
Status of the refund.
Time when the refund was completed.
Payments associated with this refund.
Allocations associated with this refund.