Integrate

Run a card sale

A merchant can use their POS to run card sales.

Integration steps

  • Run a sale.

Before you begin

Bearer tokens

Use our 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.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>'

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}

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.

Run a sale

To run a sale, send a POST request to our Payments endpoint.

Important: This method includes the following functions:

  • Tokenization
  • Pre-authorization
  • Currency conversion
  • Offline processing

We don’t describe how to integrate with these functions in this guide.

Request parameters

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

Request

channelenumRequired
Channel that the merchant used to receive the payment details.
Allowed values:
processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
orderobjectRequired
Object that contains information about the payment.
paymentMethodobjectRequired
Object that contains information about the customer's payment details.
operatorstringOptional>=0 characters<=50 characters
Operator who ran the transaction.
customerobjectOptional
Customer contact and address details.
ipAddressobjectOptional
Object that contains information about the IP address of the device that sent the request.
threeDSecureobjectOptional
Object that contains information for an authentication check on the customer's payment details using the 3-D Secure protocol.
credentialOnFileobjectOptional
Object that contains information about saving the customer’s payment details.
offlineProcessingobjectOptional
Object that contains information about the transaction if the merchant ran it when the terminal was offline.
autoCapturebooleanOptionalDefaults to true
Indicates if we should automatically capture the payment amount. - `true` - Run a sale and automatically capture the transaction. - `false`- Run a pre-authorization and capture the transaction later. **Note:** If you send `false` and the terminal doesn't support pre-authorization, we set the transaction's status to pending. The merchant must capture the transaction to take payment from the customer.
processAsSalebooleanOptionalDefaults to false
Indicates if we should immediately settle the sale transaction. The merchant cannot adjust the transaction if we immediately settle it. **Note:** If the value for **processAsSale** is `true`, the gateway ignores the value in **autoCapture**.
customFieldslist of objectsOptional
Array of customField objects.

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": "pos",
7  "processingTerminalId": "1234001",
8  "order": {
9    "amount": 4999,
10    "currency": "AED",
11    "orderId": "OrderRef6543"
12  },
13  "paymentMethod": {
14    "type": "card",
15    "cardDetails": {
16      "entryMethod": "raw",
17      "device": {
18        "model": "bbposChp",
19        "serialNumber": "1850010868"
20      },
21      "rawData": "A1B2C3D4E5F67890ABCD1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF"
22    }
23  }
24}'

Response fields

If your request is successful, our gateway uses the card details to run a sale. The response contains the following fields:

Response

paymentIdstringRequired=10 characters
Unique identifier that our gateway assigned to the transaction.
processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier of the terminal that initiated the transaction.
orderobjectRequired
Object that contains information about the payment.
cardobjectRequired
Object that contains information about the card.
transactionResultobjectRequired
Object that contains information about the transaction response details.
operatorstringOptional>=0 characters<=50 characters
Operator who initiated the request.
customerobjectOptional
Customer contact and address details.
refundslist of objectsOptional
Array of refundSummary objects. Each object contains information about refunds linked to the transaction.
supportedOperationslist of enumsOptional
Array of operations that you can perform on the transaction. - `capture` - Capture the payment. - `refund` - Refund the payment. - `fullyReverse` - Fully reverse the transaction. - `partiallyReverse` - Partially reverse the payment. - `incrementAuthorization` - Increase the amount of the authorization. - `adjustTip` - Adjust the tip post-payment. - `addSignature` - Add a signature to the payment. - `setAsReady` - Set the transaction’s status to `ready`. - `setAsPending` - Set the transaction’s status to `pending`. - `setAsDeclined` - Set the transaction’s status to `declined`.
customFieldslist of objectsOptional
Array of customField objects.

Example response

Response
1{
2  "paymentId": "M2MJOG6O2Y",
3  "processingTerminalId": "1234001",
4  "order": {
5    "amount": 4999,
6    "currency": "USD",
7    "orderId": "OrderRef6543",
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": "Postman",
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 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}