production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/recurring-charges/info/retrieve
post /v1/cards/recurring-charges/info/retrieve
retrieve-info-recurring-charges
LOB:Credit&Cards; Feature: List of recurring charges; Functionality: Retrieve.
This API is used to retrieve a list of recurring charges registered.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/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
ChannelId
Required in header
string
Channel where request originated
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
infoRecurringChargesRequest
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://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/recurring-charges/info/retrieve
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",
"maxLength": 12,
"example": "321654987321"
},
"bankCode": {
"description": "Name of the issuing bank where the branch is associated. Eg 2 = Banamex.",
"type": "string",
"maxLength": 4,
"example": "2"
},
"companyCode": {
"description": "Code associated to a service provider. Eg. 201 = CFE, 115 = TELMEX.",
"type": "string",
"maxLength": 6,
"example": "201"
},
"accountType": {
"description": "This specify the account type. Eg. 1 = Check, 3 = Card, 40 = CLABE account.",
"type": "string",
"maxLength": 2,
"example": "3"
},
"cardPlastic": {
"$ref": "#/definitions/CardPlastic"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"recordCount": {
"description": "Number of registered services for consulted customer.",
"type": "integer",
"format": "int32",
"example": 20
},
"customerId": {
"description": "Customer ID is a key associated with a specific entity or person Citi does business or has some relationship with.",
"type": "string",
"maxLength": 12,
"example": "321654987321"
},
"bankCode": {
"description": "Name of the issuing bank where the branch is associated. Eg 2 = Banamex.",
"type": "string",
"maxLength": 4,
"example": "2"
},
"companyCode": {
"description": "Code associated to a service provider. Eg. 201 = CFE, 115 = TELMEX.",
"type": "string",
"maxLength": 6,
"example": "201"
},
"paymentInstructionId": {
"description": "Number generated by the backend system to identify the recurring charge.",
"type": "string",
"maxLength": 8,
"example": "80202047"
},
"moreInformationFlag": {
"description": "Flag to validate if there are more than 12 services available for the consulted client.",
"type": "boolean",
"example": true
},
"recurringCharges": {
"type": "array",
"items": {
"$ref": "#/definitions/RecurringCharge"
}
}
}
}
{
"type": "object",
"properties": {
"bankCode": {
"description": "Name of the issuing bank where the branch is associated. Eg 2 = Banamex.",
"type": "string",
"maxLength": 4,
"example": "2"
},
"lastUpdateDate": {
"description": "Date last when payee was updated.",
"type": "string",
"format": "date",
"example": "22/06/2022"
},
"cancelReason": {
"description": "Reason for case cancellation of the recurrent payment instruction.",
"type": "string",
"maxLength": 4,
"example": "1000"
},
"companyCode": {
"description": "Code associated to a service provider. Eg. 201 = CFE, 115 = TELMEX.",
"type": "string",
"maxLength": 6,
"example": "201"
},
"aliasName": {
"description": "Description added by user to identify the operation.",
"type": "string",
"maxLength": 20,
"example": "Electricity Service"
},
"account": {
"$ref": "#/definitions/Account"
}
}
}
{
"type": "object",
"properties": {
"paymentInstructionId": {
"description": "Number generated by the backend system to identify the recurring charge.",
"type": "string",
"maxLength": 8,
"example": "80202047"
},
"accountNumber": {
"description": "Customer's Account Number with the Bank.",
"type": "string",
"maxLength": 20,
"example": "4152313655668879"
}
}
}
{
"type": "object",
"properties": {
"accountType": {
"description": "This specify the account type. Eg. 1 = Check, 3 = Card, 40 = CLABE acco",
"type": "string",
"maxLength": 2,
"example": "3"
},
"paymentFrequency": {
"description": "Periodicity of instruction. Eg: 4 Daily, 5 Weekly, 6 Fortnightly, 7 Monthly, 8 Bimonthly, 9 Quarterly, 10 Four-monthly, 11 Semester, 12 Annual.",
"type": "string",
"maxLength": 2,
"example": "7"
},
"paymentInitiatedDate": {
"description": "Date the payment was initiated into the system.",
"type": "string",
"format": "date",
"example": "06/01/2022"
},
"terminationDate": {
"description": "The last payment of a standing order or installment loan, or the last transfer of a recurring transfer, is to be made on this date.",
"type": "string",
"format": "date",
"example": "06/01/2023"
},
"paymentCycleDay": {
"description": "Payment Day for the autopay scheduled.",
"type": "string",
"maxLength": 2,
"example": "15"
},
"cardPlasticInfo": {
"$ref": "#/definitions/CardPlasticInfo"
}
}
}
{
"type": "object",
"properties": {
"paymentInstructionId": {
"description": "Number generated by the backend system to identify the recurring charge.",
"type": "string",
"maxLength": 8,
"example": "12345678"
},
"accountNumber": {
"description": "Customer's Account Number with the Bank.",
"type": "string",
"maxLength": 20,
"example": "4152313655668879"
}
}
}
{
"type": "object",
"properties": {
"statementCycleCode": {
"description": "This date indicates the plastic cutoff day.",
"type": "string",
"maxLength": 2,
"example": "12"
},
"paymentMode": {
"description": "Payment option. Eg: Minimum = M, Total = T, 1 = Pesos, 3 = UDIS.",
"type": "string",
"maxLength": 1,
"example": "1"
},
"transactionStatus": {
"description": "Refers to the status of the transaction.",
"type": "string",
"maxLength": 2,
"example": "90"
},
"localTransactionTime": {
"description": "Local time when the transaction takes place at the acceptor location.This is also printed on the credit card receipt.",
"type": "string",
"example": "17:32:28"
}
}
}
{
"type": "object",
"properties": {
"destinationAccountNumber": {
"description": "Destination account number of the payment.",
"type": "string",
"maxLength": 20,
"example": "4152313612344123"
},
"paymentFrequencyType": {
"description": "Periodicity of instruction. Eg: 4 = Daily, 5 = Weekly, 6 = Fortnightly, 7 = Monthly, 8 = Bimonthly, 9 = Quarterly, 10 = Four-monthly, 11 = Semester, 12 = Annual.",
"type": "string",
"maxLength": 2,
"example": "4"
},
"contractNumber": {
"description": "Unique identifier used for identifying payee.",
"type": "string",
"maxLength": 20,
"example": "20508060304070904010"
},
"transaction": {
"$ref": "#/definitions/Transaction"
},
"payment": {
"$ref": "#/definitions/Payment"
}
}
}
{
"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"
]
}