Authorization with Additional Data

June 5, 2026 ยท View on GitHub

The authorization with additional payment details, such as risk assessment and processor response. These details are populated only for certain payment methods.

Structure

AuthorizationWithAdditionalData

Fields

NameTypeTagsDescriptionGetterSetter
StatusAuthorizationStatusOptional, Read-onlyThe status for the authorized payment.AuthorizationStatus getStatus()setStatus(AuthorizationStatus status)
StatusDetailsAuthorizationStatusDetailsOptionalThe details of the authorized payment status.AuthorizationStatusDetails getStatusDetails()setStatusDetails(AuthorizationStatusDetails statusDetails)
IdStringOptional, Read-onlyThe PayPal-generated ID for the authorized payment.String getId()setId(String id)
AmountMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getAmount()setAmount(Money amount)
InvoiceIdStringOptional, Read-onlyThe API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.String getInvoiceId()setInvoiceId(String invoiceId)
CustomIdStringOptionalThe API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

Constraints: Maximum Length: 255
String getCustomId()setCustomId(String customId)
NetworkTransactionReferenceNetworkTransactionOptionalReference values used by the card network to identify a transaction.NetworkTransaction getNetworkTransactionReference()setNetworkTransactionReference(NetworkTransaction networkTransactionReference)
SellerProtectionSellerProtectionOptionalThe level of protection offered as defined by PayPal Seller Protection for Merchants.SellerProtection getSellerProtection()setSellerProtection(SellerProtection sellerProtection)
ExpirationTimeStringOptionalThe date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Constraints: Minimum Length: 20, Maximum Length: 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})$
String getExpirationTime()setExpirationTime(String expirationTime)
LinksList<LinkDescription>Optional, Read-onlyAn array of related HATEOAS links.List getLinks()setLinks(List links)
CreateTimeStringOptionalThe date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Constraints: Minimum Length: 20, Maximum Length: 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})$
String getCreateTime()setCreateTime(String createTime)
UpdateTimeStringOptionalThe date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Constraints: Minimum Length: 20, Maximum Length: 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})$
String getUpdateTime()setUpdateTime(String updateTime)
ProcessorResponseProcessorResponseOptionalThe processor response information for payment requests, such as direct credit card transactions.ProcessorResponse getProcessorResponse()setProcessorResponse(ProcessorResponse processorResponse)

Example (as JSON)

{
  "status": "VOIDED",
  "status_details": {
    "reason": "PENDING_REVIEW"
  },
  "id": "id6",
  "amount": {
    "currency_code": "currency_code6",
    "value": "value0"
  },
  "invoice_id": "invoice_id6"
}