Guides
Start typing to search…

Merchant Data API

This API is for the 3DS Requesters to create/update and retrieve the merchants information via API.

API Documentation

Create Merchant

Sample API URL (Demo):
POST /3dssdata/Merchants/{userId}

Request Fields Format and Description

Header

Field NameData TypeExampleDescriptionRequirement
AuthorizationstringBearer xxxxRequiredRequired
Content-Typestringapplication/jsonRequiredRequired

Params

Field NameData TypeLengthExampleDescriptionRequirement
userIdstringuser-test1Unique usernameRequired

Body

Field NameData TypeLengthExampleDescriptionRequirement
acquirerCodestringvarchar(15)“BANKCODE”Unique Bank identifierRequired
acquirerMerchantIdstringvarchar(35)"Merchant001"Merchant unique identifier in acquirer levelRequired
merchantCodestringvarchar(35)"M001"Merchant unique identifier codeRequired
merchantCountryCodestringvarchar(3)"764"Merchant countryRequired
merchantNamestringvarchar(40)"Merchant001"Merchant NameRequired
contactNamestringvarchar(255)"Merchant Main User"Merchant contact personRequired
contactEmailstringvarchar(255)“[email protected]”Merchant contact person emailOptional
contactPhonestringvarchar(15)“+66123456789”Merchant contact person phoneRequired
currencystringvarchar(3)“764”Merchant currency codeRequired
addressstringvarchar(255)“address”Merchant addressOptional
logoPicturestringtext“base64 code”Merchant logo in base 64Optional
alertEmailsstringvarchar(255)“[email protected]”Merchant alert emailOptional
websiteUrlstringvarchar(255)“www.merchant.com”Merchant URLOptional
globalMerchantIdstringint(11)“ ”Global Merchant idOptional
isActivebooltrueMerchant statusOptional
merchantBinsObject[]Merchant Card Scheme level assigned Acquirer BINs and MerchantIdsOptional

Each merchant bin could consist of the following sub fields:

Field NameData TypeExampleDescriptionRequirement
cardSchemeNamestring"VISA"Card scheme's nameOptional
cardschemeMerchantIdstring"123456"Card scheme's merchant idOptional
acquirerCardBinstring"123456"Acquirer card BINOptional
merchantCategoryCodestring3099MCC codeOptional
createdBystringuser-test1UserId which created this merchant and card schemeOptional
modifiedBystringuser-test1Last updated UserId of this merchant and card schemeOptional
createdDatetimetimestamp2022-01-12T06:17:57.637ZCreate Datetime of merchant and card scheme Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'”Optional
modifiedDatetimetimestamp2022-01-12T06:17:59.67ZLast modification datetime of merchant and card scheme Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'”Optional

Request Header

POST /3dssdata/Merchants/{userId} Content-Type: application/json
Authorization: Bearer xxx

Request Body

{
  "acquirerCode": "BANK_CODE",
  "acquirerMerchantId": "Merchant001",
  "merchantCode": "MERCHANT001",
  "merchantCountryCode": "string",
  "merchantName": "MERCHANT001",
  "contactName": "Merchant",
  "contactEmail": "[email protected]",
  "contactPhone": "+66123456789",
  "currency": "764",
  "address": "124 Bkk",
  "logoPicture": "23xxpfdfdfdfdf",
  "alertEmails": "[email protected]",
  "websiteUrl": " www.merchant.com ",
  "globalMerchantId": 0,
  "isActive": true,
  "merchantBins": [
    {
      "cardSchemeName": "string",
      "merchantCategoryCode": "string",
      "cardschemeMerchantId": "string",
      "acquirerCardBin": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "createdDatetime": "2022-10-25T01:46:17.861Z",
      "modifiedDatetime": "2022-10-25T01:46:17.861Z"
    }
  ]
}

Response Fields Format and Description

