Refunds
Create, retrieve, update, and list refunds.
A refund reverses all or part of a previously succeeded payment. Funds are returned to the customer's original payment method, typically within 5–10 business days depending on the card network.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The refund objectAsk
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the refund, e.g. re_7Kp1mQ. |
payment | string | ID of the payment being refunded. |
amount | integer | Amount refunded, in the smallest currency unit (e.g. cents). |
currency | string | Three-letter ISO currency code matching the original payment. |
status | enum | One of pending, succeeded, or failed. |
reason | enum | One of duplicate, fraudulent, or requested_by_customer. |
created | integer | Unix timestamp when the refund was created. |
Create a refundAsk
Pass the payment ID and an optional amount. If amount is omitted, the full uncaptured amount is
refunded.
Retrieve a refundAsk
Fetch a refund by its ID to check its current status.
Update a refundAsk
Update the metadata on a refund. Only the metadata field is editable after creation.
List refundsAsk
Returns a paginated list of refunds, newest first. Use the payment filter to scope results to a
single payment.
| Parameter | Type | Description |
|---|---|---|
payment | string | Filter refunds by payment ID. |
limit | integer | Number of results to return. Default 10, max 100. |
Related eventsAsk
refund.created, refund.updated. See Events.
