Get payment refund

Retrieve a single payment refund by its ID and the ID of its parent payment.

get/v2/payments/{paymentId}/refunds/{refundId}

Query parameters

embedstring nullable

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring

Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

The payment object.

Changes

Changed in 6 of the 92 revisions of this API.1138

Sep 15, 202626176035db581See the full diff
- ▲
  the response property //// became nullable for the status
  response-property-became-nullable
Aug 31, 2026eca80d9f39721033See the full diff
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added to the response body allOf list for the response status
  response-body-all-of-added
- ○
  removed the optional write-only property reverseRouting from the response with the status
  response-optional-write-only-property-removed
- ○
  removed the optional write-only property testmode from the response with the status
  response-optional-write-only-property-removed
Jun 15, 20265e44242e94d31See the full diff
- ○
  the response property became required for the status
  response-property-became-required
May 19, 20267cab62b218301See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
May 12, 2026ef4b5a97b56a2See the full diff
- ○
  the endpoint scheme security advancedAccessToken was added to the API
  api-security-added
- ○
  the endpoint scheme security organizationAccessToken was removed from the API
  api-security-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 4, 202618e0e58eb54d1See the full diff
- ○
  response property settlementAmount deprecated
  response-property-deprecated

Of the 92 revisions, 9 have no diff computed.

Full history