Show details for authorized payment

Shows details for an authorized payment, by ID.

GET /v2/payments/authorizations/{authorization_id}

Show details for authorized payment

cURL

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

200

{
  "status_details": {},
  "id": "<string>",
  "amount": {
    "currency_code": "<string>",
    "value": "<string>"
  },
  "invoice_id": "<string>",
  "custom_id": "<string>",
  "network_transaction_reference": {
    "id": "<string>",
    "date": "<string>",
    "acquirer_reference_number": "<string>"
  },
  "seller_protection": {
    "dispute_categories": []
  },
  "expiration_time": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ],
  "create_time": "<string>",
  "update_time": "<string>",
  "supplementary_data": {
    "related_ids": {
      "order_id": "<string>",
      "authorization_id": "<string>",
      "capture_id": "<string>"
    }
  },
  "payee": {
    "email_address": "<string>",
    "merchant_id": "<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

authorization_id · string · required

The PayPal-generated ID for the authorized payment to void.

Response

200

application/json

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

The authorized payment transaction.

status · enum<string> · read-only

The status for the authorized payment.

Available options: CREATED, CAPTURED, DENIED, PARTIALLY_CAPTURED, VOIDED, PENDING

status_details · Authorization Status Details · object · read-only

The details of the authorized order pending status.

Show child attributes

id · string · read-only

The PayPal-generated ID for the authorized payment.

amount · Money · object · read-only

The amount for this authorized payment.

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.

Maximum string length: 255

network_transaction_reference · Network Transaction · object

Reference values used by the card network to identify a transaction.

Show child attributes

seller_protection · Seller Protection · object · read-only

The level of protection offered as defined by PayPal Seller Protection for Merchants.

Show child attributes

expiration_time · string<ppaas_date_time_v3> · read-only

The date and time when the authorized payment expires, 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})$

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})$

supplementary_data · Payment Supplementary Data · object · read-only

An object that provides supplementary/additional data related to a payment transaction.

Show child attributes

payee · Payee Base · object · read-only

The details associated with the merchant for this transaction.

Show child attributes