v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB

Refunds

RefundPayment

Refunds a payment. You can refund the entire payment amount or a portion of it. You can use this endpoint to refund a card payment or record a refund of a cash or external payment. For more information, see Refund Payment.

post/v2/refunds

Request body

idempotency_keystring required

A unique string that identifies this RefundPayment request. The key can be any valid string but must be unique for every RefundPayment request.

For more information, see Idempotency.

payment_idstring required

The unique ID of the payment being refunded.

reasonstring

A description of the reason for the refund.

Example request

{
  "request_body": {
    "amount_money": {
      "amount": 100,
      "currency": "USD"
    },
    "idempotency_key": "a7e36d40-d24b-11e8-b568-0800200c9a66",
    "payment_id": "UNOE3kv2BZwqHlJ830RCt5YCuaB"
  }
}

Response

Success

Example response

{
  "refund": {
    "amount_money": {
      "amount": 100,
      "currency": "USD"
    },
    "created_at": "2018-10-17T20:41:55.520Z",
    "id": "UNOE3kv2BZwqHlJ830RCt5YCuaB_xVteEWVFkXDvKN1ddidfJWipt8p9whmElKT5mZtJ7wZ",
    "payment_id": "UNOE3kv2BZwqHlJ830RCt5YCuaB",
    "status": "PENDING",
    "updated_at": "2018-10-17T20:41:55.520Z"
  }
}