Simulation Tests

In API calls to the PayPal sandbox, you can pass specific information in a request to trigger simulated positive and negative test scenarios. The simulated responses mimic live API responses without calling downstream services. You can handle these responses in your code to manage your customer’s experience.

Know before you code

• Complete the steps in Get started to get your sandbox account information from the Developer Dashboard:
  • Access token
  • Business account credentials
  • Personal account credentials
• Make sure you have the most recent version of Postman.

How it works

Use the PayPal sandbox and our specific test scenarios to trigger different API flows and make sure you’ve handled them in your integration. To trigger the simulated response, choose from either of the following trigger methods:

• A JSON pointer in the request payload
• A path parameter in the request URI

The following sample requests show you how to use each method.

How to use a JSON pointer in the request payload

This sample request shows how to trigger a specific error response by passing a JSON pointer in the request payload.

Request

1curl -X POST \
2  https://api-m.sandbox.paypal.com/v2/invoicing/invoices \
3  -H 'Authorization: Bearer <Access Token>' \
4  -H 'Content-Type: application/json' \
5  -d '{
6          "detail":
7          {
8                    "reference": "ERRINV002"
9          }
10}'

Response

1{
2    "localizedMessage": "No permission for the requested operation. ",
3    "name": "PERMISSION_DENIED",
4    "message": "No permission for the requested operation. ",
5    "details": [
6        {
7            "issue": "No permission for the requested operation. "
8        }
9    ],
10    "information_link": "https://developer.paypal.com/docs/archive/permissions-service/",
11    "debug_id": "6e07326c281c4"
12}

How to use a path parameter in the request URI

This sample request shows how to trigger a specific error response by passing a path parameter in the request URI.

Request

1curl -X GET \
2  https://api-m.sandbox.paypal.com/v2/invoicing/invoices/INV2-ABCD-1234-EINV-0010 \
3  -H 'Authorization: Bearer <Access Token>' \
4  -H 'Content-Type: application/json'

Response

1{
2    "name": "RESOURCE_NOT_FOUND",
3    "message": "The specified resource does not exist.",
4    "debug_id": "98b2b9d2d89cb",
5    "links": [
6        {
7            "href": "https://developer.paypal.com/docs/api/invoicing/#errors",
8            "rel": "information_link"
9        }
10    ]
11}

Disputes

To run the disputes simulation tests:

1. Download the Postman collection for the Disputes API:

   

2. Use the following test values to trigger negative responses for these disputes actions:

   • List disputes
   • Show dispute details
   • Send message to other party
   • Make offer to resolve dispute
   • Escalate dispute to claim
   • Provide evidence
   • Accept claim
   • Acknowledge return item
   • Appeal dispute

List disputes

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at GET /v1/customer/disputes?disputed_transaction_id={transaction_id}.

Show dispute details

Negative response test values

Use the JSON pointer method to simulate the following error responses at GET /v1/customer/disputes/{dispute_id}.

Send message to other party

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/customer/disputes/{dispute_id}/send-message.

Make offer to resolve dispute

Negative response test values

Use the path parameter in the request URI method to simulate the following response at POST /v1/customer/disputes/{dispute_id}/make-offer.

Escalate dispute to claim

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/customer/disputes/{dispute_id}/escalate.

Provide evidence

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/customer/disputes/{dispute_id}/provide-evidence .

Accept claim

Negative response test values

Use the path parameter in the request URI method to simulate the following response at POST /v1/customer/disputes/{dispute_id}/accept-claim.

Acknowledge return item

Negative response test values

Use the path parameter in the request URI method to simulate the following response at POST /v1/customer/disputes/{dispute_id}/acknowledge-return-item.

Appeal dispute

Negative response test values

Use the path parameter in the request URI method to simulate the following response at POST /v1/customer/disputes/{dispute_id}/appeal.

Invoicing

To run the invoicing simulation tests:

1. Download the Postman collection for the Invoicing API:

   

2. Use the following test values to trigger positive and negative responses for these invoice actions:

   • Generate invoice number
   • Create invoices
   • Get invoice
   • Delete invoice
   • Fully update invoice details
   • Cancel sent invoice
   • Record payment for invoice
   • Delete payment
   • Record refund for invoice
   • Delete refund
   • Send invoice reminder
   • Send invoice
   • Search invoices

Generate invoice number

Use the path parameter in the request URI method to simulate the following error responses at POST /v2/invoicing/invoices/generate-next-invoice-number.

Create invoices

Use the JSON pointer method to simulate the following error responses at POST v2/invoicing/invoices/.

Get invoice

Use the path parameter in the request URI method to simulate the following error responses at GET /v2/invoicing/invoices/{invoice_id}.

Delete invoice

Positive response test values

Use the path parameter in the request URI method to simulate the following response at DELETE /v2/invoicing/invoices/{invoice_id}.

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at DELETE /v2/invoicing/invoices/{invoice_id}.

Fully update invoice details

Use the path parameter in the request URI method to simulate the following error responses at PUT /v2/invoicing/invoices/{invoice_id}.

Cancel sent invoice

Positive response test values

