Test your integration

Test your front-end payment flows, and transaction lifecycle requests.

Testing the Payments API

When testing Primer's Payments API, we have a special Primer Test Processor connection which is ready for use on your Sandbox account when you first log in. We have a series of test tokens you can use with the Primer Test Processor to elicit a variety of status responses. Learn more about statuses in Managing payments.

Environment	API	Dashboard
Sandbox	api.sandbox.primer.io	sandbox-dashboard.primer.io

Testing authorization scenarios

Pass in a test token in the paymentInstrument field during payment creation to test various transaction statuses.

Test Token	Scenario	Transaction Status
tok_auth_authorized_card	The payment was authorized by the processor. This will put the transaction into an authorized state.	Authorized
tok_auth_declined_card	The payment was declined by the processor, either at a gateway or acquirer level.	Declined
tok_auth_failed_card	Primer failed to get a response from the chosen processor, it may be down or otherwise unavailable.	Failed
tok_auth_settled_card	The payment was authorized and subsequently settled by the processor.	Settled

Testing AVS and CVV scenarios

The test tokens described above can also be used in conjunction with special test amounts. Pass in a test amount in the amount field to test different AVS and CVV check scenarios.

Amount	Scenario	Risk Data Attribute in Response	Attribute Value
1-99	AVS postal code check passed.	avsPostalCode	MATCHED
100-199	AVS postal code check failed.	avsPostalCode	NOT_MATCHED
200-299	AVS postal code check not supplied. No check performed.	avsPostalCode	NOT_PROVIDED
300-399	AVS street address check passed.	avsStreetAddress	MATCHED
400-499	AVS street address check failed.	avsStreetAddress	NOT_MATCHED
500-599	AVS street address check not supplied. No check performed.	avsStreetAddress	NOT_PROVIDED
600-699	CVV check passed.	cvv	MATCHED
700-799	CVV check failed.	cvv	NOT_MATCHED
800-899	CVV not supplied. No check performed.	cvv	NOT_PROVIDED

The example below would return an authorized payment with a failed AVS check on the postal code:

1
2
3
4
5
6
7
8
9
10
11
12
curl --location --request \
    POST 'https://api.sandbox.primer.io/payments' \
    --header 'X-API-KEY: <YOUR_API_KEY>' \
    --header 'IDEMPOTENCY_KEY: order-123' \
    --data '{
                "amount": 100, # use a test amount here
                "currencyCode": "EUR",
                "orderId": "order-123",
                "paymentInstrument": {
                    "token": "tok_auth_authorized_card", # use a test token here
                },
    }'

curl

Testing 3D Secure

Scenarios

To test 3D secure, specify one of the values referenced below within the testScenario field.

test scenario value	Scenario	3D Secure Authorization Response	3D Secure Verification Response On Challenge
3DS_V2_FRICTIONLESS_SUCCESS	3DS v2 successful authentication without challenge	AUTH_SUCCESS	N/A
3DS_V2_FRICTIONLESS_FAIL	3DS v2 failed authentication without challenge	AUTH_FAILED	N/A
3DS_V2_CHALLENGE_SUCCESS	3DS v2 successful authentication after challenge	CHALLENGE	AUTH_SUCCESS
3DS_V2_CHALLENGE_FAIL	3DS v2 failed authentication after challenge	CHALLENGE	AUTH_FAILED
3DS_V2_NOT_AVAILABLE	3DS v2 skipped - not available from the issuer	SKIPPED	N/A
3DS_V1_SUCCESS	3DS v1 successful authentication	CHALLENGE	AUTH_SUCCESS
3DS_V1_FAIL	3DS v1 failed authentication	CHALLENGE	AUTH_FAILED
3DS_V1_NOT_AVAILABLE	3DS v1 skipped - not available from the issuer	SKIPPED	N/A

Example usage:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
// client.js
window.addEventListener("load", onLoaded);
async function onLoaded() {
  const clientTokenResponse = await fetch("/client-token", {
    method: "post",
    headers: { "Content-Type": "application/json" },
  });
  const { clientToken } = await clientTokenResponse.json();
  const primer = new Primer({
    credentials: {
      clientToken, // Your server generated client token
    },
  });
  /**
   * For Universal Checkout, add testScenario to the threeDSecure options:
   */
  primer.checkout({
    container: "#checkout-container",
    threeDSecure: {
      // Choose a test scenario
      testScenario: "3DS_V2_CHALLENGE_SUCCESS",
      // Provide your order information as normal
      order: myThreeDSOrderInfo,
      additionalInfo: moreCustomerInformation,
    },
  });
  /**
   * For Checkout Components, add the testScenario to the 3ds verify call:
   */
  primer.threeDSecure.verify({
    // Choose a test scenario
    testScenario: "3DS_V2_CHALLENGE_SUCCESS",
    // Provide your order information and token as normal
    token: myUnauthenticatedToken,
    order: myThreeDSOrderInfo,
    additionalInfo: moreCustomerInformation,
  });
}

← 03. Managing payments

05. Connections →