openapi: 3.0.0 info: description: >- Obtain authorized & cleared transaction details on a Virtual Cards for reporting and payment reconciliation. Download our SDKs: * [Python SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=python&apiTitle=all&isClientSecReq=true) * [Java SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=java&apiTitle=all&isClientSecReq=true) * [.Net SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=dotnet&apiTitle=all&isClientSecReq=true) * [Ruby SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=ruby&apiTitle=all&isClientSecReq=true) * [NodeJS SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=nodejs&apiTitle=all&isClientSecReq=true) * [Go SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=go&apiTitle=all&isClientSecReq=true) * [CLI Tool SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=ccapi-cli&apiTitle=all&isClientSecReq=true) Note: You must be logged in to download the SDKs. version: 2.0.0 title: VCA Reporting contact: name: Global CitiConnect Support email: citiconnectsupport@citi.com x-ibm-name: vca-reporting servers: - url: https://tts.apib2b.citi.com/tts/cards description: Production Gateway URL - url: https://tts.sandbox.apib2b.citi.com/tts/cards description: Sandbox Gateway URL security: - clientCredentials: - /api paths: /vca/v2/reports/authorization: post: summary: Obtain Authorized Transaction Details description: >- Obtain authorized transaction details on a VCA for reporting & payment reconciliation operationId: Authorization Report parameters: - name: Content-Type in: header description: Supports application/json required: true schema: type: string - name: Authorization in: header description: >- Oauth token included by the external client to APIm. APIm will external the client ID and pass it to GRACE required: true schema: type: string - name: Country in: header description: >- Three character length country code used during onboarding into GRACE schema: type: string required: true - name: Region in: header description: >- This value will be used by APIm to route to the respective GRACE backend instance schema: type: string required: true - name: Req-Sys-Id in: header description: >- Unique ID of the API message sent. This ID will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration. schema: type: string required: false requestBody: description: AuthReportInboundRequest required: true content: application/json: schema: $ref: '#/components/schemas/AuthReportInboundRequest' examples: Mastercard-Request-Required-Fields: summary: Mastercard Sample Request with Required Fields value: vcaId: '17896177' virtualCardAccountNumber: '9898121243438778' programId: '431341' messageId: CITI00000AuthReport00020260521195320 startDate: '2026-04-01' endDate: '2026-04-30' timeZone: UTC-04:00 Visa-Request-Required-Fields: summary: Visa Sample Request with Required Fields value: vcaId: '2026052113115824204' virtualCardAccountNumber: '9898121243438000' programId: '918' messageId: CITI00000AuthReport00020260521195321 startDate: '2026-04-01' endDate: '2026-04-30' Mastercard-Request-All-Fields: summary: Mastercard Sample Request with All Fields value: vcaId: '17896177' virtualCardAccountNumber: '9898121243438778' programId: '431341' messageId: CITI00000AuthReport00020260521195322 startDate: '2026-04-01' endDate: '2026-04-30' startTime: '00:00' endTime: '23:00' timeZone: UTC-04:00 transactionType: All Visa-Request-All-Fields: summary: Visa Sample Request with All Fields value: vcaId: '2026052113115824204' virtualCardAccountNumber: '9898121243438000' programId: '918' messageId: CITI00000AuthReport00020260521195323 startDate: '2026-04-01' endDate: '2026-04-30' startTime: '00:00' endTime: '23:00' Mastercard-Pagination-Request: summary: Mastercard Sample Request with Pagination value: vcaId: '17896177' virtualCardAccountNumber: '9898121243438778' programId: '431341' messageId: CITI00000AuthReport00020260521195324 startDate: '2026-04-01' endDate: '2026-04-30' timeZone: UTC-04:00 transactionType: All reportIds: - '1234567' - '2345678' filters: paginationRequired: 'true' sortOrder: DESCENDING startIndex: '101' endIndex: '200' Visa-Pagination-Request: summary: Visa Sample Request with Pagination value: vcaId: '2026052113115824204' virtualCardAccountNumber: '9898121243438000' programId: '918' messageId: CITI00000AuthReport00020260521195325 startDate: '2026-04-01' endDate: '2026-04-30' filters: paginationRequired: 'true' startIndex: '150' endIndex: '300' Mastercard-Retry-Request: summary: Mastercard Sample Retry Request for Pending/Active Status value: vcaId: '17896177' virtualCardAccountNumber: '9898121243438778' programId: '431341' messageId: CITI00000AuthReport00020260521195326 startDate: '2026-04-01' endDate: '2026-04-30' timeZone: UTC-04:00 transactionType: All reportIds: - '1234567' responses: '200': description: >-
CodeDetails
AuthReportInboundResponsesuccess
content: application/json: schema: $ref: '#/components/schemas/AuthReportInboundResponse' examples: Mastercard-Response-All-Transaction-Type: summary: Mastercard Sample Response for All Transaction Type value: vcaId: '17896177' startDate: '2026-02-27' endDate: '2026-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: All virtualCardAccountNumber: '5281722601926445' programId: '429777' reportStatus: COMPLETED info: - fromDate: '2026-02-27' toDate: '2026-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2026-03-30' toDate: '2026-04-27' reportId: '1122331' status: COMPLETED authorizationRecords: - expiryDate: '122026' billingCurrencyAmount: '123' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '123' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:52:11' transactionType: Authorization preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Refer to card issuer vcaAuthorizationResponseDetail: Iss/Netwk decline - expiryDate: '012026' billingCurrencyAmount: '-143' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '-143' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:26:26' transactionType: Reversal preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO acquirerIdentifier: '999080' authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval - expiryDate: '012026' billingCurrencyAmount: '143' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '143' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:24:56' transactionType: Authorization preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval - expiryDate: '012026' billingCurrencyAmount: '141' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '141' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:23:33' transactionType: Authorization preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval - expiryDate: '122026' billingCurrencyAmount: '0' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '0' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-15 transactionTime: '17:34:03' transactionType: Reversal preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5999' mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO acquirerIdentifier: '999080' authorizationResponseDetail: Do not honor vcaAuthorizationResponseDetail: No Auth for Revl - expiryDate: '122026' billingCurrencyAmount: '143' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '143' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-15 transactionTime: '17:32:47' transactionType: Auth Purchase Return preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5999' mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval - expiryDate: '122026' billingCurrencyAmount: '141' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '141' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-15 transactionTime: '17:29:20' transactionType: Auth Purchase Return preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5999' mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval Mastercard-Response-Approved-Transaction-Type: summary: Mastercard Sample Response for Approved Transaction Type value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: Approved virtualCardAccountNumber: '5281722601926445' programId: '429777' reportStatus: COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED authorizationRecords: - expiryDate: '012023' billingCurrencyAmount: '-143' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '-143' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:26:26' transactionType: Reversal preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO acquirerIdentifier: '999080' authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval - expiryDate: '012023' billingCurrencyAmount: '143' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '143' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:24:56' transactionType: Authorization preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval - expiryDate: '012023' billingCurrencyAmount: '141' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '141' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:23:33' transactionType: Authorization preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval - expiryDate: '122023' billingCurrencyAmount: '143' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '143' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-15 transactionTime: '17:32:47' transactionType: Auth Purchase Return preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5999' mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval - expiryDate: '122023' billingCurrencyAmount: '141' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '141' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-15 transactionTime: '17:29:20' transactionType: Auth Purchase Return preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5999' mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval Mastercard-Response-Declined-Transaction-Type: summary: Mastercard Sample Response for Declined Transaction Type value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: Declined virtualCardAccountNumber: '5281722601926445' programId: '429777' reportStatus: COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED authorizationRecords: - expiryDate: '122021' billingCurrencyAmount: '123' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '123' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:52:11' transactionType: Authorization preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Refer to card issuer vcaAuthorizationResponseDetail: Iss/Netwk decline - expiryDate: '122023' billingCurrencyAmount: '0' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '0' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-15 transactionTime: '17:34:03' transactionType: Reversal preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5999' mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO acquirerIdentifier: '999080' authorizationResponseDetail: Do not honor vcaAuthorizationResponseDetail: No Auth for Revl Mastercard-Response-Issuer-Declined-Transaction-Type: summary: >- Mastercard Sample Response for Issuer-Declined Transaction Type value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: Issuer-Declined virtualCardAccountNumber: '5281722601926445' programId: '429777' reportStatus: COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED authorizationRecords: - expiryDate: '122021' billingCurrencyAmount: '123' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '123' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:52:11' transactionType: Authorization preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Refer to card issuer vcaAuthorizationResponseDetail: Iss/Netwk decline Mastercard-Response-Reversal-Response-Transaction-Type: summary: >- Mastercard Sample Response for Reversal-Response Transaction Type value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: Reversal-Response virtualCardAccountNumber: '5281722601926445' programId: '429777' reportStatus: COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED authorizationRecords: - expiryDate: '012023' billingCurrencyAmount: '-143' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '-143' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:26:26' transactionType: Reversal preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO acquirerIdentifier: '999080' authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval - expiryDate: '122023' billingCurrencyAmount: '0' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '0' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-15 transactionTime: '17:34:03' transactionType: Reversal preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5999' mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO acquirerIdentifier: '999080' authorizationResponseDetail: Do not honor vcaAuthorizationResponseDetail: No Auth for Revl Mastercard-Response-Request-Response-Transaction-Type: summary: >- Mastercard Sample Response for Request-Response Transaction Type value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: Request-Response virtualCardAccountNumber: '5281722601926445' programId: '429777' reportStatus: COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED authorizationRecords: - expiryDate: '122021' billingCurrencyAmount: '123' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '123' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:52:11' transactionType: Authorization preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Refer to card issuer vcaAuthorizationResponseDetail: Iss/Netwk decline - expiryDate: '012023' billingCurrencyAmount: '143' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '143' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:24:56' transactionType: Authorization preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval - expiryDate: '012023' billingCurrencyAmount: '141' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '141' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '19:23:33' transactionType: Authorization preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' transactionEnvironment: POS authorizationResponseDetail: Approved or completed successfully vcaAuthorizationResponseDetail: Approval Mastercard-Response-Purchase-Return: summary: Mastercard Sample Response for Purchase-Return value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: All virtualCardAccountNumber: '5281723603983210' programId: '429777' reportStatus: COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED authorizationRecords: - expiryDate: '122023' billingCurrencyAmount: '143' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '143' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-15 transactionTime: '17:32:47' transactionType: Purchase Return preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5999' mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES merchantId: 00000R-5411-USA merchantName: GROCERY STORES SUPERM OFALLON MO merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '999080' terminalId: '33248931' transactionEnvironment: UNKNOWN vcaAuthorizationResponseDetail: Approval Mastercard-Response-Forced-Post: summary: Mastercard Sample Response for Forced-Post value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: All virtualCardAccountNumber: '5281723603983210' programId: '429777' reportStatus: COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED authorizationRecords: - billingCurrencyAmount: '127.00' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '127.00' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '14:41:52' transactionType: Forced Post preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: R-5411-USA merchantName: GROCERY STORES SUPERM merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '00000999080' transactionEnvironment: POS vcaAuthorizationResponseDetail: Approval - billingCurrencyAmount: '143.00' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '143.00' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '14:37:13' transactionType: Forced Post preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: R-5411-USA merchantName: GROCERY STORES SUPERM merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '00000999080' transactionEnvironment: POS vcaAuthorizationResponseDetail: Approval - billingCurrencyAmount: '125.00' billingCurrencyCode: USD billingCurrencyCodeDescription: US Dollar transactionCurrencyCode: USD transactionCurrencyAmount: '125.00' transactionCurrencyCodeDescription: US Dollar transactionDate: 04-20 transactionTime: '14:36:25' transactionType: Forced Post preAuthorizationFlag: 'No' addressVerificationServiceFlag: 'No' merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: R-5411-USA merchantName: GROCERY STORES SUPERM merchantCountryCode: USA merchantCountryName: United States (the) acquirerIdentifier: '00000999080' transactionEnvironment: POS vcaAuthorizationResponseDetail: Approval Mastercard-Pending-Response: summary: Mastercard Sample Response for Pending Response value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: All virtualCardAccountNumber: '5281723603983210' programId: '429777' reportStatus: PARTIALLY COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' errorMessage: >- Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments errorCode: ERC0004 status: PENDING - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' errorMessage: >- Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments errorCode: ERC0004 status: PENDING Mastercard-Active-Response: summary: Mastercard Sample Response for Active Response value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: All virtualCardAccountNumber: '5281723603983210' programId: '429777' reportStatus: PARTIALLY COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' errorMessage: >- Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments errorCode: ERC0004 status: ACTIVE - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' errorMessage: >- Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments errorCode: ERC0004 status: ACTIVE '400': description: >-
ErrorResponseForAuthReport\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeError Description
ERS0001Invalid Virtual Card Account Number format
ERS0002Invalid Transaction Type
ERS0003timeZone field is empty or has an invalid UTC offset time zone format
ERC0004Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments.
ERS0007Invalid Message ID format
ERS0009Client Onboard Configuration setup is missing. Contact Citi support.
ERS0010Invalid Report ID format. Report ID must include numeric values
ERS0053Start Date is Mandatory.
ERS0054End Date is Mandatory.
ERS0055Requested report date cannot exceed 180 days in the past from today's date
ERS0057startDate value exceeds requested endDate value
ERS0060Client ID and/or Program Id is missing in Client Onboard Configuration setup. Contact Citi support.
ERS0061VCA ID is not present in our system
ERS0063Requested Time Zone is not supported
ERS0068Program Id is Mandatory.
ERS0069Vca Id is Mandatory.
ERS0070Message Id is Mandatory.
ERS0071Virtual Card Account Number is Mandatory.
ERS0072Requested report date cannot exceed 36 months in the past from todays date
ERS0079The requested report ID(s) is for a VCA that is different than the VCA included in the request. Please include the VCA associated to the report ID(s).
ERS0080The requested report ID(s) is for a programId that is different than the programId included in the request. Please include the programId associated to the report ID(s).
ERS0081The requested report ID(s) is for a timeZone that is different than the timeZone included in the request. Please include the timeZone associated to the report ID(s).
ERS0082The requested report IDs are for different VCAs, Please include report IDs that belong to the same VCA.
ERS0083The requested report IDs are for different program IDs, Please include report IDs that belong to the same program ID.
ERS0084The requested report IDs are for different requested time zones, Please include report IDs that belong to the same requested time zone.
ERS0091startDate value must have valid format: YYYY-MM-DD
ERS0092endDate value must have valid format: YYYY-MM-DD
ERS0093The date specified in startDate does not exist
ERS0094The date specified in endDate does not exist
ERS0095Report ID included in your request is not present for the given ClientID/program ID. Please generate a new report ID for this Reports request by calling the Reports API without a report ID
ERS0097startTime value must have valid format: HH:MM - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)
ERS0098endTime value must have valid format: HH:MM - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)
ERS0099startTime value cannot exceed the requested endTime value
ERS0100Invalid sortOrder value
ERS0101startIndex should be numeric
ERS0102endIndex should be numeric
ERS0103startIndex should be less than or equal to endIndex
ERS0104The startIndex & endIndex range cannot be greater than 150
ERS0105The startDate and endDate range cannot be greater than 30 days if paginationRequired is true
MS0001Invalid Virtual Card Account Number
MS0002From date should be before to date.
MS0006Invalid vcaId value
MS0008Invalid Report ID
GRC0002Client ID is missing in the request header
GRC0003Invalid JSON Input
GRC0004Region ID is not available in the request
GRC0011Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support.
GRC0016Country code is not available in the request
content: application/json: schema: $ref: '#/components/schemas/ErrorResponseForAuthReport' '500': description: >-
ServerErrorResponseForAuthReport
Error CodeError Description
GRC0001We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments.
GRC0006We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments.
GRC0009We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments.
GRC0014We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments
content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponseForAuthReport' '504': description: >-
ErrorResponseForAuthReportBackend Connectivity Error
content: application/json: schema: $ref: '#/components/schemas/ErrorResponseForAuthReport' /vca/v2/reports/clearing: post: summary: Obtain Cleared Transaction Details Reporting description: >- Obtain cleared transaction details on a VCA for reporting and payment reconciliation operationId: Clearing Report parameters: - name: Content-Type in: header description: Supports application/json required: true schema: type: string - name: Authorization in: header description: >- Oauth token included by the external client to APIm. APIm will external the client ID and pass it to GRACE required: true schema: type: string - name: Country in: header description: >- Three character length country code used during onboarding into GRACE schema: type: string required: true - name: Region in: header description: >- This value will be used by APIm to route to the respective GRACE backend instance schema: type: string required: true - name: Req-Sys-Id in: header description: >- Unique ID of the API message sent. This ID will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration. schema: type: string required: false requestBody: description: ClearingReportInboundRequest required: true content: application/json: schema: $ref: '#/components/schemas/ClearingReportInboundRequest' examples: Mastercard-Request-Required-Fields: summary: Mastercard Sample Request with Required Fields value: vcaId: '17896177' virtualCardAccountNumber: '9898121243438778' programId: '431341' messageId: CITI00ClearingReport0020260521195320 startDate: '2026-04-01' endDate: '2026-04-30' timeZone: UTC-04:00 Visa-Request-Required-Fields: summary: Visa Sample Request with Required Fields value: vcaId: '2026052113115824204' virtualCardAccountNumber: '9898121243438000' programId: '918' messageId: CITI00ClearingReport0020260521195321 startDate: '2026-04-01' endDate: '2026-04-30' Mastercard-Request-All-Fields: summary: Mastercard Sample Request with All Fields value: vcaId: '17896177' virtualCardAccountNumber: '9898121243438778' programId: '431341' messageId: CITI00ClearingReport0020260521195322 startDate: '2026-04-01' endDate: '2026-04-30' startTime: '00:00' endTime: '23:00' timeZone: UTC-04:00 transactionType: All Visa-Request-All-Fields: summary: Visa Sample Request with All Fields value: vcaId: '2026052113115824204' virtualCardAccountNumber: '9898121243438000' programId: '918' messageId: CITI00ClearingReport0020260521195323 startDate: '2026-04-01' endDate: '2026-04-30' startTime: '00:00' endTime: '23:00' Mastercard-Pagination-Request: summary: Mastercard Sample Request with Pagination value: vcaId: '17896177' virtualCardAccountNumber: '9898121243438778' programId: '431341' messageId: CITI00ClearingReport0020260521195324 startDate: '2026-04-01' endDate: '2026-04-30' timeZone: UTC-04:00 transactionType: All reportIds: - '1234567' - '2345678' filters: paginationRequired: 'true' sortOrder: DESCENDING startIndex: '101' endIndex: '200' Visa-Pagination-Request: summary: Visa Sample Request with Pagination value: vcaId: '2026052113115824204' virtualCardAccountNumber: '9898121243438000' programId: '918' messageId: CITI00ClearingReport0020260521195325 startDate: '2026-04-01' endDate: '2026-04-30' filters: paginationRequired: 'true' startIndex: '150' endIndex: '300' Mastercard-Retry-Request: summary: Mastercard Sample Retry Request for Pending/Active Status value: vcaId: '17896177' virtualCardAccountNumber: '9898121243438778' programId: '431341' messageId: CITI00ClearingReport0020260521195326 startDate: '2026-04-01' endDate: '2026-04-30' timeZone: UTC-04:00 transactionType: All reportIds: - '1234567' responses: '200': description: >-
CodeDetails
ClearingReportInboundResponsesuccess
content: application/json: schema: $ref: '#/components/schemas/ClearingReportInboundResponse' examples: Mastercard-Response-All-Transaction-Type: summary: Mastercard Sample Response for All Transaction Type value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 virtualCardAccountNumber: '5281722601926445' programId: '429777' reportStatus: COMPLETED transactionType: All info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED clearingRecords: - transactionCurrencyAmount: '143' transactionCurrencyCode: USD transactionCurrencyCodeDescription: U.S. DOLLAR transactionExchangerate: '1' billingCurrencyCode: USD billingCurrencyAmount: '143' billingCurrencyCodeDescription: U.S. DOLLAR merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000999080R-5411-USA merchantName: GROCERY STORES SUPERM merchantCity: OFALLON merchantState: MO merchantCountryCode: USA merchantCountryName: UNITED STATES acquirerIdentifier: '00000999080' acquirerReferenceData: '25567681110000232050357' messageType: '1240' messageReasonCode: '1400' functionCode: '200' transactionDate: '2021-04-21' transactionTime: '11:06:00' settlementAmount: '189.98' settlementCurrencyCode: SGD settlementCurrencyDescription: Singapore Dollar approvalCode: '802907' transactionPostDate: '2021-04-21' transactionType: First Presentment - transactionCurrencyAmount: '141' transactionCurrencyCode: USD transactionCurrencyCodeDescription: U.S. DOLLAR transactionExchangerate: '1' billingCurrencyCode: USD billingCurrencyAmount: '141' billingCurrencyCodeDescription: U.S. DOLLAR merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000999080R-5411-USA merchantName: GROCERY STORES SUPERM merchantCity: OFALLON merchantState: MO merchantCountryCode: USA merchantCountryName: UNITED STATES acquirerIdentifier: '00000999080' acquirerReferenceData: '25567681110000232050340' messageType: '1240' messageReasonCode: '1400' functionCode: '200' transactionDate: '2021-04-21' transactionTime: '11:06:00' settlementAmount: '187.32' settlementCurrencyCode: SGD settlementCurrencyDescription: Singapore Dollar approvalCode: '802931' transactionPostDate: '2021-04-21' transactionType: First Presentment Mastercard-Response-Presentment-Transaction-Type: summary: Mastercard Sample Response for Presentment Transaction Type value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 virtualCardAccountNumber: '5281723603983210' transactionType: Presentment programId: '429777' reportStatus: COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED clearingRecords: - transactionCurrencyAmount: '127' transactionCurrencyCode: USD transactionCurrencyCodeDescription: U.S. DOLLAR transactionExchangerate: '1' billingCurrencyCode: USD billingCurrencyAmount: '127' billingCurrencyCodeDescription: U.S. DOLLAR merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000999080R-5411-USA merchantName: GROCERY STORES SUPERM merchantCity: OFALLON merchantState: MO merchantCountryCode: USA merchantCountryName: UNITED STATES acquirerIdentifier: '00000999080' acquirerReferenceData: '25567681110000232050407' messageType: '1240' messageReasonCode: '1400' functionCode: '200' transactionDate: '2021-04-21' transactionTime: '11:06:00' settlementAmount: '168.72' settlementCurrencyCode: SGD settlementCurrencyDescription: Singapore Dollar approvalCode: '802910' transactionPostDate: '2021-04-21' transactionType: First Presentment - transactionCurrencyAmount: '143' transactionCurrencyCode: USD transactionCurrencyCodeDescription: U.S. DOLLAR transactionExchangerate: '1' billingCurrencyCode: USD billingCurrencyAmount: '143' billingCurrencyCodeDescription: U.S. DOLLAR merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000999080R-5411-USA merchantName: GROCERY STORES SUPERM merchantCity: OFALLON merchantState: MO merchantCountryCode: USA merchantCountryName: UNITED STATES acquirerIdentifier: '00000999080' acquirerReferenceData: '25567681110000232050399' messageType: '1240' messageReasonCode: '1400' functionCode: '200' transactionDate: '2021-04-21' transactionTime: '11:06:00' settlementAmount: '189.98' settlementCurrencyCode: SGD settlementCurrencyDescription: Singapore Dollar approvalCode: '802933' transactionPostDate: '2021-04-21' transactionType: First Presentment - transactionCurrencyAmount: '125' transactionCurrencyCode: USD transactionCurrencyCodeDescription: U.S. DOLLAR transactionExchangerate: '1' billingCurrencyCode: USD billingCurrencyAmount: '125' billingCurrencyCodeDescription: U.S. DOLLAR merchantCategoryCode: '5812' mccDescription: EATING PLACES RESTAURANTS merchantId: 00000999080R-5411-USA merchantName: GROCERY STORES SUPERM merchantCity: OFALLON merchantState: MO merchantCountryCode: USA merchantCountryName: UNITED STATES acquirerIdentifier: '00000999080' acquirerReferenceData: '25567681110000232050381' messageType: '1240' messageReasonCode: '1400' functionCode: '200' transactionDate: '2021-04-21' transactionTime: '11:06:00' settlementAmount: '166.06' settlementCurrencyCode: SGD settlementCurrencyDescription: Singapore Dollar approvalCode: '802909' transactionPostDate: '2021-04-21' transactionType: First Presentment Mastercard-Response-Second-Presentment-Transaction-Type: summary: >- Mastercard Sample Response for Second Presentment Transaction Type value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 virtualCardAccountNumber: '5281723603983210' transactionType: Second Presentment programId: '429777' reportStatus: COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED Mastercard-Response-Chargeback-Transaction-Type: summary: Mastercard Sample Response for Chargeback Transaction Type value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 virtualCardAccountNumber: '5281723603983210' transactionType: Chargeback programId: '429777' reportStatus: COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED Mastercard-Response-Retrieval-Request-Transaction-Type: summary: >- Mastercard Sample Response for Retrieval Request Transaction Type value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 virtualCardAccountNumber: '5281723603983210' transactionType: Retrieval Request programId: '429777' reportStatus: COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' status: COMPLETED - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' status: COMPLETED Mastercard-Pending-Response: summary: Mastercard Sample Response for Pending Response value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: All virtualCardAccountNumber: '5281723603983210' programId: '429777' reportStatus: PARTIALLY COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' errorMessage: >- Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments errorCode: ERC0004 status: PENDING - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' errorMessage: >- Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments errorCode: ERC0004 status: PENDING Mastercard-Active-Response: summary: Mastercard Sample Response for Active Response value: vcaId: '17896177' startDate: '2021-02-27' endDate: '2021-04-27' messageId: '123456789123456789123456789123450066' timeZone: UTC+05:30 transactionType: All virtualCardAccountNumber: '5281723603983210' programId: '429777' reportStatus: PARTIALLY COMPLETED info: - fromDate: '2021-02-27' toDate: '2021-03-29' reportId: '1122330' errorMessage: >- Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments errorCode: ERC0004 status: ACTIVE - fromDate: '2021-03-30' toDate: '2021-04-27' reportId: '1122331' errorMessage: >- Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments errorCode: ERC0004 status: ACTIVE '400': description: >-
ErrorResponseForAuthReport\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeError Description
ERS0001Invalid Virtual Card Account Number format
ERS0002Invalid Transaction Type
ERS0003timeZone field is empty or has an invalid UTC offset time zone format
ERC0004Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments.
ERS0007Invalid Message ID format
ERS0009Client Onboard Configuration setup is missing. Contact Citi support.
ERS0010Invalid Report ID format. Report ID must include numeric values
ERS0053Start Date is Mandatory.
ERS0054End Date is Mandatory.
ERS0055Requested report date cannot exceed 180 days in the past from today's date
ERS0057startDate value exceeds requested endDate value
ERS0060Client ID and/or Program Id is missing in Client Onboard Configuration setup. Contact Citi support.
ERS0061VCA ID is not present in our system
ERS0063Requested Time Zone is not supported
ERS0068Program Id is Mandatory.
ERS0069Vca Id is Mandatory.
ERS0070Message Id is Mandatory.
ERS0071Virtual Card Account Number is Mandatory.
ERS0072Requested report date cannot exceed 36 months in the past from todays date
ERS0079The requested report ID(s) is for a VCA that is different than the VCA included in the request. Please include the VCA associated to the report ID(s).
ERS0080The requested report ID(s) is for a programId that is different than the programId included in the request. Please include the programId associated to the report ID(s).
ERS0081The requested report ID(s) is for a timeZone that is different than the timeZone included in the request. Please include the timeZone associated to the report ID(s).
ERS0082The requested report IDs are for different VCAs, Please include report IDs that belong to the same VCA.
ERS0083The requested report IDs are for different program IDs, Please include report IDs that belong to the same program ID.
ERS0084The requested report IDs are for different requested time zones, Please include report IDs that belong to the same requested time zone.
ERS0091startDate value must have valid format: YYYY-MM-DD
ERS0092endDate value must have valid format: YYYY-MM-DD
ERS0093The date specified in startDate does not exist
ERS0094The date specified in endDate does not exist
ERS0095Report ID included in your request is not present for the given ClientID/program ID. Please generate a new report ID for this Reports request by calling the Reports API without a report ID
ERS0097startTime value must have valid format: HH:MM - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)
ERS0098endTime value must have valid format: HH:MM - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)
ERS0099startTime value cannot exceed the requested endTime value
ERS0100Invalid sortOrder value
ERS0101startIndex should be numeric
ERS0102endIndex should be numeric
ERS0103startIndex should be less than or equal to endIndex
ERS0104The startIndex & endIndex range cannot be greater than 150
ERS0105The startDate and endDate range cannot be greater than 30 days if paginationRequired is true
MS0001Invalid Virtual Card Account Number
MS0002From date should be before to date.
MS0006Invalid vcaId value
MS0008Invalid Report ID
GRC0002Client ID is missing in the request header
GRC0003Invalid JSON Input
GRC0004Region ID is not available in the request
GRC0011Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support.
GRC0016Country code is not available in the request
content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponseForClearingReport' '504': description: >-
ErrorResponseForClearingReportBackend Connectivity Error
content: application/json: schema: $ref: '#/components/schemas/ErrorResponseForClearingReport' components: schemas: AuthReportInboundRequest: properties: startDate: description: >- Specifies the start date upto when the reports can be retrieved

