production
development
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
Paths
/v1/servicing/payments/customers/services/retrieve
post /v1/servicing/payments/customers/services/retrieve
retrieve-payment-service-information
With some payment file information, several apis of the customer domain are consulted for retriving services information.
Retrieve information of payment services witch contains informations of charge account, customer data and the representatives which sends the file. The api consulting various APIs in the client's domain.
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
ClientID
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
Required in header
string
Content-Types that are sent in the request
countryCode
Optional in header
string
Country code in 2 character ISO 3166 format
businesscode
Optional 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
PaymentServiceInformation
Optional in body
object
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
POST https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/payments/customers/services/retrieve
/v1/servicing/payments/customers/services/validate
post /v1/servicing/payments/customers/services/validate
payment-service-validation
This api consults a catalog of products in payments doman checking that the product sent is activated for the customer
A product catalog of the payment domain is consulted, in order to verify if the service is activated to confirm if the client can send payroll files, returning for this case an Http200 code Ok, and otherwise an error with code Http 422
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
ClientID
X-IBM-Client-Id
(apiKey located in header)
client_id
Optional in header
string
Client ID generated during application registration
Authorization
Optional 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
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businesscode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
SessionId sent by Consumer
PaymentServiceValidationRequest
Optional in body
object
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
POST https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/payments/customers/services/validate
Definitions
{
"type": "object",
"properties": {
"accountNumber": {
"description": "Customer's Account Number with the Bank.",
"type": "string",
"example": "12345678901",
"maxLength": 11
},
"customerId": {
"description": "CitiBanamex internal customer identifier.",
"type": "string",
"example": "123456789012",
"minLength": 1,
"maxLength": 12,
"pattern": "^[0-9]{1,12}"
},
"dataCenterLocation": {
"description": "this field indicates data center location, where the infomation is processed.",
"type": "string",
"example": "12",
"maxLength": 2
},
"authorizationIndicator": {
"description": "Indicator to identify if the file needs a remote authorization of the representative 2. It will happen in different moment",
"type": "integer",
"format": "int32",
"example": 1
},
"makerLegalRepresentativeId": {
"description": "this is the Id of representant/customer who sends the file.",
"type": "string",
"example": "12",
"maxLength": 2,
"default": "00"
},
"checkerLegalRepresentativeId": {
"description": "this is the Id of representant who autorize sends the file.",
"type": "string",
"example": "12",
"maxLength": 2,
"default": "00"
},
"totalPaymentAmount": {
"description": "the total payment amount.",
"type": "number",
"format": "double",
"example": 1000.8
},
"serviceSubType": {
"description": "this field refers to the nature of the file, with which the file is categorized in the payment domain.",
"type": "string",
"example": "05",
"maxLength": 2,
"pattern": "^[0-9]*$"
}
},
"required": [
"accountNumber",
"customerId",
"dataCenterLocation",
"authorizationIndicator",
"makerLegalRepresentativeId",
"checkerLegalRepresentativeId",
"totalPaymentAmount",
"serviceSubType"
]
}
{
"type": "object",
"properties": {
"acoount": {
"$ref": "#/definitions/Account"
},
"service": {
"$ref": "#/definitions/Service"
},
"fullName": {
"description": "Client name",
"type": "string",
"example": "Juan Perez"
}
}
}
{
"type": "object",
"properties": {
"productCode": {
"description": "Unique code that identifies the product",
"type": "string",
"example": "1234"
},
"productInstrument": {
"description": "This is the instrument number",
"type": "string",
"example": "1234"
}
}
}
{
"type": "object",
"properties": {
"contractNumber": {
"description": "contract number for client",
"type": "string",
"example": "123456789012"
},
"branchId": {
"description": "Is the branch office for the account",
"type": "string",
"example": "12"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "CitiBanamex internal customer identifier",
"type": "string",
"example": "668450123",
"maxLength": 12,
"pattern": "^[0-9]*$"
},
"serviceSubType": {
"description": "this field refers to the nature of the file, with which the file is categorized in the payment domain.",
"type": "string",
"example": "05",
"maxLength": 2,
"pattern": "^[0-9]*$"
}
},
"required": [
"customerId",
"serviceSubType"
]
}
{
"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"
]
}