Use the path parameter in the request URI method to simulate the following response at POST /v2/invoicing/invoices/{invoice_id}/cancel.

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v2/invoicing/invoices/{invoice_id}/cancel.

Record payment for invoice

Positive response test values

Use the path parameter in the request URI method to simulate the following response at POST /v2/invoicing/invoices/{invoice_id}/payments.

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v2/invoicing/invoices/{invoice_id}/payments.

Delete payment

Positive response test values

Use the path parameter in the request URI method to simulate the following response at DELETE /v2/invoicing/invoices/INV2-ABCD-1234-EFGH-5678/payments/{transaction_id}.

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at DELETE /v2/invoicing/invoices/INV2-ABCD-1234-EFGH-5678/payments/{transaction_id}.

Record refund for invoice

Positive response test values

Use the path parameter in the request URI method to simulate the following response at POST /v2/invoicing/invoices/{invoice_id}/refunds.

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v2/invoicing/invoices/{invoice_id}/refunds.

Delete refund

Positive response test values

Use the path parameter in the request URI method to simulate the following response at DELETE /v2/invoicing/invoices/{invoice_id}/refunds/{transaction_id}.

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at DELETE /v2/invoicing/invoices/{invoice_id}/refunds/{transaction_id}/delete.

Send invoice reminder

Positive response test values

Use the path parameter in the request URI method to simulate the following response at POST /v2/invoicing/invoices/{invoice_id}/remind.

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v2/invoicing/invoices/{invoice_id}/remind.

Send invoice

Positive response test values

Use the path parameter in the request URI method to simulate the following response at POST /v2/invoicing/invoices/{invoice_id}/send.

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v2/invoicing/invoices/{invoice_id}/send.

Search invoices

Use the path parameter in the request URI method to simulate the following error responses at POST /v2/invoicing/search-invoices.

Payments v2

To simulate errors, you can use the PayPal-Mock-Response request header in the following Payments v2 REST API calls:

• Show details for authorized payment
• Capture authorized payment
• Void authorized payment
• Show captured payment details
• Refund captured payment
• Show refund details

To simulate a specific error, add a mock_application_codes value that equals the error code you want to test.

The following sample header tests an authorization that has already been captured in a Capture authorized payment call:

-H "PayPal-Mock-Response: {"mock_application_codes" : "AUTHORIZATION_ALREADY_CAPTURED"}"

Orders v2

To simulate errors, you can use the PayPal-Mock-Response request header in the following Orders v2 REST API calls:

• Create order
• Update order
• Show order details
• Authorize payment for order
• Capture payment for order

To simulate a specific error, add a mock_application_codes value that equals the error code you want to test.

The following sample header tests a declined instrument in a Capture payment for order call:

-H "PayPal-Mock-Response: {"mock_application_codes" : "INSTRUMENT_DECLINED"}"

Subscriptions

To run the subscription simulation tests:

1. Download the Postman collection for the Product, Plan, and Subscriptions APIs:

   

2. Use the following test values to trigger positive and negative responses for these subscriptions actions:

   Product

   • Create product
   • Get product
   • List products
   • Update product

   Plan

   • Create plan
   • Activate plan
   • Deactivate plan
   • Get plan
   • List plans
   • Update plan
   • Change plan pricing

   Subscription

   • Create subscription
   • Activate subscriptions
   • Get subscription
   • Update subscription
   • Revise subscription
   • Suspend subscription
   • Capture subscription
   • Get subscription transaction
   • Cancel subscription

Product

Create product

Negative response test values

Use the JSON pointer in the request payload to simulate the following error responses at POST /v1/catalogs/products.

Get product

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at GET /v1/catalogs/products/{test_value}.

List products

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at GET /v1/billing/plans/?&total_required={test_value}.

Update product

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at PATCH /v1/catalog/products/{test_value}.

Plan

Create plan

Negative response test values

Use the JSON pointer in the request payload to simulate the following error responses at POST /v1/billing/plans/.

Activate plan

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST/v1/billing/plans/{test_value}/activate.

Deactivate plan

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/plans/{test_value}/deactivate.

Get plan

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at GET /v1/billing/plans/{test_value}.

List plans

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at GET /v1/billing/plans/?page_size=3&page=1&total_required={test_value}.

Update plan

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at PATCH /v1/billing/plans/{test_value}.

Change plan pricing

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/plans/{test_value}/update-pricing-schemes.

Subscription

Create subscription

Negative response test values

Use the JSON pointer in the request payload to simulate the following error responses at POST /v1/billing/subscriptions.

Activate subscriptions

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/subscriptions/{test_value}/activate.

Get subscription

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at GET /v1/billing/subscriptions/{test_value}.

Update subscription

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at PATCH /v1/billing/subscriptions/{test_value}.

Revise subscription

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/subscriptions/{test_value}/revise.

Suspend subscription

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/subscriptions/{test_value}/suspend.

Capture subscription

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/subscriptions/{test_value}/capture.

Get subscription transaction

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at GET /v1/billing/subscriptions/{test_value}/transactions.

Cancel subscription

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/subscriptions/{test_value}/cancel.