Fetch refund

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type

string

Content-Type must be set to application/json

Path Parameters

businessId

string

required

The UUID of the business to fetch refunds for.

refundId

string

required

The UUID of the refund to fetch.

Response

200 - application/json

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.

string

Unique identifier for the refund.

external_id

string

Unique ID of the refund in your system for linking purposes. Idempotency key.

refunded_amount

integer

Amount refunded to the customer in cents.

status

string

Status of the refund.

completed_at

string

Time when the refund was completed.

payments

object[]

Payments associated with this refund.

allocations

object[]

Allocations associated with this refund.

allocations.id

string

Unique identifier for the refund allocation.

allocations.invoice_id

string | null

ID of the invoice this allocation is associated with.

allocations.amount

integer

Amount of the allocation in cents.

allocations.account_identifier

object

Identifier of the ledger account for the refund allocation to apply to

allocations.invoice_external_id

string | null

External ID of the invoice this allocation is associated with.

allocations.invoice_line_item_id

string | null

ID of the invoice line item this allocation is associated with. If specified, must not refer to a different invoice invoice_external or invoice_id.

allocations.invoice_line_item_external_id

string | null

The external ID of the invoice line item to refund. If specified alongside invoice_line_item_id, they must refer to the same invoice line item.

allocations.invoice_payment_id

string | null

ID of the invoice payment this allocation is associated with.

allocations.invoice_payment_external_id

string | null

External ID of the invoice payment this allocation is associated with.

allocations.customer

object

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Fetch refund

Authorizations

Headers

Path Parameters

Response