{
"id": "<string>",
"amount": 123,
"paymentIntentId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Entities
Refund
A refund returns some or all of a captured payment to the buyer. Refunds
are created against a payment intent and are processed asynchronously: a refund
starts as
pending, moves to processing, and ends in a terminal succeeded
or failed state.
Statuses
| Status | Meaning |
|---|---|
pending | The refund was accepted by POST /payments/refund. No money has moved yet. |
processing | Slash has picked up the refund and is submitting it to the card network. |
succeeded | The refund was accepted by the card network. This is the terminal success state; when the funds appear on the buyer’s statement is up to their bank. |
failed | The refund was rejected and no money moved. The amount is released back to the payment’s refundable balance, so you can retry with a new POST /payments/refund. |
Creating refunds
POST /payments/refund requires the
paymentIntentId to refund and the amount in the smallest unit of the
payment intent’s currency. Refunds are always issued in the currency of the
original payment — you cannot pass a different one. You can refund all or
part of a payment by setting amount to the desired value. You can create
multiple partial refunds against the same payment; the total across all
refunds can never exceed the captured amount.
Refund creation supports idempotent requests
via the optional X-Idempotency-Key header.
Tracking refund state
Subscribe to thepayments.refund.created and
payments.refund.updated webhooks
to be notified when a refund is created and on every status change, then read
the refund back with
GET /payments/refund/{refundId}.
If you cannot receive webhooks, poll
GET /payments/refund/{refundId} until
status is terminal.A refund returns all or part of a succeeded payment to the buyer.
Unique identifier for the refund.
Current refund processing status.
Available options:
pending, processing, succeeded, failed Refund amount in cents.
ISO currency code for the refund. Supported currencies are usd and eur.
Available options:
usd, eur The payment intent being refunded.
ISO-8601 timestamp the refund was created at.
ISO-8601 timestamp the refund last changed status.