Skip to main content
GET
/
v2
/
payments
/
authorizations
/
{authorization_id}
Show details for authorized payment
curl --request GET \
  --url https://api-m.sandbox.paypal.com/v2/payments/authorizations/{authorization_id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "CREATED",
  "status_details": {
    "reason": "PENDING_REVIEW"
  },
  "id": "<string>",
  "amount": {
    "currency_code": "<string>",
    "value": "<string>"
  },
  "invoice_id": "<string>",
  "custom_id": "<string>",
  "network_transaction_reference": {
    "id": "<string>",
    "date": "<string>",
    "network": "VISA",
    "acquirer_reference_number": "<string>"
  },
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED"
    ]
  },
  "expiration_time": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ],
  "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.<blockquote><strong>Note:</strong>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.</blockquote>

Path Parameters

​
authorization_id
string
required

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

Response

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

The authorized payment transaction. The status fields and status details for an authorized payment. The date and time stamps that are common to authorized payment, captured payment, and refund transactions.

​
supplementary_data
object

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

​
payee
object

The details associated with the merchant for this transaction.

​
status
enum<string>

The status for the authorized payment.

Available options:
CREATED,
CAPTURED,
DENIED,
PARTIALLY_CAPTURED,
VOIDED,
PENDING
​
status_details
object

The details of the authorized order pending status.

​
create_time
string<ppaas_date_time_v3>

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

Required string length: 20 - 64
​
update_time
string<ppaas_date_time_v3>

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

Required string length: 20 - 64
​
id
string

The PayPal-generated ID for the authorized payment.

​
amount
object

The amount for this authorized payment.

​
invoice_id
string

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 length: 255
​
network_transaction_reference
object

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

​
seller_protection
object

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

​
expiration_time
string<ppaas_date_time_v3>

The date and time when the authorized payment expires, in Internet date and time format.

Required string length: 20 - 64
​
links
Link Description · object[]

An array of related HATEOAS links.

⌘I