Test your integration

Payments

Before you can run live payments, we require you to run our test cases to make sure that you have correctly integrated against our API.

Note: If you have any issues when you run our test cases, email our integrations team at [email protected].

Before you begin

To help you with testing, we provide you with:

  • Test environment
  • Test cards
  • Test values

You should also review our testing recommendations.

Test environment

Send your requests to our test environment:

Test environment base URI: https://api.uat.payroc.com/v1

Important: Use only test cards in our test environment.

Authenticating your requests

Use our test Identity Service to generate a Bearer token to include in the header of your requests. To generate your Bearer token, complete the following steps:

  1. Include your API key in the x-api-key parameter in the header of a POST request.
  2. Send your request to https://identity.uat.payroc.com/authorize.

Note: You need to generate a new Bearer token before the previous Bearer token expires.

Example request

$curl --location --request POST 'https://identity.uat.payroc.com/authorize' --header 'x-api-key: <api key>'

Example response

If your request is successful, we return a response that contains your Bearer token, information about its scope, and when it expires.

1{
2  "access_token": "eyJhbGc....adQssw5c",
3  "expires_in": 3600,
4  "scope": "service_a service_b",
5  "token_type": "Bearer"
6}

Example request header

$curl
>-H "Authorization: Bearer <access token>"

Test cards

Note: Our gateway accepts any value for the CVV.

Card schemeCard numberRequires CVV?
American Express3400000000000000Yes
Debit MasterCard5100270000000007Yes
Diners3600000000000008No
Discover6011000000000004Yes
JCB3528000000000007Yes
Maestro5000330000000000Yes
MasterCard5001650000000000Yes
Visa Credit4539858876047062Yes
Visa Debit4000060000000006Yes
Visa Electron4001020000000009No

EBT test cards

Note: You can only test EBT transactions if the processor is Fiserv or TSYS.

Card numberBenefit categoryPIN
6007602801003837964Food Stamp1234
6007602801003837965Food Stamp1234
060076028010038379673Cash Only1234
6007602801003837968Cash Only1234
6007602801003837969Cash Only1234
6007602801003837971Inactive card1234

Test values

To return a specific response from the gateway, change the value in the amount parameter to end in one of the following values:

ValueResponseExample
01Declined501
02Referral1002
03CVV failure1403
Any otherAuthorized4541

Testing recommendations

Important: Do not use live card data to test your integration. This is a breach of PCI DSS.

When you test your integration, we recommend that you do the following:

  • Test error scenarios – To check that your integration can handle errors, run scenarios that produce errors. For example, test that your integration can handle the response when the value for a request parameter is in the wrong format.
  • Follow PCI DSS – To help protect the payment data, make sure that your integration complies with PCI DSS.
  • Test all card types – If your integration accepts multiple card types, test your integration with each card type. For example, if your integration accepts EBT cards, you should test with an EBT card.
  • Refresh tokens for authentication – Bearer tokens expire after a fixed period. Test your integration to make sure that it can correctly refresh Bearer tokens.

Test cases

We provide you with test cases for the following:

Card payments

Run a card sale without a surcharge

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/payments

Example response

1{
2	"paymentId": "F1I17KBL0E",
3	"processingTerminalId": "3204001",
4	"order": {
5		"orderId": "Test_001",
6		"dateTime": "2023-05-24T14:44:20.63+01:00",
7		"amount": 4000,
8		"currency": "USD"
9	},
10	"card": {
11		"type": "Visa Credit",
12		"entryMethod": "keyed",
13		"cardNumber": "444433******1111",
14		"expiryDate": "0334",
15		"securityChecks": {
16			"cvvResult": "M",
17			"avsResult": "Y"
18		}
19	},
20	"paymentResult": {
21		"type": "sale",
22		"status": "ready",
23		"approvalCode": "OK14472",
24		"authorizedAmount": 4000,
25		"currency": "USD",
26		"responseCode": "A",
27		"responseMessage": "OK14472"
28	}
29}

Run a card sale with a surcharge

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/payments

Note: If you are unsure whether your account supports surcharges, email our Integration team at [email protected].

Example response