Format:YYYY-MM-DD

Rules:
  1. Start date should be less than end date.
  2. Start date should not be earlier than create VCA date
  3. Mastercard:
  4. Visa:
type: string format: alphanumeric example: '2023-01-01' maxLength: 10 endDate: description: >- Specifies the end date upto when the reports can be retrieved

Format:YYYY-MM-DD

Rules:
  1. End date should greater than the start date
  2. Mastercard:
  3. Visa:
type: string format: alphanumeric example: '2023-03-30' maxLength: 10 startTime: description: >- Specifies the start time from when the reports can be retrieved

Format:HH:MM type: string format: alphanumeric example: '00:00' maxLength: 10 endTime: description: >- Specifies the end time upto when the reports can be retrieved

Format:HH:MM type: string format: alphanumeric example: '23:59' maxLength: 10 transactionType: description: >- Specifies the nature of the transaction whether it was authorized or returned etc.

Visa - Not applicable

Mastercard - Optional

Possible Values:
"All" - Returns all Authorization transactions associated to a virtual card account for a given time range
"Approved" - Authorization requests that have an Approved Authorization status from the issuer or card network
"Partial-Approved" - Authorization requests that have a Partial Approval Authorization status from the issuer
"Declined" - Authorization requests that have a declined Authorization status from the issuer or card network
"Issuer-Declined" - Authorization requests that have an declined Authorization status from the issuer
"Request-Response" - Response to an authorization request. It carries the response information required to service (approve or deny) the Authorization Request.
"Advice-Response" - Response by an Issuer or System to either an Acquirer-generated, Issuer-generated, or System-generated Authorization Advice message Note: Advices for Issuer declines, that match an earlier Auth, do not generate a record and therefore will not be included in this filter.
"Reversal-Response" - Response to a reversal request and denotes the disposition of the Reversal Request type: string format: alphanumeric example: All maxLength: 20 vcaId: description: >- A reference number that uniquely identifies the virtual card account. type: string format: alphanumeric example: '67676781' maxLength: 19 programId: description: >- Unique ID of the company record defined in the virtual cards system.

