PayPal · Schema
orders.capture-422
BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| details | array |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/orders.capture-422",
"title": "orders.capture-422",
"properties": {
"details": {
"type": "array",
"items": {
"anyOf": [
{
"title": "AGREEMENT_ALREADY_CANCELLED",
"properties": {
"issue": {
"type": "string",
"enum": [
"AGREEMENT_ALREADY_CANCELLED"
]
},
"description": {
"type": "string",
"enum": [
"The requested agreement is already canceled."
]
}
}
},
{
"title": "BILLING_AGREEMENT_NOT_FOUND",
"properties": {
"issue": {
"type": "string",
"enum": [
"BILLING_AGREEMENT_NOT_FOUND"
]
},
"description": {
"type": "string",
"enum": [
"The requested Billing Agreement token was not found."
]
}
}
},
{
"title": "DECLINED_DUE_TO_RELATED_TXN",
"properties": {
"issue": {
"type": "string",
"enum": [
"DECLINED_DUE_TO_RELATED_TXN"
]
},
"description": {
"type": "string",
"enum": [
"One or more transactions in this Order did not succeed. Since this Order is being processed as an All or None Order, if one or more transactions in this Order do not succeed, then all purchase units are marked declined and will not be processed."
]
}
}
},
{
"title": "MISSING_PREVIOUS_REFERENCE",
"properties": {
"issue": {
"type": "string",
"enum": [
"MISSING_PREVIOUS_REFERENCE"
]
},
"description": {
"type": "string",
"enum": [
"For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request."
]
}
}
},
{
"title": "MISSING_CRYPTOGRAM",
"properties": {
"issue": {
"type": "string",
"enum": [
"MISSING_CRYPTOGRAM"
]
},
"description": {
"type": "string",
"enum": [
"Cryptogram is mandatory for any customer initiated network token transactions."
]
}
}
},
{
"title": "CARD_BRAND_NOT_SUPPORTED",
"properties": {
"issue": {
"type": "string",
"enum": [
"CARD_BRAND_NOT_SUPPORTED"
]
},
"description": {
"type": "string",
"enum": [
"Processing of this card brand is not supported. Please use another card to continue with this transaction."
]
}
}
},
{
"title": "COMPLIANCE_VIOLATION",
"properties": {
"issue": {
"type": "string",
"enum": [
"COMPLIANCE_VIOLATION"
]
},
"description": {
"type": "string",
"enum": [
"Transaction is declined due to compliance violation."
]
}
}
},
{
"title": "DOMESTIC_TRANSACTION_REQUIRED",
"properties": {
"issue": {
"type": "string",
"enum": [
"DOMESTIC_TRANSACTION_REQUIRED"
]
},
"description": {
"type": "string",
"enum": [
"This transaction requires the payee and payer to be resident in the same country, a domestic transaction is required to create this payment."
]
}
}
},
{
"title": "DUPLICATE_INVOICE_ID",
"properties": {
"issue": {
"type": "string",
"enum": [
"DUPLICATE_INVOICE_ID"
]
},
"description": {
"type": "string",
"enum": [
"Duplicate Invoice ID detected. To avoid a potential duplicate transaction your account setting requires that Invoice Id be unique for each transaction."
]
}
}
},
{
"title": "INSTRUMENT_DECLINED",
"properties": {
"issue": {
"type": "string",
"enum": [
"INSTRUMENT_DECLINED"
]
},
"description": {
"type": "string",
"enum": [
"The instrument presented was either declined by the processor or bank, or it can't be used for this payment."
]
}
}
},
{
"title": "ORDER_NOT_APPROVED",
"properties": {
"issue": {
"type": "string",
"enum": [
"ORDER_NOT_APPROVED"
]
},
"description": {
"type": "string",
"enum": [
"Payer has not yet approved the Order for payment. Please redirect the payer to the 'rel':'approve' url returned as part of the HATEOAS links within the Create Order call or provide a valid `payment_source` in the request."
]
}
}
},
{
"title": "MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED",
"properties": {
"issue": {
"type": "string",
"enum": [
"MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED"
]
},
"description": {
"type": "string",
"enum": [
"You have exceeded the maximum number of payment attempts."
]
}
}
},
{
"title": "PAYEE_BLOCKED_TRANSACTION",
"properties": {
"issue": {
"type": "string",
"enum": [
"PAYEE_BLOCKED_TRANSACTION"
]
},
"description": {
"type": "string",
"enum": [
"The Fraud settings for this seller are such that this payment cannot be executed."
]
}
}
},
{
"title": "PAYEE_FX_RATE_ID_EXPIRED",
"properties": {
"issue": {
"type": "string",
"enum": [
"PAYEE_FX_RATE_ID_EXPIRED"
]
},
"description": {
"type": "string",
"enum": [
"The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate."
]
}
}
},
{
"title": "PAYER_ACCOUNT_LOCKED_OR_CLOSED",
"properties": {
"issue": {
"type": "string",
"enum": [
"PAYER_ACCOUNT_LOCKED_OR_CLOSED"
]
},
"description": {
"type": "string",
"enum": [
"The payer account cannot be used for this transaction."
]
}
}
},
{
"title": "PAYER_ACCOUNT_RESTRICTED",
"properties": {
"issue": {
"type": "string",
"enum": [
"PAYER_ACCOUNT_RESTRICTED"
]
},
"description": {
"type": "string",
"enum": [
"PAYER_ACCOUNT_RESTRICTED"
]
}
}
},
{
"title": "PAYER_CANNOT_PAY",
"properties": {
"issue": {
"type": "string",
"enum": [
"PAYER_CANNOT_PAY"
]
},
"description": {
"type": "string",
"enum": [
"Payer cannot pay for this transaction. Please contact the payer to find other ways to pay for this transaction."
]
}
}
},
{
"title": "PAYPAL_TRANSACTION_ID_EXPIRED",
"properties": {
"issue": {
"type": "string",
"enum": [
"PAYPAL_TRANSACTION_ID_EXPIRED"
]
},
"description": {
"type": "string",
"enum": [
"Specified `paypal_transaction_id` has expired. PayPal transaction ID expires 4 years after the date of the initial transaction."
]
}
}
},
{
"title": "PNREF_EXPIRED",
"properties": {
"issue": {
"type": "string",
"enum": [
"PNREF_EXPIRED"
]
},
"description": {
"type": "string",
"enum": [
"Specified `pnref` has expired. PNREF expires 15 months after the date of the initial transaction."
]
}
}
},
{
"title": "REFERENCED_CARD_EXPIRED",
"properties": {
"issue": {
"type": "string",
"enum": [
"REFERENCED_CARD_EXPIRED"
]
},
"description": {
"type": "string",
"enum": [
"The card underlying the token has expired and hence cannot be used to process a payment."
]
}
}
},
{
"title": "TOKEN_ID_NOT_FOUND",
"properties": {
"issue": {
"type": "string",
"enum": [
"TOKEN_ID_NOT_FOUND"
]
},
"description": {
"type": "string",
"enum": [
"Specified token was not found. Verify the token and try the request again."
]
}
}
},
{
"title": "TRANSACTION_LIMIT_EXCEEDED",
"properties": {
"issue": {
"type": "string",
"enum": [
"TRANSACTION_LIMIT_EXCEEDED"
]
},
"description": {
"type": "string",
"enum": [
"Total payment amount exceeded transaction limit."
]
}
}
},
{
"title": "TRANSACTION_RECEIVING_LIMIT_EXCEEDED",
"properties": {
"issue": {
"type": "string",
"enum": [
"TRANSACTION_RECEIVING_LIMIT_EXCEEDED"
]
},
"description": {
"type": "string",
"enum": [
"The transaction exceeds the receiver's receiving limit."
]
}
}
},
{
"title": "TRANSACTION_REFUSED",
"properties": {
"issue": {
"type": "string",
"enum": [
"TRANSACTION_REFUSED"
]
},
"description": {
"type": "string",
"enum": [
"The request was refused."
]
}
}
},
{
"title": "REDIRECT_PAYER_FOR_ALTERNATE_FUNDING",
"properties": {
"issue": {
"type": "string",
"enum": [
"REDIRECT_PAYER_FOR_ALTERNATE_FUNDING"
]
},
"description": {
"type": "string",
"enum": [
"Transaction failed. Redirect the payer to select another funding source."
]
}
}
},
{
"title": "ORDER_ALREADY_CAPTURED",
"properties": {
"issue": {
"type": "string",
"enum": [
"ORDER_ALREADY_CAPTURED"
]
},
"description": {
"type": "string",
"enum": [
"Order already captured.If 'intent=CAPTURE' only one capture per order is allowed."
]
}
}
},
{
"title": "TRANSACTION_BLOCKED_BY_PAYEE",
"properties": {
"issue": {
"type": "string",
"enum": [
"TRANSACTION_BLOCKED_BY_PAYEE"
]
},
"description": {
"type": "string",
"enum": [
"Transaction blocked by Payee\u2019s Fraud Protection settings."
]
}
}
},
{
"title": "AUTH_CAPTURE_NOT_ENABLED",
"properties": {
"issue": {
"type": "string",
"enum": [
"AUTH_CAPTURE_NOT_ENABLED"
]
},
"description": {
"type": "string",
"enum": [
"Authorization and Capture feature is not enabled for the merchant. Make sure that the recipient of the funds is a verified business account."
]
}
}
},
{
"title": "NOT_ENABLED_FOR_BANK_PROCESSING",
"properties": {
"issue": {
"type": "string",
"enum": [
"NOT_ENABLED_FOR_BANK_PROCESSING"
]
},
"description": {
"type": "string",
"enum": [
"The API Caller account is not setup to be able to process bank payments. Please contact your PayPal account manager."
]
}
}
},
{
"title": "NOT_ENABLED_FOR_CARD_PROCESSING",
"properties": {
"issue": {
"type": "string",
"enum": [
"NOT_ENABLED_FOR_CARD_PROCESSING"
]
},
"description": {
"type": "string",
"enum": [
"The API Caller account is not setup to be able to process card payments. Please contact PayPal customer support."
]
}
}
},
{
"title": "PAYEE_NOT_ENABLED_FOR_BANK_PROCESSING",
"properties": {
"issue": {
"type": "string",
"enum": [
"PAYEE_NOT_ENABLED_FOR_BANK_PROCESSING"
]
},
"description": {
"type": "string",
"enum": [
"Payee account is not setup to be able to process bank payments. Please contact your PayPal account manager."
]
}
}
},
{
"title": "PAYEE_NOT_ENABLED_FOR_CARD_PROCESSING",
"properties": {
"issue": {
"type": "string",
"enum": [
"PAYEE_NOT_ENABLED_FOR_CARD_PROCESSING"
]
},
"description": {
"type": "string",
"enum": [
"Payee account is not setup to be able to process card payments. Please contact PayPal customer support."
]
}
}
},
{
"title": "INVALID_PICKUP_ADDRESS",
"properties": {
"issue": {
"type": "string",
"enum": [
"INVALID_PICKUP_ADDRESS"
]
},
"description": {
"type": "string",
"enum": [
"If the 'shipping_option.type' is set as 'PICKUP' then the 'shipping_detail.name.full_name' should start with 'S2S' meaning Ship To Store. Example: 'S2S My Store'."
]
}
}
},
{
"title": "SHIPPING_ADDRESS_INVALID",
"properties": {
"issue": {
"type": "string",
"enum": [
"SHIPPING_ADDRESS_INVALID"
]
},
"description": {
"type": "string",
"enum": [
"Provided shipping address is invalid."
]
}
}
},
{
"title": "PAYMENT_SOURCE_NOT_SUPPORTED",
"properties": {
"issue": {
"type": "string",
"enum": [
"PAYMENT_SOURCE_NOT_SUPPORTED"
]
},
"description": {
"type": "string",
"enum": [
"The payer selected method of payment is not supported when multiple purchase units are specified for an Order."
]
}
}
},
{
"title": "ORDER_COMPLETION_IN_PROGRESS",
"properties": {
"issue": {
"type": "string",
"enum": [
"ORDER_COMPLETION_IN_PROGRESS"
]
},
"description": {
"type": "string",
"enum": [
"The order was created with processing_instruction of ORDER_COMPLETE_ON_PAYMENT_APPROVAL. The customer has approved the payment and PayPal is still in the process of capturing the order on your behalf as instructed. Please try your request again."
]
}
}
},
{
"title": "BILLING_AGREEMENT_ID_MISMATCH",
"properties": {
"issue": {
"type": "string",
"enum": [
"BILLING_AGREEMENT_ID_MISMATCH"
]
},
"description": {
"type": "string",
"enum": [
"Billing Agreement ID must exactly match the Billing Agreement ID that was provided during order creation."
]
}
}
},
{
"title": "PREFERRED_PAYMENT_SOURCE_MISMATCH",
"properties": {
"issue": {
"type": "string",
"enum": [
"PREFERRED_PAYMENT_SOURCE_MISMATCH"
]
},
"description": {
"type": "string",
"enum": [
"Payment Source must exactly match the Preferred Payment Source that was provided during order creation."
]
}
}
},
{
"title": "INCOMPATIBLE_PARAMETER_VALUE",
"properties": {
"issue": {
"type": "string",
"enum": [
"INCOMPATIBLE_PARAMETER_VALUE"
]
},
"description": {
"type": "string",
"enum": [
"The value of the field is incompatible/redundant with other fields in the order."
]
}
}
},
{
"title": "INVALID_PREVIOUS_TRANSACTION_REFERENCE",
"properties": {
"issue": {
"type": "string",
"enum": [
"INVALID_PREVIOUS_TRANSACTION_REFERENCE"
]
},
"description": {
"type": "string",
"enum": [
"The authorization or capture referenced by `previous_transaction_reference` is not valid. This could be either because the previous_transaction_reference is not found or doesn't belong to the payee. Please use a valid `previous_transaction_reference`."
]
}
}
},
{
"title": "PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK",
"properties": {
"issue": {
"type": "string",
"enum": [
"PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK"
]
},
"description": {
"type": "string",
"enum": [
"The capture referenced by `previous_transaction_reference` has a chargeback and hence cannot be used for this order. Please use a `previous_transaction_reference` which does not have a chargeback."
]
}
}
},
{
"title": "PREVIOUS_TRANSACTION_REFERENCE_VOIDED",
"properties": {
"issue": {
"type": "string",
"enum": [
"PREVIOUS_TRANSACTION_REFERENCE_VOIDED"
]
},
"description": {
"type": "string",
"enum": [
"The status of authorization referenced by `previous_transaction_reference` is `VOIDED` and hence cannot be used for this order. Please use a `previous_transaction_reference` whose status is not `VOIDED`."
]
}
}
},
{
"title": "PAYMENT_SOURCE_MISMATCH",
"properties": {
"issue": {
"type": "string",
"enum": [
"PAYMENT_SOURCE_MISMATCH"
]
},
"description": {
"type": "string",
"enum": [
"The `payment_source` in the request must match the `payment_source` used for the authorization or capture referenced by `previous_transaction_reference`. Please use `previous_transaction_reference` whose `payment_source` matches with the `payment_source` specified in the order."
]
}
}
},
{
"title": "MERCHANT_INITIATED_WITH_SECURITY_CODE",
"properties": {
"issue": {
"type": "string",
"enum": [
"MERCHANT_INITIATED_WITH_SECURITY_CODE"
]
},
"description": {
"type": "string",
"enum": [
"`stored_payment_source.payment_initiator` = `MERCHANT` is not supported if `payment_source.card.security_code` is present in the order. `security_code` can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with `security_code` is the order."
]
}
}
},
{
"title": "MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS",
"properties": {
"issue": {
"type": "string",
"enum": [
"MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS"
]
},
"description": {
"type": "string",
"enum": [
"`stored_payment_source.payment_initiator` = `MERCHANT` is not supported if 3D-Secure authentication results are present in the order. 3D-Secure authentication results can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with 3D-Secure authentication results is the order."
]
}
}
},
{
"title": "MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS",
"properties": {
"issue": {
"type": "string",
"enum": [
"MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS"
]
},
"description": {
"type": "string",
"enum": [
"`stored_payment_source.payment_initiator` = `MERCHANT` is not supported if more than one purchase_unit is present in the Order. Merchant initiated payments are not supported from orders with more than one purchase_unit. Please retry the request with multiple Order requests (one for each purchase_unit)."
]
}
}
},
{
"title": "RETURN_URL_REQUIRED",
"properties": {
"issue": {
"type": "string",
"enum": [
"RETURN_URL_REQUIRED"
]
},
"description": {
"type": "string",
"enum": [
"The return url is required when attempting to vault this source."
]
}
}
},
{
"title": "CANCEL_URL_REQUIRED",
"properties": {
"issue": {
"type": "string",
"enum": [
"CANCEL_URL_REQUIRED"
]
},
"description": {
"type": "string",
"enum": [
"The cancel url is required when attempting to vault this source."
]
}
}
},
{
"title": "SETUP_ERROR_FOR_BANK",
"properties": {
"issue": {
"type": "string",
"enum": [
"SETUP_ERROR_FOR_BANK"
]
},
"description": {
"type": "string",
"enum": [
"The API Caller account setup, for bank payments, is incomplete or incorrect. Please contact your PayPal account manager."
]
}
}
},
{
"title": "BANK_NOT_SUPPORTED_FOR_VERIFICATION",
"properties": {
"issue": {
"type": "string",
"enum": [
"BANK_NOT_SUPPORTED_FOR_VERIFICATION"
]
},
"description": {
"type": "string",
"enum": [
"Verification for this bank account is not supported."
]
}
}
},
{
"title": "PAYER_ACTION_REQUIRED",
"properties": {
"issue": {
"type": "string",
"enum": [
"PAYER_ACTION_REQUIRED"
]
},
"description": {
"type": "string",
"enum": [
"Transaction cannot complete successfully, instruct the buyer to return to PayPal."
]
}
}
},
{
"title": "APPLE_PAY_AMOUNT_MISMATCH",
"properties": {
"issue": {
"type": "string",
"enum": [
"APPLE_PAY_AMOUNT_MISMATCH"
]
},
"description": {
"type": "string",
"enum": [
"The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay."
]
}
}
},
{
"title": "CURRENCY_NOT_SUPPORTED_FOR_BANK",
"properties": {
"issue": {
"type": "string",
"enum": [
"CURRENCY_NOT_SUPPORTED_FOR_BANK"
]
},
"description": {
"type": "string",
"enum": [
"The payment_source does not support the currency of the Order. For ACH debit, only USD is supported and for SEPA debit, only EUR is supported."
]
}
}
},
{
"title": "ONLY_ONE_BANK_SOURCE_ALLOWED",
"properties": {
"issue": {
"type": "string",
"enum": [
"ONLY_ONE_BANK_SOURCE_ALLOWED"
]
},
"description": {
"type": "string",
"enum": [
"More than one payment method within the bank payment object is not supported."
]
}
}
},
{
"title": "INVALID_IBAN",
"properties": {
"issue": {
"type": "string",
"enum": [
"INVALID_IBAN"
]
},
"description": {
"type": "string",
"enum": [
"IBAN provided is not a valid bank account number."
]
}
}
},
{
"title": "IBAN_COUNTRY_NOT_SUPPORTED",
"properties": {
"issue": {
"type": "string",
"enum": [
"IBAN_COUNTRY_NOT_SUPPORTED"
]
},
"description": {
"type": "string",
"enum": [
"Country code of issuer bank for the provided IBAN is not supported for SEPA debit payments."
]
}
}
},
{
"title": "CARD_NUMBER_REQUIRED",
"properties": {
"issue": {
"type": "string",
"enum": [
"CARD_NUMBER_REQUIRED"
]
},
"description": {
"type": "string",
"enum": [
"The card number is required when attempting to process payment with card."
]
}
}
},
{
"title": "CARD_EXPIRY_REQUIRED",
"properties": {
"issue": {
"type": "string",
"enum": [
"CARD_EXPIRY_REQUIRED"
]
},
"description": {
"type": "string",
"enum": [
"The card expiry is required when attempting to process payment with card."
]
}
}
},
{
"title": "VAULT_INSTRUCTION_REQUIRED",
"properties": {
"issue": {
"type": "string",
"enum": [
"VAULT_INSTRUCTION_REQUIRED"
]
},
"descripti
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/paypal/refs/heads/main/json-schema/paypal-orderscapture-422-schema.json