production
development
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
Paths
/v1/servicing/customers/merchants/retrieve
get /v1/servicing/customers/merchants/retrieve
retrieve-customer-merchants
To obtain all previously registered merchants for a customer so he can perform a payment
This API is used to obtain all previously registered merchants for a customer so he can perform a payment
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Optional in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Content-Types that are sent in the request2 character ISO country code
{
"default": "MX"
}businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
accountType
Optional in query
string
Type of the account
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
GET https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/customers/merchants/retrieve
/v1/servicing/customers/merchants/info/{merchantTableReferenceId}
get /v1/servicing/customers/merchants/info/{merchantTableReferenceId}
merchant-info
To retrieve the information of one specific merchant
This API is used to retrieve the information of one specific merchant
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Optional in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Content-Types that are sent in the request2 character ISO country code
{
"default": "MX"
}businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
merchantTableReferenceId
Required in path
string
Service Database Identifier
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
GET https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/customers/merchants/info/{merchantTableReferenceId}
Definitions
{
"type": "object",
"properties": {
"merchants": {
"type": "array",
"items": {
"$ref": "#/definitions/Merchant"
}
}
}
}
{
"type": "object",
"properties": {
"merchantId": {
"description": "Unique identifier of a company which provides a product or service (merchant)",
"type": "string",
"example": "117418"
},
"merchantCategoryCode": {
"description": "Line of business or activity of the merchant",
"type": "string",
"example": "1174"
},
"merchantBusinessName": {
"description": "Legal name of the merchant under which it performs their business",
"type": "string",
"example": "Teléfonos de México, S. A. B. de C. V."
},
"merchantNickName": {
"description": "Nick Name of Merchant, given by customer for easier recognition",
"type": "string",
"example": "Teléfono"
},
"transactionLimitAmount": {
"description": "Any transaction amount limit fixed for any payee.",
"type": "number",
"format": "double",
"example": 1234.56
},
"currencyCode": {
"description": "The currency code identifier of the account",
"type": "integer",
"format": "int32",
"example": 1
},
"currencyCodeDescription": {
"description": "Currency Code of the account",
"type": "string",
"example": "MXN"
},
"merchantServiceInformation": {
"type": "array",
"items": {
"$ref": "#/definitions/MerchantServiceInformation"
}
}
},
"required": [
"merchantBusinessName",
"merchantCategoryCode",
"merchantNickName",
"transactionLimitAmount",
"merchantServiceInformation",
"currencyCode"
]
}
{
"type": "object",
"properties": {
"merchantSubCategory": {
"description": "Identifier of the service provided by the merchant",
"type": "string",
"example": "18"
},
"merchantName": {
"description": "Name of the merchant",
"type": "string",
"example": "Telmex"
},
"merchantTableReferenceId": {
"description": "Service Database Identifier",
"type": "string",
"example": "1000:084"
}
},
"required": [
"merchantSubCategory",
"merchantName",
"merchantTableReferenceId"
]
}
{
"type": "object",
"properties": {
"merchantId": {
"description": "Unique identifier of a company which provides a product or service (merchant)",
"type": "string",
"example": "117418"
},
"captureLineType": {
"description": "Type of the capture line",
"type": "string",
"example": "3"
},
"captureLineAccessType": {
"description": "Type of the access of the capture line",
"type": "string",
"example": "1"
},
"imageName": {
"description": "Name of the image, used to help icon",
"type": "string",
"example": "117418"
},
"multiplePaymentCode": {
"description": "Code to identify if the payment can be do it one or more times. Values A) more than one B) once",
"type": "string",
"example": "A"
},
"modifyAmountFlag": {
"description": "Flag to indicate if the amount could be modified or not",
"type": "boolean",
"example": false
},
"paymentOperationType": {
"description": "Type of the payment operation, to identify if is going to use DB with capture line or with web services",
"type": "string",
"example": "1"
},
"paymentOperationSubType": {
"description": "Subtype of the payment operation, if the payment is going to use web services, identify if is going to be direct or in group",
"type": "string",
"example": "1"
},
"paymentConfiguration": {
"type": "array",
"items": {
"$ref": "#/definitions/PaymentConfiguration"
}
}
},
"required": [
"paymentConfiguration",
"merchantId",
"captureLineType",
"captureLineAccessType"
]
}
{
"type": "object",
"properties": {
"referenceId": {
"description": "Unique ID used by front-end to identify the input of the payment reference",
"type": "integer",
"format": "int32",
"example": 77
},
"referenceLabel": {
"description": "Label and placeholder to the input of the form of the reference field",
"type": "string",
"example": "LINEA CAPTURA"
},
"referenceMaximumLength": {
"description": "Max length of the input of the form of the reference field",
"type": "integer",
"format": "int32",
"example": 20
},
"referenceMinimumLength": {
"description": "Min length of the input of the form of the reference field",
"type": "integer",
"format": "int32",
"example": 2
},
"referenceType": {
"description": "Data Type of the reference field",
"type": "string",
"example": "N"
}
},
"required": [
"referenceId",
"referenceLabel",
"referenceType",
"referenceMaximumLength"
]
}
{
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "More Info can be used to pass any additional details",
"type": "string"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}