production
development
https://sit.api.banamex.com/mx-gcgapi/sit
Custom Gateway API Endpoint
Paths
/v1/payments/debit/checking
post /v1/payments/debit/checking
debit-checking-account
To debit an amount from the checking account in system S500
This API is used to debit an amount from the checking account in system S500
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://sit.api.banamex.com/mx-gcgapi/sit/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
Required in header
string
Content-Types that are sent in the request
channelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
dataCenterLocation
Optional in header
string
CSI Data center location number
{
"maxLength": 2
}stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}debitCheckingAccountRequest
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://sit.api.banamex.com/mx-gcgapi/sit/api/v1/payments/debit/checking
Try this operation
Definitions
{
"type": "object",
"properties": {
"stationName": {
"description": "identificador de la estacion (lenght 8)",
"type": "string",
"example": "Y0870A76"
},
"applicationReferenceNumber": {
"description": "Authorization number sent by front end for each transaction",
"type": "string",
"example": "00000001"
},
"dataCenterLocation": {
"description": "customer csi length 2",
"type": "integer",
"example": "10"
},
"idCaja": {
"description": "identificador de caja contable (lenght 1)",
"type": "string",
"example": "A"
},
"numeroCaja": {
"description": "numero de caja contable (length 2)",
"type": "integer",
"example": 70
},
"debitDetailInformation": {
"$ref": "#/definitions/DebitDetailInformation"
},
"account": {
"$ref": "#/definitions/AccountDetails"
}
},
"required": [
"applicationReferenceNumber",
"stationName",
"dataCenterLocation",
"idCaja",
"numeroCaja",
"debitDetailInformation"
]
}
{
"type": "object",
"properties": {
"debitAmount": {
"description": "Debit Amount",
"type": "number",
"format": "double",
"example": 2500
},
"debitReference": {
"description": "Numeric Reference (Length 12)",
"type": "string",
"example": "123456789012"
},
"debitDescription": {
"description": "Legend Alphanumeric (identificador j-16)",
"type": "string",
"example": "OXXO"
}
},
"required": [
"paymentAmount",
"debitReference",
"debitDescription"
]
}
{
"type": "object",
"properties": {
"accountIdentifier": {
"description": "Account Contract",
"type": "string",
"example": "123456789012"
},
"branchId": {
"description": "Origin bank branch Id",
"type": "string",
"example": "9999"
}
},
"required": [
"accountIdentifier",
"branchId"
]
}
{
"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": "URI to human readable documentation or detailed description of the error",
"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"
]
}