amount to refund the full payment amount, or pass a specific value to issue a partial refund. Multiple partial refunds can be issued against the same payment until the fully refunded amount equals the original charge.
Status values
Create a refund
POST /v1/refunds
Issues a refund against an existing payment. The payment must have a status of succeeded or partially_refunded.
Request parameters
string
required
ID of the payment to refund (e.g.
pay_xxx).number
Amount to refund in whole ISK kronur. Minimum value is
1. Omit to refund the full remaining amount of the payment.string
Reason for the refund. Stored on the refund object and visible in the dashboard.
object
Set of key-value pairs to attach to the refund. Values must be strings.
Response fields
string
required
Unique identifier for the refund (e.g.
ref_xxx).string
required
ID of the payment that was refunded.
number
required
Amount refunded in whole ISK kronur.
string
required
Three-letter ISO 4217 currency code, inherited from the payment.
string
required
Current refund status. One of
pending, succeeded, failed.string
Reason provided at creation.
object
Key-value pairs attached to the refund.
string
required
ISO 8601 timestamp of when the refund was created.
List refunds
GET /v1/refunds
Returns a paginated list of refunds, ordered by creation date descending.
Query parameters
string
Filter refunds by payment ID. Use this to retrieve all refunds for a specific payment.
number
Maximum number of refunds to return per page.
Response fields
object[]
required
Array of refund objects.
boolean
required
Whether more refunds exist beyond this page.
Retrieve a refund
GET /v1/refunds/{id}
Retrieves the details of an existing refund.
Path parameters
string
required
The ID of the refund to retrieve.
Response fields
string
required
Unique refund identifier.
string
required
ID of the refunded payment.
number
required
Refunded amount in whole ISK kronur.
string
required
Three-letter ISO 4217 currency code.
string
required
Current refund status. One of
pending, succeeded, failed.string
Reason for the refund.
object
Key-value pairs attached to the refund.
string
required
ISO 8601 timestamp of when the refund was created.