Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
Transactions

CreateRefund

Initiates a refund for a previously charged tender.

You must issue a refund within 120 days of the associated payment. See this article for more information on refund behavior.

NOTE: Card-present transactions with Interac credit cards cannot be refunded using the Connect API. Interac transactions must refunded in-person (e.g., dipping the card using POS app).

post/v2/locations/{location_id}/transactions/{transaction_id}/refund

Path parameters

location_idstring required

The ID of the original transaction's associated location.

transaction_idstring required

The ID of the original transaction that includes the tender to refund.

Request body

idempotency_keystring required

A value you specify that uniquely identifies this refund among refunds you've created for the tender.

If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund.

See Idempotency keys for more information.

reasonstring

A description of the reason for the refund.

Default value: Refund via API

tender_idstring required

The ID of the tender to refund.

A Transaction has one or more tenders (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API.

Example request

{
  "request_body": {
    "amount_money": {
      "amount": 100,
      "currency": "USD"
    },
    "idempotency_key": "86ae1696-b1e3-4328-af6d-f1e04d947ad2",
    "reason": "a reason",
    "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF"
  }
}

Response

Success

Example response

{
  "refund": {
    "additional_recipients": [
      {
        "amount_money": {
          "amount": 10,
          "currency": "USD"
        },
        "description": "Application fees",
        "location_id": "057P5VYJ4A5X1",
        "receivable_id": "ISu5xwxJ5v0CMJTQq7RvqyMF"
      }
    ],
    "amount_money": {
      "amount": 100,
      "currency": "USD"
    },
    "created_at": "2016-02-12T00:28:18Z",
    "id": "b27436d1-7f8e-5610-45c6-417ef71434b4-SW",
    "location_id": "18YC4JDH91E1H",
    "reason": "some reason",
    "status": "PENDING",
    "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF",
    "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF"
  }
}