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
| Name | Type | Tags | Description | Getter | Setter |
|---|---|---|---|---|---|
Status | AuthorizationStatus | Optional, Read-only | The status for the authorized payment. | AuthorizationStatus getStatus() | setStatus(AuthorizationStatus status) |
StatusDetails | AuthorizationStatusDetails | Optional | The details of the authorized payment status. | AuthorizationStatusDetails getStatusDetails() | setStatusDetails(AuthorizationStatusDetails statusDetails) |
Id | String | Optional, Read-only | The PayPal-generated ID for the authorized payment. | String getId() | setId(String id) |
Amount | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getAmount() | setAmount(Money amount) |
InvoiceId | String | Optional, 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. | String getInvoiceId() | setInvoiceId(String invoiceId) |
CustomId | String | Optional | The 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) |
NetworkTransactionReference | NetworkTransaction | Optional | Reference values used by the card network to identify a transaction. | NetworkTransaction getNetworkTransactionReference() | setNetworkTransactionReference(NetworkTransaction networkTransactionReference) |
SellerProtection | SellerProtection | Optional | The level of protection offered as defined by PayPal Seller Protection for Merchants. | SellerProtection getSellerProtection() | setSellerProtection(SellerProtection sellerProtection) |
ExpirationTime | String | Optional | The 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) |
Links | List<LinkDescription> | Optional, Read-only | An array of related HATEOAS links. | List | setLinks(List |
CreateTime | String | Optional | The 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) |
UpdateTime | String | Optional | The 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) |
ProcessorResponse | ProcessorResponse | Optional | The 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"
}