--- swagger: "2.0" info: title: crds-ccc-d-recurring-charge-modification description: This microservice is used to modify instructions of recurring charges and scheduled payments. version: 1.0.0 x-ibm-name: crds-ccc-d-recurring-charge-modification host: 127.0.0.1 schemes: - https basePath: /api produces: - application/json paths: /v1/cards/credit-cards/recurring-charges/modify: put: tags: - modify-recurring-charges operationId: modify-recurring-charges summary: 'LOB:Credit&Cards; Feature: Recurring charges; Functionality: Modification.' description: This API is used to modify a recurring charge instruction registered in backend. consumes: - application/json produces: - application/json parameters: - name: client_id in: header required: false type: string description: Client ID generated during application registration - name: Authorization in: header required: false type: string description: The Authorization Token received during login - name: Accept in: header required: true type: string description: Content-Types that are acceptable for the response - name: uuid in: header required: true type: string description: 128 bit UUID that you generate for every request - name: Accept-Language in: header required: false type: string description: List of acceptable human languages for response - name: Content-Type in: header required: true type: string description: Content-Types that are sent in the request - name: ChannelId in: header required: true type: string description: Channel where request originated - name: countryCode in: header required: true type: string description: Country code in 2 character ISO 3166 format - name: businessCode in: header required: true type: string description: Business code identified during application registration - name: sid in: header required: true type: string description: SessionId sent by Consumer - name: modifyRecurringChargesRequest in: body schema: $ref: '#/definitions/ModifyRecurringChargesRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/ModifyRecurringChargesResponse' 400: description:
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
schema: $ref: '#/definitions/ErrorResponse' 404: description:
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 422: description:
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
schema: $ref: '#/definitions/ErrorResponse' definitions: ModifyRecurringChargesRequest: 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: 4 example: "201" aliasName: description: Description added by user to identify the operation. type: string maxLength: 20 example: Electricity of House account: $ref: '#/definitions/Account' required: - languageCode - bankCode - companyCode ModifyRecurringChargesResponse: type: object properties: languageCode: description: 'Agent''s language code. For Eg: 1 = Spanish, 2 = English.' type: string maxLength: 1 example: "1" paymentAuthorizationCode: description: Authorization number generated by the backend system to identify the transaction. type: string maxLength: 8 example: "1234567" transactionDescription: description: Refers to the detailed description of the transaction. type: string maxLength: 248 example: Modification Applied transactionStatus: description: 'Refers to the status of transaction. Identify the outcome of the action performed eg: active 40, canceled 90' type: string maxLength: 2 example: "40" productCode: description: Unique code that identifies the product, Only applies to instrument investments. type: string maxLength: 4 example: "1234" transactionInstrumentId: description: This attribute holds the unique identifier for different payment instrument. Only applies to instrument investments. type: string maxLength: 4 example: "1234" ErrorResponse: 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 Account: type: object properties: accountType: description: This specify the account typ. Eg. 1 = Check, 3 = Card, 40 = CLABE account. type: string maxLength: 2 example: "3" paymentFrequencyType: description: 'Periodicity of instruction provided by the user. 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" paymentFrequency: description: 'Periodicity of instruction provided by the system. 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: "2" transaction: $ref: '#/definitions/Transaction' required: - accountType - paymentFrequency Payment: type: object properties: paymentReferenceNumber: description: This attribute holds a reference number for payments. Eg RPU number. type: string maxLength: 20 example: "123456" paymentReferenceDescription: description: Unique reference number associated to a service provider. Eg RPU number. type: string maxLength: 20 example: "123456789871" paymentReferenceName: description: Unique reference for customer request. type: string maxLength: 20 example: "123456789" nextExecutionDate: description: Date of the next payment or transfer within a recurring payment or transfer. type: string format: date-time example: 2022-06-22-10:30:30 paymentCycleDay: description: Payment Day for the autopay scheduled. type: string example: "22" alertAndNotification: $ref: '#/definitions/AlertAndNotification' cardPlastic: $ref: '#/definitions/CardPlastic' recurringPayment: $ref: '#/definitions/RecurringPayment' Transaction: 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" authorizationId: description: Authorization number generated by the backend system to identify the transaction. type: string maxLength: 8 example: "12345678" billingCurrencyCode: description: Refers to currency in which billing is to be done. type: string maxLength: 2 example: "1" requestReceiptFlag: description: It indicates if a voucher should be sent to the customer. type: boolean example: true 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" payment: $ref: '#/definitions/Payment' AlertAndNotification: 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: "2" notificationChannelId: description: Number used in case of modification or deletion type: string maxLength: 4 example: "2222" CardPlastic: type: object properties: accountNumber: description: Customer's Account Number with the Bank. type: string maxLength: 20 example: "1234567898715478" paymentInstructionId: description: Number generated by the backend system to identify the recurring charge. type: string maxLength: 8 example: "12345678" required: - accountNumber - paymentInstructionId RecurringPayment: type: object properties: totalPaymentAmount: description: Total amount to be paid for a recurring transfer or payment. type: number format: double example: 750.990000 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: S terminationDate: description: The last payment of recurring transfer, is to be made on this date. type: string format: date example: 22/06/2023 required: - totalPaymentAmount - terminationDate x-ibm-configuration: enforced: true testable: true phase: realized securityDefinitions: OAuth2 Application Flow: type: oauth2 description: "" flow: application scopes: /api/v1: "" tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token Client ID: type: apiKey description: "" in: header name: X-IBM-Client-Id security: - OAuth2 Application Flow: - /api/v1 Client ID: [] x-ibm-endpoints: - endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext type: - production - development ...