Skip to main content

Show details for authorized payment

GET 
/authorizations/:authorization_id

Shows details for an authorized payment, by ID.

Request​

Path Parameters

    authorization_id stringrequired

    The ID of the authorized payment for which to show details.

Header Parameters

    Authorization stringrequired

    To make REST API calls, include the bearer token in the Authorization header with the Bearer authentication scheme. The value is Bearer <Access-Token> or Basic <client_id>:<secret>.

    Content-Type stringrequired

    Required for operations with a request body. The value is application/. Where the 'format' is 'json'.

    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.

Responses​

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

Schema

    object
    status Authorization Status (string)

    The status for the authorized payment.

    Possible values: [CREATED, CAPTURED, DENIED, PARTIALLY_CAPTURED, VOIDED, PENDING]

    status_details

    object

    The details of the authorized order pending status.

    reason Authorization Incomplete Reason (string)

    The reason why the authorized status is PENDING.

    Possible values: non-empty and <= 64 characters, Value must match regular expression ^[A-Z_]+$, [PENDING_REVIEW, DECLINED_BY_RISK_FRAUD_FILTERS]

    id string

    The PayPal-generated ID for the 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.

    Possible values: <= 255 characters

    links

    object[]

    An array of related HATEOAS links.

  • Array [

    • href stringrequired

    The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

    rel stringrequired

    The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

    method string

    The HTTP method required to make the related call.

    Possible values: [GET, POST, PUT, DELETE, HEAD, CONNECT, OPTIONS, PATCH]

  • ]

    • amount

    object

    The amount for this authorized payment.

    currency_code ppaas_common_currency_code_v2required

    The three-character ISO-4217 currency code that identifies the currency.

    Possible values: >= 3 characters and <= 3 characters

    value stringrequired

    The value, which might be:

    • An integer for currencies like JPY that are not typically fractional.
    • A decimal fraction for currencies like TND that are subdivided into thousandths.
    For the required number of decimal places for a currency code, see Currency Codes.

    Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

    network_transaction_reference

    object

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

    id stringrequired

    Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.

    Possible values: >= 9 characters and <= 36 characters, Value must match regular expression ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$

    date string

    The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date.

    Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^[0-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.

    Possible values: non-empty and <= 36 characters, Value must match regular expression ^[a-zA-Z0-9]+$

    network Card Brand (string)

    Name of the card network through which the transaction was routed.

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Z_]+$, [VISA, MASTERCARD, DISCOVER, AMEX, SOLO, JCB, STAR, DELTA, SWITCH, MAESTRO, CB_NATIONALE, CONFIGOGA, CONFIDIS, ELECTRON, CETELEM, CHINA_UNION_PAY, DINERS, ELO, HIPER, HIPERCARD, RUPAY, GE, SYNCHRONY, EFTPOS, UNKNOWN]

    seller_protection

    object

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

    status Seller Protection Status (string)

    Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants.

    Possible values: [ELIGIBLE, PARTIALLY_ELIGIBLE, NOT_ELIGIBLE]

    dispute_categories string[]

    An array of conditions that are covered for the transaction.

    Possible values: [ITEM_NOT_RECEIVED, UNAUTHORIZED_TRANSACTION]

    expiration_time ppaas_date_time_v3

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

    Possible values: >= 20 characters and <= 64 characters, Value must match regular expression ^[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})$

    create_time ppaas_date_time_v3

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

    Possible values: >= 20 characters and <= 64 characters, Value must match regular expression ^[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 ppaas_date_time_v3

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

    Possible values: >= 20 characters and <= 64 characters, Value must match regular expression ^[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

    object

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

    related_ids

    object

    Identifiers related to a specific resource.

    order_id string

    Order ID related to the resource.

    Possible values: non-empty and <= 20 characters, Value must match regular expression ^[A-Z0-9]+$

    authorization_id string

    Authorization ID related to the resource.

    Possible values: non-empty and <= 20 characters, Value must match regular expression ^[A-Z0-9]+$

    capture_id string

    Capture ID related to the resource.

    Possible values: non-empty and <= 20 characters, Value must match regular expression ^[A-Z0-9]+$

    payee

    object

    The details associated with the merchant for this transaction.

    email_address merchant_common_email_address_v2

    The email address of merchant.

    Possible values: >= 3 characters and <= 254 characters, Value must match regular expression (?:[a-zA-Z0-9!#$%&'*+/=?^_{|}~-]+(?:.[a-zA-Z0-9!#$%&'*+/=?^_{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])

    merchant_id ppaas_payer_id_v3

    The encrypted PayPal account ID of the merchant.

    Possible values: >= 13 characters and <= 13 characters, Value must match regular expression ^[2-9A-HJ-NP-Z]{13}$

Loading...