production
development
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
Paths
/v1/servicing/payments/status/retrieve
post /v1/servicing/payments/status/retrieve
retrieve-payment-status
The API is used to check the status of the success operations.
search a payment file and retrive the status details.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token
Scopes
/api/v1
ClientID
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
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
Required in header
string
retrievePaymentStatusRequest
Required 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://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/payments/status/retrieve
/v1/servicing/payments/rejected/retrieve
post /v1/servicing/payments/rejected/retrieve
retrieve-rejected-payments
The API is used to check the details of the rejected payments.
Search for a payment file and retrieve the status details of rejected payments.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token
Scopes
/api/v1
ClientID
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
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
Required in header
string
SessionId sent by Consumer.
retrieveRejectedPaymentsRequest
Required 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://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/payments/rejected/retrieve
Definitions
{
"type": "object",
"properties": {
"customerId": {
"description": "CitiBanamex internal customer indentifier.",
"type": "string",
"minLength": 1,
"maxLength": 12,
"pattern": "^[0-9]{1,12}",
"example": "668450123"
},
"paymentFile": {
"$ref": "#/definitions/PaymentFile"
}
},
"required": [
"customerId",
"paymentFile"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "CitiBanamex internal customer indentifier.",
"type": "string",
"minLength": 1,
"maxLength": 12,
"pattern": "^[0-9]{1,12}",
"example": "668450123"
},
"paymentFile": {
"$ref": "#/definitions/PaymentFile"
}
},
"required": [
"customerId",
"paymentFile"
]
}
{
"type": "object",
"properties": {
"fileSequenceNumber": {
"description": "is a sequential number of the payment file.",
"type": "integer",
"format": "int32",
"example": 99
},
"paymentDate": {
"description": "It is the date of the customer when he uploads his payment file, it is considered as the original date of the payment application.",
"type": "string",
"format": "date",
"pattern": "([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))",
"example": "2019-12-30"
},
"serviceSubType": {
"description": "This field refers to the nature of the file, with which the file is categorized in the payment domain.",
"type": "string",
"minLength": 1,
"maxLength": 2,
"example": "05",
"pattern": "^[0-9][1-9]{1,2}"
}
},
"required": [
"fileSequenceNumber",
"paymentDate",
"serviceSubType"
]
}
{
"type": "object",
"properties": {
"paymentFileDetail": {
"$ref": "#/definitions/PaymentFileDetail"
},
"paymentSummary": {
"type": "array",
"items": {
"$ref": "#/definitions/PaymentSummary"
}
}
}
}
{
"type": "object",
"properties": {
"fileStatusCode": {
"description": "Code of payment file status.",
"type": "string",
"maxLength": 2,
"example": 30
},
"fileStatusReason": {
"description": "Reason of the status the processed file.",
"type": "string",
"maxLength": 20,
"example": "Procesado"
},
"paymentFileRejectionReason": {
"description": "Reason for file payment rejection.",
"type": "string",
"maxLength": 20,
"example": "Error en el formato del archivo"
},
"authorizationCode": {
"description": "Is the code of authorization for the payment file.",
"type": "integer",
"maxLength": 6,
"format": "int32",
"example": 800
},
"fileDescription": {
"description": "Description of file.",
"type": "string",
"maxLength": 20,
"example": "PAGO NOMINA"
},
"rejectionRetryCount": {
"description": "Number of retries for all payments into the file.",
"type": "integer",
"maxLength": 6,
"format": "int32",
"example": 30
},
"totalPaymentCount": {
"description": "Total count of payments into the file.",
"type": "integer",
"format": "int32",
"example": 1500
},
"fileName": {
"description": "Name of the payment file",
"type": "string",
"example": "2019-11-05_09-32-29.302_27414s01.10.051119.000000013898.002.pgm_sol_Req.xml"
}
},
"required": [
"fileStatusCode",
"fileStatusReason",
"authorizationCode",
"fileDescription",
"rejectionRetryCount"
]
}
Summary of total amounts and payment status.
{
"type": "object",
"properties": {
"paymentCount": {
"description": "This field refers to the number of payments by status that exist within the file",
"type": "integer",
"format": "int32",
"example": 100
},
"totalPaymentAmount": {
"description": "total payment amount",
"type": "number",
"format": "double",
"example": 1500.1
},
"paymentStatusReason": {
"description": "different of the status reason that payment may have",
"type": "string",
"enum": [
"REGISTERED",
"REJECTED_LOAD",
"CANCELLED_WITHOUT_APPLIED",
"PENDING_RESPONSE",
"APPLIED",
"REJECTED",
"CANCELLED_APPLIED",
"ADJUSTMENT"
]
},
"operationType": {
"description": "describe operation type of the payment (DEBIT,CREDIT)",
"type": "string",
"enum": [
"DEBIT",
"CREDIT"
]
}
},
"required": [
"paymentCount",
"totalPaymentAmount",
"paymentStatusReason",
"operationType"
]
}
{
"type": "object",
"properties": {
"rejectedPaymentCount": {
"description": "Total number of rejected movements sent",
"type": "integer",
"format": "int32",
"example": 99
},
"rejectedPayment": {
"type": "array",
"items": {
"$ref": "#/definitions/RejectedPayment"
}
}
}
}
{
"type": "object",
"properties": {
"paymentId": {
"description": "It is a consecutive number for each payment of the file",
"type": "integer",
"format": "int32",
"example": 10
},
"paymentStatusCode": {
"description": "Status code of the payment",
"type": "string",
"maxLength": 2,
"example": "05"
},
"paymentStatusReason": {
"description": "Payment status",
"type": "string",
"maxLength": 20,
"example": "REJECTED"
},
"paymentRejectionReasonCode": {
"description": "Is code of why payment was rejected.",
"type": "string",
"maxLength": 4,
"example": "422"
},
"paymentRejectionReason": {
"description": "Is a description of why payment was rejected",
"type": "string",
"maxLength": 31,
"example": "Debit Account blocked"
}
},
"required": [
"paymentId",
"paymentStatusCode",
"paymentStatusReason",
"paymentRejectionReasonCode",
"paymentRejectionReason"
]
}
{
"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"
]
}