You are viewing an old version of the API

All Versions

Refund payment

POST /v2/refunds

Refunds a payment.

You can refund the entire payment amount or a portion of it.

Permissions

PAYMENTS_WRITE

Guide

Refund a payment Try in API Explorer

Request Body

Example code

Name	Description
`idempotency_key string` 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. Min Length 1
`amount_money Money` Required	The amount of money to refund. This amount cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. This amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see Working with Monetary Amounts. The currency code must match the currency associated with the business that is charging the card.
`app_fee_money Money` Beta	The amount of money the developer contributes to help cover the refunded amount. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). The value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see Take Payments and Collect Fees.
`payment_id string` Required	The unique ID of the payment being refunded. Min Length 1
`reason string`	A description of the reason for the refund. Max Length 192

Response Fields

Name	Description
`errors Error [ ]`	Information about errors encountered during the request.
`refund PaymentRefund`	The successfully created `PaymentRefund`.

Examples

curl https://connect.squareup.com/v2/refunds \
  -X POST \
  -H 'Square-Version: 2020-12-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "idempotency_key": "a7e36d40-d24b-11e8-b568-0800200c9a66",
    "payment_id": "UNOE3kv2BZwqHlJ830RCt5YCuaB",
    "amount_money": {
      "amount": 100,
      "currency": "USD"
    }
  }'

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

Error Descriptions

400 Bad request	AMOUNT_TOO_HIGH The requested payment amount is too high for the provided payment source.	>
400 Bad request	REFUND_DECLINED Request failed - The card issuer declined the refund.	>

{
  "errors": [
    {
      "code": "AMOUNT_TOO_HIGH",
      "category": "INVALID_REQUEST_ERROR"
    }
  ]
}

Refunds API You are viewing an old version of the API 2020-12-16 Version 2020-12-16 All Versions Refunds API Refund payment

Request Body

Response Fields

Examples

Error Descriptions

Share Feedback

You are viewing an old version of the API

All Versions

Refund payment