1{
2	"paymentId": "CBA7UOVS0J",
3	"processingTerminalId": "3204001",
4	"order": {
5		"orderId": "Test_005",
6		"dateTime": "2023-05-24T14:48:39.548+01:00",
7		"amount": 4160,
8		"currency": "USD",
9		"breakdown": {
10			"subtotal": 4000,
11			"surcharge": {
12				"bypass": false,
13				"amount": 160,
14				"percentage": 4.0
15			}
16		}
17	},
18	"card": {
19		"type": "Visa Credit",
20		"entryMethod": "keyed",
21		"cardNumber": "444433******1111",
22		"expiryDate": "0334",
23		"securityChecks": {
24			"cvvResult": "M",
25			"avsResult": "Y"
26		}
27	},
28	"paymentResult": {
29		"type": "sale",
30		"status": "ready",
31		"approvalCode": "OK14476",
32		"authorizedAmount": 4160,
33		"currency": "USD",
34		"responseCode": "A",
35		"responseMessage": "OK14476"
36	}
37}

Run a pre-authorization

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/payments

Note: Set the value for the autoCapture parameter to false.

Example response

1{
2	"paymentId": "C7BHY7KWCW",
3	"processingTerminalId": "3204001",
4	"operator": "Davi-Crisostomo-CHP",
5	"order": {
6		"orderId": "1234567890Q1",
7		"dateTime": "2023-06-20T21:03:30.925+01:00",
8		"description": "PreAuth Card Transaction (WEB) - Sale - KEYED (plain_text) with CVV",
9		"amount": 12346,
10		"currency": "USD"
11	},
12	"card": {
13		"type": "Visa Credit",
14		"entryMethod": "keyed",
15		"cardholderName": "Davi",
16		"cardNumber": "444433******1111",
17		"expiryDate": "1223",
18		"securityChecks": {
19			"cvvResult": "M",
20			"avsResult": "Y"
21		}
22	},
23	"transactionResult": {
24		"type": "sale",
25		"status": "pending",
26		"approvalCode": "OK24233",
27		"authorizedAmount": 12346,
28		"currency": "USD",
29		"responseCode": "A",
30		"responseMessage": "OK24233"
31	}
32}

Capture a pre-authorization

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/payments/{paymentId}/capture

Example response

1{
2	"paymentId": "C7BHY7KWCW",
3	"processingTerminalId": "3204001",
4	"operator": "Davi-Crisostomo-CHP",
5	"order": {
6		"orderId": "1234567890Q1",
7		"dateTime": "2023-06-20T21:03:31+01:00",
8		"description": "PreAuth Card Transaction (WEB) - Sale - KEYED (plain_text) with CVV",
9		"amount": 6532,
10		"currency": "USD"
11	},
12	"card": {
13		"type": "Visa Credit",
14		"entryMethod": "keyed",
15		"cardholderName": "Davi",
16		"cardNumber": "444433******1111",
17		"expiryDate": "1223",
18		"securityChecks": {
19			"cvvResult": "M",
20			"avsResult": "Y"
21		}
22	},
23	"transactionResult": {
24		"type": "sale",
25		"status": "ready",
26		"approvalCode": "OK24233",
27		"authorizedAmount": 6532,
28		"currency": "USD",
29		"responseCode": "A",
30		"responseMessage": "OK24233"
31	}
32}

Adjust a card payment

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/payments/{paymentId}/adjust

Example response

1{
2	"paymentId": "C7BHY7KWCW",
3	"processingTerminalId": "3204001",
4	"operator": "ROBBIE-KIRWAN-adjust",
5	"order": {
6		"orderId": "1234567890Q1",
7		"dateTime": "2023-06-20T21:03:31+01:00",
8		"description": "PreAuth Card Transaction (WEB) - Sale - KEYED (plain_text) with CVV",
9		"amount": 400,
10		"currency": "USD"
11	},
12	"card": {
13		"type": "Visa Credit",
14		"entryMethod": "keyed",
15		"cardholderName": "Davi",
16		"cardNumber": "444433******1111",
17		"expiryDate": "1223",
18		"securityChecks": {
19			"cvvResult": "M",
20			"avsResult": "Y"
21		}
22	},
23	"transactionResult": {
24		"type": "sale",
25		"status": "ready",
26		"approvalCode": "OK24233",
27		"authorizedAmount": 400,
28		"currency": "USD",
29		"responseCode": "A",
30		"responseMessage": "OK24233"
31	}
32}

