Refund a succeeded payment intent (full refund)
Fully refunds a `succeeded` payment intent and returns its updated state. The intent status stays `succeeded` until the provider's `payment.refunded` webhook confirms the refund (webhook-only confirmation, mirroring approval). Only `succeeded` intents are refundable; an already-`refunded` intent returns as-is (idempotent). Full refund only in v1 — no amount parameter (partials are a later additive change).
/intents/{intent_id}/refundFully refunds a succeeded payment intent and returns its updated
state. The intent status stays succeeded until the provider's
payment.refunded webhook confirms the refund (webhook-only
confirmation, mirroring approval). Only succeeded intents are
refundable; an already-refunded intent returns as-is (idempotent).
Full refund only in v1 — no amount parameter (partials are a later
additive change).
JWT issued by IdentityX, signed with Ed25519
In: header
Path Parameters
Payment intent ID.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/intents/497f6eca-6276-4993-bfeb-53cbbbba6f08/refund"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",
"seller_id": "28f4dc41-8499-4ead-9976-f2fa20a45fd1",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"amount_cents": 0,
"currency": "string",
"sandbox": true,
"provider": "string",
"status": "pending",
"status_detail": "insufficient_funds",
"provider_data": {},
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 401,
"title": "Unauthenticated"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 404,
"title": "Not Found"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 409,
"title": "Provider Conflict",
"provider": "string",
"reason": "string"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 500,
"title": "Internal Server Error"
}