production
development
https://sit.api.banamex.com/mx-gcgapi/sit
Custom Gateway API Endpoint
Paths
/v1/payments/accounts/payees/external/{customerId}/{accountAliasId}
get /v1/payments/accounts/payees/external/{customerId}/{accountAliasId}
retrieve-external-accounts
Retrieve an external account for Pull Payments
Retrieve an external account for Pull Payments
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
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
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
customerId
Required in path
integer
Customer ID is a key associated with a specific entity or person Citi does business or has some relationship with.
accountAliasId
Required in path
string
Clave Bancaria Estandarizada(CLABE) Id,si se recibe un 0 no se buscará por este campo
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
GET https://sit.api.banamex.com/mx-gcgapi/sit/api/v1/payments/accounts/payees/external/{customerId}/{accountAliasId}
Try this operation
/v1/payments/accounts/payees/external
post /v1/payments/accounts/payees/external
add-external-accounts
Add an external account for Pull Payments
Add an external account for Pull Payments
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
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
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
addExternalAccountRequest
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/payees/external
Try this operation
put /v1/payments/accounts/payees/external
update-external-accounts
Update an external account for Pull Payments
Update an external account for Pull Payments
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
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
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
updateExternalAccountRequest
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
PUT https://sit.api.banamex.com/mx-gcgapi/sit/api/v1/payments/accounts/payees/external
Try this operation
delete /v1/payments/accounts/payees/external
remove-external-accounts
Remove an external account for Pull Payments
Remove an external account for Pull Payments
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
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
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
removeExternalAccountRequest
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
DELETE https://sit.api.banamex.com/mx-gcgapi/sit/api/v1/payments/accounts/payees/external
Try this operation
Definitions
{
"type": "object",
"properties": {
"account": {
"$ref": "#/definitions/account"
}
}
}
{
"type": "object",
"properties": {
"accountAlias": {
"description": "Clave Bancaria Estandarizada(CLABE)",
"type": "string",
"example": "010296004588765213"
},
"accountStatus": {
"description": "status of the account",
"type": "string",
"example": "ACTIVE"
},
"activationDate": {
"description": "last date of account activation for pull payments",
"type": "string",
"example": "2019-02-22"
},
"bankId": {
"description": "Unique ID of the bank",
"type": "integer",
"example": 9
},
"bankName": {
"description": "Name of the bank",
"type": "string",
"example": "Banco Inbursa, SA"
},
"customerId": {
"description": "Customer ID is a key associated with a specific entity or person Citi does business or has some relationship with.",
"type": "integer",
"example": 12345678
},
"customerName": {
"description": "Customer Name",
"type": "string",
"example": "Josue"
},
"enrollmentDate": {
"description": "date of account enrollment for pull payments",
"type": "string",
"example": "2019-02-22"
},
"payeeName": {
"description": "Nick name of the account as defined by the user",
"type": "string",
"example": "My CLABE Account"
},
"cardPlastic": {
"$ref": "#/definitions/cardPlastic"
}
},
"required": [
"accountAlias",
"bankId",
"bankName",
"customerId",
"customerName",
"payeeName"
]
}
{
"type": "object",
"properties": {
"displayAccountAlias": {
"description": "Clave Bancaria Estandarizada(CLABE) enmascarada",
"type": "string",
"example": "5213"
},
"accountAliasId": {
"description": "Clave Bancaria Estandarizada(CLABE) Id",
"type": "string",
"example": "12345"
},
"accountStatus": {
"description": "status of the account",
"type": "string",
"example": "ACTIVE"
},
"activationDate": {
"description": "last date of account activation for pull payments",
"type": "string",
"example": "2019-02-22"
},
"bankId": {
"description": "Unique ID of the bank",
"type": "integer",
"example": 9
},
"bankName": {
"description": "Name of the bank",
"type": "string",
"example": "Banco Inbursa, SA"
},
"customerId": {
"description": "Customer ID is a key associated with a specific entity or person Citi does business or has some relationship with.",
"type": "integer",
"example": 12345678
},
"enrollmentDate": {
"description": "date of account enrollment for pull payments",
"type": "string",
"example": "2019-02-22"
},
"payeeName": {
"description": "Nick name of the account as defined by the user",
"type": "string",
"example": "My CLABE Account"
},
"cardPlastic": {
"$ref": "#/definitions/cardPlasticResponse"
}
},
"required": [
"accountAlias",
"bankId",
"bankName",
"customerId",
"payeeName"
]
}
{
"type": "object",
"properties": {
"payeeName": {
"description": "Nick name of the account as defined by the user",
"type": "string",
"example": "My CLABE Account"
},
"customerName": {
"description": "Customer Name",
"type": "string",
"example": "Josue"
},
"cardPlastic": {
"$ref": "#/definitions/cardPlastic"
}
},
"required": [
"payeeName",
"customerName",
"bankName"
]
}
{
"type": "object",
"properties": {
"cardNumber": {
"description": "It is a 16 digit number, typically imprinted on the front of the card",
"type": "string",
"example": "10"
},
"expiryDate": {
"description": "Expiry date of the card",
"type": "string",
"example": "2018-05"
},
"withdrawalLimitAmount": {
"description": "Indicates the maximum amount card holder can transfer from the external account",
"type": "string",
"example": "10000"
}
},
"required": [
"withdrawalLimitAmount"
]
}
{
"type": "object",
"properties": {
"cardNumber": {
"description": "It is a 16 digit number, typically imprinted on the front of the card",
"type": "string",
"example": "10"
},
"expiryDate": {
"description": "Expiry date of the card",
"type": "string",
"example": "2018-05"
},
"withdrawalLimitAmount": {
"description": "Indicates the maximum amount card holder can transfer from the external account",
"type": "string",
"example": "10000"
}
}
}
{
"type": "object",
"properties": {
"externalAccount": {
"type": "array",
"items": {
"$ref": "#/definitions/accountResponse"
}
}
}
}
{
"type": "object",
"properties": {
"accountAliasId": {
"description": "Clave Bancaria Estandarizada(CLABE) Id",
"type": "string",
"example": "12345"
},
"customerName": {
"description": "Customer Name",
"type": "string",
"example": "Josue"
}
},
"required": [
"accountAliasId",
"customerName",
"bankName"
]
}
{
"type": "object",
"properties": {
"successfulOperation": {
"description": "result indicator",
"type": "boolean",
"example": true
},
"notificationSent": {
"description": "notification sent indicator",
"type": "boolean",
"example": true
},
"folioId": {
"description": "folio assigned to the transaction",
"type": "string",
"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"
},
"withdrawalLimitAmount": {
"description": "Indicates the maximum amount card holder can transfer from the external account",
"type": "string",
"example": "10000"
}
}
}
{
"type": "object",
"properties": {
"accountAliasId": {
"description": "Clave Bancaria Estandarizada(CLABE) Id",
"type": "string",
"example": "12345"
},
"updatedAccount": {
"$ref": "#/definitions/updatedAccount"
}
},
"required": [
"accountAliasId"
]
}
{
"type": "object",
"properties": {
"successfulOperation": {
"description": "result indicator",
"type": "boolean",
"example": true
},
"notificationSent": {
"description": "notification sent indicator",
"type": "boolean",
"example": true
},
"folioId": {
"description": "folio assigned to the transaction",
"type": "string",
"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"
},
"withdrawalLimitAmount": {
"description": "Indicates the maximum amount card holder can transfer from the external account",
"type": "string",
"example": "10000"
}
}
}
{
"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"
]
}