Mastercard - This value is returned in the ID Provisioning API. This value is generated when the VCA program is onboarded to Mastercard's VCA platform. Data format - Long (Numeric). Max character length - 19

Visa - This value is generated when the VCA program is onboarded to Visa's VCA platform. Data format - Alphanumeric. Max character length - 25 type: string format: alphanumeric example: '233191' maxLength: 25 messageId: description: >- Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID must be unique per API request and cannot include special characters type: string format: alphanumeric example: CITI00000000AuthReport20230825120311 maxLength: 36 minLength: 28 virtualCardAccountNumber: description: >- The virtual card account number to use for transactions.

Numeric field and no decimals allowed type: string format: alphanumeric example: '5281722601926445' maxLength: 16 timeZone: description: >- Defines the time zone applicable for any date or time

UTC offset

Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: UTC+05:30 maxLength: 9 reportIds: description: >- An optional reportId array passed by client to fetch the Auth report transactions that previously returned a "PENDING" or "IN-PROGRESS" report status. When calling the API with reportId, pass all other request parameters as orignally passed in the previous request type: array items: type: string format: alphanumeric example: - '12345' filters: $ref: '#/components/schemas/RequestFilters' required: - startDate - endDate - vcaId - programId - messageId - virtualCardAccountNumber RequestFilters: description: Provides variaous filter features which are optional in nature type: object properties: sortOrder: description: >- Specifies the oder in which transactions needs to be sorted.

Applicable for Mastercard only.

`Possible values`: ASCENDING, DESCENDING type: string format: alphanumeric example: ASCENDING maxLength: 10 paginationRequired: description: >- Specifies whether pagination is required or not.

If paginationRequired is true, startDate and endDate cannot be more than 30 days apart. type: string format: boolean example: 'true' startIndex: description: >- Specifies the start index of the transactions being requested for pagination

Rules:
  1. Positive number greater than or equal to 1
  2. Visa:
type: string format: alphanumeric example: '1' endIndex: description: >- Specifies the end index of the transactions being requested for pagination

Rules:
  1. Positive number greater than or equal to 1
  2. Visa:
