Sign in
refunds

Create Refund

post/v2/refunds/

Request body

paymentstring required
amountinteger

Example request

{
  "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX"
}

Response

Successful Response

idstring required
amountinteger required

Amount in positive integer format

currencystring required

Currency in 3 digit format

date_bankstring date

Bank procession YYYY-MM-DD in epoch format

date_refundstring date-time

Refund date in YYYY-MM-DD format

payment_intentstring
paymentstring required
createdstring date-time required

Date of creation in Epoch timestamp

status'to_refund' | 'refund_sent' | 'refunded' | 'not_honored' | 'payment_canceled' | 'failed' | 'awaiting_approval' required

An enumeration.

payoutstring

Example response

{
  "id": "refd_yWYfCSzsUUhr9KwMv7vuLZHX",
  "amount": 50,
  "currency": "eur",
  "date_bank": "2023-08-16",
  "date_refund": "2023-08-15",
  "payment_intent": "pi_yWYfCSzsUUhr9KwMv7vuLZHX",
  "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  "created": "1512518400",
  "payout": "pout_yWYfCSzsUUhr9KwMv7vuLZHX"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.