XPxpaycheckout

POST /payments/merchant/refund

The Refund APIs allow merchants to process refunds for previously captured payments

Request

  • Base URL
    https://api.xpaycheckout.com
  • URL
    https://api.xpaycheckout.com/payments/merchant/refund
  • Auth
    HTTP basic

Headers

Idempotency-Keystring

A unique key for making the request idempotent. Must match pattern: ^[a-zA-Z0-9\-_:\.]+$. See Idempotent Requests for more details.

Request body

xIntentIdstring required

Unique identifier of the intent

amountstring

The amount you want to refund, specified in the smallest unit of the currency (for example, cents for USD, paise for INR).

  • If you want to issue a partial refund, provide the amount you wish to refund here. For example, if the original payment was $100 (i.e., 10000 cents), and you want to refund $20, you would enter 2000.
  • If you leave this field blank, the full payment amount will be refunded automatically.
refundReferenceIdstring

Your identifier for the refund

Example request

{
  "xIntentId": "in_fooBOwYsaK50AEfK",
  "amount": "200",
  "refundReferenceId": "re123"
}

Response

Refund API response

refundIdstring required

Unique identifier of the refund

intentIdstring required

Unique identifier of the payment intent

amountinteger required

The amount in lowest count unit. e.g.: For USD 1, amount is 100 representing 100 cents (The minimum amount should be greater than 1 USD)

currencystring required

Three letter abbreviation of the currency. Refer supported currencies

refundedAtinteger required

Epoch timestamp in milliseconds of when the refund was processed

refundReferenceIdstring

Your identifier for the refund

Example response

{
  "refundId": "rf_fooBOwYsaK50AEaJ",
  "intentId": "in_fooBOwYsaK50AEfK",
  "amount": 2000,
  "currency": "USD",
  "refundedAt": 1727340330123,
  "refundReferenceId": "re123"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.