Guides
/
Integration guides
/
Repeat payments
/
Use your own software

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.
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

{
"access_token": "eyJhbGc....adQssw5c",
"expires_in": 3600,
"scope": "service_a service_b",
"token_type": "Bearer"
}

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.
Test endpoint: https://api.uat.payroc.com/v1/processing-terminals/{processingTerminalId}/secure-tokens
Production endpoint: https://api.payroc.com/v1/processing-terminals/{processingTerminalId}/secure-tokens
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:

Path parameters

Header parameters

Body parameters

Example request

Request
curl --request post \
	--url https://api.payroc.com/v1/processing-terminals/abc123/secure-tokens \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--header 'Idempotency-Key: abc123' \
	--data '{"operator":"Adam Smith","mitAgreement":"unscheduled","customer":{"firstName":"Jessica","lastName":"Red","dateOfBirth":"1990-01-01","referenceNumber":"Customer-12","billingAddress":{"address1":"Example Street","address2":"Example address2","address3":"Example address3","city":"Fresno","state":"California","country":"US","postalCode":93650},"shippingAddress":{"recipientName":"Example shipping recipientName","address":{"address1":"Example shipping street","address2":"Example shipping address2","address3":"Exampleshipping address3","city":"Austin","state":"Texas","country":"US","postalCode":73301}},"contactMethods":[{"type":"email","value":"[email protected]"}],"notificationLanguage":"en"},"ipAddress":{"type":"ipv4","value":"124.201.101.1"},"source":{"type":"card","cardDetails":{"entryMethod":"keyed","cardholderName":"Joe Bloggs","keyedData":{"dataFormat":"plainText","cardNumber":"4001020000000009","expiryDate":"0825","cvv":"713"}}}}'

Response fields

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

Response Schema

Status Code 201

Successful request. We created a secure token that represents your customer's payment details.
Response headers
Response body

Example response

Response
application/json
{
  "secureTokenId": "MREF_fce7bf52-b3b4-4270-aee9-77b938595078Hm",
  "processingTerminalId": "1001",
  "mitAgreement": "unscheduled",
  "customer": {
    "firstName": "Joe",
    "lastName": "Bloggs",
    "dateOfBirth": "1950-01-01",
    "referenceNumber": "Customer-1",
    "billingAddress": {
      "address1": "Example Street",
      "address2": "Example address2",
      "address3": "Example address3",
      "city": "Example Town",
      "state": "California",
      "country": "US",
      "postalCode": "1234"
    },
    "shippingAddress": {
      "recipientName": "Example shipping recipientName",
      "address": {
        "address1": "Example shipping street",
        "address2": "Example shipping address2",
        "address3": "Exampleshipping address3",
        "city": "Example shipping city",
        "state": "Texas",
        "country": "US",
        "postalCode": "1"
      }
    },
    "contactMethods": [
      {
        "type": "email",
        "value": "[email protected]"
      }
    ],
    "notificationLanguage": "en"
  },
  "source": {
    "type": "card",
    "cardholderName": "Joe Bloggs",
    "cardNumber": "400102******0009",
    "expiryDate": "0825"
  },
  "token": "2967532489076298",
  "status": "notValidated"
}

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.
Test endpoint: https://api.uat.payroc.com/v1/payments
Production endpoint: https://api.payroc.com/v1/payments

Request parameters

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

Header parameters

Body parameters

Example request

Request
curl --request post \
	--url https://api.payroc.com/v1/payments \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--header 'Idempotency-Key: abc123' \
	--data '{"channel":"web","processingTerminalId":"1023","operator":"Postman","order":{"orderId":"order123","description":"Example payment","currency":"USD","amount":100},"customer":{"firstName":"Robert","lastName":"Red","billingAddress":{"address1":"billing address1","address2":"billing address2","address3":"billing address3","city":"Los Angeles","state":"California","country":"US","postalCode":90005},"shippingAddress":{"recipientName":"shipping recipientName","address":{"address1":"shipping address1","address2":"shipping address2","address3":"shipping address3","city":"San Diego","state":"California","country":"US","postalCode":91911}}},"paymentMethod":{"type":"card","cardDetails":{"entryMethod":"keyed","keyedData":{"dataFormat":"plainText","device":{"model":"paxA80","serialNumber":"WPC202833004712"},"expiryDate":"0328","cardNumber":"5001650000000000"}}}}'

Response fields

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

Response Schema

Status Code 201

Successful request. We processed the transaction.
Response headers
Response body

Example response

Response
application/json
{
  "paymentId": "KP77BIWR96",
  "processingTerminalId": "1023",
  "operator": "Postman",
  "order": {
    "orderId": "order123",
    "dateTime": "2023-07-26T16:42:25.018Z",
    "description": "Example payment",
    "amount": 100,
    "currency": "USD"
  },
  "customer": {
    "firstName": "Robert",
    "lastName": "Red",
    "billingAddress": {
      "address1": "billing address",
      "address2": "billing address2",
      "address3": "billing address3",
      "city": "Los Angeles",
      "state": "California",
      "country": "US",
      "postalCode": "90005"
    },
    "shippingAddress": {
      "recipientName": "shipping recipientName",
      "address": {
        "address1": "shipping address1",
        "address2": "shipping address2",
        "address3": "shipping address3",
        "city": "San Diego",
        "state": "California",
        "country": "US",
        "postalCode": "91911"
      }
    }
  },
  "card": {
    "type": "MasterCard",
    "entryMethod": "keyed",
    "cardNumber": "500165******0000",
    "expiryDate": "0328",
    "securityChecks": {
      "cvvResult": "M",
      "avsResult": "Y"
    }
  },
  "supportedOperations": [
    "capture",
    "fullyReverse",
    "partiallyReverse",
    "incrementAuthorization",
    "adjustTip",
    "setAsPending"
  ],
  "transactionResult": {
    "type": "sale",
    "status": "ready",
    "approvalCode": "OK3",
    "authorizedAmount": 100,
    "currency": "USD",
    "responseCode": "A",
    "responseMessage": "OK3"
  }
}

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 
{
	"paymentId": "F1I17KBL0E",
	"processingTerminalId": "3204001",
	"order": {
		"orderId": "Test_001",
		"dateTime": "2023-05-24T14:44:20.63+01:00",
		"amount": 4000,
		"currency": "USD"
	},
	"card": {
		"type": "Visa Credit",
		"entryMethod": "keyed",
		"cardNumber": "444433******1111",
		"expiryDate": "0334",
		"securityChecks": {
			"cvvResult": "M",
			"avsResult": "Y"
		}
	},
	"paymentResult": {
		"type": "sale",
		"status": "ready",
		"approvalCode": "OK14472",
		"authorizedAmount": 4000,
		"currency": "USD",
		"responseCode": "A",
		"responseMessage": "OK14472"
	}
}