production
development
https://sit.api.banamex.com/mx-gcgapi/sit
Custom Gateway API Endpoint
Paths
/v1/payments/codi-banxico/transactions-data/info
post /v1/payments/codi-banxico/transactions-data/info
save-codi-transaction-data-info
LOB: Traditional Payments, Feature: Codi Transactions, Functionality: Save the information.
This API is used for save the information of transactions made in CoDi: B2B, SPEI and refunds.
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
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
saveCodiTransactionDataRequest
Optional in body
object
204
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/codi-banxico/transactions-data/info
Try this operation
Definitions
{
"type": "object",
"properties": {
"transaction": {
"$ref": "#/definitions/Transaction"
},
"operation": {
"$ref": "#/definitions/Operation"
}
},
"required": [
"transaction",
"operation"
]
}
{
"type": "object",
"properties": {
"responseOperationCode": {
"description": "Response code of the transaction already processed in Banxico.",
"type": "integer",
"format": "int32",
"example": 200
},
"responseOperationDescription": {
"description": "Description response code of the transaction already processed in Banxico",
"type": "string",
"example": "OK"
}
},
"required": [
"responseOperationCode",
"responseOperationDescription"
]
}
{
"type": "object",
"properties": {
"transactionDate": {
"description": "Refers to the system date when the actual transaction was executed for an account.",
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"tokenType": {
"description": "The type of token requested for this digitization.",
"type": "string",
"example": "Hardtoken"
},
"codiTransactionId": {
"description": "Transaction CODI ID refers to an identifier or code which uniquely identifies.",
"type": "string",
"example": "12345678"
},
"paymentTypeCode": {
"description": "This attrbute indicates the payment type associated with the transaction",
"type": "string",
"example": "19"
},
"transactionType": {
"description": "Refers to the type of transaction.",
"type": "string",
"example": "Payment B2B"
}
},
"required": [
"transactionDate",
"tokenType",
"codiTransactionId",
"paymentTypeCode",
"transactionType"
]
}
{
"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"
]
}