Payments

Refund or cancel an existing Payment

post/payments/{id}/refunds

Path parameters

idstring uuid required

The ID of the Payment to refund

Headers

Trace-Idstring

A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.

End-User-Agentstring

A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.

End-User-Ipstring

The IP address of the end user. Recommended for compliance.

End-User-OSstring

The Operating System of the end user. Recommended for compliance.

End-User-Device-Idstring

A unique identifier for the end user's device. Recommended for compliance.

End-User-Device-Manufacturerstring

The manufacturer of the device used by the end user. Recommended for compliance.

End-User-Device-Modelstring

The device model used by the end user. Recommended for compliance.

Request body

Example request

{
  "payer": {
    "id": "8f51c396-6e29-49a6-ba5a-1a31d5420158"
  }
}

Response

Payment refunded successfully

status'REFUNDED' | 'REFUND_FAILED'

Representation of whether the Payment was successfully refunded or not

Changes

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