Create order
POST {{base_url}}/v2/checkout/orders
Creates an order.
Note: For error handling and troubleshooting, see Orders v2 errors.
Request Body
{"intent"=>"{{order_intent}}", "purchase_units"=>[{"items"=>[{"name"=>"T-Shirt", "description"=>"Green XL", "quantity"=>"1", "unit_amount"=>{"currency_code"=>"USD", "value"=>"100.00"}}], "amount"=>{"currency_code"=>"USD", "value"=>"100.00", "breakdown"=>{"item_total"=>{"currency_code"=>"USD", "value"=>"100.00"}}}}], "application_context"=>{"return_url"=>"https://example.com/return", "cancel_url"=>"https://example.com/cancel"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. | |
Prefer | string | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> | |
PayPal-Request-Id | string | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. | |
PayPal-Client-Metadata-Id | string | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. | |
PayPal-Partner-Attribution-Id | string | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. | |
PayPal-Auth-Assertion | string | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant. |
|
RESPONSES
status: Created
{"id":"4YA53131GR1797812","intent":"CAPTURE","status":"COMPLETED","payment_source":{"card":{"last_digits":"1111","expiry":"2035-02","brand":"VISA","available_networks":["VISA"],"type":"UNKNOWN","bin_details":{}}},"purchase_units":[{"reference_id":"default","amount":{"currency_code":"USD","value":"100.00"},"payee":{"email_address":"mark_merchant@example.com","merchant_id":"YYHCXACTDDFG2"},"soft_descriptor":"MARKMERCHAN","payments":{"captures":[{"id":"5FG92519JR8657809","status":"COMPLETED","amount":{"currency_code":"USD","value":"100.00"},"final_capture":true,"seller_protection":{"status":"NOT_ELIGIBLE"},"seller_receivable_breakdown":{"gross_amount":{"currency_code":"USD","value":"100.00"},"paypal_fee":{"currency_code":"USD","value":"3.08"},"net_amount":{"currency_code":"USD","value":"96.92"}},"links":[{"href":"https://api.sandbox.paypal.com/v2/payments/captures/5FG92519JR8657809","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/payments/captures/5FG92519JR8657809/refund","rel":"refund","method":"POST"},{"href":"https://api.sandbox.paypal.com/v2/checkout/orders/4YA53131GR1797812","rel":"up","method":"GET"}],"create_time":"2023-10-06T23:01:02Z","update_time":"2023-10-06T23:01:02Z","processor_response":{"avs_code":"A","cvv_code":"M","response_code":"0000"},"network_transaction_reference":{"id":"097365421420988","network":"VISA"}}]}}],"create_time":"2023-10-06T23:01:02Z","update_time":"2023-10-06T23:01:02Z","links":[{"href":"https://api.sandbox.paypal.com/v2/checkout/orders/4YA53131GR1797812","rel":"self","method":"GET"}]}