IntegrateRepeat payments

Use your own software

If you use your own software to manage repeat payments, program your software to run a sale each time the merchant wants to take a payment. Each request should also include the following information:

  • Type of repeat payment
  • Position of the payment in the billing cycle
  • Information about the first payment

You can also use our tokenization service to save the customer’s payment details instead of sending their payment details in each request.

Integration steps

To use your own software for repeat payments, integrate with the following:

Step 1. (Optional) Create a secure token.
Step 2. Create a payment.

Before you begin

Bearer tokens

Use our Identity Service to generate a Bearer token to include in the header of your requests. To generate a 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.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.payroc.com/authorize' --header 'x-api-key: <api key>'

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

Example response

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

Headers

To create the header of each POST request, you must include the following parameters:

  • Content-Type: Include application/json as the value for this parameter.
  • Authorization: Include your Bearer token in this parameter.
  • Idempotency-Key: Include a UUID v4 to make the request idempotent.
$curl
>-H "Content-Type: application/json"
>-H "Authorization: <Bearer token>"
>-H "Idempotency-Key: <UUID v4>"

Errors

If your request is unsuccessful, we return an error. For more information about errors, see Errors.

Step 1. (Optional) Create a secure token

To save the customer’s payment details, send a POST request to our Secure Tokens endpoint.

Note: We assign the secure token to the terminal that sent the request. Depending on the merchant’s account settings, other terminals within the merchant’s account can also use the secure token.

Request parameters

To create the body of your request, use the following parameters:

Example request

POST
/v1/processing-terminals/:processingTerminalId/secure-tokens
1curl -X POST https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens \
2     -H "Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324" \
3     -H "Authorization: Bearer <token>" \
4     -H "Content-Type: application/json" \
5     -d '{
6  "source": {
7    "type": "card",
8    "cardDetails": {
9      "entryMethod": "keyed",
10      "keyedData": {
11        "dataFormat": "plainText",
12        "cardNumber": "4539858876047062",
13        "expiryDate": "1225",
14        "cvv": "234"
15      },
16      "cardholderName": "Sarah Hazel Hopper"
17    }
18  },
19  "operator": "Jane",
20  "mitAgreement": "unscheduled",
21  "customer": {
22    "firstName": "Sarah",
23    "lastName": "Hopper",
24    "dateOfBirth": "1990-07-15",
25    "referenceNumber": "Customer-12",
26    "billingAddress": {
27      "address1": "1 Example Ave.",
28      "city": "Chicago",
29      "state": "Illinois",
30      "country": "US",
31      "postalCode": "60056",
32      "address2": "Example Address Line 2",
33      "address3": "Example Address Line 3"
34    },
35    "shippingAddress": {
36      "recipientName": "Sarah Hopper",
37      "address": {
38        "address1": "1 Example Ave.",
39        "city": "Chicago",
40        "state": "Illinois",
41        "country": "US",
42        "postalCode": "60056",
43        "address2": "Example Address Line 2",
44        "address3": "Example Address Line 3"
45      }
46    },
47    "contactMethods": [
48      {
49        "type": "email",
50        "value": "[email protected]"
51      }
52    ],
53    "notificationLanguage": "en"
54  },
55  "ipAddress": {
56    "type": "ipv4",
57    "value": "104.18.24.203"
58  },
59  "customFields": [
60    {
61      "name": "yourCustomField",
62      "value": "abc123"
63    }
64  ]
65}'

Response fields

If your request is successful, we store the customer’s payment details and return a response. The response contains the following fields:

Example response

Response
1{
2  "secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
3  "processingTerminalId": "1234001",
4  "source": {
5    "type": "card",
6    "cardholderName": "Sarah Hazel Hopper",
7    "cardNumber": "453985******7062",
8    "expiryDate": "1225"
9  },
10  "token": "296753123456",
11  "status": "notValidated",
12  "mitAgreement": "unscheduled",
13  "customer": {
14    "firstName": "Sarah",
15    "lastName": "Hopper",
16    "dateOfBirth": "1990-07-15",
17    "referenceNumber": "Customer-12",
18    "billingAddress": {
19      "address1": "1 Example Ave.",
20      "city": "Chicago",
21      "state": "Illinois",
22      "country": "US",
23      "postalCode": "60056",
24      "address2": "Example Address Line 2",
25      "address3": "Example Address Line 3"
26    },
27    "shippingAddress": {
28      "recipientName": "Sarah Hopper",
29      "address": {
30        "address1": "1 Example Ave.",
31        "city": "Chicago",
32        "state": "Illinois",
33        "country": "US",
34        "postalCode": "60056",
35        "address2": "Example Address Line 2",
36        "address3": "Example Address Line 3"
37      }
38    },
39    "contactMethods": [
40      {
41        "type": "email",
42        "value": "[email protected]"
43      }
44    ],
45    "notificationLanguage": "en"
46  },
47  "customFields": [
48    {
49      "name": "yourCustomField",
50      "value": "abc123"
51    }
52  ]
53}