Secure tokens

Create a secure token

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/processing-terminals/{processingTerminalId}/secure-tokens

Example response

1{
2	"secureTokenId": "MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA",
3	"processingTerminalId": "3204001",
4	"source": {
5		"type": "card",
6		"cardholderName": "",
7		"cardNumber": "444433******1111",
8		"expiryDate": "1226"
9	},
10	"token": "2967538502417872",
11	"status": "cvv_validated"
12}

Create a payment with a secure token

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/payments

Example response

1{
2	"paymentId": "C8Y177VHWR",
3	"processingTerminalId": "3204001",
4	"order": {
5		"orderId": "Test_006",
6		"dateTime": "2023-05-24T15:21:01.037+01:00",
7		"amount": 4000,
8		"currency": "USD"
9	},
10	"card": {
11		"type": "Visa Credit",
12		"entryMethod": "keyed",
13		"cardNumber": "444433******1111",
14		"expiryDate": "1226",
15		"secureToken": {
16			"secureTokenId": "MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA",
17			"customerName": "",
18			"token": "2967538502417872",
19			"status": "cvv_validated",
20			"link": {
21				"rel": "self",
22				"method": "GET",
23				"href": "https://api.uat.payroc.com/v1/processing-terminals/3204001/secure-tokens/MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA"
24			}
25		},
26		"securityChecks": {
27			"cvvResult": "M",
28			"avsResult": "Y"
29		}
30	},
31	"transactionResult": {
32		"type": "sale",
33		"status": "ready",
34		"approvalCode": "OK14486",
35		"authorizedAmount": 4000,
36		"currency": "USD",
37		"responseCode": "A",
38		"responseMessage": "OK14486",
39		"cardSchemeReferenceId": "JxDfFMHyOE2lyQJ2MnFp"
40	}
41}

Delete a secure token

Send a DELETE request to the following endpoint:

DELETE https://api.uat.payroc.com/v1/payments/processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}
Example response

No response body.

Update a secure token

Send a PATCH request to the following endpoint:

PATCH https://api.uat.payroc.com/v1/payments/processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}

Example response

1{
2	"secureTokenId": "MREF_fe532d13-d330-4872-b646-61750144030bG4",
3	"processingTerminalId": "3204001",
4	"customer": {
5		"contactMethods": [
6			{
7				"type": "email",
8				"value": "[email protected]"
9			}
10		]
11	},
12	"source": {
13		"type": "card",
14		"cardholderName": "Test Card 13 Uat Usa",
15		"cardNumber": "374245*****1003",
16		"expiryDate": "1224"
17	},
18	"token": "2967538321403871",
19	"status": "cvv_validated"
20}

Payment plans and subscriptions

Create a payment plan

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/processing-terminals/{processingTerminalId}/payment-plans

Example response

1{
2	"paymentPlanId": "PaymentPlanTest",
3	"processingTerminalId": "3204001",
4	"name": "Davi Crisostomo",
5	"description": "Payment Plan creation",
6	"currency": "USD",
7	"setupOrder": {
8		"amount": 11000,
9		"description": "Setup Amount"
10	},
11	"length": 24,
12	"type": "manual",
13	"frequency": "monthly",
14	"onUpdate": "update",
15	"onDelete": "complete"
16}

Update a payment plan

Send a PATCH request to the following endpoint:

PATCH https://api.uat.payroc.com/v1/processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}

Example response

1{
2	"paymentPlanId": "PaymentPlanTest",
3	"processingTerminalId": "3204001",
4	"name": "Davi Crisostomo",
5	"description": "Payment Plan creation",
6	"currency": "USD",
7	"setupOrder": {
8		"amount": 11000,
9		"description": "Setup Amount"
10	},
11	"length": 24,
12	"type": "automatic",
13	"frequency": "weekly",
14	"onUpdate": "update",
15	"onDelete": "complete"
16}

Create a subscription for a payment plan

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/processing-terminals/{processingTerminalId}/subscriptions

Example response