type: string format: alphanumeric example: '100' AuthReportInboundResponse: properties: vcaId: description: >- A reference number that uniquely identifies the virtual card account. type: string format: alphanumeric example: '67676781' maxLength: 19 messageId: description: >- Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per API request. type: string format: alphanumeric example: CITI00000000AuthReport20230825120311 maxLength: 36 minLength: 28 programId: description: Unique ID of the company record defined in the virtual cards system. type: string format: alphanumeric example: '233191' maxLength: 25 startDate: description: >- Specifies the start date from when the reports can be retrieved

Format:YYYY-MM-DD type: string format: alphanumeric example: '2023-01-01' maxLength: 10 endDate: description: >- Specifies the start date from when the reports can be retrieved

Format:YYYY-MM-DD type: string format: alphanumeric example: '2023-03-30' maxLength: 10 startTime: description: >- Specifies the start time from when the reports can be retrieved

Format:HH:MM type: string format: alphanumeric example: '00:00' maxLength: 10 endTime: description: >- Specifies the end time upto when the reports can be retrieved

Format:HH:MM type: string format: alphanumeric example: '23:59' maxLength: 10 reportStatus: description: >- Status of whether the report request was processed.

Mastercard - If a report status other than COMPLETED is returned, subsequently call the Reports API with the orginal request parameter previously passed along with the list of reportIds for each 30-day date range that did not return a COMPLETED report status type: string format: alphanumeric example: COMPLETED maxLength: 19 enum: - COMPLETED - PARTIALLY COMPLETED - FAILED - PENDING warning: description: >- Warning information regarding a non-fatal response condition that may be taken into account, but can be ignored type: string format: alphanumeric example: Warning message maxLength: 200 timeZone: description: Defines the time zone applicable for any date or time
UTC offset type: string format: alphanumeric example: UTC+05:30 maxLength: 9 transactionType: description: >- Specifies the type of transaction.

Possible values - Mastercard:

"Authorization" - Transactions that have a requested authorization
"Auth Purchase Return" - Authorization from issuer on a reversal (refund/credit)
"Advice" - Non-posting message generated by either an acquirer, issuer, or system. Acquirer-generated advice message - advises of an authorization that was carried out on the issuer’s behalf. Issuer-generated advice message - sent to the risk scoring system. System-generated advice message - advises of an authorization that was carried out on the issuer’s behalf.
"Reversal" - Reversal Request generated by an acquirer when the acquirer is unable to deliver an issuer’s Authorization Request Response to a merchant. Merchants also may initiate a Reversal Request to cancel the full or partial amount of the original authorization amount
"Reversal advice" - The Reversal Advice message fully reverses a previous Authorization Request. It advises an issuer of a Reversal Request responded to by the Authorization Platform. Reversal advise is generated by the Authorization Platform on detection of an exception condition while processing a previous Authorization Request Response. The Authorization Platform may generate this message when an issuer is unavailable to respond to a Reversal Request or is delayed in providing a Reversal Request Response message.
"Unspecified (Offline Settlements)" - Returned when none of the transactionType values apply: Authorization, Auth Purchase Return, Advise, Reversal, Reversal advice, Purchase Return, Forced Post
"Purchase Return" - Clearing only refund/credit
"Forced Post" - Forced Posted are records inserted in the authorization journal from clearing records when the clearing record didn’t match to a preceding authorization record

Possible values - Visa:

"0" - NOT APPLICABLE
"100" - AUTHORIZATION REQUEST
"101" - REPEAT AUTHORIZATION REQUEST
"102" - ATM CONFIRMATION
"110" - AUTHORIZATION RESPONSE
"120" - AUTHORIZATION ADVICE
"130" - AUTHORIZATION ADVICE
"200" - ORIGINAL FINANCIAL REQUEST
"201" - REPEAT FINANCIAL REQUEST
"210" - ORIGINAL FINANCIAL RESPONSE
"220" - ORIGL/ADVC/ADJMT/RPRSNT REQUEST
"221" - REPEAT FINANCIAL ADVICE
"230" - ORIGL/ADVC/ADJMT/RPRSNT RESPONSE
"282" - REPRESENTMENT STATUS ADVICE
"292" - REPRESENTMENT STATUS ADVICE RESPONSE
"300" - FILE OR INQUIRY UPDATE- ACQUIRER
"302" - FILE OR INQUIRY UPDATE-ISSUER
"310" - FILE UPDATE OR INQUIRY RESPONSE-ACQUIRER
"312" - FILE UPDATE OR INQUIRY RESPONSE-ISSUER
"322" - FILE UPDATE OR DISCREPANCY ADVICE
"332" - FILE UPDATE ADVICE RESPONSE
"400" - REVERSAL REQUEST
"401" - REPEAT REVERSAL REQUEST
"410" - REVERSAL RESPONSE
"420" - REVERSAL ADVICE
"422" - CHARGEBACK REQUEST
"430" - REVERSAL ADVICE RESPONSE
"432" - CHARGEBACK RESPONSE
"480" - CHARGEBACK STATUS ADVICE
"490" - CHARGEBACK STATUS ADVICE RESPONSE
"500" - RECONCILIATION TOTAL REQUEST
"510" - RECONCILIATION TOTAL RESPONSE
"520" - RECONCILIATION ADVICE
"530" - RECONCILIATION RESPONSE
"600" - ADMINISTRATIVE REQUEST
"610" - ADMINISTRATIVE RESPONSE
"620" - ADMINISTRATIVE ADVICE
"622" - ADMINISTRATIVE ADVICE RESPONSE type: string format: alphanumeric example: All maxLength: 20 virtualCardAccountNumber: description: The virtual card account number to use for transactions. type: string format: alphanumeric example: '5281722601926445' maxLength: 19 filters: $ref: '#/components/schemas/ResponseFilters' info: type: array items: $ref: '#/components/schemas/AuthInfo' authorizationRecords: type: array items: $ref: '#/components/schemas/AuthorizationRecords' required: - vcaId - messageId - programId - startDate - endDate - reportStatus - transactionType - virtualCardAccountNumber ResponseFilters: description: Provides variaous filter features which are optional in nature type: object properties: sortOrder: description: >- Specifies the oder in which transactions are sorted.

Applicable for Mastercard only

`Possible values`: ASCENDING, DESCENDING type: string format: alphanumeric example: ASCENDING maxLength: 10 paginationApplied: description: Specifies whether pagination has been requested or not type: string format: boolean example: 'true' startIndex: description: >- Specifies the start index of the transactions being requested for pagination type: string format: alphanumeric example: '1' endIndex: description: >- Specifies the end index of the transactions being requested for pagination. type: string format: alphanumeric example: '100' lastIndex: description: >- Specifies the index of the last available transaction.

Applicable for Mastercard only type: string format: alphanumeric example: '250' hasMore: description: Specifie if there further transactions after the endIndex. type: string format: boolean example: 'true' AuthInfo: properties: fromDate: description: >- Specifies the start date from when the reports can be retrieved
Format - YYYY-MM-DD

Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '2023-01-01' maxLength: 10 toDate: description: >- Specifies the end date upto when the reports can be retrieved

Format - YYYY-MM-DD

Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '2023-02-01' maxLength: 10 reportId: description: >- The report Id generated for a given 30-day date range
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric errorCode: description: >- The error code if there is any error occurred while retrieving the transaction type: string format: alphanumeric example: ERC0004 errorMessage: description: >- The error description that corresponds to error code when there is any error occurred while retrieving the transaction. type: string format: alphanumeric example: >- Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments. maxLength: 200 status: description: >- Defines the status of the data that was requested whether the request has been processed or not.
Visa - Not applicable
Mastercard - Required

Possible values:
COMPLETED
FAILED
PENDING
IN PROGRESS type: string format: alphanumeric example: PENDING maxLength: 10 AuthorizationRecords: properties: expiryDate: description: >- Expiry Date of the virtual card account.

Format MMYYYY

Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '122021' maxLength: 6 billingCurrencyAmount: description: >- Specifies the value of transaction amount which is converted to billling currency type: string format: alphanumeric example: '123.00' maxLength: 16 billingCurrencyCode: description: >- Specifies the ISO currency code of accounts that was initially set up for billing the transactions. type: string format: alphanumeric example: USD maxLength: 3 billingCurrencyCodeDescription: description: >- Specifies the description of currency code of accounts that was initially set up for billing the transactions. type: string format: alphanumeric example: US Dollar maxLength: 70 billingAmountInUSD: description: >- Card Holder billing amount converted to USD currency.
Mastercard - Not applicable
Visa - Required type: string format: alphanumeric example: '123.00' maxLength: 16 transactionCurrencyAmount: description: Specifies the actual transaction amount in transaction currency. type: string format: alphanumeric example: '123.00' maxLength: 16 transactionCurrencyCode: description: >- Specifies the ISO currency code on which actual authorization of transaction was done. type: string format: alphanumeric example: USD maxLength: 3 transactionCurrencyCodeDescription: description: >- Specifies the currency code description on which actual authorization of transaction was done. type: string format: alphanumeric example: US Dollar maxLength: 70 transactionExchangerate: description: >- Currency exchange in operation during a payment.
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '1' maxLength: 7 transactionDate: description: >- The date of the transaction that was initiated and amount debited.
Format - YYYY-MM-DD type: string format: alphanumeric example: '2023-01-20' maxLength: 10 transactionTime: description: >- The time of the transaction that was initiated and amount debited
Format - hh:mm:ss type: string format: alphanumeric example: '19:52:11' maxLength: 8 transactionType: description: >- Specifies the type of transaction.

Possible values - Mastercard:

"Authorization" - Transactions that have a requested authorization
"Auth Purchase Return" - Authorization from issuer on a reversal (refund/credit)
"Advice" - Non-posting message generated by either an acquirer, issuer, or system. Acquirer-generated advice message - advises of an authorization that was carried out on the issuer’s behalf. Issuer-generated advice message - sent to the risk scoring system. System-generated advice message - advises of an authorization that was carried out on the issuer’s behalf.
"Reversal" - Reversal Request generated by an acquirer when the acquirer is unable to deliver an issuer’s Authorization Request Response to a merchant. Merchants also may initiate a Reversal Request to cancel the full or partial amount of the original authorization amount
"Reversal advice" - The Reversal Advice message fully reverses a previous Authorization Request. It advises an issuer of a Reversal Request responded to by the Authorization Platform. Reversal advise is generated by the Authorization Platform on detection of an exception condition while processing a previous Authorization Request Response. The Authorization Platform may generate this message when an issuer is unavailable to respond to a Reversal Request or is delayed in providing a Reversal Request Response message.
"Unspecified (Offline Settlements)" - Returned when none of the transactionType values apply: Authorization, Auth Purchase Return, Advise, Reversal, Reversal advice, Purchase Return, Forced Post
"Purchase Return" - Clearing only refund/credit
"Forced Post" - Forced Posted are records inserted in the authorization journal from clearing records when the clearing record didn’t match to a preceding authorization record

Possible values - Visa:

"0" - NOT APPLICABLE
"100" - AUTHORIZATION REQUEST
"101" - REPEAT AUTHORIZATION REQUEST
"102" - ATM CONFIRMATION
"110" - AUTHORIZATION RESPONSE
"120" - AUTHORIZATION ADVICE
"130" - AUTHORIZATION ADVICE
"200" - ORIGINAL FINANCIAL REQUEST
"201" - REPEAT FINANCIAL REQUEST
"210" - ORIGINAL FINANCIAL RESPONSE
"220" - ORIGL/ADVC/ADJMT/RPRSNT REQUEST
"221" - REPEAT FINANCIAL ADVICE
"230" - ORIGL/ADVC/ADJMT/RPRSNT RESPONSE
"282" - REPRESENTMENT STATUS ADVICE
"292" - REPRESENTMENT STATUS ADVICE RESPONSE
"300" - FILE OR INQUIRY UPDATE- ACQUIRER
"302" - FILE OR INQUIRY UPDATE-ISSUER
"310" - FILE UPDATE OR INQUIRY RESPONSE-ACQUIRER
"312" - FILE UPDATE OR INQUIRY RESPONSE-ISSUER
"322" - FILE UPDATE OR DISCREPANCY ADVICE
"332" - FILE UPDATE ADVICE RESPONSE
"400" - REVERSAL REQUEST
"401" - REPEAT REVERSAL REQUEST
"410" - REVERSAL RESPONSE
"420" - REVERSAL ADVICE
"422" - CHARGEBACK REQUEST
"430" - REVERSAL ADVICE RESPONSE
"432" - CHARGEBACK RESPONSE
"480" - CHARGEBACK STATUS ADVICE
"490" - CHARGEBACK STATUS ADVICE RESPONSE
"500" - RECONCILIATION TOTAL REQUEST
"510" - RECONCILIATION TOTAL RESPONSE
"520" - RECONCILIATION ADVICE
"530" - RECONCILIATION RESPONSE
"600" - ADMINISTRATIVE REQUEST
"610" - ADMINISTRATIVE RESPONSE
"620" - ADMINISTRATIVE ADVICE
"622" - ADMINISTRATIVE ADVICE RESPONSE type: string format: alphanumeric example: Authorization maxLength: 107 preAuthorizationFlag: description: Pre-Authorization request indicator with Yes/No type: string format: alphanumeric example: 'No' maxLength: 3 addressVerificationServiceFlag: description: >- Indicates whether merchant requests address verification service. Indicator with Yes/No
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: 'No' maxLength: 3 merchantCategoryCode: description: >- The category under which the merchant is been assigned by the network type: string format: alphanumeric example: '5812' maxLength: 10 mccDescription: description: >- The decsription of the category in which merchant has been assigned by the netwrok type: string format: alphanumeric example: EATING PLACES, RESTAURANTS maxLength: 200 merchantId: description: >- The ID created for a specific merchant by the network
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: 00000R-5411-USA maxLength: 50 merchantName: description: >- The merchant name that corresponds to merchant id defined by the netwrok type: string format: alphanumeric example: GROCERY STORES, SUPERM maxLength: 200 merchantState: description: >- The state under which the merchant has been categorized
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: MO maxLength: 100 merchantCity: description: The city under which the merchant has been categorised type: string format: alphanumeric example: OFALLON maxLength: 100 merchantCountryCode: description: >- The conutry code defined under which the merchant has been categorised type: string format: alphanumeric example: USA maxLength: 3 merchantCountryName: description: >- The conutry name that corresponds to merchant country code under which the merchant has been categorised type: string format: alphanumeric example: United States (the) maxLength: 50 merchantZipCode: description: >- The ZIP code defined under which the merchant city has been categorised
Mastercard - Not applicable
Visa - Required type: string format: alphanumeric example: '12345' maxLength: 10 acquirerIdentifier: description: >- The identifier under which the acquirer has been categorised
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '00000999080' maxLength: 50 terminalId: description: The id under which the terminal has been categorised type: string format: alphanumeric example: '789254' maxLength: 50 transactionId: description: >- Unique identifier of the transaction
Mastercard - Not applicable
Visa - Required type: string format: alphanumeric example: '380198318999999' maxLength: 50 transactionEnvironment: description: >- The environment where the transaction was initaited either through ATM or POS etc.
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: POS maxLength: 7 partialAuthorizationAmount: description: >- Partial Authorization Amount
Mastercard - Not applicable
Visa - Required type: string format: alphanumeric example: '100.02' maxLength: 16 authorizationResponseDetail: description: >- Authorization Status/Reason Description from Issuer

Possible values:

Visa:

0 - APPROVED
1 - REFER TO ISSUER
2 - REFER TO ISSUER, SPCL COND
3 - INVALID MERCHANT
4 - PICK UP CARD
5 - DO NOT HONOR - If a transaction declines due to a VPC rule, it will fall under this error code.
6 - ERROR
7 - PICK UP CARD, SPCL COND
10 - APPROVAL FOR PARTIAL AMT
11 - APPROVED(VIP)
12 - INVALID TRANSACTION
13 - INVALID AMOUNT
14 - INVALID ACCOUNT NUMBER
15 - NO SUCH ISSUER
19 - RE-ENTER TRANSACTION
21 - NO ACTION TAKEN
25 - UNABLE TO LOCATE RECORD
28 - FILE TEMP UNAVAILABLE
30 - STRUCTURAL MESSAGE ERROR
31 - BANK NOT SUPPORTED
39 - NO CREDIT ACCOUNT
41 - PICK UP CARD-LOST
43 - PICK UP CARD-STOLEN
51 - NOT SUFFICIENT FUNDS
52 - NO CHECKING ACCOUNT
53 - NO SAVINGS ACCOUNT
54 - EXPIRED CARD/NO EXP DATE
55 - INCORRECT OR MISSING PIN
56 - UNABLE TO LOCATE RECORD
57 - TRANSACTION NOT PERMITTED
58 - TRAN INVALID AT TERMINAL
59 - SUSPECTED FRAUD
61 - OVER ACTIVITY AMT LIMI
62 - RESTRICTED CARD
63 - SECURITY VIOLATION
64 - TRANSACTION DOES NOT MEET
65 - OVER ACTIVITY COUNT LIMIT
68 - LATE RESPONSE
75 - PIN ENTRY TRIES EXCEEDED
76 - UNSOLICITED REVERSAL
77 - PREV MSG INCONSISTENT
78 - NO ACCOUNT
79 - ALREADY REVERSED
80 - NO FINANCIAL IMPACT
81 - CRYPTOGRAPHIC ERROR FOUND
82 - INCORRECT CVV/ICVV
83 - UNABLE TO VERIFY PIN
84 - OVER PREAUTH TIME LIMIT
85 - NO REASON TO DECLINE
86 - CANNOT VERIFY PIN NO PVV
87 - RECONCILIATION TOTALING S
88 - CANNOT PROVIDE TOTALS NOW
89 - INELIGIBLE TO RECEIVE GIV
91 - ISSUER/SWITCH INOPERATIVE
92 - ROUTING DEST NOT FOUND
93 - ILLEGAL TRAN NOT COMPLETE
94 - DUPLICATE TRANSMISSION
96 - SYSTEM MALFUNCTION
A4 - EXCPTN FILE 6000USD LIMIT
A7 - EXCPTN FILE 10K USD LIMIT
A8 - EXCPTN FILE 1500USD LIMIT
A9 - EXCPTN FILE 2225USD LIMIT
B1 - SURCHARGE AMT NOT PERMITT
B2 - SURCHARGE AMT NOT SUPPORT
N0 - FORCE STIP
N3 - CASH SERVICE UNAVAILABLE
N4 - CASH REQ > ISSUER LIMIT
N5 - INELIGIBLE TO RESUBMIT
N6 - INCORRECT CVV
N7 - DECLINE CVV2 FAILURE
N8 - TRAN AMOUNT > PREAUTH AMT
P0 - APPROVED, PVID CD MISSING
P1 - DECLINED, PVID CD MISSING
P2 - INVALID BILLER INFORMATIO
P5 - DECLINE OF REQUEST
P6 - UNSAFE PIN
Q1 - CARD AUTHENTICATION FAIL
R0 - STOP PAYMENT ORDER
R1 - REVOCATION OF AUTH ORDER
R2 - TRANSACTION DOESN'T QUALI
R3 - REVOCATION OF ALL AUTHORI
T0 - FIRST-TIME CHECK
T1 - CHECK OK CANNOT CONVERT
T2 - INVALID ROUTING TRANSIT
T3 - AMOUNT > SERVICE LIMIT
T4 - UNPAID ITEMS/NEG FILE CHK
T5 - DUPLICATE CHECK NUMBER
T6 - MICR ERROR
T7 - TOO MANY CHECKS > LIMIT
XA - FORWARD TO ISSUER
XD - FORWARD TO ISSUER
Y1 - OFFLINE APPROVED
Y3 - APPROVED UNABLE ONLINE
Z1 - OFFLINE DECLINED
Z3 - DECLINED UNABLE ONLINE

Mastercard:

"Approved or completed successfully"
"Refer to card issuer"
"Invalid merchant"
"Capture card"
"Do not honor"
"Honor with ID"
"Partial Approval"
"Invalid transaction"
"Invalid amount"
"Invalid card number"
"Invalid issuer"
"Format error"
"Lost card"
"Insufficient funds/over credit limit"
"Expired card"
"Invalid PIN"
"Transaction not permitted to issuer/cardholder"
"Transaction not permitted to acquirer/terminal"
"Exceeds withdrawal amount limit"
"Restricted card"
"Security violation"
"Exceeds withdrawal count limit"
"Contact Card Issuer"
"PIN Not Changed"
"Allowable number of PIN tries exceeded"
"Invalid/nonexistent To Account specified"
"Invalid/nonexistent From Account specified"
"Invalid/nonexistent account specified (general)"
"Domestic Debit Transaction Not Allowed (Regional use only)"
"Invalid Authorization Life Cycle"
"Not declined"
"PIN Validation not possible"
"Purchase Amount Only, No Cash Back Allowed"
"Cryptographic failure"
"Unacceptable PIN - Transaction Declined - Retry"
"Authorization Platform or issuer system inoperative"
"Unable to route transaction"
"Duplicate transmission detected"
"System error" type: string format: alphanumeric example: Refer to card issuer maxLength: 83 vcaAuthorizationResponseDetail: description: >- Authorization status/reason description from Networks Payment Control

Possible values:

Visa:

ADT - Adult Themed merchants restriction
AIR - Airline merchants restriction
ALC - Alcohol merchants restriction
ATM - ATM cash disbursement restriction
ATML - ATM cash disbursement amount limit
AUTO - Auto merchants restriction
BUS - Business hours restriction
BUSS - Business Services merchants restriction
CAID - Card Acceptor Code restriction
CLOTH - General retail merchants restriction
CNP - Card-not-present restriction
CNTR - General Contractor Services merchant restriction
DOM - State-level transaction restrictions
EAM - E-commerce with transaction amount limit
ECOM - E-commerce transaction restriction
ELEC - Electronics merchants restriction
ENT - Entertainment related merchants restriction
FUEL - Fuel merchants restriction
GOV - Government Services merchants restriction
GROC - Grocery Stores and Pharmacies merchants restriction
GTM - Ground Transportation merchants restriction
HOT - Hotel merchants restriction
JEWL - Jewelery merchants restriction
MED - Medical retail merchants restriction
MISC - Miscellaneous Retailer restriction
NOC - Block all other cash access transaction
NOTFUEL - Non fuel merchants restriction
OSS - Office Supply merchants restriction
PROF - Professional Services and Membership Organizations restriction
PUR - Purchase amount limit
QSR - Fastfood merchants restriction
REST - Restaurant merchants restriction
RETL - Retail Outlet Services restriction
SPV - Spend Velocity restriction
TOLRNC - Tolerance range restriction
UTIL - Utilities merchants restriction
VPAS - Exact Match restriction
XBR - Cross-border transaction restriction
XBRA - Cross-border transaction restrictions with amount limits
XBRB - Country restriction
XBRX - Country restriction

