Merchant Management
Create Merchant
POST/v2/merchant/onBoardMerchant

Complete endpoint dedicated to onboarding a brand new merchant profile along with initial baseline configurations.

Header Parameters

Authorization*
string

Body Parameters

merchantData

dba*
string
firstName*
string
lastName
string
email*
string
addressLine1*
string
addressLine2
string
zipCode*
string
phoneNumber*
string
ebt
string
isoAgentReference
string
isoMerchant
string
merchantLogoUrl
string
ISDcode*
string

storeData

mccCode*
string
firstName*
string
lastName
string
dba*
string
addressLine1*
string
addressLine2
string
zipCode*
string
email*
string
phoneNumber*
string
ISDcode*
string
ebt
string

tpnData

deviceManufacturer*
enum
deviceModel*
enum
tpnApplicationSign*
enum
tpnAssignTemplate
string
tpnRoutingType*
enum
defaultLabel
string
tpnBin*
string
processorName*
enum
profileId*
enum
Mid*
string
Agent*
string
Chain*
string
Store*
string
TermNo*
string
TermId*
string
ABA_No
string
Agent_FIID
string
dsGroup
string
POST/v2/merchant/onBoardMerchant
1curl --location 'https://externalapi.ipospays.tech/v2/merchant/onBoardMerchant' \
2--header 'Authorization: ' \
3--header 'Content-Type: application/json' \
4--data '{
5 "merchantData": {
6 "dba": "ABCZ",
7 "firstName": "John",
8 "lastName": "john",
9 "email": "te12st@gmail.com",
10 "addressLine1": "8320 S HARDY DRIVE",
11 "addressLine2": "8320 S HARDY DRIVE",
12 "zipCode": "85284",
13 "phoneNumber": "9898989898",
14 "ebt": "0910991",
15 "isoAgentReference": "123",
16 "isoMerchant": "123",
17 "merchantLogoUrl": "",
18 "ISDcode": "+1"
19 },
20 "storeData": {
21 "mccCode": "0742",
22 "firstName": "John",
23 "lastName": "john",
24 "dba": "ABCZ",
25 "addressLine1": "8320 S HARDY DRIVE",
26 "addressLine2": "8320 S HARDY DRIVE",
27 "zipCode": "85284",
28 "email": "te12st@gmail.com",
29 "phoneNumber": "9898989898",
30 "ISDcode": "+1",
31 "ebt": "0910991"
32 },
33 "tpnData": {
34 "deviceManufacturer": "Cloud POS",
35 "deviceModel": "Cloud POS",
36 "tpnApplicationSign": "CRDT",
37 "tpnAssignTemplate": "",
38 "tpnRoutingType": "SIMPLE",
39 "defaultLabel": "onboardAPI",
40 "tpnBin": "",
41 "tpnProcessor": {
42 "processorName": "TSYS",
43 "profile": [
44 {
45 "profileId": "01",
46 "Mid": "",
47 "Agent": "",
48 "Chain": "",
49 "Store": "5999",
50 "TermNo": "1515",
51 "TermId": "75091651",
52 "ABA_No": "",
53 "Agent_FIID": "",
54 "dsGroup": ""
55 }
56 ]
57 }
58 }
59}'
Response

// Awaiting response…

Sample response
{
  "message": "Merchant onboard successfully",
  "data": {
    "merchantId": "merchId12chr",
    "storeId": "storeId12chr",
    "tpn": "75124668",
    "tpnId": "tpnId12chr"
  }
}