Test and go live

Use test values to simulate error responses with the PayPal Invoicing API and verify that your application handles different scenarios correctly.

Prerequisites

• Get your access token.
• Use Postman to test the PayPal APIs.
• Use the sandbox environment.

Simulation methods

You can simulate responses in two ways: JSON pointer method or the path parameter method.

JSON pointer method

The following sample code shows a simulated request with a test value and the sandbox response.

Request

curl -X POST \
  https://api-m.sandbox.paypal.com/v2/invoicing/invoices \
  -H 'Authorization: Bearer ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
          "detail":
          {
                    "reference": "ERRINV002"
          }
}'

Response

{
    "localizedMessage": "No permission for the requested operation. ",
    "name": "PERMISSION_DENIED",
    "message": "No permission for the requested operation. ",
    "details": [
        {
            "issue": "No permission for the requested operation. "
        }
    ],
    "information_link": "/log-in/how-it-works/",
    "debug_id": "6e07326c281c4"
}

Path parameter method

Use test value in the request URI. This simulates a response.

The following sample code shows a simulated request with a test value and the sandbox response.

Request

curl -X GET \
  https://api-m.sandbox.paypal.com/v2/invoicing/invoices/INV2-ABCD-1234-EINV-0010 \
  -H 'Authorization: Bearer ACCESS-TOKEN' \
  -H 'Content-Type: application/json'

Response

{
    "name": "RESOURCE_NOT_FOUND",
    "message": "The specified resource does not exist.",
    "debug_id": "98b2b9d2d89cb",
    "links": [
        {
            "href": "https://developer.paypal.com/invoicing/errors/",
            "rel": "information_link"
        }
    ]
}

Test values

The following test values simulate different responses for each Invoicing API operation. Each operation shows where to insert the test value and the response you can expect.

Generate invoice number

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

Create invoices

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

Get invoice

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

Delete invoice

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

Success

Error

Update the invoice

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

Cancel a sent invoice

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

Success

Error

Record payment for invoice

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

Success

Error

Delete payment

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

Success

Error

Record refund for invoice

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

Success

Error

Delete refund

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

Success

Error

Send invoice reminder

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

Success

Error

Send invoice

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

Success

Error

Search invoices

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