Mastercard:

"Approval" - Transaction within the VCN limits.
"CPN does not exist" - Invalid VCN, not registered in In Control.
"Status bad" - VCN not in an active state. Cannot use forauthorizations.
"Expiry match fail" - Expiry provided for the authorization does not match the VCN Expiry.
"AVV match fail" - CVC2 provided for the authorization does not match the VCN CVC2.
"Valid period fail" - Transaction falls outside the VCN’s defined validity period.
"Trans limit fail" - Transaction amount greater than the VCN’s transaction limit.
"Cumul limit fail" - Current authorization causes the VCN to breach its cumulative spend limit.
"Num usages fail" - Current authorization causes the VCN to breach its usage limit.
"Merch Id limit fail" - Merchant Id for authorization does not match the Merchant Id linked to the VCN.
"MCC limit fail" - Merchant Category Code for the authorization does not match the MCC linked to this VCN.
"Iss/Netwk decline" - Authorization declined by the issuer or card network. Outside of In Control.
"Base/CPN conv. Err" -
"Crit Field Missing" - Critical field missing from the incoming authorization message.
"No Auth for Rev" - In Control cannot map the reversal to an original authorization.
"Unmatched Response" - Advice does not match any past requests in the authorization journal
"Revl of unsucc auth" - In Control cannot reverse an unsuccessful authorization
"Exp. Date of CPN used is expired" - VCN expired.
"Repeat message" - Repeat of a previous message. Based on a flag in the message header or on key message fields.
"Api fail"
"Api System Fail"
"Enhanced MID" - Acquirer Id (DE32) and Card Acceptor Id (DE42) in the authorization message do not match the values specified for the control.
"Enhanced MCC" - MCC value in the authorization message (D18) does not match the values specified for the control.
"Txn Env Control" - VCN breached its transaction environment control.
"Err Travel Control" - VCN breached its travel control rule.
"Multi Merch ID Assoc Lim" - Merchant Id for the authorization does not match any of those linked to this VCN.
"Single Merch Name Assoc Lim" - Merchant Name for the authorization does not match that linked to this VCN.
"Geographic Control" - VCN breached its geographic control rule.
"Curfew Control" - VCN breached its curfew control rule.
"Approve Control" - VCN breached its approve control rule.
"RCN Decline" - Transaction failed due to decline by a subsequent service.
"No Rules Fail" - Rule set with no rules to evaluate.
"No Controls Fail" - Rule with no controls to evaluate.
"Unknown Control Type Fail" - Cannot classify the control fail
"Svc Not Enabled" - Transaction received for an account with no service enabled
"Merch Amount Fail" - Transaction amount breaches the expected merchant currency
"Merch Curr Fail" - Transaction amount breaches the amount limit for the merchant currency.
"DE Control fail" - Values for DE3.1 – Processing Code and/or DE22.1 – PAN Entry Mode and/or61.11 – POS Term Capability Indicator do not match the values in the authorization.
"EVCN Control fail" - EVCN not in an active state. Cannot use for authorization.
"Roaming VC Fail" - VCN breaches its roaming velocity control.
"Amount Range Control Fail" - Transaction amount falls outside the minimum and maximum amount range set.
"CPN State Control Fail" - Account suspended. No authorization activity permitted.
"Aging Cumul limit fail" - Control that keeps track of the current remaining Available Credit. Approves transactions only if the requested amount is less than or equal to the remaining Available Credit. type: string format: alphanumeric example: Iss/Netwk decline maxLength: 69 authorizationResponseCategory: description: >- Authorization Category Description from VisaNet
Mastercard - Not applicable
Visa - Required type: string format: alphanumeric example: ADT - Adult Themed merchants restriction settled: description: >- Indicates whether the transaction is unsettled, or settled with anassociated cleared transaction record.

Visa - Not Applicable

Mastercard - Required

Possible values:
Settled
Unsettled type: string format: alphanumeric example: Unsettled maxLength: 9 stipAdviceCode: description: >- Stand In Processing Advance Code

Mastercard - Not Applicable
Visa - Required type: string format: alphanumeric example: '5' maxLength: 4 stipSwitchReasonCod: description: >- Stand In Processing Switch Reason Code

Mastercard - Not Applicable
Visa - Required type: string format: alphanumeric example: '0000' maxLength: 10 stipSwitchReasonDescription: description: >- Stand In Processing Switch Reason Description

Mastercard - Not Applicable
Visa - Required type: string format: alphanumeric example: NOT APPLICABLE maxLength: 200 ErrorResponseForAuthReport: properties: startDate: description: Specifies the start date from when the reports can be retrieved type: string format: alphanumeric example: '2023-01-01' endDate: description: Specifies the start date from when the reports can be retrieved type: string format: alphanumeric example: '2023-01-30' startTime: description: Specifies the start date from when the reports can be retrieved type: string format: alphanumeric example: '00:00' endTime: description: Specifies the start date from when the reports can be retrieved type: string format: alphanumeric example: '23:59' vcaId: description: >- A reference number that uniquely identifies the virtual card account. type: string format: alphanumeric example: '123456' programId: description: Unique ID of the company record defined in the virtual cards system. type: string format: alphanumeric example: '429777' messageId: description: >- Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration. type: string format: alphanumeric example: CITI00000000AuthReport20230825120311 timeZone: description: Defines the time zone applicable for any date or time type: string format: alphanumeric example: UTC+05:30 transactionType: description: >- Specifies the nature of the transaction whether it was authorized or returned etc. type: string format: alphanumeric example: All virtualCardAccountNumber: description: The virtual card account number to use for transactions. type: string format: alphanumeric example: '5281722601926445' reportStatus: description: >- Defines the status of the data that was requested whether the request has been processed or not. type: string format: alphanumeric example: FAILED maxLength: 19 errors: type: array items: $ref: '#/components/schemas/AuthErrors' AuthErrors: properties: errorCode: description: >- The error code if there is any error occurred while retrieving the transaction type: string format: alphanumeric example: ERS0001 errorDescription: description: >- "The error description that corresponds to error code when there is any error occurred while retrieving the transaction.
* `ERS0001` - Invalid Virtual Card Account Number format
* `ERS0002` - Invalid Transaction Type
* `ERS0003` - timeZone field is empty or has an invalid UTC offset time zone format
* `ERC0004` - Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments.
* `ERS0007` - Invalid Message ID format
* `ERS0009` - Client Onboard Configuration setup is missing. Contact Citi support.
* `ERS0010` - Invalid Report ID format. Report ID must include numeric values
* `ERS0053` - Start Date is Mandatory.
* `ERS0054` - End Date is Mandatory.
* `ERS0055` - Requested report date cannot exceed 180 days in the past from today's date
* `ERS0057` - startDate value exceeds requested endDate value
* `ERS0060` - Client ID and/or Program Id is missing in Client Onboard Configuration setup. Contact Citi support.
* `ERS0061` - VCA ID is not present in our system
* `ERS0063` - Requested Time Zone is not supported
* `ERS0068` - Program Id is Mandatory.
* `ERS0069` - Vca Id is Mandatory.
* `ERS0070` - Message Id is Mandatory.
* `ERS0071` - Virtual Card Account Number is Mandatory.
* `ERS0072` - Requested report date cannot exceed 36 months in the past from todays date
* `ERS0079` - The requested report ID(s) is for a VCA that is different than the VCA included in the request. Please include the VCA associated to the report ID(s).
* `ERS0080` - The requested report ID(s) is for a programId that is different than the programId included in the request. Please include the programId associated to the report ID(s).
* `ERS0081` - The requested report ID(s) is for a timeZone that is different than the timeZone included in the request. Please include the timeZone associated to the report ID(s).
* `ERS0082` - The requested report IDs are for different VCAs, Please include report IDs that belong to the same VCA.
* `ERS0083` - The requested report IDs are for different program IDs, Please include report IDs that belong to the same program ID.
* `ERS0084` - The requested report IDs are for different requested time zones, Please include report IDs that belong to the same requested time zone.
* `ERS0091` - startDate value must have valid format: YYYY-MM-DD
* `ERS0092` - endDate value must have valid format: YYYY-MM-DD
* `ERS0093` - The date specified in startDate does not exist
* `ERS0094` - The date specified in endDate does not exist
* `ERS0095` - Report ID included in your request is not present for the given ClientID/program ID. Please generate a new report ID for this Reports request by calling the Reports API without a report ID
* `ERS0097` - startTime value must have valid format: HH:MM` - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)
* `ERS0098` - endTime value must have valid format: HH:MM` - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)
* `ERS0099` - startTime value cannot exceed the requested endTime value
* `ERS0100` - Invalid sortOrder value
* `ERS0101` - startIndex should be numeric
* `ERS0102` - endIndex should be numeric
* `ERS0103` - startIndex should be less than or equal to endIndex
* `ERS0104` - The startIndex & endIndex range cannot be greater than 150
* `ERS0105` - The startDate and endDate range cannot be greater than 30 days if paginationRequired is true

* `MS0001` - Invalid Virtual Card Account Number
* `MS0002` - From date should be before to date.
* `MS0006` - Invalid vcaId value
* `MS0008` - Invalid Report ID