Step 2. Create a payment

To take a payment from the customer, send a POST request to the Payments endpoint. In your request, include the standingInstructions object, which contains information about the repeat payment.

Request parameters

To create the body of your request, use the following parameters:

Example request

POST
/v1/payments
1curl -X POST https://api.payroc.com/v1/payments \
2     -H "Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324" \
3     -H "Authorization: Bearer <token>" \
4     -H "Content-Type: application/json" \
5     -d '{
6  "channel": "web",
7  "processingTerminalId": "1234001",
8  "order": {
9    "orderId": "OrderRef6543",
10    "amount": 4999,
11    "currency": "USD",
12    "description": "Large Pepperoni Pizza"
13  },
14  "paymentMethod": {
15    "type": "card",
16    "cardDetails": {
17      "entryMethod": "keyed",
18      "keyedData": {
19        "dataFormat": "plainText",
20        "device": {
21          "model": "paxA80",
22          "serialNumber": "WPC202833004712"
23        },
24        "cardNumber": "4539858876047062",
25        "expiryDate": "1225"
26      }
27    }
28  },
29  "operator": "Jane",
30  "customer": {
31    "firstName": "Sarah",
32    "lastName": "Hopper",
33    "billingAddress": {
34      "address1": "1 Example Ave.",
35      "city": "Chicago",
36      "state": "Illinois",
37      "country": "US",
38      "postalCode": "60056",
39      "address2": "Example Address Line 2",
40      "address3": "Example Address Line 3"
41    },
42    "shippingAddress": {
43      "recipientName": "Sarah Hopper",
44      "address": {
45        "address1": "1 Example Ave.",
46        "city": "Chicago",
47        "state": "Illinois",
48        "country": "US",
49        "postalCode": "60056",
50        "address2": "Example Address Line 2",
51        "address3": "Example Address Line 3"
52      }
53    }
54  },
55  "customFields": [
56    {
57      "name": "yourCustomField",
58      "value": "abc123"
59    }
60  ]
61}'

Response fields

If your request is successful, we create the payment and return a response. The response contains the following fields:

Example response

Response
1{
2  "paymentId": "M2MJOG6O2Y",
3  "processingTerminalId": "1234001",
4  "order": {
5    "orderId": "OrderRef6543",
6    "amount": 4999,
7    "currency": "USD",
8    "dateTime": "2024-07-02T15:30:00Z",
9    "description": "Large Pepperoni Pizza"
10  },
11  "card": {
12    "type": "MasterCard",
13    "entryMethod": "keyed",
14    "cardNumber": "453985******7062",
15    "expiryDate": "1225",
16    "securityChecks": {
17      "cvvResult": "M",
18      "avsResult": "Y"
19    }
20  },
21  "transactionResult": {
22    "type": "sale",
23    "status": "ready",
24    "responseCode": "A",
25    "responseMessage": "OK3",
26    "approvalCode": "OK3",
27    "authorizedAmount": 4999,
28    "currency": "USD"
29  },
30  "operator": "Jane",
31  "customer": {
32    "firstName": "Sarah",
33    "lastName": "Hopper",
34    "billingAddress": {
35      "address1": "1 Example Ave.",
36      "city": "Chicago",
37      "state": "Illinois",
38      "country": "US",
39      "postalCode": "60056",
40      "address2": "Example Address Line 2",
41      "address3": "Example Address Line 3"
42    },
43    "shippingAddress": {
44      "recipientName": "Sarah Hopper",
45      "address": {
46        "address1": "1 Example Ave.",
47        "city": "Chicago",
48        "state": "Illinois",
49        "country": "US",
50        "postalCode": "60056",
51        "address2": "Example Address Line 2",
52        "address3": "Example Address Line 3"
53      }
54    }
55  },
56  "supportedOperations": [
57    "capture",
58    "fullyReverse",
59    "partiallyReverse",
60    "incrementAuthorization",
61    "adjustTip",
62    "setAsPending"
63  ],
64  "customFields": [
65    {
66      "name": "yourCustomField",
67      "value": "abc123"
68    }
69  ]
70}

Test cases

Before you run test cases, read the Payments page in Test Your Integration.

Run a card sale

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}