production
development
https://sit.api.banamex.com/mx-gcgapi/sit
Custom Gateway API Endpoint
Paths
/v1/payments/schedule/auto/retreive
post /v1/payments/schedule/auto/retreive
retrieve-recurring-payments
Retrieve recurring payments of a Customer
Gets all recurring transactions from Credit Card of a customer
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
CountryCode
Optional in header
string
Country code where the request was made
BusinessCode
Optional in header
string
Code of the business which made the request
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
retrieveRecurringPaymentsRequest
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/schedule/auto/retreive
Try this operation
/v1/payments/schedule/auto
put /v1/payments/schedule/auto
update-recurring-payments
This API updates the status of the recurring payment of a credit card
This API uodates the status of the recurring payment information from ECS
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
CountryCode
Optional in header
string
Country code where the request was made
BusinessCode
Optional in header
string
Code of the business which made the request
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
updateRecurringPaymentRequest
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 |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
PUT https://sit.api.banamex.com/mx-gcgapi/sit/api/v1/payments/schedule/auto
Try this operation
Definitions
{
"type": "object",
"properties": {
"cardNumber": {
"description": "Number of the plastic card",
"type": "string",
"maxLength": 19,
"example": "4332233223233285"
},
"productClasification": {
"description": "Product clasification for plastic card",
"type": "string",
"maxLength": 3,
"example": "32"
},
"customerId": {
"description": "ID of the Customer",
"type": "string",
"maxLength": 19,
"example": "73320983"
},
"requestType": {
"description": "Identify the detail required",
"type": "string",
"maxLength": 1,
"example": "C"
},
"payeeId": {
"description": "Id to identify the payee",
"type": "string",
"example": "33442"
},
"contractId": {
"description": "Id to identify the contract between customer and payee",
"type": "string",
"maxLength": 20,
"example": "333567443"
},
"autoPayStatus": {
"description": "Identify the status of contracts required to be listed",
"type": "string",
"maxLength": 1,
"example": "A"
},
"nextRecords": {
"$ref": "#/definitions/nextRecords"
}
},
"required": [
"cardNumber",
"requestType"
]
}
{
"type": "object",
"properties": {
"totalRecurringPayments": {
"description": "total of recurrent payments retrieved",
"type": "integer",
"format": "int32",
"example": 89
},
"customerId": {
"description": "Customer number for Identification",
"type": "string",
"maxLength": 19,
"example": "39867433389"
},
"cardAccount": {
"$ref": "#/definitions/CardAccount"
},
"nextRecords": {
"$ref": "#/definitions/nextRecords"
}
},
"required": [
"customerId",
"totalRecurringPayments"
]
}
{
"type": "object",
"properties": {
"accountNumber": {
"description": "Number of the Customer's account",
"type": "string",
"maxLength": 19,
"example": "3348889222"
},
"cardNumber": {
"description": "Number of the plastic card",
"type": "string",
"maxLength": 19,
"example": "2334993322137766"
},
"cardStatus": {
"description": "Status of the plastic card",
"type": "string",
"maxLength": 1,
"example": "active"
},
"accountLogoName": {
"description": "Logo description",
"type": "string",
"maxLength": 30,
"example": "active"
},
"autoPayDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/AutoPayDetails"
}
}
},
"required": [
"accountNumber",
"cardNumber",
"cardStatus",
"cardType",
"productClasification"
]
}
{
"type": "object",
"properties": {
"autoPayCancelDate": {
"description": "Date of the last transaction of the recurring payment",
"type": "string",
"format": "date",
"maxLength": 8,
"example": "20180122"
},
"autoPayStartDate": {
"description": "Date when the recurring payment is restarted",
"type": "string",
"format": "date",
"maxLength": 8,
"example": "20181212"
},
"autoPayDate": {
"description": "Date when the recurring payment is recorded",
"type": "string",
"format": "date",
"maxLength": 8,
"example": "20181212"
},
"autoPayStatus": {
"description": "Status of the recurring payment",
"type": "string",
"maxLength": 1,
"example": "Block"
},
"paymentAmount": {
"description": "Total of the amount for paying in the recurring payment",
"type": "number",
"format": "double",
"example": 2220032.22
},
"contractId": {
"description": "Contract or Id of scheduled payment",
"type": "string",
"maxLength": 20,
"example": "9884383"
},
"customerSource": {
"description": "Source from the data was recorded",
"type": "string",
"maxLength": 1,
"example": "M"
},
"suspendedUpdateDaysCount": {
"description": "Number of days is going to be blocked any change for this recurring payment",
"type": "integer",
"format": "int32",
"example": 30
},
"terminationDate": {
"description": "Date when the recurring payment was canceled or blocked",
"type": "string",
"format": "date",
"maxLength": 8,
"example": "20181209"
},
"recurringPaymentBlockedReasonType": {
"description": "Type of recurring payment block, it could be Merchant or Contract ",
"type": "string",
"maxLength": 1,
"example": "M"
},
"folioNumber": {
"description": "Folio number of an operation generated in OneEclipse",
"type": "string",
"maxLength": 16,
"example": "20181209"
},
"payeeDetails": {
"$ref": "#/definitions/PayeeDetails"
}
},
"required": [
"autoPayCancelnDate",
"autoPayStartDate",
"autoPayStatus",
"paymentAmount",
"paymentScheduleId",
"suspendedUpdateDaysCount",
"terminationDate"
]
}
{
"type": "object",
"properties": {
"payeeId": {
"description": "Id number of the merchant",
"type": "string",
"maxLength": 19,
"example": "443255"
},
"payeeName": {
"description": "Name of the merchant",
"type": "string",
"maxLength": 40,
"example": "Empresas Transnacionales S.A. de C.V."
},
"payeeStatus": {
"description": "Status of the merchant",
"type": "string",
"maxLength": 1,
"example": "A"
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/definitions/Transaction"
}
}
},
"required": [
"payeeId",
"payeeName",
"payeeStatus"
]
}
{
"type": "object",
"properties": {
"transactionAmount": {
"description": "Amount of the transaction",
"type": "number",
"format": "double",
"example": 3323.22
},
"transactionDate": {
"description": "Date when the transaction was made",
"type": "string",
"format": "date",
"maxLength": 8,
"example": "20181212"
}
},
"required": [
"transactionAmount",
"transactionDate"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Customer Id from the requester",
"type": "string",
"maxLength": 19,
"example": "4467965668"
},
"autoPay": {
"$ref": "#/definitions/AutoPay"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"suspendedUpdateDate": {
"description": "Next date when the customer can perform action (Block/unlock/reactivation)",
"type": "string",
"format": "Date",
"example": "20181018"
}
}
}
{
"type": "object",
"properties": {
"nextAccountNumberToFetch": {
"description": "Next customer's account number to retrieve",
"type": "string",
"maxLength": 19,
"example": "996774933"
},
"NextPayeeIdToFetch": {
"description": "Next payee Id to retrieve",
"type": "string",
"maxLength": 19,
"example": "5588"
},
"nextContractNumberToFetch": {
"description": "Next contract number to retrieve",
"type": "string",
"maxLength": 20,
"example": "1008933"
}
}
}
{
"type": "object",
"properties": {
"autoPayStatus": {
"description": "Type of update requested",
"type": "string",
"maxLength": 1,
"example": "B"
},
"contractId": {
"description": "Contract or Id of scheduled payment",
"type": "string",
"maxLength": 20,
"example": "9884383"
},
"folioNumber": {
"description": "Folio number of an operation generated in OneEclipse",
"type": "string",
"maxLength": 16,
"example": "20181209"
},
"updateLevel": {
"description": "Level for indicate the type of updating, for CARD, Merchant or Contract Number",
"type": "string",
"maxLength": 1,
"example": "M"
},
"cardPlastic": {
"$ref": "#/definitions/CardPlastic"
},
"payee": {
"$ref": "#/definitions/Payee"
}
},
"required": [
"accountNumber"
]
}
{
"type": "object",
"properties": {
"cardNumber": {
"description": "Number of the plastic card",
"type": "string",
"maxLength": 19,
"example": "3344336643482200"
},
"productClasification": {
"description": "Product clasification for plastic card",
"type": "string",
"maxLength": 3,
"example": "32"
}
},
"required": [
"cardNumber"
]
}
{
"type": "object",
"properties": {
"payeeId": {
"description": "Id number of the payee",
"type": "string",
"maxLength": 19,
"example": "33432"
}
}
}
{
"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"
]
}