* `GRC0002` - Client ID is missing in the request header
* `GRC0003` - Invalid JSON Input
* `GRC0004` - Region ID is not available in the request
* `GRC0011` - Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support.
* `GRC0016` - Country code is not available in the request" type: string format: alphanumeric example: Invalid Virtual Card Account Number format ServerErrorResponseForAuthReport: properties: errors: type: array items: $ref: '#/components/schemas/AuthServerErrors' AuthServerErrors: properties: errorCode: description: >- The error code if there is any error occurred while retrieving the transaction type: string format: alphanumeric example: GRC0014 errorDescription: description: >- "The error description that corresponds to error code when there is any error occurred while retrieving the transaction.
* `GRC0001` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.
* `GRC0006` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.
* `GRC0009` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.
* `GRC0014` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments. type: string format: alphanumeric example: >- We have encountered an error and couldn`t receive your request. Please try again, or contact Citi support if you have any further questions or comments ClearingReportInboundRequest: properties: startDate: description: >- Specifies the end date upto when the reports can be retrieved

Format:YYYY-MM-DD

Rules:
  1. End date should greater than the start date
  2. Mastercard:
  3. Visa:
type: string format: alphanumeric example: '2023-01-01' maxLength: 10 endDate: description: >- Specifies the end date upto when the reports can be retrieved

Format:YYYY-MM-DD

Rules:
  1. End date should greater than the start date
  2. Mastercard:
  3. Visa:
type: string format: alphanumeric example: '2023-01-30' maxLength: 10 startTime: description: >- Specifies the start time from when the reports can be retrieved

Format:HH:MM

Mastercard - Optional
Visa - Not applicable type: string format: alphanumeric example: '00:00' maxLength: 10 endTime: description: >- Specifies the end time upto when the reports can be retrieved

Format:HH:MM

Mastercard - Optional
Visa - Not applicable type: string format: alphanumeric example: '23:59' maxLength: 10 transactionType: description: >- Specifies the nature of the transaction whether it was authorized or returned etc.

Visa - Not applicable

Mastercard - Optional

Possible Values:

"All" - Returns all Clearing transactions associated to a virtual card account for a given time range
"Presentment" - First Presentment transactions
"Second Presentment" - Second Presentment transactions in response to a Chargeback initaited from Issuer
"Chargeback" - First Chargeback transactions (Full & Partial)
"Arbitration Chargeback" - Arbitration chargeback transactions (Full & Partial)
"Retrieval Request" - Transactions where an issuer sent a Retrieval Request to an acquirer when it is determined that thetransaction information document needs to be examined for issuer or cardholder needs.
"Fee collection" - Transactions related to the collection or disbursement of fees that require funds settlement between various clearing system participants. Fee Collection messages may include fees generated between pairs of customers, and fees generated between the Corporation and customers. Following are some examples of Fee Collection messages: • Collection or disbursement from customer to customer of fees that brand, program, and service rules permit
• Collection or disbursement from Mastercard to customer of fees related to processing services that the clearing system provides
• Collection or disbursement from Mastercard to customer of such fees as administrative fees, membership fees, and penalties, according to brand, program, and service
• Collection or disbursement from customer to customer of summary settlement positions between customers that participate in bilateral clearing arrangements with clearing system summary settlement type: string format: alphanumeric example: All maxLength: 20 vcaId: description: >- A reference number that uniquely identifies the virtual card account. type: string format: alphanumeric example: '67676781' maxLength: 19 programId: description: >- Unique ID of the company record defined in the virtual cards system.

Mastercard - This value is returned in the ID Provisioning API. This value is generated when the VCA program is onboarded to Mastercard's VCA platform. Data format - Long (Numeric). Max character length - 19

Visa - This value is generated when the VCA program is onboarded to Visa's VCA platform. Data format - Alphanumeric. Max character length - 25 type: string format: alphanumeric example: '233191' maxLength: 25 messageId: description: >- nique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID must be unique per API request and cannot include special characters type: string format: alphanumeric example: CITI0000000ClearReport20230825120311 maxLength: 36 minLength: 28 virtualCardAccountNumber: description: >- The virtual card account number to use for transactions.

Numeric field and no decimals allowed type: string format: alphanumeric example: '5281722601926445' maxLength: 16 timeZone: description: >- Defines the time zone applicable for any date or time

UTC offset

Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: UTC+05:30 maxLength: 9 reportIds: description: >- An optional reportId array passed by client to fetch the Clearing report transactions that previously returned a "PENDING" or "IN-PROGRESS" report status. When calling the API with reportId, pass all other request parameters as orignally passed in the previous request

Mastercard - Optional
Visa - Not applicable type: array items: type: string format: alphanumeric example: - '12345' filters: $ref: '#/components/schemas/RequestFilters' required: - startDate - endDate - vcaId - programId - messageId - virtualCardAccountNumber ClearingReportInboundResponse: properties: vcaId: description: >- A reference number that uniquely identifies the virtual card account. type: string format: alphanumeric example: '67676781' maxLength: 19 messageId: description: >- Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per API request. type: string format: alphanumeric example: CITI0000000ClearReport20230825120311 maxLength: 36 minLength: 28 programId: description: Unique ID of the company record defined in the virtual cards system. type: string format: alphanumeric example: '233191' maxLength: 25 startDate: description: >- Specifies the start date from when the reports can be retrieved

Format:YYYY-MM-DD type: string format: alphanumeric example: '2023-01-01' maxLength: 10 endDate: description: >- Specifies the end date from when the reports can be retrieved

Format:YYYY-MM-DD type: string format: alphanumeric example: '2023-03-30' maxLength: 10 startTime: description: >- Specifies the start time from when the reports can be retrieved

Format:HH:MM

Mastercard - Optional
Visa - Not applicable type: string format: alphanumeric example: '00:00' maxLength: 10 endTime: description: >- Specifies the end time upto when the reports can be retrieved

Format:HH:MM

Mastercard - Optional
Visa - Not applicable type: string format: alphanumeric example: '23:59' maxLength: 10 reportStatus: description: >- Status of whether the report request was processed.

Mastercard - If a report status other than COMPLETED is returned, subsequently call the Reports API with the orginal request parameter previously passed along with the list of reportIds for each 30-day date range that did not return a COMPLETED report status type: string format: alphanumeric example: COMPLETED maxLength: 19 enum: - COMPLETED - PARTIALLY COMPLETED - FAILED - PENDING warning: description: >- Warning information regarding a non-fatal response condition that may be taken into account, but can be ignored type: string format: alphanumeric example: Warning message maxLength: 200 timeZone: description: Defines the time zone applicable for any date or time
UTC offset type: string format: alphanumeric example: UTC+05:30 maxLength: 9 virtualCardAccountNumber: description: The virtual card account number to use for transactions. type: string format: alphanumeric example: '5281722601926445' maxLength: 19 transactionType: description: >- Specifies the type of transaction.

Possible values:

Mastercard:

"First Presentment" - Transactions where an acquire has initiated a first presentment to advise the issuer or its agent that a financial transaction was completed on its behalf
"Second Presentment (Full)" - Acquirer-initiated transaction to remedy a previous First Chargeback for the full First Presentment amount
"Second Presentment (Partial)" - Acquirer-initiated transaction to remedy a previous First Presentment or First Chargeback for part of the First Presentment amount or First Chargeback amount
"First Chargeback (Full)" - Issuer-initiated transaction to completely return a previous First Presentment amount
"Arbitration Chargeback (Full)" - Issuer-initiated transaction to completely return a previous First Presentment amount
"First Chargeback (Partial)" - Issuer-initiated transaction to partially return a previous First Presentment amount
"Arbitration Chargeback (Partial)" - Issuer-initiated transaction to partially return a previous First Presentment amount or Second Presentment amount

Visa:

10 = Purchase
11 = Credit Voucher
20 = Manual Cash Disbursement
22 = ATM Cash Disbursement
30 = Payment
Reversal - NSF Check
31 = Payment
40 = Finance Charge
50 = Annual Fee
52 = Miscellaneous Fees
54 = NSF Check Fee
56 = Report Fee
61 = Credit Adjustment
62 = Debit Adjustment
63 = Finance Charge Credit Adjustment
64 = Finance Charge Debit Adjustment
65 = Other Credits
66 = Other Debits
71 = Fuel Discount
73 = Non-Fuel Discount
80 = Convenience Checks
82 = Convenience Checks Fees
84 = Travelers Checks Fees
86 = ATM Fees
88 = Late Fees type: string format: alphanumeric example: All filters: $ref: '#/components/schemas/ResponseFilters' info: type: array items: $ref: '#/components/schemas/ClearingInfo' clearingRecords: type: array items: $ref: '#/components/schemas/ClearingRecords' required: - vcaId - messageId - programId - startDate - endDate - reportStatus - virtualCardAccountNumber - transactionType ClearingInfo: properties: fromDate: description: >- Specifies the start date from when the reports can be retrieved
Format - YYYY-MM-DD

Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '2023-01-01' maxLength: 10 toDate: description: >- Specifies the end date upto when the reports can be retrieved

Format - YYYY-MM-DD

Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '2023-02-01' maxLength: 10 reportId: description: >- The report Id generated for a given 30-day date range
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '12345' errorCode: description: >- The error code if there is any error occurred while retrieving the trsansaction type: string format: alphanumeric example: MS0006 errorMessage: description: >- The error description that corresponds to error code when there is any error occurred while retrieving the transaction. type: string format: alphanumeric example: Invalid vcaId value maxLength: 200 status: description: >- Defines the status of the data that was requested whether the request has been processed or not.
Visa - Not applicable
Mastercard - Required

Possible values:
COMPLETED
FAILED
PENDING
IN PROGRESS type: string format: alphanumeric example: COMPLETED maxLength: 10 ClearingRecords: properties: clearingType: description: >- Specifies the type of clearing, Which it is debit or credit
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: Debit maxLength: 6 billingCurrencyAmount: description: >- Specifies the value of transaction amount which is converted to billling currency type: string format: alphanumeric example: '123.00' maxLength: 16 billingCurrencyCode: description: >- Specifies the ISO currency code of accounts that was initially set up for billing the transactions. type: string format: alphanumeric example: USD maxLength: 3 billingCurrencyCodeDescription: description: >- Specifies the description of currency code of accounts that was initially set up for billing the transactions type: string format: alphanumeric example: US Dollar maxLength: 70 transactionCurrencyAmount: description: Specifies the actual transaction amount in transaction currency type: string format: alphanumeric example: '123.00' maxLength: 32 transactionCurrencyCode: description: >- Specifies the ISO currency code on which actual authorization of transaction was done type: string format: alphanumeric example: USD maxLength: 10 transactionCurrencyCodeDescription: description: >- Specifies the currency code description on which actual authorization of transaction was done type: string format: alphanumeric example: US Dollar maxLength: 70 transactionExchangeRate: description: >- Currency exchange in operation during a payment.
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '1' maxLength: 7 transactionDate: description: Specifies card transaction date.
Format - YYYY-MM-DD type: string format: alphanumeric example: '2023-01-20' maxLength: 10 transactionTime: description: Specifies card transaction time.
Format - hh:mm:ss type: string format: alphanumeric example: '19:52:11' maxLength: 8 transactionType: description: >- Specifies the type of transaction

Possible values:

Mastercard:

"First Presentment" - Transactions where an acquire has initiated a first presentment to advise the issuer or its agent that a financial transaction was completed on its behalf
"Second Presentment (Full)" - Acquirer-initiated transaction to remedy a previous First Chargeback for the full First Presentment amount
"Second Presentment (Partial)" - Acquirer-initiated transaction to remedy a previous First Presentment or First Chargeback for part of the First Presentment amount or First Chargeback amount
"First Chargeback (Full)" - Issuer-initiated transaction to completely return a previous First Presentment amount
"Arbitration Chargeback (Full)" - Issuer-initiated transaction to completely return a previous First Presentment amount
"First Chargeback (Partial)" - Issuer-initiated transaction to partially return a previous First Presentment amount
"Arbitration Chargeback (Partial)" - Issuer-initiated transaction to partially return a previous First Presentment amount or Second Presentment amount

Visa:

10 = Purchase
11 = Credit Voucher
20 = Manual Cash Disbursement
22 = ATM Cash Disbursement
30 = Payment
Reversal - NSF Check
31 = Payment
40 = Finance Charge
50 = Annual Fee
52 = Miscellaneous Fees
54 = NSF Check Fee
56 = Report Fee
61 = Credit Adjustment
62 = Debit Adjustment
63 = Finance Charge Credit Adjustment
64 = Finance Charge Debit Adjustment
65 = Other Credits
66 = Other Debits
71 = Fuel Discount
73 = Non-Fuel Discount
80 = Convenience Checks
82 = Convenience Checks Fees
84 = Travelers Checks Fees
86 = ATM Fees
88 = Late Fees type: string format: alphanumeric example: First Presentment maxLength: 40 merchantCategoryCode: description: >- The category under which the merchant is been assigned by the network type: string format: alphanumeric example: '5812' maxLength: 10 mccDescription: description: >- The decsription of the category on which merchant has been assigned by the netwrok type: string format: alphanumeric example: EATING PLACES, RESTAURANTS maxLength: 200 merchantId: description: >- The ID created for a specific merchant by the network
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: 00000R-5411-USA maxLength: 50 merchantName: description: >- The merchant name that corresponds to merchant id defined by the netwrok type: string format: alphanumeric example: GROCERY STORES, SUPERM maxLength: 200 merchantState: description: The state under which the merchant has been categorised type: string format: alphanumeric example: MO maxLength: 100 merchantCity: description: The city under which the merchant has been categorised type: string format: alphanumeric example: OFALLON maxLength: 100 merchantCountryCode: description: >- The conutry code defined under which the merchant has been categorised type: string format: alphanumeric example: USA maxLength: 3 merchantCountryName: description: >- The conutry name that corresponds to merchant country code under which the merchant has been categorised type: string format: alphanumeric example: United States (the) maxLength: 50 merchantZipCode: description: >- The ZIP code defined under which the merchant city has been categorised
Mastercard - Not applicable
Visa - Required type: string format: alphanumeric example: '12345' maxLength: 10 acquirerIdentifier: description: The identifier under which the acquirer has been categorised type: string format: alphanumeric example: '00000999080' maxLength: 50 terminalId: description: >- The ID under which the terminal has been categorised
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '789254' maxLength: 50 transactionId: description: >- Unique identifier of the transaction
Mastercard - Not applicable
Visa - Required type: string format: alphanumeric example: '380198318999999' maxLength: 50 cardAcceptorId: description: >- Specifies card transaction acceptor ID
Mastercard - Not applicable
Visa - Required type: string format: alphanumeric example: '490050000000053' maxLength: 26 transactionSequenceNumber: description: >- Specifies card transaction sequence number
Mastercard - Not applicable
Visa - Required type: string format: alphanumeric example: '4910' maxLength: 24 acquirerReferenceData: description: >- Specifies card transaction acquirer reference number
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '25567681110000232050357' maxLength: 23 messageType: description: >- Four-digit numeric field describing the type of message being interchanged.

Mastercard - Required
Visa - Not applicable

Possible Values:
1240 Presentment
1442 Chargeback
1644 Administrative
1740 Fee Collection type: string format: alphanumeric example: '1740' maxLength: 4 messageReasonCode: description: >- Four-digit data element that indicates the reason for sending a message
Mastercard - Required
Visa - Not applicbale type: string format: alphanumeric example: '1400' maxLength: 4 functionCode: description: >- Three-digit data element that indicates the specific purpose of a message in a message class.
Uniquely identifies all transaction functions the clearing system performs.

Mastercard - Required
Visa - Not applicbale

Possible values:

"200" – First Presentment
"205" – Second Presentment (Full)
"282" – Second Presentment (Partial)
"450" – First Chargeback (Full)
"451" – Arbitration Chargeback (Full)
"603" – Retrieval Request
"695" – File Trailer
"696" – Financial Detail Addendum
"697" – File Header
"700" – Fee Collection type: string format: alphanumeric example: '200' maxLength: 3 transactionPostDate: description: >- Specifies card transaction once its posted / settled from network
Format - YYYY-MM-DD type: string format: alphanumeric example: '2023-01-20' maxLength: 10 settlementAmount: description: >- Specifies card transaction amount where actual settlement was done
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: '189.98' maxLength: 32 settlementCurrencyCode: description: >- Specifies the currency code on which actual settlement of transaction was done
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: SGD maxLength: 3 settlementCurrencyDescription: description: >- Specifies the currency code description on which actual settlement of transaction was done
Mastercard - Required
Visa - Not applicable type: string format: alphanumeric example: Singapore Dollar maxLength: 70 approvalCode: description: >- Specifies approval code which can be used for reconciliation, advise supplier/ merchants and trouble shoot declines across network type: string format: alphanumeric example: '802907' maxLength: 50 ErrorResponseForClearingReport: properties: startDate: description: Specifies the start date from when the reports can be retrieved type: string format: alphanumeric example: '2023-01-01' endDate: description: Specifies the start date from when the reports can be retrieved type: string format: alphanumeric example: '2023-01-30' startTime: description: Specifies the start date from when the reports can be retrieved type: string format: alphanumeric example: '00:00' endTime: description: Specifies the start date from when the reports can be retrieved type: string format: alphanumeric example: '23:59' vcaId: description: >- A reference number that uniquely identifies the virtual card account. type: string format: alphanumeric example: '123456' programId: description: Unique ID of the company record defined in the virtual cards system. type: string format: alphanumeric example: '429777' messageId: description: >- Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration. type: string format: alphanumeric example: CITI0000ClearingReport20230825120311 timeZone: description: Defines the time zone applicable for any date or time type: string format: alphanumeric example: UTC+05:30 transactionType: description: >- Specifies the nature of the transaction whether it was authorized or returned etc. type: string format: alphanumeric example: All virtualCardAccountNumber: description: The virtual card account number to use for transactions. type: string format: alphanumeric example: '5281722601926445' reportStatus: description: >- Defines the status of the data that was requested whether the request has been processed or not. type: string format: alphanumeric example: FAILED maxLength: 16 errors: type: array items: $ref: '#/components/schemas/ClearingErrors' ClearingErrors: properties: errorCode: description: >- The error code if there is any error occurred while retrieving the transaction type: string format: alphanumeric example: ERS0001 errorDescription: description: >- "The error description that corresponds to error code when there is any error occurred while retrieving the transaction.
* `ERS0001` - Invalid Virtual Card Account Number format
* `ERS0002` - Invalid Transaction Type
* `ERS0003` - timeZone field is empty or has an invalid UTC offset time zone format
* `ERC0004` - Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments.
* `ERS0007` - Invalid Message ID format
* `ERS0009` - Client Onboard Configuration setup is missing. Contact Citi support.
* `ERS0010` - Invalid Report ID format. Report ID must include numeric values
* `ERS0053` - Start Date is Mandatory.
* `ERS0054` - End Date is Mandatory.
* `ERS0055` - Requested report date cannot exceed 180 days in the past from today's date.
* `ERS0057` - startDate value exceeds requested endDate value
* `ERS0060` - Client ID and/or Program Id is missing in Client Onboard Configuration setup. Contact Citi support.
* `ERS0061` - VCA ID is not present in our system
* `ERS0063` - Requested Time Zone is not supported
* `ERS0068` - Program Id is Mandatory.
* `ERS0069` - Vca Id is Mandatory.
* `ERS0070` - Message Id is Mandatory.
* `ERS0071` - Virtual Card Account Number is Mandatory.
* `ERS0072` - Requested report date cannot exceed 36 months in the past from todays date
* `ERS0079` - The requested report ID(s) is for a VCA that is different than the VCA included in the request. Please include the VCA associated to the report ID(s).
* `ERS0080` - The requested report ID(s) is for a programId that is different than the programId included in the request. Please include the programId associated to the report ID(s).
* `ERS0081` - The requested report ID(s) is for a timeZone that is different than the timeZone included in the request. Please include the timeZone associated to the report ID(s).
* `ERS0082` - The requested report IDs are for different VCAs, Please include report IDs that belong to the same VCA.
* `ERS0083` - The requested report IDs are for different program IDs, Please include report IDs that belong to the same program ID.
* `ERS0084` - The requested report IDs are for different requested time zones, Please include report IDs that belong to the same requested time zone.
* `ERS0091` - startDate value must have valid format: YYYY-MM-DD
* `ERS0092` - endDate value must have valid format: YYYY-MM-DD
* `ERS0093` - The date specified in startDate does not exist
* `ERS0094` - The date specified in endDate does not exist
* `ERS0095` - Report ID included in your request is not present for the given ClientID/program ID. Please generate a new report ID for this Reports request by calling the Reports API without a report ID
* `ERS0097` - startTime value must have valid format: HH:MM` - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)
* `ERS0098` - endTime value must have valid format: HH:MM` - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)
* `ERS0099` - startTime value cannot exceed the requested endTime value
* `ERS0100` - Invalid sortOrder value
* `ERS0101` - startIndex should be numeric
* `ERS0102` - endIndex should be numeric
* `ERS0103` - startIndex should be less than or equal to endIndex
* `ERS0104` - The startIndex & endIndex range cannot be greater than 150
* `ERS0105` - The startDate and endDate range cannot be greater than 30 days if paginationRequired is true

* `MS0001` - Invalid Virtual Card Account Number
* `MS0002` - From date should be before to date.
* `MS0006` - Invalid vcaId value
* `MS0008` - Invalid Report ID

* `GRC0002` - Client ID is missing in the request header
* `GRC0003` - Invalid JSON Input
* `GRC0004` - Region ID is not available in the request
* `GRC0011` - Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support.
* `GRC0016` - Country code is not available in the request" type: string format: alphanumeric example: Invalid Virtual Card Account Number format ServerErrorResponseForClearingReport: properties: errors: type: array items: $ref: '#/components/schemas/ClearingServerErrors' ClearingServerErrors: properties: errorCode: description: >- The error code if there is any error occurred while retrieving the transaction type: string format: alphanumeric example: GRC0014 errorDescription: description: >- "The error description that corresponds to error code when there is any error occurred while retrieving the transaction.
* `GRC0001` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.
* `GRC0006` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.
* `GRC0009` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.
* `GRC0014` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments. type: string format: alphanumeric example: >- We have encountered an error and couldn`t receive your request. Please try again, or contact Citi support if you have any further questions or comments securitySchemes: clientCredentials: description: >+ All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token.

