production
development
https://sit.api.banamex.com/mx-gcgapi/sit
Custom Gateway API Endpoint
Paths
/v1/payments/accounts/checks/status/retrieve
post /v1/payments/accounts/checks/status/retrieve
retrieve-check-status-list
To retrieve the status details of the check for the customer
This API is used to retrieve the status details of the check for the customer
Client ID
X-IBM-Client-Id
(apiKey located in header)
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
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
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
SessionId sent by Consumer
retrieveCheckStatusRequest
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/accounts/checks/status/retrieve
Try this operation
Definitions
{
"type": "object",
"properties": {
"accountAccessPrefix": {
"description": "Account access prefix",
"type": "string",
"example": "123456"
},
"accountNumber": {
"description": "Account Number",
"type": "string",
"example": "1234567890123456"
},
"checkNumber": {
"description": "The check number is the unique identification number of the check",
"type": "string",
"example": "1925678"
},
"pageId": {
"description": "Unique identifier of the page for pagination",
"type": "integer",
"format": "int32",
"example": 2
},
"dataCenterLocation ": {
"description": "Location of the data center. Values 10.- Valle and 4.-MTY",
"type": "integer",
"example": 10
}
},
"required": [
"accountAccessPrefix",
"accountNumber",
"checkNumber"
]
}
{
"type": "object",
"properties": {
"accountAccessPrefix": {
"description": "Account access prefix",
"type": "string",
"example": "123456"
},
"accountNumber": {
"description": "Account Number",
"type": "string",
"example": "1234567890123456"
},
"checkNumber": {
"description": "The check number is the unique identification number of the check",
"type": "string",
"example": "1925678"
},
"moreInformationFlag": {
"description": "More Information Flag",
"type": "boolean",
"example": true
},
"pageId": {
"description": "Unique identifier of the page for pagination",
"type": "integer",
"format": "int32",
"example": 2
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/definitions/Transaction"
}
}
},
"required": [
"accountAccessPrefix",
"accountNumber",
"checkNumber"
]
}
{
"type": "object",
"properties": {
"checkAmount": {
"description": "Amount specified in the check for the transaction",
"type": "number",
"format": "double",
"example": 5000.55
},
"finalCheckNumber": {
"description": "Final continuity code id of the check group where the change status was applied",
"type": "string",
"example": "1925685"
},
"finalCheckStatus": {
"description": "Refers to the detail of the final check (cheque) status",
"type": "string",
"example": "Active"
},
"initialCheckNumber": {
"description": "Initial continuity code id of the check group where the change status was applied",
"type": "string",
"example": "1925678"
},
"initialCheckStatus": {
"description": "Refers to the detail of the initial check (cheque) status",
"type": "string",
"example": "Inactive"
},
"transactionTimestamp": {
"description": "Refers to the system date and time when the actual transaction was executed for an account",
"type": "string",
"format": "datetime",
"example": "2019-09-12T03:22:00.000z"
},
"transactionAuthorization": {
"$ref": "#/definitions/TransactionAuthorization"
}
},
"required": [
"checkAmount",
"finalCheckNumber",
"finalCheckStatus",
"initialCheckNumber",
"initialCheckStatus",
"transactionTimestamp"
]
}
{
"type": "object",
"properties": {
"agentId": {
"description": "Id of the operator",
"type": "string",
"example": "123456"
},
"authorizationCode": {
"description": "Authorization Number",
"type": "string",
"example": "123456789"
},
"branchId": {
"description": "Unique identifier of the branch where the transaction was applied",
"type": "integer",
"format": "int32",
"example": 1234
},
"originatingChannelId": {
"description": "Originating Channel Id",
"type": "string",
"example": "123456789012"
}
},
"required": [
"agentId",
"authorizationCode",
"branchId",
"originatingChannelId"
]
}
{
"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"
]
}