production
development
https://sit.api.banamex.com/mx-gcgapi/sit
Custom Gateway API Endpoint
Paths
/v1/payments/pemex
post /v1/payments/pemex
processRefineryPayment
To process a PEMEX refinery payment created from citidirect platform.
This API is to process a PEMEX refinery payment created from citidirect platform. The PEMEX Refinery microservice is going to place the request to intelligent channel (tuxedo) via an undefined mechanism (pending definition). This API is post-login, and entry-point and private.
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 Id identifies the consumer from where the request comes
sid
Required in header
string
SessionId sent by Consumer
processRefineryPaymentRequest
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
POST https://sit.api.banamex.com/mx-gcgapi/sit/api/v1/payments/pemex
Try this operation
Definitions
{
"type": "object",
"properties": {
"sourceAccount": {
"$ref": "#/definitions/SourceAccount"
}
}
}
{
"type": "object",
"properties": {
"accountNumber": {
"description": "Account number of the customer",
"type": "string",
"example": "123456789012"
},
"branchId": {
"description": "Branch Code of the branch which hold the account.",
"type": "string",
"example": "b001"
},
"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": "A123"
},
"payment": {
"$ref": "#/definitions/Payment"
}
},
"required": [
"accountNumber",
"branchId",
"customerId"
]
}
{
"type": "object",
"properties": {
"paymentAmount": {
"description": "Payment Amount",
"type": "number",
"format": "double",
"example": 25000
},
"paymentDescription": {
"description": "Detail description of the payment made",
"type": "string",
"example": "Sample description"
},
"pemexId": {
"description": "Unique identifier associated with Pemex account",
"type": "string",
"example": "0"
}
},
"required": [
"paymentAmount",
"pemexId"
]
}
{
"type": "object",
"properties": {
"paymentAuthorizationNumber": {
"description": "Payment Authorization Number.",
"type": "string",
"example": "527016"
},
"paymentDate": {
"description": "Date and time on which payment is made",
"type": "string",
"format": "datetime",
"example": "2018-04-22 07:22:06"
}
},
"required": [
"paymentAuthorizationNumber",
"paymentDate"
]
}
{
"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"
}
},
"required": [
"type",
"code"
]
}