curl --request POST \
--url https://api-m.sandbox.paypal.com/v2/checkout/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"intent": "CAPTURE",
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
],
"payment_source": {
"paypal": {
"experience_context": {
"payment_method_preference": "IMMEDIATE_PAYMENT_REQUIRED",
"payment_method_selected": "PAYPAL",
"brand_name": "EXAMPLE INC",
"locale": "en-US",
"landing_page": "LOGIN",
"user_action": "PAY_NOW",
"return_url": "https://example.com/returnUrl",
"cancel_url": "https://example.com/cancelUrl"
}
}
}
}
'{
"create_time": "<string>",
"update_time": "<string>",
"id": "<string>",
"payment_source": {
"card": {
"name": "<string>",
"last_digits": "<string>",
"brand": "VISA",
"available_networks": [
"VISA"
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
},
"attributes": {
"vault": {
"id": "<string>",
"status": "VAULTED",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"customer": {
"id": "<string>",
"email_address": "<string>",
"phone": {
"phone_number": {
"national_number": "<string>"
},
"phone_type": "FAX"
},
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"merchant_customer_id": "<string>"
}
}
},
"from_request": {
"expiry": "<string>",
"last_digits": "<string>"
},
"expiry": "<string>",
"bin_details": {
"bin": "<string>",
"issuing_bank": "<string>",
"bin_country_code": "<string>",
"products": [
"<string>"
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "DERIVED",
"previous_network_transaction_reference": {
"id": "<string>",
"date": "<string>",
"network": "VISA",
"acquirer_reference_number": "<string>"
}
}
},
"paypal": {
"email_address": "<string>",
"account_id": "<string>",
"account_status": "VERIFIED",
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"phone_type": "FAX",
"phone_number": {
"national_number": "<string>"
},
"birth_date": "<string>",
"business_name": "<string>",
"tax_info": {
"tax_id": "<string>",
"tax_id_type": "BR_CPF"
},
"address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"attributes": {
"vault": {
"id": "<string>",
"status": "VAULTED",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"customer": {
"id": "<string>",
"email_address": "<string>",
"phone": {
"phone_number": {
"national_number": "<string>"
},
"phone_type": "FAX"
},
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"merchant_customer_id": "<string>"
}
},
"cobranded_cards": [
{
"labels": [
"<string>"
],
"payee": {
"email_address": "<string>",
"merchant_id": "<string>"
},
"amount": {
"currency_code": "<string>",
"value": "<string>"
}
}
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"charge_pattern": "IMMEDIATE",
"usage_pattern": "IMMEDIATE",
"usage": "DERIVED"
},
"experience_status": "NOT_STARTED"
},
"bancontact": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>",
"iban_last_chars": "<string>",
"card_last_digits": "<string>"
},
"blik": {
"name": "<string>",
"country_code": "<string>",
"email": "<string>",
"one_click": {
"consumer_reference": "<string>"
}
},
"eps": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>"
},
"giropay": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>"
},
"ideal": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>",
"iban_last_chars": "<string>"
},
"swish": "<unknown>",
"mybank": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>",
"iban_last_chars": "<string>"
},
"p24": {
"name": "<string>",
"email": "<string>",
"country_code": "<string>",
"payment_descriptor": "<string>",
"method_id": "<string>",
"method_description": "<string>"
},
"sofort": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>",
"iban_last_chars": "<string>"
},
"trustly": {
"name": "<string>",
"country_code": "<string>",
"email": "<string>",
"bic": "<string>",
"iban_last_chars": "<string>"
},
"apple_pay": {
"id": "<string>",
"token": "<string>",
"name": "<string>",
"email_address": "<string>",
"phone_number": {
"national_number": "<string>"
},
"card": {
"name": "<string>",
"last_digits": "<string>",
"brand": "VISA",
"available_networks": [
"VISA"
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
},
"attributes": {
"vault": {
"id": "<string>",
"status": "VAULTED",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"customer": {
"id": "<string>",
"email_address": "<string>",
"phone": {
"phone_number": {
"national_number": "<string>"
},
"phone_type": "FAX"
},
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"merchant_customer_id": "<string>"
}
}
},
"from_request": {
"expiry": "<string>",
"last_digits": "<string>"
},
"expiry": "<string>",
"bin_details": {
"bin": "<string>",
"issuing_bank": "<string>",
"bin_country_code": "<string>",
"products": [
"<string>"
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "DERIVED",
"previous_network_transaction_reference": {
"id": "<string>",
"date": "<string>",
"network": "VISA",
"acquirer_reference_number": "<string>"
}
},
"billing_address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"country_code": "<string>"
},
"attributes": {
"vault": {
"id": "<string>",
"status": "VAULTED",
"customer": {
"id": "<string>",
"name": {
"given_name": "<string>",
"surname": "<string>"
}
},
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
]
}
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "DERIVED",
"previous_network_transaction_reference": {
"id": "<string>",
"date": "<string>",
"network": "VISA",
"acquirer_reference_number": "<string>"
}
}
},
"google_pay": {
"name": "<string>",
"email_address": "<string>",
"phone_number": {
"country_code": "<string>",
"national_number": "<string>"
},
"card": {
"name": "<string>",
"last_digits": "<string>",
"type": "CREDIT",
"brand": "VISA",
"billing_address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
}
}
},
"venmo": {
"email_address": "<string>",
"account_id": "<string>",
"user_name": "<string>",
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"phone_number": {
"national_number": "<string>"
},
"address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"attributes": {
"vault": {
"id": "<string>",
"status": "VAULTED",
"customer": {
"id": "<string>",
"name": {
"given_name": "<string>",
"surname": "<string>"
}
},
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
]
}
}
},
"crypto": "<unknown>"
},
"intent": "CAPTURE",
"processing_instruction": "<unknown>",
"payer": {
"email_address": "<string>",
"payer_id": "<string>",
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"phone": {
"phone_number": {
"national_number": "<string>"
},
"phone_type": "FAX"
},
"birth_date": "<string>",
"tax_info": {
"tax_id": "<string>",
"tax_id_type": "BR_CPF"
},
"address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
}
},
"purchase_units": [
{
"reference_id": "<string>",
"amount": {
"currency_code": "<string>",
"value": "<string>",
"breakdown": {
"item_total": {
"currency_code": "<string>",
"value": "<string>"
},
"shipping": {
"currency_code": "<string>",
"value": "<string>"
},
"handling": {
"currency_code": "<string>",
"value": "<string>"
},
"tax_total": {
"currency_code": "<string>",
"value": "<string>"
},
"insurance": {
"currency_code": "<string>",
"value": "<string>"
},
"shipping_discount": {
"currency_code": "<string>",
"value": "<string>"
},
"discount": {
"currency_code": "<string>",
"value": "<string>"
}
}
},
"payee": {
"email_address": "<string>",
"merchant_id": "<string>"
},
"payment_instruction": {
"platform_fees": [
{
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"payee": {
"email_address": "<string>",
"merchant_id": "<string>"
}
}
],
"disbursement_mode": "INSTANT",
"payee_pricing_tier_id": "<string>",
"payee_receivable_fx_rate_id": "<string>"
},
"description": "<string>",
"custom_id": "<string>",
"invoice_id": "<string>",
"id": "<string>",
"soft_descriptor": "<string>",
"items": [
{
"name": "<string>",
"unit_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"quantity": "<string>",
"tax": {
"currency_code": "<string>",
"value": "<string>"
},
"description": "<string>",
"sku": "<string>",
"url": "<string>",
"category": "DIGITAL_GOODS",
"image_url": "<string>",
"upc": {
"type": "UPC-A",
"code": "<string>"
},
"billing_plan": {
"billing_cycles": [
{
"tenure_type": "REGULAR",
"pricing_scheme": {
"pricing_model": "FIXED",
"price": {
"currency_code": "<string>",
"value": "<string>"
},
"reload_threshold_amount": {
"currency_code": "<string>",
"value": "<string>"
}
},
"frequency": "<unknown>",
"total_cycles": 1,
"sequence": 1,
"start_date": "<string>"
}
],
"setup_fee": {
"currency_code": "<string>",
"value": "<string>"
},
"name": "<string>"
}
}
],
"shipping": {
"name": {
"full_name": "<string>"
},
"email_address": "<string>",
"phone_number": {
"country_code": "<string>",
"national_number": "<string>"
},
"type": "SHIPPING",
"options": [
{
"id": "<string>",
"label": "<string>",
"selected": true,
"type": "SHIPPING",
"amount": {
"currency_code": "<string>",
"value": "<string>"
}
}
],
"address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"trackers": [
{
"id": "<string>",
"status": "CANCELLED",
"items": [
{
"name": "<string>",
"quantity": "<string>",
"sku": "<string>",
"url": "<string>",
"image_url": "<string>",
"upc": {
"type": "UPC-A",
"code": "<string>"
}
}
],
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"create_time": "<string>",
"update_time": "<string>"
}
]
},
"supplementary_data": {
"card": {
"level_2": {
"invoice_id": "<string>",
"tax_total": {
"currency_code": "<string>",
"value": "<string>"
}
},
"level_3": {
"shipping_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"duty_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"discount_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"shipping_address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"ships_from_postal_code": "<string>",
"line_items": [
{
"name": "<string>",
"quantity": "<string>",
"description": "<string>",
"sku": "<string>",
"url": "<string>",
"image_url": "<string>",
"upc": {
"type": "UPC-A",
"code": "<string>"
},
"billing_plan": {
"billing_cycles": [
{
"tenure_type": "REGULAR",
"pricing_scheme": {
"pricing_model": "FIXED",
"price": {
"currency_code": "<string>",
"value": "<string>"
},
"reload_threshold_amount": {
"currency_code": "<string>",
"value": "<string>"
}
},
"frequency": "<unknown>",
"total_cycles": 1,
"sequence": 1,
"start_date": "<string>"
}
],
"setup_fee": {
"currency_code": "<string>",
"value": "<string>"
},
"name": "<string>"
},
"unit_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"tax": {
"currency_code": "<string>",
"value": "<string>"
},
"commodity_code": "<string>",
"discount_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"total_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"unit_of_measure": "<string>"
}
]
}
},
"risk": {
"customer": {
"ip_address": "<string>"
}
}
},
"payments": {
"authorizations": [
{
"status": "CREATED",
"status_details": {
"reason": "PENDING_REVIEW"
},
"id": "<string>",
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"invoice_id": "<string>",
"custom_id": "<string>",
"network_transaction_reference": {
"id": "<string>",
"date": "<string>",
"network": "VISA",
"acquirer_reference_number": "<string>"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED"
]
},
"expiration_time": "<string>",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"create_time": "<string>",
"update_time": "<string>",
"processor_response": {
"avs_code": "A",
"cvv_code": "E",
"response_code": "0000",
"payment_advice_code": "01"
}
}
],
"captures": [
{
"status": "COMPLETED",
"status_details": {
"reason": "BUYER_COMPLAINT"
},
"id": "<string>",
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"invoice_id": "<string>",
"custom_id": "<string>",
"network_transaction_reference": {
"id": "<string>",
"date": "<string>",
"network": "VISA",
"acquirer_reference_number": "<string>"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED"
]
},
"final_capture": false,
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"paypal_fee": {
"currency_code": "<string>",
"value": "<string>"
},
"paypal_fee_in_receivable_currency": {
"currency_code": "<string>",
"value": "<string>"
},
"net_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"receivable_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"exchange_rate": {
"source_currency": "<string>",
"target_currency": "<string>",
"value": "<string>"
},
"platform_fees": [
{
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"payee": {
"email_address": "<string>",
"merchant_id": "<string>"
}
}
]
},
"disbursement_mode": "INSTANT",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"processor_response": {
"avs_code": "A",
"cvv_code": "E",
"response_code": "0000",
"payment_advice_code": "01"
},
"create_time": "<string>",
"update_time": "<string>"
}
],
"refunds": [
{
"status": "CANCELLED",
"status_details": {
"reason": "ECHECK"
},
"id": "<string>",
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"invoice_id": "<string>",
"custom_id": "<string>",
"acquirer_reference_number": "<string>",
"note_to_payer": "<string>",
"seller_payable_breakdown": {
"gross_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"paypal_fee": {
"currency_code": "<string>",
"value": "<string>"
},
"paypal_fee_in_receivable_currency": {
"currency_code": "<string>",
"value": "<string>"
},
"net_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"net_amount_in_receivable_currency": {
"currency_code": "<string>",
"value": "<string>"
},
"platform_fees": [
{
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"payee": {
"email_address": "<string>",
"merchant_id": "<string>"
}
}
],
"net_amount_breakdown": [
{
"payable_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"converted_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"exchange_rate": {
"source_currency": "<string>",
"target_currency": "<string>",
"value": "<string>"
}
}
],
"total_refunded_amount": {
"currency_code": "<string>",
"value": "<string>"
}
},
"payer": {
"email_address": "<string>",
"merchant_id": "<string>"
},
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"create_time": "<string>",
"update_time": "<string>"
}
]
},
"most_recent_errors": [
"<unknown>"
]
}
],
"status": "CREATED",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
]
}Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.
Note: For error handling and troubleshooting, see Orders v2 errors.
curl --request POST \
--url https://api-m.sandbox.paypal.com/v2/checkout/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"intent": "CAPTURE",
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
],
"payment_source": {
"paypal": {
"experience_context": {
"payment_method_preference": "IMMEDIATE_PAYMENT_REQUIRED",
"payment_method_selected": "PAYPAL",
"brand_name": "EXAMPLE INC",
"locale": "en-US",
"landing_page": "LOGIN",
"user_action": "PAY_NOW",
"return_url": "https://example.com/returnUrl",
"cancel_url": "https://example.com/cancelUrl"
}
}
}
}
'{
"create_time": "<string>",
"update_time": "<string>",
"id": "<string>",
"payment_source": {
"card": {
"name": "<string>",
"last_digits": "<string>",
"brand": "VISA",
"available_networks": [
"VISA"
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
},
"attributes": {
"vault": {
"id": "<string>",
"status": "VAULTED",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"customer": {
"id": "<string>",
"email_address": "<string>",
"phone": {
"phone_number": {
"national_number": "<string>"
},
"phone_type": "FAX"
},
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"merchant_customer_id": "<string>"
}
}
},
"from_request": {
"expiry": "<string>",
"last_digits": "<string>"
},
"expiry": "<string>",
"bin_details": {
"bin": "<string>",
"issuing_bank": "<string>",
"bin_country_code": "<string>",
"products": [
"<string>"
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "DERIVED",
"previous_network_transaction_reference": {
"id": "<string>",
"date": "<string>",
"network": "VISA",
"acquirer_reference_number": "<string>"
}
}
},
"paypal": {
"email_address": "<string>",
"account_id": "<string>",
"account_status": "VERIFIED",
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"phone_type": "FAX",
"phone_number": {
"national_number": "<string>"
},
"birth_date": "<string>",
"business_name": "<string>",
"tax_info": {
"tax_id": "<string>",
"tax_id_type": "BR_CPF"
},
"address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"attributes": {
"vault": {
"id": "<string>",
"status": "VAULTED",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"customer": {
"id": "<string>",
"email_address": "<string>",
"phone": {
"phone_number": {
"national_number": "<string>"
},
"phone_type": "FAX"
},
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"merchant_customer_id": "<string>"
}
},
"cobranded_cards": [
{
"labels": [
"<string>"
],
"payee": {
"email_address": "<string>",
"merchant_id": "<string>"
},
"amount": {
"currency_code": "<string>",
"value": "<string>"
}
}
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"charge_pattern": "IMMEDIATE",
"usage_pattern": "IMMEDIATE",
"usage": "DERIVED"
},
"experience_status": "NOT_STARTED"
},
"bancontact": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>",
"iban_last_chars": "<string>",
"card_last_digits": "<string>"
},
"blik": {
"name": "<string>",
"country_code": "<string>",
"email": "<string>",
"one_click": {
"consumer_reference": "<string>"
}
},
"eps": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>"
},
"giropay": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>"
},
"ideal": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>",
"iban_last_chars": "<string>"
},
"swish": "<unknown>",
"mybank": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>",
"iban_last_chars": "<string>"
},
"p24": {
"name": "<string>",
"email": "<string>",
"country_code": "<string>",
"payment_descriptor": "<string>",
"method_id": "<string>",
"method_description": "<string>"
},
"sofort": {
"name": "<string>",
"country_code": "<string>",
"bic": "<string>",
"iban_last_chars": "<string>"
},
"trustly": {
"name": "<string>",
"country_code": "<string>",
"email": "<string>",
"bic": "<string>",
"iban_last_chars": "<string>"
},
"apple_pay": {
"id": "<string>",
"token": "<string>",
"name": "<string>",
"email_address": "<string>",
"phone_number": {
"national_number": "<string>"
},
"card": {
"name": "<string>",
"last_digits": "<string>",
"brand": "VISA",
"available_networks": [
"VISA"
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
},
"attributes": {
"vault": {
"id": "<string>",
"status": "VAULTED",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"customer": {
"id": "<string>",
"email_address": "<string>",
"phone": {
"phone_number": {
"national_number": "<string>"
},
"phone_type": "FAX"
},
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"merchant_customer_id": "<string>"
}
}
},
"from_request": {
"expiry": "<string>",
"last_digits": "<string>"
},
"expiry": "<string>",
"bin_details": {
"bin": "<string>",
"issuing_bank": "<string>",
"bin_country_code": "<string>",
"products": [
"<string>"
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "DERIVED",
"previous_network_transaction_reference": {
"id": "<string>",
"date": "<string>",
"network": "VISA",
"acquirer_reference_number": "<string>"
}
},
"billing_address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"country_code": "<string>"
},
"attributes": {
"vault": {
"id": "<string>",
"status": "VAULTED",
"customer": {
"id": "<string>",
"name": {
"given_name": "<string>",
"surname": "<string>"
}
},
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
]
}
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "DERIVED",
"previous_network_transaction_reference": {
"id": "<string>",
"date": "<string>",
"network": "VISA",
"acquirer_reference_number": "<string>"
}
}
},
"google_pay": {
"name": "<string>",
"email_address": "<string>",
"phone_number": {
"country_code": "<string>",
"national_number": "<string>"
},
"card": {
"name": "<string>",
"last_digits": "<string>",
"type": "CREDIT",
"brand": "VISA",
"billing_address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
}
}
},
"venmo": {
"email_address": "<string>",
"account_id": "<string>",
"user_name": "<string>",
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"phone_number": {
"national_number": "<string>"
},
"address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"attributes": {
"vault": {
"id": "<string>",
"status": "VAULTED",
"customer": {
"id": "<string>",
"name": {
"given_name": "<string>",
"surname": "<string>"
}
},
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
]
}
}
},
"crypto": "<unknown>"
},
"intent": "CAPTURE",
"processing_instruction": "<unknown>",
"payer": {
"email_address": "<string>",
"payer_id": "<string>",
"name": {
"given_name": "<string>",
"surname": "<string>"
},
"phone": {
"phone_number": {
"national_number": "<string>"
},
"phone_type": "FAX"
},
"birth_date": "<string>",
"tax_info": {
"tax_id": "<string>",
"tax_id_type": "BR_CPF"
},
"address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
}
},
"purchase_units": [
{
"reference_id": "<string>",
"amount": {
"currency_code": "<string>",
"value": "<string>",
"breakdown": {
"item_total": {
"currency_code": "<string>",
"value": "<string>"
},
"shipping": {
"currency_code": "<string>",
"value": "<string>"
},
"handling": {
"currency_code": "<string>",
"value": "<string>"
},
"tax_total": {
"currency_code": "<string>",
"value": "<string>"
},
"insurance": {
"currency_code": "<string>",
"value": "<string>"
},
"shipping_discount": {
"currency_code": "<string>",
"value": "<string>"
},
"discount": {
"currency_code": "<string>",
"value": "<string>"
}
}
},
"payee": {
"email_address": "<string>",
"merchant_id": "<string>"
},
"payment_instruction": {
"platform_fees": [
{
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"payee": {
"email_address": "<string>",
"merchant_id": "<string>"
}
}
],
"disbursement_mode": "INSTANT",
"payee_pricing_tier_id": "<string>",
"payee_receivable_fx_rate_id": "<string>"
},
"description": "<string>",
"custom_id": "<string>",
"invoice_id": "<string>",
"id": "<string>",
"soft_descriptor": "<string>",
"items": [
{
"name": "<string>",
"unit_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"quantity": "<string>",
"tax": {
"currency_code": "<string>",
"value": "<string>"
},
"description": "<string>",
"sku": "<string>",
"url": "<string>",
"category": "DIGITAL_GOODS",
"image_url": "<string>",
"upc": {
"type": "UPC-A",
"code": "<string>"
},
"billing_plan": {
"billing_cycles": [
{
"tenure_type": "REGULAR",
"pricing_scheme": {
"pricing_model": "FIXED",
"price": {
"currency_code": "<string>",
"value": "<string>"
},
"reload_threshold_amount": {
"currency_code": "<string>",
"value": "<string>"
}
},
"frequency": "<unknown>",
"total_cycles": 1,
"sequence": 1,
"start_date": "<string>"
}
],
"setup_fee": {
"currency_code": "<string>",
"value": "<string>"
},
"name": "<string>"
}
}
],
"shipping": {
"name": {
"full_name": "<string>"
},
"email_address": "<string>",
"phone_number": {
"country_code": "<string>",
"national_number": "<string>"
},
"type": "SHIPPING",
"options": [
{
"id": "<string>",
"label": "<string>",
"selected": true,
"type": "SHIPPING",
"amount": {
"currency_code": "<string>",
"value": "<string>"
}
}
],
"address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"trackers": [
{
"id": "<string>",
"status": "CANCELLED",
"items": [
{
"name": "<string>",
"quantity": "<string>",
"sku": "<string>",
"url": "<string>",
"image_url": "<string>",
"upc": {
"type": "UPC-A",
"code": "<string>"
}
}
],
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"create_time": "<string>",
"update_time": "<string>"
}
]
},
"supplementary_data": {
"card": {
"level_2": {
"invoice_id": "<string>",
"tax_total": {
"currency_code": "<string>",
"value": "<string>"
}
},
"level_3": {
"shipping_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"duty_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"discount_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"shipping_address": {
"country_code": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"admin_area_2": "<string>",
"admin_area_1": "<string>",
"postal_code": "<string>"
},
"ships_from_postal_code": "<string>",
"line_items": [
{
"name": "<string>",
"quantity": "<string>",
"description": "<string>",
"sku": "<string>",
"url": "<string>",
"image_url": "<string>",
"upc": {
"type": "UPC-A",
"code": "<string>"
},
"billing_plan": {
"billing_cycles": [
{
"tenure_type": "REGULAR",
"pricing_scheme": {
"pricing_model": "FIXED",
"price": {
"currency_code": "<string>",
"value": "<string>"
},
"reload_threshold_amount": {
"currency_code": "<string>",
"value": "<string>"
}
},
"frequency": "<unknown>",
"total_cycles": 1,
"sequence": 1,
"start_date": "<string>"
}
],
"setup_fee": {
"currency_code": "<string>",
"value": "<string>"
},
"name": "<string>"
},
"unit_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"tax": {
"currency_code": "<string>",
"value": "<string>"
},
"commodity_code": "<string>",
"discount_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"total_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"unit_of_measure": "<string>"
}
]
}
},
"risk": {
"customer": {
"ip_address": "<string>"
}
}
},
"payments": {
"authorizations": [
{
"status": "CREATED",
"status_details": {
"reason": "PENDING_REVIEW"
},
"id": "<string>",
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"invoice_id": "<string>",
"custom_id": "<string>",
"network_transaction_reference": {
"id": "<string>",
"date": "<string>",
"network": "VISA",
"acquirer_reference_number": "<string>"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED"
]
},
"expiration_time": "<string>",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"create_time": "<string>",
"update_time": "<string>",
"processor_response": {
"avs_code": "A",
"cvv_code": "E",
"response_code": "0000",
"payment_advice_code": "01"
}
}
],
"captures": [
{
"status": "COMPLETED",
"status_details": {
"reason": "BUYER_COMPLAINT"
},
"id": "<string>",
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"invoice_id": "<string>",
"custom_id": "<string>",
"network_transaction_reference": {
"id": "<string>",
"date": "<string>",
"network": "VISA",
"acquirer_reference_number": "<string>"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED"
]
},
"final_capture": false,
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"paypal_fee": {
"currency_code": "<string>",
"value": "<string>"
},
"paypal_fee_in_receivable_currency": {
"currency_code": "<string>",
"value": "<string>"
},
"net_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"receivable_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"exchange_rate": {
"source_currency": "<string>",
"target_currency": "<string>",
"value": "<string>"
},
"platform_fees": [
{
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"payee": {
"email_address": "<string>",
"merchant_id": "<string>"
}
}
]
},
"disbursement_mode": "INSTANT",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"processor_response": {
"avs_code": "A",
"cvv_code": "E",
"response_code": "0000",
"payment_advice_code": "01"
},
"create_time": "<string>",
"update_time": "<string>"
}
],
"refunds": [
{
"status": "CANCELLED",
"status_details": {
"reason": "ECHECK"
},
"id": "<string>",
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"invoice_id": "<string>",
"custom_id": "<string>",
"acquirer_reference_number": "<string>",
"note_to_payer": "<string>",
"seller_payable_breakdown": {
"gross_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"paypal_fee": {
"currency_code": "<string>",
"value": "<string>"
},
"paypal_fee_in_receivable_currency": {
"currency_code": "<string>",
"value": "<string>"
},
"net_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"net_amount_in_receivable_currency": {
"currency_code": "<string>",
"value": "<string>"
},
"platform_fees": [
{
"amount": {
"currency_code": "<string>",
"value": "<string>"
},
"payee": {
"email_address": "<string>",
"merchant_id": "<string>"
}
}
],
"net_amount_breakdown": [
{
"payable_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"converted_amount": {
"currency_code": "<string>",
"value": "<string>"
},
"exchange_rate": {
"source_currency": "<string>",
"target_currency": "<string>",
"value": "<string>"
}
}
],
"total_refunded_amount": {
"currency_code": "<string>",
"value": "<string>"
}
},
"payer": {
"email_address": "<string>",
"merchant_id": "<string>"
},
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
],
"create_time": "<string>",
"update_time": "<string>"
}
]
},
"most_recent_errors": [
"<unknown>"
]
}
],
"status": "CREATED",
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
]
}Oauth 2.0 authentication
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. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).
1 - 1081 - 361 - 36The preferred server response upon successful completion of the request. Value is:
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.1 - 25An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.
The order request details.
The intent to either capture payment immediately or authorize a payment for an order after order creation.
CAPTURE, AUTHORIZE An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.
1 - 10 elementsShow child attributes
DEPRECATED. The customer is also known as the payer. The Payer object was intended to only be used with the payment_source.paypal object. In order to make this design more clear, the details in the payer object are now available under payment_source.paypal. Please use payment_source.paypal.
Show child attributes
The payment source definition.
Show child attributes
Customize the payer experience during the approval process for the payment with PayPal.
Show child attributes
A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows order details.
The order details.
The date and time when the transaction occurred, in Internet date and time format.
20 - 64The date and time when the transaction was last updated, in Internet date and time format.
20 - 64The ID of the order.
The payment source used to fund the payment.
Show child attributes
The intent to either capture payment immediately or authorize a payment for an order after order creation.
CAPTURE, AUTHORIZE DEPRECATED. The customer is also known as the payer. The Payer object was intended to only be used with the payment_source.paypal object. In order to make this design more clear, the details in the payer object are now available under payment_source.paypal. Please use payment_source.paypal.
Show child attributes
An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.
1 - 10 elementsShow child attributes
The order status.
CREATED, SAVED, APPROVED, VOIDED, COMPLETED, PAYER_ACTION_REQUIRED 1 - 255An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 6 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 6 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.
Show child attributes
Was this page helpful?