Refund a succeeded payment

POST

/api/v1/payments/{id}/refund

const url = 'https://example.com/api/v1/payments/example/refund';
const options = {method: 'POST', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/payments/example/refund \
  --header 'x-api-key: <x-api-key>'

Authorizations

x-api-key

Parameters

Path Parameters

required

string

Responses

201

application/json

object

required

string

stripePaymentIntentId

required

string

customerId

required

string

amount

required

Smallest currency unit (cents)

number

currency

required

string

status

required

string

Allowed values: requires_payment_method requires_confirmation requires_action processing succeeded canceled refunded

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "status": "requires_payment_method"
}