Field NameData TypeLengthExampleDescriptionRequirement
idstring“user-test1”Unique usernameRequired
acquirerCodestringvarchar(15)“BANKCODE”Unique Bank identifierRequired
acquirerMerchantIdstringvarchar(35)"Merchant001"Merchant unique identifier in acquirer levelRequired
merchantCodestringvarchar(35)"M001"Merchant unique identifier codeRequired
merchantCountryCodestringvarchar(3)"764"Merchant countryRequired
merchantNamestringvarchar(40)"Merchant001"Merchant NameRequired
contactNamestringvarchar(255)"Merchant Main User"Merchant contact personRequired
contactEmailstringvarchar(255)“[email protected]”Merchant contact person emailOptional
contactPhonestringvarchar(15)“+66123456789”Merchant contact person phoneRequired
currencystringvarchar(3)“764”Merchant currency codeRequired
addressstringvarchar(255)“address”Merchant addressOptional
logoPicturestringtext“base64 code”Merchant logo in base 64Optional
alertEmailsstringvarchar(255)“[email protected]”Merchant alert emailOptional
websiteUrlstringvarchar(255)“www.merchant.com”Merchant URLOptional
isActivebooltrueMerchant statusOptional
merchantBinsObject[]Merchant Card Scheme level assigned Acquirer BINs and MerchantIdsOptional

Each merchant bin could consist of the following sub-fields:

Field NameData TypeExampleDescriptionRequirement
idstring"11"Unique merchant and card scheme idOptional
cardSchemeNamestring"VISA"Card scheme's nameOptional
cardschemeMerchantIdstring"123456"Card scheme's merchant idOptional
acquirerCardBinstring"123456"Acquirer card BINOptional
merchantCategoryCodestring3099MCC codeOptional
createdBystringuser-test1UserId which created this merchant and card schemeOptional
modifiedBystringuser-test1Last updated UserId of this merchant and card schemeOptional
createdDatetimetimestamp2022-01-12T06:17:57.637ZCreate Datetime of merchant and card scheme Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'”Optional
modifiedDatetimetimestamp2022-01-12T06:17:59.67ZLast modification datetime of merchant and card scheme Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'”Optional

Response Body

{
  "id": 150,
  "acquirerMerchantId": "string",
  "merchantCountryCode": "804",
  "merchantName": "Juicy Grasp Ltd",
  "contactName": "Pavlo Ter",
  "contactEmail": "[email protected]",
  "contactPhone": "+380000000000",
  "isActive": true,
  "currency": "980",
  "address": "Lviv, Naukova Str.",
  "createdBy": "Pavlo",
  "modifiedBy": "Pavlo",
  "createdDatetime": "2022-10-25T11:50:13.537606Z",
  "modifiedDatetime": "2022-10-25T11:55:40.9010925Z",
  "alertEmails": "[email protected]",
  "websiteUrl": "https://www.google.com/",
  "merchantCode": "JGRASP",
  "acquirerCode": "2C2PPLUS",
  "merchantBins": [
    {
      "id": 149,
      "cardSchemeName": "VISA",
      "merchantCategoryCode": "0742",
      "cardschemeMerchantId": "Juicy Grasp 0040",
      "acquirerCardBin": "411111",
      "createdBy": "Pavlo",
      "modifiedBy": "Pavlo",
      "createdDatetime": "2022-10-25T11:50:13.716934Z",
      "modifiedDatetime": "2022-10-25T11:50:13.716958Z"
    },
    {
      "id": 150,
      "cardSchemeName": "MASTERCARD",
      "merchantCategoryCode": "0742",
      "cardschemeMerchantId": "Juicy Grasp 0040",
      "acquirerCardBin": "511111",
      "createdBy": "Pavlo",
      "modifiedBy": "Pavlo",
      "createdDatetime": "2022-10-25T11:50:13.73032Z",
      "modifiedDatetime": "2022-10-25T11:50:13.73032Z"
    }
  ]
}

Merchant Retreive API

Sample API URL (Demo):
GET /3dssdata/Merchants/{userId}

Request Fields Format and Description

Header

Field NameData TypeExampleDescriptionRequirement
AuthorizationstringBearer xxxxRequiredRequired
Content-Typestringapplication/jsonRequiredRequired

Params

Field NameData TypeLengthExampleDescriptionRequirement
userIdstring“user-test1”Unique usernameRequired

Request Header

GET /3dssdata/Merchants/{userId} Content-Type: application/json
Authorization: Bearer xxx

Response Fields Format and Description

