Get payment refund

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

Access with

API key

Organization access token with refunds.read

OAuth access with refunds.read

Path Params
string
required

Provide the ID of the related payment.

string
required

Provide the ID of the related refund.

Query Params
string
enum

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

Show Details
paymentEmbed the payment related to this refund.
Allowed:
boolean

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.

Responses

Language
Credentials
Request
Response
Choose an example:
application/hal+json