1{
2	"subscriptionId": "SubTest",
3	"processingTerminalId": "3204001",
4	"paymentPlan": {
5		"paymentPlanId": "PaymentPlanTest",
6		"name": "Davi Crisostomo",
7		"link": {
8			"rel": "self",
9			"method": "GET",
10			"href": "https://api.uat.payroc.com/v1/processing-terminals/3204001/payment-plans/PaymentPlanTest"
11		}
12	},
13	"secureToken": {
14		"secureTokenId": "MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA",
15		"customerName": "",
16		"token": "2967538502417872",
17		"status": "cvv_validated",
18		"link": {
19			"rel": "self",
20			"method": "GET",
21			"href": "https://api.uat.payroc.com/v1/processing-terminals/3204001/secure-tokens/MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA"
22		}
23	},
24	"name": "Davi Crisostomo",
25	"description": "Create Subscription from ICC payment",
26	"currency": "USD",
27	"setupOrder": {
28		"orderId": "TheOrderID",
29		"amount": 11000,
30		"description": "Desription of SETUPORDER"
31	},
32	"recurringOrder": {
33		"amount": 11000,
34		"description": "RECURRING Order price"
35	},
36	"currentState": {
37		"status": "active",
38		"nextDueDate": "2023-08-02",
39		"paidInvoices": 0,
40		"outstandingInvoices": 122
41	},
42	"startDate": "2023-08-02",
43	"endDate": "2025-12-02",
44	"length": 24,
45	"type": "automatic",
46	"frequency": "weekly",
47	"pauseCollectionFor": 0
48}

Manually pay a subscription

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/pay

Example response

1{
2	"paymentId": "KOHM1D3EZH",
3	"processingTerminalId": "3204001",
4	"operator": "Davi Crisostomo",
5	"order": {
6		"orderId": "UniqueValueForOrderID",
7		"dateTime": "2023-06-20T20:25:57.641+01:00",
8		"description": "Subscription Payment - Manual",
9		"amount": 11000,
10		"currency": "USD"
11	},
12	"card": {
13		"type": "Visa Credit",
14		"entryMethod": "keyed",
15		"cardNumber": "444433******1111",
16		"expiryDate": "1226",
17		"secureToken": {
18			"secureTokenId": "MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA",
19			"customerName": "",
20			"token": "2967538502417872",
21			"status": "cvv_validated",
22			"link": {
23				"rel": "self",
24				"method": "GET",
25				"href": "https://api.uat.payroc.com/v1/processing-terminals/3204001/secure-tokens/MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA"
26			}
27		},
28		"securityChecks": {
29			"cvvResult": "M",
30			"avsResult": "Y"
31		}
32	},
33	"transactionResult": {
34		"type": "sale",
35		"status": "ready",
36		"approvalCode": "OK24225",
37		"authorizedAmount": 11000,
38		"currency": "USD",
39		"responseCode": "A",
40		"responseMessage": "OK24225",
41		"cardSchemeReferenceId": "nkMX2G7ZqPavgbYiYacQ"
42	}
43}

Update a subscription

Send a PATCH request to the following endpoint:

PATCH https://api.uat.payroc.com/v1/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}

Example response

1{
2	"subscriptionId": "SubTest",
3	"processingTerminalId": "3204001",
4	"paymentPlan": {
5		"paymentPlanId": "PaymentPlanTest",
6		"name": "Davi Crisostomo",
7		"link": {
8			"rel": "self",
9			"method": "GET",
10			"href": "https://api.uat.payroc.com/v1/processing-terminals/3204001/payment-plans/PaymentPlanTest"
11		}
12	},
13	"secureToken": {
14		"secureTokenId": "MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA",
15		"customerName": "",
16		"token": "2967538502417872",
17		"status": "cvv_validated",
18		"link": {
19			"rel": "self",
20			"method": "GET",
21			"href": "https://api.uat.payroc.com/v1/processing-terminals/3204001/secure-tokens/MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA"
22		}
23	},
24	"name": "Davi Crisostomo",
25	"description": "NEW DESCRIPTION FOR SUBSCRIPTION",
26	"currency": "USD",
27	"setupOrder": {
28		"orderId": "TheOrderID",
29		"amount": 11000,
30		"description": "Desription of SETUPORDER"
31	},
32	"recurringOrder": {
33		"amount": 11000,
34		"description": "RECURRING Order price"
35	},
36	"currentState": {
37		"status": "active",
38		"nextDueDate": "2023-08-02",
39		"paidInvoices": 1,
40		"outstandingInvoices": 121
41	},
42	"startDate": "2023-08-02",
43	"endDate": "2025-12-02",
44	"length": 24,
45	"type": "automatic",
46	"frequency": "weekly",
47	"pauseCollectionFor": 0
48}