Field Name Data Type Length Example Description Requirement

id

string

“user-test1”

Unique username

Required

acquirerCode

string

varchar(15)

“BANKCODE”

Unique Bank identifier

Required

acquirerMerchantId

string

varchar(35)

"Merchant001"

Merchant unique identifier in acquirer level

Required

merchantCode

string

varchar(35)

"M001"

Merchant unique identifier code

Required

merchantCountryCode

string

varchar(3)

"764"

Merchant country

Required

merchantName

string

varchar(40)

"Merchant001"

Merchant Name

Required

contactName

string

varchar(255)

"Merchant Main User"

Merchant contact person

Required

contactEmail

string

varchar(255)

“[email protected]”

Merchant contact person email

Optional

contactPhone

string

varchar(15)

“+66123456789”

Merchant contact person phone

Required

currency

string

varchar(3)

“764”

Merchant currency code

Required

address

string

varchar(255)

“address”

Merchant address

Optional

logoPicture

string

text

“base64 code”

Merchant logo in base 64

Optional

alertEmails

string

varchar(255)

“[email protected]”

Merchant alert email

Optional

websiteUrl

string

varchar(255)

“www.merchant.com”

Merchant URL

Optional

globalMerchantId

string

int(11)

12345678901

Global Merchant id

Optional

isActive

bool

true

Merchant status

Optional

createdBy

string

varchar(40)

"user-test1"

UserId which created this merchant

Optional

modifiedBy

string

varchar(40)

"user-test1"

Last updated UserId of this merchant

Optional

createdDatetime

timestamp

datetime

2022-01-12T06:17:57.637Z

Create Datetime of merchant
Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'

Optional

modifiedDatetime

timestamp

datetime

2022-01-12T06:17:57.637Z

Last modification datetime of merchant
Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'”

Optional

merchantBins

Object

[]

Merchant Card Scheme level assigned Acquirer BINs and MerchantIds

Optional

Each merchant bin could consist of the following sub-fields:

Field NameData TypeExampleDescriptionRequirement
idstring"11"Unique merchant and card scheme idOptional
cardSchemeNamestring"VISA"Card scheme's nameOptional
cardschemeMerchantIdstring"123456"Card scheme's merchant idOptional
acquirerCardBinstring"123456"Acquirer card BINOptional
merchantCategoryCodestring3099MCC codeOptional
createdBystringuser-test1UserId which created this merchant and card schemeOptional
modifiedBystringuser-test1Last updated UserId of this merchant and card schemeOptional
createdDatetimetimestamp2022-01-12T06:17:57.637ZCreate Datetime of merchant and card scheme Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'”Optional
modifiedDatetimetimestamp2022-01-12T06:17:59.67ZLast modification datetime of merchant and card scheme Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'”Optional

Response Body

{
  "id": 150,
  "acquirerMerchantId": "string",
  "merchantCountryCode": "804",
  "merchantName": "Juicy Grasp Ltd",
  "contactName": "Pavlo Ter",
  "contactEmail": "[email protected]",
  "contactPhone": "+380000000000",
  "isActive": true,
  "currency": "980",
  "address": "Lviv, Naukova Str.",
  "createdBy": "Pavlo",
  "modifiedBy": "Pavlo",
  "createdDatetime": "2022-10-25T11:50:13.537606Z",
  "modifiedDatetime": "2022-10-25T11:55:40.9010925Z",
  "alertEmails": "[email protected]",
  "websiteUrl": "https://www.google.com/",
  "merchantCode": "JGRASP",
  "acquirerCode": "2C2PPLUS",
  "merchantBins": [
    {
      "id": 149,
      "cardSchemeName": "VISA",
      "merchantCategoryCode": "0742",
      "cardschemeMerchantId": "Juicy Grasp 0040",
      "acquirerCardBin": "411111",
      "createdBy": "Pavlo",
      "modifiedBy": "Pavlo",
      "createdDatetime": "2022-10-25T11:50:13.716934Z",
      "modifiedDatetime": "2022-10-25T11:50:13.716958Z"
    },
    {
      "id": 150,
      "cardSchemeName": "MASTERCARD",
      "merchantCategoryCode": "0742",
      "cardschemeMerchantId": "Juicy Grasp 0040",
      "acquirerCardBin": "511111",
      "createdBy": "Pavlo",
      "modifiedBy": "Pavlo",
      "createdDatetime": "2022-10-25T11:50:13.73032Z",
      "modifiedDatetime": "2022-10-25T11:50:13.73032Z"
    }
  ]
}

