--- swagger: "2.0" info: title: crds-crc-d-debit-card-transaction description: A service that is able to expose information debit card, using the information that is populating in EAS. The API must seek to send information to One Dispute (OD) looking for the operation to be similar to today version: 1.0.0 x-ibm-name: crds-crc-d-debit-card-transaction host: 127.0.0.1 basePath: /api schemes: - https produces: - application/json paths: /v1/cards/debit-cards/transactions/retrieve: post: tags: - retrieve-debit-card-transaction operationId: retrieve-debit-card-transaction summary: 'LOB: One Dispute; Feature: Advanced Dispute System; Functionality: Retrieve transactions information for debit card' description: This API helps to obtain the information of transactions for a debit card consumes: - application/json produces: - application/json parameters: - name: client_id in: header required: true type: string description: Client ID generated during application registration - name: Authorization in: header required: true 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: 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: ChannelId in: header required: true type: string description: Channel where request originated - in: body name: retrieveDebitCardTrnsRequest schema: $ref: '#/definitions/RetrieveDebitCardTrnsRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/RetrieveDebitCardTrnsResponse' 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: RetrieveDebitCardTrnsRequest: type: object properties: valuesInputRequest: $ref: '#/definitions/ValuesInputRequest' detailRequest: $ref: '#/definitions/DetailRequest' required: - valuesInputRequest - detailRequest ValuesInputRequest: type: object properties: messageId: type: integer format: int32 example: 0 description: Id request message versionNumber: type: integer format: int32 example: 0 description: Request version languagueCode: maxLength: 1 type: string example: Default description: Request languague traceFlag: type: integer format: int32 example: 0 description: Request trace flag terminalId: maxLength: 10 type: string example: Default description: Request terminal id userId: maxLength: 8 type: string example: Default description: Request user id dateTime: maxLength: 14 type: string format: date-time example: Default description: Request date time messageLengthRequest: type: integer format: int32 example: 0 description: Length for message applicationId: maxLength: 2 type: string example: Default description: Application Id getMoreIndR: maxLength: 1 type: string example: Default description: More indicator dateRequest: maxLength: 10 type: string format: date example: "2022-05-10" description: Date of the request timeRequest: maxLength: 8 type: string format: date-time example: "20:00:05" description: Time of the request resultCode: maxLength: 4 type: string example: "0" description: Response code based on seccesful or unsuccesfull retreival of record errorMessage: maxLength: 80 type: string example: Sin Movimientos description: Description of the failure footPrintInd: maxLength: 1 type: string example: Default description: Foot indicator callOrLink: maxLength: 1 type: string example: Default description: Call or Link isoKeyLanguage: maxLength: 2 type: string example: ES or EL description: Which language the result will be displayed DetailRequest: type: object properties: account_Number: maxLength: 18 type: string example: "4295229271256431" description: Account OPR Cuenta subProductTypeCode: maxLength: 16 type: string example: Default description: Instrument OPR_Instrumento customerNo: maxLength: 16 type: string example: Default description: Product CTE_Numero mediumAccessAccountNo: maxLength: 16 type: string example: Default description: Means of Access CTE_MedioAcceso startDate: maxLength: 10 type: string format: date example: "2017-09-08" description: Start date OPR_FechaInicial endDate: maxLength: 10 type: string format: date example: "2017-07-10" description: End Date OPR_FechaFinal disputesOperationOption: maxLength: 2 type: string example: CC description: Disputes Operation Option OPR_Opcion debitCardTransactionPage: type: object properties: nextStartIndex1: type: integer format: int32 example: 1 description: Field of the pagination, next start index moreIndicator1: maxLength: 1 type: string example: "Y" description: Field of the pagination, indicates if there is a next page totalRecordSize1: type: integer format: int32 example: 30 description: Field of the pagination, total record size nextStartIndex2: type: integer format: int32 example: 0 description: Field of the pagination, next start index of the next page moreIndicator2: maxLength: 1 type: string example: "N" description: Field of the pagination, indicates if there is a next page of the next page totalRecordSize2: type: integer format: int32 example: 0 description: Field of the pagination, total record size of the next page pageSize151: type: integer format: int32 example: 0 description: Field of the pagination, max record count lastRecordReadStartDate: maxLength: 10 type: string format: date example: "2022-02-10" description: DATE1 -to be taken from ADS Call 1 response lastRecordTimeStamp: maxLength: 26 type: string example: 2022-02-28-22.04.10.842043 description: TIMESTAMP1 -to be taken from ADS Call 1 response lastRecordReadFrom: maxLength: 10 type: string example: AUTHLOG1 description: INDEX1 -to be taken from ADS Call 1 response lastRecordIndex: type: integer format: int32 example: 30 description: fixed value(as the number of occurences) RetrieveDebitCardTrnsResponse: required: - valuesOutputResponse - recordResponse properties: valuesOutputResponse: $ref: '#/definitions/ValuesOutputResponse' recordResponse: $ref: '#/definitions/RecordResponse' ValuesOutputResponse: type: object properties: messageId: type: integer format: int32 example: 0 description: Id response message versionNumber: type: integer format: int32 example: 0 description: Response version number languagueCode: maxLength: 1 type: string example: Default description: Response languague traceFlag: type: integer format: int32 example: 0 description: Response trace flag terminalId: maxLength: 10 type: string example: Default description: Response terminal identification userId: maxLength: 8 type: string example: Default description: Response user id dateTime: maxLength: 14 type: string example: Default description: Response date time format: date-time messageLength: type: integer format: int32 example: 0 description: Length for message applicationId: maxLength: 2 type: string example: "" description: Application Id getMoreInd: maxLength: 1 type: string example: Default description: More indicator dateRequest: maxLength: 10 type: string example: "2022-05-10" description: Date of the request format: date timeRequest: maxLength: 8 type: string example: "20:00:05" description: Time of the request format: date-time responseCode: maxLength: 4 type: string example: "0" description: Response code based on seccesful or unsuccesfull retreival of record errorMessage: maxLength: 80 type: string example: Sin Movimientos description: Description of the failure footPrintInd: maxLength: 1 type: string example: Default description: Foot indicator callOrLink: maxLength: 1 type: string example: Default description: Call or Link isoKeyLanguage: maxLength: 2 type: string example: ES or EL description: Which language the result will be displayed RecordResponse: type: object properties: debitCardTransactionPage: type: object properties: nextStartIndex1: type: integer format: int32 example: 0 description: Field of the pagination, next start index moreIndicator1: maxLength: 1 type: string example: "Y" description: Field of the pagination, indicates if there is a next page totalRecordSize1: type: integer format: int32 example: 0 description: Field of the pagination, total record size nextStartIndex2: type: integer format: int32 example: 101 description: Field of the pagination, next start index of the next page moreIndicator2: maxLength: 1 type: string example: "Y" description: Field of the pagination, indicates if there is a next page of the next page totalRecordSize2: type: integer format: int32 example: 100 description: Field of the pagination, total record size of the next page pageSize151: type: integer format: int32 example: 30 description: Field of the pagination, max record count lastRecordReadStartDate: maxLength: 10 type: string format: date example: "2022-02-10" description: DATE1 provided by API/ADS - to be passed by OD TIBCO in next request lastRecordTimeStamp: maxLength: 26 type: string example: 2022-02-28-22.04.10.842043 description: TIMESTAMP1 provided by API/ADS - to be passed by OD TIBCO in next request lastRecordReadFrom: maxLength: 10 type: string example: AUTHLOG1 description: File/DB name provided by API/ADS - to be passed by OD TIBCO in next request lastRecordIndex: type: integer format: int32 example: 30 description: Fixed value (as the number of ocurences) debitCardTransactionDetailSummary: type: array maxItems: 30 items: type: object properties: account_Number: maxLength: 18 type: string example: 5256783475XXXXX description: Basic account externalAccountNumber: maxLength: 3 type: string example: "000" description: External Account Number purchaseDate: maxLength: 10 type: string format: date example: 08/04/2021 description: Last purchase date destinationAuthAmount: multipleOf: 0.010000 type: number format: decimal example: 300 description: Destination Currency Transaction Ammount sourceAuthAmount: multipleOf: 0.010000 type: number format: decimal example: 300 description: Source Currency Transaction Ammount transaction_Code: type: integer example: 12000 description: Transaction Code destinationTransaction: maxLength: 1 type: string example: Default description: DestinationTransaction sourceCurrencyCode: maxLength: 3 type: string example: "484" description: Source Currency Number destinationCurrencyCode: maxLength: 3 type: string example: "484" description: Destination Currency Number businessId: type: integer example: "953" description: Affiliate Business Number businessName: maxLength: 25 type: string example: Digital Engineering description: Business Name businessPopulationCode: maxLength: 13 type: string example: Default description: Business Population Code businessCountryCode: maxLength: 3 type: string example: MEX description: Business Country businessCatalogCode: type: integer example: 6011 description: Business Catalog postalZipCode: type: integer example: 0 description: Business Postal Code businessState: maxLength: 3 type: string example: FMX description: Business State businessRateCode: maxLength: 2 type: string example: Default description: Business Rate Code businessReference: maxLength: 23 type: string example: Default description: Acquiring Business Reference transUtilizationCode: type: integer example: Default description: Transaction utilization Code authCode: maxLength: 6 type: string example: "862908" description: Authorization Code tpvCapacity: maxLength: 1 type: string example: Default description: TPV Capacity transaction_POS_Entry_Mode: maxLength: 3 type: string example: "51" description: Entry pos Mode eCommerceIndex: maxLength: 1 type: string example: "0" description: E-comerce index captureType: maxLength: 1 type: string example: Default description: Capture Type processing_Date: maxLength: 10 type: string format: date example: 08/04/2021 description: Process Date transaction_Description: maxLength: 40 type: string example: Shopping description: Description branchPromo: type: integer example: Default description: Promo Branch pointOfSale: type: integer example: Default description: Point of Sale authorizationCode: type: integer example: "862908" description: Authorization Code consecutiveMovements: type: integer example: Default description: Movements sourceSystem: type: integer example: Default description: Source System transaction_Reference_Number: type: integer example: Default description: Transaction Number transactionTime: maxLength: 8 type: string example: "0235010" description: Transaction Time billedUnbilledFlag: type: integer example: 'Auth: Fixed 1' description: Billing Index tpPlanKey: maxLength: 2 type: string example: Default description: TP Plan Key channel: type: integer example: 3 description: Acquiring Business Code meansOfContact: maxLength: 3 type: string example: Default description: Means of contanct processCode: maxLength: 6 type: string example: "12000" description: Process Code serviceCode: maxLength: 3 type: string example: "201" description: Service Code arqcCategoryCode: maxLength: 1 type: string example: Default description: ARQC Category Code terminalCapabillity: type: integer example: 0 description: Terminal Entry Capability cardHolderMethod: maxLength: 1 type: string example: "0" description: Cardholder Identification cryptogramInformationData: maxLength: 2 type: string example: "80" description: Cryptogram Information Data terminalVerificationResult: maxLength: 10 type: string example: "8000048000" description: TVR applicationCryptogram: maxLength: 16 type: string example: 82402F76D3ABBAA3 description: ARQC authorizedAmount: maxLength: 12 type: string example: "30000" description: Authorized Amount secondaryAmount: maxLength: 12 type: string example: "0" description: Secondary Amount applicationInterchangeProfile: maxLength: 4 type: string example: "3900" description: AIP applicationTransactionCounter: maxLength: 4 type: string example: "0010" description: ATC terminalCountryCode: maxLength: 3 type: string example: "484" description: Terminal Country Code transactionCountryCode: maxLength: 3 type: string example: "484" description: Transaction Currency Code transaction_Date: maxLength: 6 type: string example: "170131" description: Transaction Date transaction_Type: maxLength: 2 type: string example: "1" description: Transaction Type unpredictableNumber: maxLength: 8 type: string example: FEC39F1C description: Unpredictable Num issuedApplicationData: maxLength: 64 type: string example: 0303A15084E20300000000000000000000FF description: IAD - Issued Appl Data ifdInterfaceDeviceNumber: maxLength: 8 type: string example: "00000000" description: IFD - Interface Device Number emvTerminalCapabilities: maxLength: 8 type: string example: "604020" description: EMV Terminal Capabilities emvTerminalType: maxLength: 2 type: string example: "14" description: EMV Terminal Type applicationVersionNumber: maxLength: 4 type: string example: 008C description: Application Version Number cardHolderVerificationResult: maxLength: 6 type: string example: "420100" description: CVMR dedicatedFileNameAppId: maxLength: 32 type: string example: A0000000041010000000000000000000 description: Dedicated File Name / Application ID posEntryModeInp: type: integer example: 500 description: Pos Entry Mod INP entryPinInp: type: integer example: 0 description: Entry PIN INP terminalEntryCapability: maxLength: 1 type: string example: "0" description: Terminal Entry Capability lastEmvStatus: maxLength: 1 type: string example: "1" description: Last EMV Status dataSuspect: maxLength: 1 type: string example: Default description: Data Suspect panSequenceNumber: maxLength: 2 type: string example: Default description: PAN Sequence Number deviceInfo: maxLength: 6 type: string example: Default description: Device Info reasonOnlineCode: maxLength: 4 type: string example: Default description: Reason On Line Code arqcVerify: maxLength: 1 type: string example: "3" description: ARQC VRFY isoRespCodeInd: maxLength: 1 type: string example: Default description: ISO Resp Code Ind (Reserved for future use) issuerAuthorizationDataLength: maxLength: 4 type: string example: "10" description: Issuer Authoritation Data Length issuerAuthorizationData: maxLength: 32 type: string example: 0303A15084E20300000000000000000000FF description: Issuer Authoritation Data sendCardBlock: maxLength: 1 type: string example: "N" description: Send Card Block sendPutData: maxLength: 1 type: string example: "N" description: Send Put Data debitCveMessageType: maxLength: 4 type: string example: "0210" description: Message Type cvvPresenciaFlag: maxLength: 10 type: string example: No Present description: Presencia Flag dcvvResult: maxLength: 10 type: string example: No se pued description: dcvv2 Result presenceOfTheFa: maxLength: 10 type: string example: No Present description: Presence of the 2FA valueAuthentication: maxLength: 10 type: string example: No se pued description: DCVV2 2FA Result tipoAuthentication1: maxLength: 3 type: string example: ATM or Null (empty) description: Tipo Auth 01 tipoAuthentication2: maxLength: 3 type: string example: CHP description: Tipo Auth 02 tipoAuthentication3: maxLength: 3 type: string example: 3DS description: Tipo Auth 03 tipoAuthentication4: maxLength: 3 type: string example: WLL description: Tipo Auth 04 tipoAuthentication5: maxLength: 3 type: string example: CV2 description: Tipo Auth 05 tipoAuthentication6: maxLength: 3 type: string example: 2FA description: Tipo Auth 06 tipoAuthentication7: maxLength: 3 type: string example: "NULL" description: Tipo Auth 07 secure3dVersionNumber: maxLength: 1 type: string example: "1" description: Tipo 3D Version secure3dAuthType: maxLength: 30 type: string example: A, B, C and E description: Tipo Authentication directoryServer: maxLength: 36 type: string example: Default description: TXN_DirectoryServer cryptogramPresence: maxLength: 1 type: string example: Y or N description: Indica si viajó el criptograma al autorizador. cryptogramValidation: maxLength: 1 type: string example: 0, 1, 2 or 3 description: MSTR_3DS2_IAV Value Result ipAddress: maxLength: 50 type: string example: Default description: DireccionIP macAddress: maxLength: 20 type: string example: Default description: MAC address address del dispositivo donde se realizó la txn. cvePosEntryMode: maxLength: 3 type: string example: 010, 012, 050, 051, 052, 801, 901 description: CTE_CveModAcceso prevalResult: maxLength: 1 type: string example: Default description: Tipo Validacion Token Wallet debitWalletId: maxLength: 1 type: string example: Default description: ClaveProveedor walletDpanAccount: maxLength: 16 type: string example: Default description: CUENTA DIGITAL WALLET VPAN walletTokenReqId: maxLength: 11 type: string example: Default description: SEG_PIN Dinam Acceso CLAVE TOKEN 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: URI to human readable documentation of the error 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 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 ...