Show refund details

Shows details for a refund, by ID.

GET /v2/payments/refunds/{refund_id}

Show refund details

cURL

curl --request GET \
  --url https://api-m.sandbox.paypal.com/v2/payments/refunds/{refund_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "status_details": {
    "reason": "ECHECK"
  },
  "id": "<string>",
  "amount": {
    "currency_code": "<string>",
    "value": "<string>"
  },
  "invoice_id": "<string>",
  "custom_id": "<string>",
  "acquirer_reference_number": "<string>",
  "note_to_payer": "<string>",
  "seller_payable_breakdown": {
    "gross_amount": {
      "currency_code": "<string>",
      "value": "<string>"
    },
    "paypal_fee": {
      "currency_code": "<string>",
      "value": "<string>"
    },
    "paypal_fee_in_receivable_currency": {
      "currency_code": "<string>",
      "value": "<string>"
    },
    "net_amount": {
      "currency_code": "<string>",
      "value": "<string>"
    },
    "net_amount_in_receivable_currency": {
      "currency_code": "<string>",
      "value": "<string>"
    },
    "platform_fees": [
      {
        "amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "payee": {
          "email_address": "<string>",
          "merchant_id": "<string>"
        }
      }
    ],
    "net_amount_breakdown": [
      {
        "payable_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "converted_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "exchange_rate": {
          "source_currency": "<string>",
          "target_currency": "<string>",
          "value": "<string>"
        }
      }
    ],
    "total_refunded_amount": {
      "currency_code": "<string>",
      "value": "<string>"
    }
  },
  "payer": {
    "email_address": "<string>",
    "merchant_id": "<string>"
  },
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ],
  "create_time": "<string>",
  "update_time": "<string>"
}

Authorizations

Authorization · string · header · required

OAuth 2.0 authentication

Headers

PayPal-Auth-Assertion · string

An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.

Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.

Path Parameters

refund_id · string · required

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

Response

200

application/json

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

The refund information.

status · enum<string> · read-only

The status of the refund.

Available options: CANCELLED, FAILED, PENDING, COMPLETED

status_details · Refund Status Details · object · read-only

The details of the refund status.

Show child attributes

id · string · read-only

The PayPal-generated ID for the refund.

amount · Money · object · read-only

The amount that the payee refunded to the payer.

Show child attributes

invoice_id · string · read-only

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_id · string

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

Required string length: 1 - 255

Pattern: ^[A-Za-z0-9-_.,]*$

acquirer_reference_number · string

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

Required string length: 1 - 36

Pattern: ^[a-zA-Z0-9]+$

note_to_payer · string · read-only

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

seller_payable_breakdown · Seller Payable Breakdown · object · read-only

The breakdown of the refund.

Show child attributes

payer · Payee Base · object · read-only

The details associated with the merchant for this transaction.

Show child attributes

links · Link Description · object[] · read-only

An array of related HATEOAS links.

Show child attributes

create_time · string<ppaas_date_time_v3> · read-only

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

Required string length: 20 - 64

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

update_time · string<ppaas_date_time_v3> · read-only

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

Required string length: 20 - 64

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$