Merchant Update API

Sample API URL (Demo):
PATCH /3dssdata/Merchants/{userId}?merchantId={merchantId}

Request Fields Format and Description

Header

Field NameData TypeExampleDescriptionRequirement
AuthorizationstringBearer xxxxRequiredRequired
Content-Typestringapplication/jsonRequiredRequired

Params

Field NameData TypeLengthExampleDescriptionRequirement
userIdstringuser-test1Unique usernameRequired

Query

Field NameData TypeLengthExampleDescriptionRequirement
merchantIdstring11Unique merchant idRequired

Body

Field NameData TypeLengthExampleDescriptionRequirement
acquirerCodestringvarchar(15)“BANKCODE”Unique Bank identifierRequired
acquirerMerchantIdstringvarchar(35)"Merchant001"Merchant unique identifier in acquirer levelRequired
merchantCodestringvarchar(35)"M001"Merchant unique identifier codeRequired
merchantCountryCodestringvarchar(3)"764"Merchant countryRequired
merchantNamestringvarchar(40)"Merchant001"Merchant NameRequired
contactNamestringvarchar(255)"Merchant Main User"Merchant contact personRequired
contactEmailstringvarchar(255)“[email protected]”Merchant contact person emailOptional
contactPhonestringvarchar(15)“+66123456789”Merchant contact person phoneRequired
currencystringvarchar(3)“764”Merchant currency codeRequired
addressstringvarchar(255)“address”Merchant addressOptional
logoPicturestringtext“base64 code”Merchant logo in base 64Optional
alertEmailsstringvarchar(255)“[email protected]”Merchant alert emailOptional
websiteUrlstringvarchar(255)“www.merchant.com”Merchant URLOptional
globalMerchantIdstringint(11)“ ”Global Merchant idOptional
isActivebooltrueMerchant statusOptional
merchantBinsObject[]Merchant Card Scheme level assigned Acquirer BINs and MerchantIdsOptional

Each merchant bin could consist of the following sub fields:

Field NameData TypeExampleDescriptionRequirement
idstring"11"Unique merchant and card scheme idOptional
cardSchemeNamestring"VISA"Card scheme's nameOptional
cardschemeMerchantIdstring"123456"Card scheme's merchant idOptional
acquirerCardBinstring"123456"Acquirer card BINOptional
merchantCategoryCodestring3099MCC codeOptional
createdBystringuser-test1UserId which created this merchant and card schemeOptional
modifiedBystringuser-test1Last updated UserId of this merchant and card schemeOptional
createdDatetimetimestamp2022-01-12T06:17:57.637ZCreate Datetime of merchant and card scheme Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'”Optional
modifiedDatetimetimestamp2022-01-12T06:17:59.67ZLast modification datetime of merchant and card scheme Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'”Optional

Request Header

PATCH /3dssdata/Merchants/{userId}?merchantId={merchantId} Content-Type: application/json
Authorization: Bearer xxx

Request Body

{
  "acquirerCode": "BANK_CODE",
  "acquirerMerchantId": "Merchant001",
  "merchantCode": "MERCHANT001",
  "merchantCountryCode": "string",
  "merchantName": "MERCHANT001",
  "contactName": "Merchant",
  "contactEmail": "[email protected]",
  "contactPhone": "+66123456789",
  "currency": "764",
  "address": "124 Bkk",
  "logoPicture": "23xxpfdfdfdfdf",
  "alertEmails": "[email protected]",
  "websiteUrl": " www.merchant.com ",
  "globalMerchantId": 0,
  "isActive": true,
  "merchantBins": [
    {
      "id": 0,
      "cardSchemeName": "string",
      "merchantCategoryCode": "string",
      "cardschemeMerchantId": "string",
      "acquirerCardBin": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "createdDatetime": "2022-10-25T01:46:17.861Z",
      "modifiedDatetime": "2022-10-25T01:46:17.861Z"
    }
  ]
}

