production
development
https://sit.api.banamex.com/mx-gcgapi/sit
Custom Gateway API Endpoint
Paths
/v1/payments/schedule
post /v1/payments/schedule
SchedulePayment
Schedule a Credit Card payment with external account
This API is used to Schedule a Credit Card Payment with an External Account
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)
Accept
Required in header
string
Content-Types that are acceptable for the response
Accept-Language
Optional in header
string
List of acceptable human languages for response
Authorization
Required in header
string
The Authorization Token recieved during login
client_id
Required in header
string
Client ID generated during application registration
{
"default": "29738e5a-fbbf-4b55-981d-d2f3d2a60605"
}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
uuid
Required in header
string
128 bit UUID that you generate for every request
schedulePaymentRequest
Required in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidCard | Card not found or invalid |
| invalid | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
Example Request
Example Response
POST https://sit.api.banamex.com/mx-gcgapi/sit/api/v1/payments/schedule
Try this operation
Definitions
{
"type": "object",
"properties": {
"customerId": {
"description": "Customer ID is a key associated with a specific entity or person Citi does business or has some relationship with",
"type": "string",
"example": "3399874442"
},
"customerName": {
"description": "Name of the customer",
"type": "string",
"example": "Hugo Martinez"
},
"account": {
"$ref": "#/definitions/account"
}
},
"required": [
"customerId",
"customerName"
]
}
{
"type": "object",
"properties": {
"accountAliasId": {
"description": "Clave Bancaria Estandarizada(CLABE) Id",
"type": "string",
"example": "12345"
},
"accountNumber": {
"description": "Source Account Number.",
"type": "string",
"example": "1234567890"
},
"paymentDetail": {
"$ref": "#/definitions/paymentDetail"
}
},
"required": [
"accountNumber",
"paymentDetail"
]
}
{
"type": "object",
"properties": {
"paymentAmount": {
"description": "The amount to pay.",
"type": "number",
"format": "double",
"example": 35000
},
"paymentDate": {
"description": "The payment date",
"type": "string",
"example": "2017-03-31"
}
},
"required": [
"paymentAmount",
"paymentDate"
]
}
{
"type": "object",
"properties": {
"notificationStatus": {
"description": "Indicates if notification was sent",
"type": "boolean",
"example": true
},
"displayAccountAlias": {
"description": "Clave Bancaria Estandarizada(CLABE) enmascarada",
"type": "string",
"example": "5213"
},
"bankId": {
"description": "Unique ID of the bank",
"type": "integer",
"example": 9
},
"bankName": {
"description": "Name of the bank",
"type": "string",
"example": "Banco Inbursa, SA"
},
"payeeName": {
"description": "Nick name of the account as defined by the user",
"type": "string",
"example": "My CLABE Account"
},
"accountInformation": {
"$ref": "#/definitions/accountInformation"
}
}
}
{
"type": "object",
"properties": {
"accountNumber": {
"description": "Account Number.",
"type": "string",
"example": "1234567"
},
"paymentInformation": {
"$ref": "#/definitions/paymentInformation"
}
},
"required": [
"accountNumber"
]
}
{
"type": "object",
"properties": {
"paymentAmount": {
"description": "The amount to pay.",
"type": "number",
"format": "double",
"example": 3500
},
"paymentDate": {
"description": "The payment date",
"type": "string",
"example": "2017-03-31"
},
"referenceNumber": {
"description": "The reference Number for this payment",
"type": "string",
"example": "123456"
}
},
"required": [
"paymentAmount",
"paymentDate",
"referenceNumber",
"sourceAccountDetail"
]
}
{
"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 of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}