Barclaycard APACS Merchant Setup

You can board a Barclaycard APACS merchant via the Gateway Manager or via an API.
Boarding a Merchant via the Gateway Manager
Before boarding a Barclaycard APACS merchant in the Gateway Manager, you must have this information available:
  • Barclaycard merchant ID
  • Terminal IDs: Talk to your account manager to get the terminal IDs activated. 
  • Sort code of settlement account
When you have the required information available, follow these steps to board a merchant:
  1. Open the merchant account in the Gateway Manager.
  2. Select
    Attach processing path
    .
  3. For the Clearing Institute, select
    Barclaycard
    and enter the required data.
  4. To finish the setup, select
    Attach processing path
    .
Boarding a Merchant via the API
Follow these steps to use the API to create a merchant and board that can process payments using Barclaycard.
1. Create a merchant with
Barclaycard
as the processing path.
POST
/v2/merchants/
Try it out!
Request
{ "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" } }
Enter these parameters:
$.name
Specify a unique (internal) name for each merchant that you create.
$.details
For the payment receipts, you must provide this information about the merchant:
  • Public name
  • Address
  • Contact phone number/email address
After successfully creating the merchant, you will receive a
merchantIdentifier
in the response:
Response
{ "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
Try it out!
Request
{ "permissions": ["READER_MANAGEMENT","TRANSACTIONS"] }
You will receive the merchant secret key (
key
) in the response:
Response
{ "status": "ok", "data": { "status": "ACTIVE",
"key": "9pCcTI2mzUbLKoCdezVBowhv0b6gGwoo"
} }
3. Select the card reader you want to assign to the merchant. (Optional)
The platform track all of the card readers that you purchased. In order to assign a reader to the new merchant that 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=999100001
Try it out!
Request
You will receive the
readerIdentifier
in the response:
Response
{ "status": "ok", "data": [{ /*...*/
"identifier": "0665ede3-3990-4c9b-beac-77abfeda5858"
, "model": "MIURA_M010", "details": { "serialNo": "999100001" /*...*/ } }] }
4. Assign the card reader to a new merchant. (Optional)
Based on the
merchantIdentifier
from step 1 above, and the
readerIdentifier
from step 3 above, you can now assign the card reader to the merchant:
put
/v2/merchants/{merchantIdentifier}/readers/{readerIdentifier}
Try it out!
Request