Response Fields Format and Description

Field NameData TypeLengthExampleDescriptionRequirement
idstring“user-test1”Unique usernameRequired
acquirerCodestringvarchar(15)“BANKCODE”Unique Bank identifierRequired
acquirerMerchantIdstringvarchar(35)"Merchant001"Merchant unique identifier in acquirer levelRequired
merchantCodestringvarchar(35)"M001"Merchant unique identifier codeRequired
merchantCountryCodestringvarchar(3)"764"Merchant countryRequired
merchantNamestringvarchar(40)"Merchant001"Merchant NameRequired
contactNamestringvarchar(255)"Merchant Main User"Merchant contact personRequired
contactEmailstringvarchar(255)“[email protected]”Merchant contact person emailOptional
contactPhonestringvarchar(15)“+66123456789”Merchant contact person phoneRequired
currencystringvarchar(3)“764”Merchant currency codeRequired
addressstringvarchar(255)“address”Merchant addressOptional
logoPicturestringtext“base64 code”Merchant logo in base 64Optional
alertEmailsstringvarchar(255)“[email protected]”Merchant alert emailOptional
websiteUrlstringvarchar(255)“www.merchant.com”Merchant URLOptional
isActivebooltrueMerchant statusOptional
merchantBinsObject[]Merchant Card Scheme level assigned Acquirer BINs and MerchantIdsOptional

Each merchant bin could consist of the following sub-fields:

Field NameData TypeExampleDescriptionRequirement
idstring"11"Unique merchant and card scheme idOptional
cardSchemeNamestring"VISA"Card scheme's nameOptional
cardschemeMerchantIdstring"123456"Card scheme's merchant idOptional
acquirerCardBinstring"123456"Acquirer card BINOptional
merchantCategoryCodestring3099MCC codeOptional
createdBystringuser-test1UserId which created this merchant and card schemeOptional
modifiedBystringuser-test1Last updated UserId of this merchant and card schemeOptional
createdDatetimetimestamp2022-01-12T06:17:57.637ZCreate Datetime of merchant and card scheme Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'”Optional
modifiedDatetimetimestamp2022-01-12T06:17:59.67ZLast modification datetime of merchant and card scheme Date format is “yyyy-MM-dd'T'hh:mm:ss.SS'Z'”Optional

Response Body

{
  "id": 150,
  "acquirerMerchantId": "string",
  "merchantCountryCode": "804",
  "merchantName": "Juicy Grasp Ltd",
  "contactName": "Pavlo Ter",
  "contactEmail": "[email protected]",
  "contactPhone": "+380000000000",
  "isActive": true,
  "currency": "980",
  "address": "Lviv, Naukova Str.",
  "createdBy": "Pavlo",
  "modifiedBy": "Pavlo",
  "createdDatetime": "2022-10-25T11:50:13.537606Z",
  "modifiedDatetime": "2022-10-25T11:55:40.9010925Z",
  "alertEmails": "[email protected]",
  "websiteUrl": "https://www.google.com/",
  "merchantCode": "JGRASP",
  "acquirerCode": "2C2PPLUS",
  "merchantBins": [
    {
      "id": 149,
      "cardSchemeName": "VISA",
      "merchantCategoryCode": "0742",
      "cardschemeMerchantId": "Juicy Grasp 0040",
      "acquirerCardBin": "411111",
      "createdBy": "Pavlo",
      "modifiedBy": "Pavlo",
      "createdDatetime": "2022-10-25T11:50:13.716934Z",
      "modifiedDatetime": "2022-10-25T11:50:13.716958Z"
    },
    {
      "id": 150,
      "cardSchemeName": "MASTERCARD",
      "merchantCategoryCode": "0742",
      "cardschemeMerchantId": "Juicy Grasp 0040",
      "acquirerCardBin": "511111",
      "createdBy": "Pavlo",
      "modifiedBy": "Pavlo",
      "createdDatetime": "2022-10-25T11:50:13.73032Z",
      "modifiedDatetime": "2022-10-25T11:50:13.73032Z"
    }
  ]
}

Updated 9 months ago