Deactivate a subscription

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/deactivate

Example response

1{
2	"subscriptionId": "SubTest",
3	"processingTerminalId": "3204001",
4	"paymentPlan": {
5		"paymentPlanId": "PaymentPlanTest",
6		"name": "Davi Crisostomo",
7		"link": {
8			"rel": "self",
9			"method": "GET",
10			"href": "https://api.uat.payroc.com/v1/processing-terminals/3204001/payment-plans/PaymentPlanTest"
11		}
12	},
13	"secureToken": {
14		"secureTokenId": "MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA",
15		"customerName": "",
16		"token": "2967538502417872",
17		"status": "cvv_validated",
18		"link": {
19			"rel": "self",
20			"method": "GET",
21			"href": "https://api.uat.payroc.com/v1/processing-terminals/3204001/secure-tokens/MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA"
22		}
23	},
24	"name": "Davi Crisostomo",
25	"description": "NEW DESCRIPTION FOR SUBSCRIPTION",
26	"currency": "USD",
27	"setupOrder": {
28		"orderId": "TheOrderID",
29		"amount": 11000,
30		"description": "Desription of SETUPORDER"
31	},
32	"recurringOrder": {
33		"amount": 11000,
34		"description": "RECURRING Order price"
35	},
36	"currentState": {
37		"status": "cancelled",
38		"nextDueDate": "2023-08-02",
39		"paidInvoices": 1,
40		"outstandingInvoices": 121
41	},
42	"startDate": "2023-08-02",
43	"endDate": "2025-12-02",
44	"length": 24,
45	"type": "automatic",
46	"frequency": "weekly",
47	"pauseCollectionFor": 0
48}

Re-activate a subscription

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/reactivate

Example response

1{
2	"subscriptionId": "SubTest",
3	"processingTerminalId": "3204001",
4	"paymentPlan": {
5		"paymentPlanId": "PaymentPlanTest",
6		"name": "Davi Crisostomo",
7		"link": {
8			"rel": "self",
9			"method": "GET",
10			"href": "https://api.uat.payroc.com/v1/processing-terminals/3204001/payment-plans/PaymentPlanTest"
11		}
12	},
13	"secureToken": {
14		"secureTokenId": "MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA",
15		"customerName": "",
16		"token": "2967538502417872",
17		"status": "cvv_validated",
18		"link": {
19			"rel": "self",
20			"method": "GET",
21			"href": "https://api.uat.payroc.com/v1/processing-terminals/3204001/secure-tokens/MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA"
22		}
23	},
24	"name": "Davi Crisostomo",
25	"description": "NEW DESCRIPTION FOR SUBSCRIPTION",
26	"currency": "USD",
27	"setupOrder": {
28		"orderId": "TheOrderID",
29		"amount": 11000,
30		"description": "Desription of SETUPORDER"
31	},
32	"recurringOrder": {
33		"amount": 11000,
34		"description": "RECURRING Order price"
35	},
36	"currentState": {
37		"status": "active",
38		"nextDueDate": "2023-08-02",
39		"paidInvoices": 1,
40		"outstandingInvoices": 121
41	},
42	"startDate": "2023-08-02",
43	"endDate": "2025-12-02",
44	"length": 24,
45	"type": "automatic",
46	"frequency": "weekly",
47	"pauseCollectionFor": 0
48}

Bank transfers

Run a sale with bank account details

Send a POST request to the following endpoint:

POST https://api.uat.payroc.com/v1/bank-transfer-payments

Example response

1{
2    "channel": "POS",
3    "processingTerminalId": "3204001",
4    "operator": "Davi-CHP",
5    "order": {
6        "orderId": "CC-12",
7        "description": "BT ACH - Sale with CC",
8        "currency": "USD",
9        "amount": 9700
10    },
11    "paymentMethod": {
12        "type": "ach",
13        "accountType": "checking",
14        "secCode": "web",
15        "nameOnAccount": "Davi",
16        "accountNumber": "49100130",
17        "routingNumber": "292735277"
18    }
19}