production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/recurring-charges/retrieve
post /v1/cards/recurring-charges/retrieve
retrieve-recurring-charges
LOB:Credit&Cards; Feature: Recurring charges; Functionality: Retrieve.
This API is used to retrieve a recurring charge instruction registered in backend.
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
retrieveRecurringChargesRequest
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/retrieve
Definitions
{
"type": "object",
"properties": {
"languageCode": {
"description": "Agent's language code. For Eg: 1 = Spanish, 2 = English.",
"type": "string",
"maxLength": 1,
"example": "1"
},
"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": "115"
},
"payment": {
"$ref": "#/definitions/Payment"
}
},
"required": [
"languageCode",
"companyCode"
]
}
{
"type": "object",
"properties": {
"languageCode": {
"description": "Agent's language code. For Eg: 1 = Spanish, 2 = English.",
"type": "string",
"maxLength": 1,
"example": "1"
},
"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": "115"
},
"aliasName": {
"description": "Description added by user to identify the operation.",
"type": "string",
"maxLength": 20,
"example": "Home Electricity"
},
"lastUpdateDate": {
"description": "Date when last updated.Date in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "22/06/2022"
},
"cancelReason": {
"description": "Reason for Case Cancellation, Only in the scenario in which an inoperable instruction is activated again in the registration.",
"type": "string",
"maxLength": 4,
"example": "12"
},
"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": "12345678"
},
"accountNumber": {
"description": "Customer's Account Number with the Bank.",
"type": "string",
"maxLength": 20,
"example": "4152313655668879"
},
"paymentReferenceNumber": {
"description": "This attribute holds a reference number for payments. Eg RPU number.",
"type": "string",
"maxLength": 20,
"example": "12345678901"
}
},
"required": [
"paymentInstructionId"
]
}
{
"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": "123456789"
},
"autoDebitAccountNumber": {
"description": "Account number or destination account related with the service to be paid.",
"type": "string",
"maxLength": 20,
"example": "4152313645671594"
},
"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"
},
"accountingTellerId": {
"description": "It is the accounting box that is affected. Register the accounting movements of an account.",
"type": "string",
"maxLength": 2,
"example": "12"
},
"contractNumber": {
"description": "Contract number used to represent an account contract uniquely",
"type": "string",
"maxLength": 20,
"example": "123456789"
},
"transaction": {
"$ref": "#/definitions/Transaction"
},
"partyAndOrganization": {
"$ref": "#/definitions/PartyAndOrganization"
}
}
}
{
"type": "object",
"properties": {
"statementCycleCode": {
"description": "This date indicates the plastic cutoff day.",
"type": "string",
"maxLength": 2,
"example": "12"
},
"transactionId": {
"description": "Refers to the unique identifier associated with the operation made by the operator.",
"type": "string",
"maxLength": 4,
"example": "1234"
},
"paymentMode": {
"description": "Payment option. Eg: Minimum = M, Total = T, 1 = Pesos, 3 = UDIS.",
"type": "string",
"maxLength": 1,
"example": "1"
},
"requestReceiptFlag": {
"description": "It indicates if a voucher should be sent to the customer.",
"type": "boolean",
"example": true
},
"transactionStatus": {
"description": "Refers to the status of the transaction.",
"type": "string",
"maxLength": 2,
"example": "40"
},
"billingCurrencyCode": {
"description": "Refers to currency in which billing is to be done.",
"type": "string",
"maxLength": 2,
"example": "1"
},
"transactionDescription": {
"description": "Refers to the detailed description of the transaction.",
"type": "string",
"maxLength": 20,
"example": "REGISTER"
},
"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"
},
"paymentDetails": {
"$ref": "#/definitions/PaymentDetails"
}
}
}
{
"type": "object",
"properties": {
"accountType": {
"description": "This specify the account type. Eg. 1 = Check, 3 = Card, 40 = CLABE",
"type": "string",
"maxLength": 2,
"example": "3"
},
"paymentReferenceNumber": {
"description": "This attribute holds a reference number for payments. Eg RPU number.",
"type": "string",
"maxLength": 20,
"example": "12345678901"
},
"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": "8"
},
"paymentReferenceDescription": {
"description": "Description of the unique reference number for individual options for market linked deposits.",
"type": "string",
"maxLength": 20,
"example": "123456789"
},
"paymentReferenceName": {
"description": "Unique reference for customer request",
"type": "string",
"maxLength": 20,
"example": "123485689"
},
"nextExecutionDate": {
"description": "Date of the next payment or transfer within a recurring payment or transfer.",
"type": "string",
"format": "date",
"example": "22/06/2022"
},
"paymentCycleDay": {
"description": "Payment Day for the autopay scheduled.",
"type": "string",
"maxLength": 2,
"example": "12"
},
"alertAndNotification": {
"$ref": "#/definitions/AlertAndNotification"
},
"cardPlastic": {
"$ref": "#/definitions/CardPlastic"
},
"recurringPayment": {
"$ref": "#/definitions/RecurringPayment"
}
}
}
{
"type": "object",
"properties": {
"paymentAlertFlag": {
"description": "Indicator to notify to the customer previous to load the charge.",
"type": "boolean",
"example": true
},
"paymentNotificationFlag": {
"description": "Indicator to notify to the customer after to load the charge.",
"type": "boolean",
"example": true
},
"channelType": {
"description": "Via to notify to the customer about the charge. Eg: 0 without warning, 1 Email, 2 Fax, 3 pager.",
"type": "string",
"maxLength": 2,
"example": "3"
},
"notificationChannelId": {
"description": "Number used in case of modification or deletion.",
"type": "string",
"maxLength": 4,
"example": "1234"
}
}
}
{
"type": "object",
"properties": {
"branchId": {
"description": "Unique identifier for the branch",
"type": "string",
"maxLength": 4,
"example": "100"
},
"branchCode": {
"description": "Branch Code of the branch which the pre-registration was made.",
"type": "string",
"maxLength": 4,
"example": "102"
},
"employeeId": {
"description": "Unique indentity number that identifies the employee of an organization uniquely.",
"type": "string",
"maxLength": 8,
"example": "48039"
}
}
}
{
"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": {
"totalPaymentAmount": {
"description": "Total amount to be paid for a recurring transfer or payment.",
"type": "number",
"format": "double",
"example": 1275.5
},
"paymentScheduleId": {
"description": "This attribute holds the unique identifier for the scheduled payments. Payment indicator 1,2,3 o 4. If the value is null, 0 is assigned. If the type is 4, the paymentDueDate and transferStartTime are mandatory.",
"type": "string",
"maxLength": 1,
"example": "4"
},
"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": "22/06/2023"
}
}
}
{
"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"
]
}