Sandbox Token URL: https://tts.sandbox.apib2b.citi.com/tts/api/v1/oauth2/token
type: oauth2 flows: clientCredentials: tokenUrl: https://tts.apib2b.citi.com/tts/api/v1/oauth2/token scopes: /api: Grants access to the API x-ibm-configuration: enforced: true testable: true phase: realized cors: enabled: false properties: hostName: value: >- https://base-b-grace-engine-dev-icg-tts-grace-173707.apps.namicggtd29d.ecs.dyn.nsroot.net/api/tts/cards description: '' encoded: false catalogs: UAT: properties: hostName: >- https://base-b-grace-engine-uat-icg-tts-grace-173707.apps.namicgswd40u.ecs.dyn.nsroot.net/api/tts/cards External: properties: hostName: >- https://base-b-grace-engine-dev-icg-tts-grace-173707.apps.namicggtd29d.ecs.dyn.nsroot.net/api/tts/cards assembly: execute: - gatewayscript: title: gatewayscript version: 1.0.0 source: "var hm = require('header-metadata');\r\nvar client_id = apim.getvariable('client.app.id');\r\napim.setvariable('message.headers.x-citiportal-apim-client-id',client_id);\r\nif(apim.getvariable('oauth.miscinfo') !=null){\r\nvar oauthmiscinfo = apim.getvariable('oauth.miscinfo');\r\napim.setvariable(\"message.headers.ssoId\",oauthmiscinfo.substring(2));\r\nconsole.error(\"vminfo API failed with return code=\" + oauthmiscinfo.substring(2) );\r\napim.setvariable('message.headers.x-citiportal-apim-client-id',client_id);\r\napim.setvariable(\"message.headers.x-citiportal-loginid\",oauthmiscinfo.substring(2)); \r\n}" - proxy: title: proxy timeout: 60 verb: keep cache-response: protocol cache-ttl: 900 version: 1.0.0 tls-profile: icg-tts-ic target-url: $(hostName)$(api.operation.path) - activity-log: title: activity-log content: header error-content: header version: 1.0.0 catch: []