There are two options for boarding a Barclaycard APACS
merchant: via the Gateway Manager and via the API.
Boarding via the
Gateway Manager
To board a Barclaycard APACS merchant in the Gateway Manager, you will need the
following information:
Barclaycard Merchant ID
Terminal ID(s):
can be used. Talk to your Payworks account manager to get the terminal
ID(s) activated.
Sort Code of settlement account
Once you have the above information, open the merchant in the Gateway
Manager and select Attach processing path.
Select Barclaycard as Clearing Institute and enter the data.
To finish setup, select Attach processing path.
1. Create a Merchant with a Barclaycard processing
path.
{
"processingPaths": [{
"currencies": ["GBP"],
"schemes": ["VISA", "MAESTRO", "VISAELECTRON", "MASTER"],
"details": {
"institute": "BARCLAYCARD",
"country": "GB",
"sortCode": "123456",
"merchantId": "123456",
"terminalIds": ["31969999"]
},
"name": "Default processing",
"active": true
}],
"name": "Test Merchant",
"readers": [],
"details": {
"publicName": "Barclaycard Sample",
"address": "Street 1",
"zip": "123456",
"city": "London",
"country": "GB",
"contact": "+44 123 456 789",
"additionalInformation": "VAT Number: 123456"
}
}
Pay attention to those parameters:
$.name
Specify a unique (internal) name for each merchant that you
create.
$.details
For the payment receipts, you need to provide some information
about the merchant, including
Public Name, Address and a
Contact Phone Number/Email Address
.
You will receive a
merchantIdentifier
after successfully
creating the merchant:
{
"status": "ok",
"data": {
/*...*/
"identifier": "74b47dcd-45b0-4c65-a4d1-afd4aae32708"
,
"name": "Test Merchant"
/*...*/
}
}
2. Generate the Merchant Secret Key for the Merchant via the API.
post
/v2/merchants/{merchantIdentifier}/secretKey
Request
{
"permissions": ["READER_MANAGEMENT","TRANSACTIONS"]
}
You will receive the Merchant Secret Key in the response:
{
"status": "ok",
"data": {
"status": "ACTIVE",
"key": "9pCcTI2mzUbLKoCdezVBowhv0b6gGwoo"
}
}
3. (Optional) Select the card reader you want to assign to the merchant.
The platform keeps track of all the card readers that you purchased. In order to
assign a reader to the new merchant you created in Step 1 above, you must know the
card reader's
readerIdentifier
. Use this API to find the
readerIdentifier
of a reader based on its serial number
(e.g., 999-100001):
get
/v2/readers/?search=999-100001
Request
You will receive the
readerIdentifier
in the response:
{
"status": "ok",
"data": [{
/*...*/
"identifier": "0665ede3-3990-4c9b-beac-77abfeda5858"
,
"model": "MIURA_M010",
"details": {
"serialNo": "999100001"
/*...*/
}
}]
}
4. (Optional) Assign the card reader to a new merchant.
Based on the
merchantIdentifier
from Step 1 above, and the
readerIdentifier
from Step 3 above, you can now assign the
reader to the merchant:
put
/v2/merchants/{merchantIdentifier}/readers/{readerIdentifier}
Try it out!
Request