Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
refunds

Show refund details

Shows details for a refund, by ID.

get/v2/payments/refunds/{refund_id}

Path parameters

refund_idstring required

The PayPal-generated ID for the refund for which to show details.

Headers

Authorizationstring

Standard headers are generally less restrictive in structure due to historical precedent across browsers, etc. This is a common schema for use in defining most standard headers.

Holds authorization information for external API calls.

PayPal-Auth-Assertionstring

Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.

Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.

Response

A successful request returns the HTTP <code>200 OK</code> status code and a JSON response body that shows refund details.

status'CANCELLED' | 'FAILED' | 'PENDING' | 'COMPLETED'

The status of the refund.

idstring

The PayPal-generated ID for the refund.

invoice_idstring

The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.

custom_idstring

The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

acquirer_reference_numberstring

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

note_to_payerstring

The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.

create_timestring ppaas_date_time_v3

The date and time when the transaction occurred, in Internet date and time format.

update_timestring ppaas_date_time_v3

The date and time when the transaction was last updated, in Internet date and time format.