An array of merchant payments that are complete. Payments that you just created with the create payment call do not appear in the list.
paymentsobject<payment>[]OptionalintentenumRequiredsale. Makes an immediate payment.authorize. [Authorizes a payment for capture later](/docs/integration/direct/payments/authorize-and-capture-payments/).order. [Creates an order](/docs/integration/direct/payments/orders/).payerobject<payer>Requiredfunding_instrumentsobject<funding_instrument>[]Optionalcredit_card_tokenobject<credit_card_token>Optionalpayer_idstringOptionalpayer_infoobject<payer_info>Optionalbilling_addressobject<address>Optionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
statestringOptionalshipping_addressobject<shipping_address>Optionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
statestringOptionalapplication_contextobject<application_context>Optionaluser_actionstringOptional| Flow | Action | Description |
|---|---|---|
| Pay Now | user_action=commit | After the customer is redirected to the PayPal payment page, shows the Pay Now button. Use this option when you know the final amount when checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now. |
| Continue | user_action=continue | After the customer is redirected to the PayPal payment page, shows the Continue button. Use this option when you do not know the final amount when you initiate the checkout flow and you want to redirect the customer to the merchant page without processing the payment. |
preferred_payment_sourceobject<payment_source>Optionaltokenobject<token>Optionalpayment_patternenum<payment_pattern>Optionaltransactionsobject<transaction>[]Optionalamountobject<amount>OptionaltotalstringRequiredsubtotalstringOptionalNote: For an order authorization or capture, you cannot include the subtotal parameter.handling_feestringOptionalNote: For an order authorization or capture, you cannot include the handling_fee parameter.shipping_discountstringOptionalNote: For an order authorization or capture, you cannot include the shipping_discount parameter.insurancestringOptionalNote: For an order authorization or capture, you cannot include the insurance parameter.payeeobject<payee>OptionalemailstringOptionalitemsobject<item>[]Optionalcurrencystring<currency_code>Requiredshipping_addressobject<shipping_address>Optionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
statestringOptionalshipping_phone_numberstringOptionalstateenumOptionalcreated. The transaction was successfully created.approved. The customer approved the transaction. The state changes from created to approved on generation of the sale_id for sale transactions, authorization_id for authorization transactions, or order_id for order transactions.failed. The transaction request failed.linksobject<link_description>[]OptionalhrefstringRequired