openapi: 3.1.0 info: title: Connexpay Search API version: '1.0' description: 'Operations tagged Search across 2 of this provider''s published API definitions: connexpay-purchases-openapi.yml, connexpay-sales-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://sandboxpurchasesapi.connexpay.com - url: https://sandboxsalesapi.connexpay.com security: - sec0: [] tags: - name: Search paths: /api/v1/Search/IssuedCards/: post: summary: Search Issued Cards description: This endpoint searches for Issued Virtual Cards. operationId: search-issued-cards parameters: - name: PageNumber in: path description: Number of page of the results. Default is 1. schema: type: integer format: int32 required: true - name: PageSize in: path description: Size of each page of the results. Default is 1000. schema: type: integer format: int32 required: true - name: Content-Type in: header description: '"application/json"' schema: type: string - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string requestBody: content: application/json: schema: type: object required: - MerchantGuid properties: MerchantGuid: type: string description: Your assigned Merchant GUID. SaleGuid: type: string description: Sale GUID linked to the card you are searching. IncomingTransactionCode: type: string description: Incoming Transaction Code linked to the card you are searching. OrderNumber: type: string description: Order Number linked to the card you are searching. CustomerID: type: string description: Order Number linked to the card you are searching. TimeStampFrom: type: string description: Starting Issued Date linked to the card(s) you are searching. format: date TimeStampTo: type: string description: Ending Issued Date linked to the card(s) you are searching. format: date IssuedAmountFrom: type: number description: Start of Issued Amount range linked to the card(s) you are searching. format: float IssuedAmountTo: type: number description: End of Issued Amount range linked to the card(s) you are searching. format: float OutgoingTransactionCode: type: string description: Outgoing Transaction Code linked to the card(s) you are searching. SettledAmountFrom: type: integer description: Start of Settled Amount range linked to the card(s) you are searching. format: int64 SettledAmountTo: type: integer description: End of Settled Amount range linked to the card(s) you are searching. format: int64 ReturnedAmountFrom: type: integer description: Start of Settled Returned Amount range linked to the card(s) you are searching. format: int64 ReturnedAmountTo: type: integer description: End of Settled Returned Amount range linked to the card(s) you are searching. format: int64 responses: '200': description: '200' content: application/json: examples: Search Issued Cards Response Example: value: "{\n \"pageCurrent\":1,\n \"pageCurrentResults\":2,\n \"pageTotal\":1,\n \"pageSize\":5,\n \"totalResults\":2,\n \"cardSummary\":null,\n \"searchResultDTO\":[\n {\n \"customerName\":\"John Smith\",\n \"merchantId\":\"b19d3b78-627b-4b7e-b60f-3b842a64a213\",\n \"incomingTransactionCodeCreationDate\":\"2020-02-18T17:40:43.66\",\n \"outgoingTransactionCodeCreationDate\":\"2020-02-18T17:40:54.63\",\n \"issuedAmount\":150.00,\n \"currencyCode\":\"USD\",\n \"cardType\":\"Other\",\n \"lastFour\":\"9766\",\n \"bin\":\"5ed416a2-a2da-41fc-957a-a9ee366f86b3\",\n \"incomingTransactionCode\":\"03AGCW7D9ZW8KHC3300030000\",\n \"outgoingTransactionCode\":\"03AGCW7D9ZW8KHC3300030000USD01ZZZ00015000\",\n \"outgoingTransactionCodeDetail\":{\n \"incomingTransactionCode\":\"03AGCW7D9ZW8KHC3300030000\",\n \"incomingTransactionCodeDetail\":{\n \"expectedOutgoingTransactionCount\":3,\n \"filler\":\"AGC\",\n \"authorizationResponseCode\":\"W7D9ZW\",\n \"authorizationDate\":\"2020-02-18T17:40:43.66\",\n \"authorizedAmount\":300.0\n },\n \"currencyCode\":\"USD\",\n \"purchaseType\":\"01\",\n \"filler\":\"ZZZ\",\n \"paymentAmount\":150.0\n },\n \"timeStamp\":\"2020-02-18T17:40:54.63\",\n \"guid\":\"179c7243-6b43-4d47-b77c-3f5bb0fc37f5\",\n \"cardStatus\":\"Card - Active\",\n \"toleranceAmount\":30.00,\n \"terminateDate\": \"2020-11-26T18:59:59\"\n },\n },\n {\n \"customerName\":\"John Smith\",\n \"merchantId\":\"b19d3b78-627b-4b7e-b60f-3b842a64a213\",\n \"incomingTransactionCodeCreationDate\":\"2020-02-18T17:40:43.66\",\n \"outgoingTransactionCodeCreationDate\":\"2020-02-18T17:41:03.81\",\n \"issuedAmount\":100.00,\n \"currencyCode\":\"USD\",\n \"cardType\":\"Other\",\n \"lastFour\":\"8493\",\n \"bin\":\"5ed416a2-a2da-41fc-957a-a9ee366f86b3\",\n \"incomingTransactionCode\":\"03AGCW7D9ZW8KHC3300030000\",\n \"outgoingTransactionCode\":\"03AGCW7D9ZW8KHC3300030000USD01ZZZ00005000\",\n \"outgoingTransactionCodeDetail\":{\n \"incomingTransactionCode\":\"03AGCW7D9ZW8KHC3300030000\",\n \"incomingTransactionCodeDetail\":{\n \"expectedOutgoingTransactionCount\":3,\n \"filler\":\"AGC\",\n \"authorizationResponseCode\":\"W7D9ZW\",\n \"authorizationDate\":\"2020-02-18T17:40:43.66\",\n \"authorizedAmount\":300.0\n },\n \"currencyCode\":\"USD\",\n \"purchaseType\":\"01\",\n \"filler\":\"ZZZ\",\n \"paymentAmount\":50.0\n },\n \"timeStamp\":\"2020-02-18T17:41:03.81\",\n \"guid\":\"7638a84e-40cb-4db7-b9b8-a401a906b310\",\n \"cardStatus\":\"Card - Active\",\n \"orderNumber\": \"Test-Search\",\n \"customerID\": \"Test Search\"\n }\n ],\n \"allowedToCreateVC\":false\n}" '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Search servers: - url: https://sandboxpurchasesapi.connexpay.com /api/v1/Search/Settlements/: post: summary: Search Settlements description: This endpoint searches for Virtual Card Settlements. operationId: search-settlements parameters: - name: PageNumber in: path description: Number of pages of results to return. Default is 1. schema: type: integer format: int32 required: true - name: PageSize in: path description: Size of each page of results. Default is 1000. schema: type: integer format: int32 required: true - name: Content-Type in: header description: '"application/json"' schema: type: string - name: Authorization in: header description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' schema: type: string requestBody: content: application/json: schema: type: object required: - MerchantGuid properties: MerchantGuid: type: string description: Merchant's Guid. DateFrom: type: string description: Card's Issued Date. format: date DateTo: type: string description: Card's Issued Date. format: date PostedDateFrom: type: string description: Card settlement post date. format: date PostedDateTo: type: string description: Card settlement post date. format: date OrderNumber: type: string description: Order Number. Max. Length = 50. IssuedAmountFrom: type: integer description: Issued Amount of the Card. format: int64 IssuedAmountTo: type: integer description: Issued Amount of the Card. format: int64 IssuedCardLastFour: type: string description: Card last four number. PostedAmountFrom: type: number description: Posted Amount of the Card. format: float PostedAmountTo: type: number description: Posted Amount of the Card. format: float ExpirationDateFrom: type: string description: Card's expiration date. format: date ExpirationDateTo: type: string description: Card's expiration date. format: date examples: By card issued date range: value: merchantGuid: 568f7853-6e3d-4b3b-80f5-058763318fcb dateFrom: '2019-11-01T00:00:00.0000000' dateTo: '2019-11-30T00:00:00.0000000' orderNumber: Dan-TV9J6VJ By card settled date range: value: MerchantGuid: '{{Merchant}}' postedDateFrom: '2020-08-05T00:00:00.0000000' postedDateTo: '2020-08-10T00:00:00.0000000' responses: '200': description: '200' content: application/json: examples: Search Settlements Response Example: value: "{\n \"activeCards\": {\n \"total\": 62,\n \"availableBalance\": null\n },\n \"deactivateCards\": {\n \"total\": 25,\n \"availableBalance\": null\n },\n \"unactiveCards\": {\n \"total\": null,\n \"availableBalance\": null\n },\n \"pageCurrent\": 1,\n \"pageCurrentResults\": 10,\n \"pageTotal\": 9,\n \"pageSize\": 10,\n \"totalResults\": 88,\n \"cardSummary\": null,\n \"searchResultDTO\": [\n {\n \"customerName\": \"Card Name\",\n \"merchantId\": \"e454dc78-e8b9-4b7f-8568-8bf6246d94a9\",\n \"incomingTransactionCodeCreationDate\": \"2025-03-04T18:25:10.82\",\n \"outgoingTransactionCodeCreationDate\": \"2025-03-04T18:25:10.74\",\n \"issuedAmount\": 7.00,\n \"currencyCode\": \"USD\",\n \"cardType\": \"Visa\",\n \"lastFour\": \"1234\",\n \"bin\": \"VISACOMMPRE999999\",\n \"incomingTransactionCode\": \"5D3F372638767095088335123\",\n \"outgoingTransactionCode\": \"5D3F3726387670950883351234A65802F28EE4423\",\n \"outgoingTransactionCodeDetail\": {\n \"incomingTransactionCode\": \"5D3F372638767095088335123\",\n \"incomingTransactionCodeDetail\": {\n \"expectedOutgoingTransactionCount\": 1,\n \"filler\": \"ZZZ\",\n \"authorizationResponseCode\": \"726555\",\n \"authorizationDate\": \"2025-03-04T18:25:10.82\",\n \"authorizedAmount\": 7.0\n },\n \"currencyCode\": \"USD\",\n \"purchaseType\": \"06\",\n \"filler\": \"ZZZ\",\n \"paymentAmount\": 0.0\n },\n \"timeStamp\": \"2025-03-04T18:25:10.74\",\n \"timeStampOffset\": \"2025-03-04T18:25:10.74+00:00\",\n \"guid\": \"50816dd3-d5b1-4524-b36e-331f3ee6f678\",\n \"cardStatus\": \"Device - Active\",\n \"terminateDate\": \"2026-08-30T19:59:59\",\n \"orderNumber\": \"123456\"\n },\n {\n \"customerName\": \"Name Cardholder\",\n \"merchantId\": \"e454dc78-e8b9-4b7f-8568-8bf6246d94a9\",\n \"incomingTransactionCodeCreationDate\": \"2025-03-04T17:36:34.95\",\n \"outgoingTransactionCodeCreationDate\": \"2025-03-04T17:36:34.9\",\n \"issuedAmount\": 10.00,\n \"currencyCode\": \"USD\",\n \"cardType\": \"Visa\",\n \"lastFour\": \"1111\",\n \"bin\": \"MVBVSPRECOMM123456\",\n \"incomingTransactionCode\": \"A76C770638766883969272789\",\n \"outgoingTransactionCode\": \"A76C7706387668839692727896154773A225B4F22\",\n \"outgoingTransactionCodeDetail\": {\n \"incomingTransactionCode\": \"A76C770638766883969272432\",\n \"incomingTransactionCodeDetail\": {\n \"expectedOutgoingTransactionCount\": 1,\n \"filler\": \"ZZZ\",\n \"authorizationResponseCode\": \"706444\",\n \"authorizationDate\": \"2025-03-04T17:36:34.95\",\n \"authorizedAmount\": 13.0\n },\n \"currencyCode\": \"USD\",\n \"purchaseType\": \"06\",\n \"filler\": \"ZZZ\",\n \"paymentAmount\": 3.0\n },\n \"timeStamp\": \"2025-03-04T17:36:34.9\",\n \"timeStampOffset\": \"2025-03-04T17:36:34.9+00:00\",\n \"guid\": \"a967e303-253c-415e-8889-47b91e38a260\",\n \"cardStatus\": \"Device - Active\",\n \"terminateDate\": \"2025-12-08T18:59:59\",\n \"orderNumber\": \"Hotel\"\n },\n {\n \"customerName\": \"Test Cardmember\",\n \"merchantId\": \"e454dc78-e8b9-4b7f-8568-8bf6246d94a9\",\n \"incomingTransactionCodeCreationDate\": \"2025-03-04T17:24:22.94\",\n \"outgoingTransactionCodeCreationDate\": \"2025-03-04T17:24:22.86\",\n \"issuedAmount\": 7.00,\n \"currencyCode\": \"USD\",\n \"cardType\": \"Visa\",\n \"lastFour\": \"7777\",\n \"bin\": \"MVBVSPRECOMM123456\",\n \"incomingTransactionCode\": \"2835E52638767058610951456\",\n \"outgoingTransactionCode\": \"2835E526387670586109514562D1BF590926E46F7\",\n \"outgoingTransactionCodeDetail\": {\n \"incomingTransactionCode\": \"2835E52638767058610951789\",\n \"incomingTransactionCodeDetail\": {\n \"expectedOutgoingTransactionCount\": 1,\n \"filler\": \"ZZZ\",\n \"authorizationResponseCode\": \"526333\",\n \"authorizationDate\": \"2025-03-04T17:24:22.94\",\n \"authorizedAmount\": 7.0\n },\n \"currencyCode\": \"USD\",\n \"purchaseType\": \"06\",\n \"filler\": \"ZZZ\",\n \"paymentAmount\": 0.0\n },\n \"timeStamp\": \"2025-03-04T17:24:22.86\",\n \"timeStampOffset\": \"2025-03-04T17:24:22.86+00:00\",\n \"guid\": \"801e20c1-41e9-420c-b5ea-73aa9a94af00\",\n \"cardStatus\": \"Device - Active\",\n \"terminateDate\": \"2026-08-30T19:59:59\",\n \"orderNumber\": \"903456\"\n },\n" '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Search servers: - url: https://sandboxpurchasesapi.connexpay.com /api/v1/Search/AvailableFunds/{merchantGuid}: get: summary: Available Funds description: Use this endpoint to pull details regarding your Available Funds like cash balance, Available to Authorize (ATA) or Available to Issue (ATI), and the details that make up the final number. operationId: available-funds parameters: - name: MerchantGuid in: path description: Merchant's Guid assigned by ConnexPay schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Available to Authorize: value: '{     "cashBalance": 305405.45,     "minimumCashBalance": 10.00,     "reserveDeposit": 25.50,     "salesAllowance": 38100231.43,     "overage": 0.00,     "outstandingAuthorization": 29.00,     "outstandingLiability": 0.00,     "totalATA": 38405607.88 }' Available to Issue: value: '{     "cashBalance": 305405.45,     "minimumCashBalance": 10.00,     "reserveDeposit": 25.50,     "salesAllowance": 38100231.43,     "overage": 0.00,     "outstandingAuthorization": 0.00,     "outstandingLiability": 8809244.33,     "totalAvailable": 29596392.55 }' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Search servers: - url: https://sandboxpurchasesapi.connexpay.com /api/v1/Search/Sales/{exportable}/{pageNumber}/{pageSize}: post: summary: Search sales description: This endpoint searches sales. operationId: search-sales parameters: - name: Content-Type in: header schema: type: string default: '"application/json"' - name: Authorization in: header schema: type: string default: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' - name: Exportable in: path description: True or False. It means if you want results exportable to CSV. schema: type: string default: Mandatory required: true - name: PageNumber in: path description: Int. Number of page of the results. Default is 1 (Page size default is 500). schema: type: integer format: int32 default: null required: true - name: PageSize in: path description: Int. Size of each page of the results. Default is 500. schema: type: string default: Optional required: true requestBody: content: application/json: schema: type: object properties: MerchantGuid: type: string description: Merchant’s Guid. default: Mandatory AmountFrom: type: number description: 'Amount of the transaction. Min. amt.: $0.50' default: null format: float AmountTo: type: number description: 'Amount of the transaction. Min. amt.: $0.50' default: null format: float CardHolderName: type: string description: Cardholder’s name. default: Optional CardLastFour: type: string description: Card last four number. default: Optional CardType: type: string description: Card type. default: Optional InvoiceNumber: type: integer description: Sale’s InvoiceNumber. default: null format: int32 OrderNumber: type: string description: Sale’s order number. Length = 17. default: Optional OrderDateFrom: type: string description: Sale’s order Date. default: Optional format: date OrderDateTo: type: string description: Sale’s order Date. default: Optional format: date TimeStampFrom: type: string description: Sale’s TimeStamp. default: Optional format: date TimeStampTo: type: string description: Sale’s TimeStamp. default: Optional format: date Status: type: string description: 'Sale’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning' default: Optional MerchantCustomerId: type: string description: Merchant Customer Id. default: Optional Activated: type: boolean description: Delayed Activation Sales to be included or not default: false ActivationDateFrom: type: string description: Activation Start Date. This field is applicable only when Activated flag is set to true. default: Optional format: date ActivationDateTo: type: string description: Activation End Date. This field is applicable only when Activated flag is set to true. default: Optional format: date examples: Example Request: value: merchantGuid: 19344275-985e-4dff-81ee-cb84b8ad356c status: Transaction - Approved responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"pageCurrent\": 1,\n \"pageCurrentResults\": 1,\n \"pageTotal\": 1,\n \"pageSize\": 1,\n \"totalResults\": 1,\n \"cardSummary\": null,\n \"searchResultDTO\": [\n {\n \"status\": \"Transaction - Approved\",\n \"amount\": 1,\n \"card\": {\n \"cardHolderName\": null,\n \"cardType\": \"Visa\",\n \"last4\": \"0473\"\n },\n \"orderNumber\": null,\n \"orderDate\": null,\n \"timeStamp\": \"2018-11-23T14:57:43.78-03:00\",\n \"customerID\": null,\n \"processorResponseMessage\": null,\n \"effectiveAmount\": 0,\n \"batchStatus\": \"Batch - Open\",\n \"relatedVoid\": null,\n \"relatedReturns\": null,\n \"guid\": \"d38a9133-6643-4a0a-9675-3cd820a8b5ff\",\n \"deviceGuid\": \"8ec1c40b-0c00-4a57-a9c7-7800bd52c308\",\n \"captureGuid\": null,\n \"customData\": null,\n \"generatedByCapture\": false,\n \"partiallyApprovedAmount\": null,\n \"type\": \"Credit\",\n \"surcharge\": null,\n \"surchargeType\": null,\n \"serviceFee\": null,\n \"tipAmount\": null,\n \"cardDataSource\": \"INTERNET\",\n \"allowCardEmv\": true,\n \"incomingTransactionCode\": \"09ZZZTAS37411231800000100\",\n \"activationDate\": \"2021-10-10T00:00:00\"\n }\n ]\n}\n" schema: type: object properties: pageCurrent: type: integer example: 1 default: 0 pageCurrentResults: type: integer example: 1 default: 0 pageTotal: type: integer example: 1 default: 0 pageSize: type: integer example: 1 default: 0 totalResults: type: integer example: 1 default: 0 cardSummary: {} searchResultDTO: type: array items: type: object properties: status: type: string example: Transaction - Approved amount: type: integer example: 1 default: 0 card: type: object properties: cardHolderName: {} cardType: type: string example: Visa last4: type: string example: '0473' orderNumber: {} orderDate: {} timeStamp: type: string example: '2018-11-23T14:57:43.78-03:00' customerID: {} processorResponseMessage: {} effectiveAmount: type: integer example: 0 default: 0 batchStatus: type: string example: Batch - Open relatedVoid: {} relatedReturns: {} guid: type: string example: d38a9133-6643-4a0a-9675-3cd820a8b5ff deviceGuid: type: string example: 8ec1c40b-0c00-4a57-a9c7-7800bd52c308 captureGuid: {} customData: {} generatedByCapture: type: boolean example: false default: true partiallyApprovedAmount: {} type: type: string example: Credit surcharge: {} surchargeType: {} serviceFee: {} tipAmount: {} cardDataSource: type: string example: INTERNET allowCardEmv: type: boolean example: true default: true incomingTransactionCode: type: string example: 09ZZZTAS37411231800000100 activationDate: type: string example: '2021-10-10T00:00:00' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Search servers: - url: https://sandboxsalesapi.connexpay.com /api/v1/Search/Voids/{exportable}/{pageNumber}/{pageSize}: post: summary: Search voids description: This endpoint searches sales voids. operationId: search-voids parameters: - name: Exportable in: path description: True or False. It means if you want results exportable to CSV. schema: type: string default: Mandatory required: true - name: PageNumber in: path description: Int. Number of page of the results. Default is 1 (Page size default is 500). schema: type: integer format: int32 default: null required: true - name: PageSize in: path description: Int. Size of each page of the results. Default is 500. schema: type: string default: Optional required: true - name: Content-Type in: header schema: type: string default: '"application/json"' - name: Authorization in: header schema: type: string default: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' requestBody: content: application/json: schema: type: object properties: MerchantGuid: type: string description: Merchant’s Guid. default: Mandatory VoidReason: type: string description: 'Indicates the reason the transaction was voided. Allowed values: 1. POST_AUTH_USER_DECLINE 2. DEVICE_TIMEOUT 3. DEVICE_UNAVAILABLE 4. PARTIAL_REVERSAL 5. TORN_TRANSACTIONS 6. POST_AUTH_CHIP_DECLINE' default: Optional Status: type: string description: 'Void’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning' default: Optional TimeStampFrom: type: string description: Void’s TimeStamp. default: Optional format: date TimeStampTo: type: string description: Void’s TimeStamp. default: Optional format: date examples: Example Request: value: merchantGuid: 19344275-985e-4dff-81ee-cb84b8ad356c status: Transaction - Approved responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"pageCurrent\": 1,\n \"pageCurrentResults\": 1,\n \"pageTotal\": 1,\n \"pageSize\": 1,\n \"totalResults\": 1,\n \"cardSummary\": null,\n \"searchResultDTO\": [\n {\n \"status\": \"Transaction - Approved\",\n \"sale\": {\n \"amount\": 10,\n \"card\": {\n \"cardHolderName\": null,\n \"cardType\": \"Visa\",\n \"last4\": \"0445\"\n }\n },\n \"authOnly\": null,\n \"debitSale\": null,\n \"debitReturn\": null,\n \"ebtFoodStampPurchase\": null,\n \"ebtElectronicVoucher\": null,\n \"ebtReturn\": null,\n \"ebtCashBenefitPurchase\": null,\n \"return\": null,\n \"voidReason\": null,\n \"timeStamp\": \"2018-11-22T16:57:41.74\",\n \"processorStatusCode\": \"A0000\",\n \"batchStatus\": \"Batch - Closed\",\n \"guid\": \"211c7e9e-f0ce-45e1-be79-ff0333c81478\",\n \"allowCardEmv\": true\n }\n ]\n}" schema: type: object properties: pageCurrent: type: integer example: 1 default: 0 pageCurrentResults: type: integer example: 1 default: 0 pageTotal: type: integer example: 1 default: 0 pageSize: type: integer example: 1 default: 0 totalResults: type: integer example: 1 default: 0 cardSummary: {} searchResultDTO: type: array items: type: object properties: status: type: string example: Transaction - Approved sale: type: object properties: amount: type: integer example: 10 default: 0 card: type: object properties: cardHolderName: {} cardType: type: string example: Visa last4: type: string example: '0445' authOnly: {} debitSale: {} debitReturn: {} ebtFoodStampPurchase: {} ebtElectronicVoucher: {} ebtReturn: {} ebtCashBenefitPurchase: {} return: {} voidReason: {} timeStamp: type: string example: '2018-11-22T16:57:41.74' processorStatusCode: type: string example: A0000 batchStatus: type: string example: Batch - Closed guid: type: string example: 211c7e9e-f0ce-45e1-be79-ff0333c81478 allowCardEmv: type: boolean example: true default: true '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Search servers: - url: https://sandboxsalesapi.connexpay.com /api/v1/Search/Returns/{exportable}/{pageNumber}/{pageSize}: post: summary: Search returns description: This endpoint searches sale returns. operationId: search-returns parameters: - name: Exportable in: path description: True or False. It means if you want results exportable to CSV. schema: type: string default: Mandatory required: true - name: PageNumber in: path description: Int. Number of page of the results. Default is 1 (Page size default is 500). schema: type: integer format: int32 default: null required: true - name: PageSize in: path description: Int. Size of each page of the results. Default is 500. schema: type: string default: Optional required: true - name: Content-Type in: header schema: type: string default: '"application/json"' - name: Authorization in: header schema: type: string default: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' requestBody: content: application/json: schema: type: object properties: MerchantGuid: type: string description: Merchant’s Guid. default: Mandatory AmountFrom: type: number description: 'Amount of the transaction. Min. amt.: $0.50' default: null format: float AmountTo: type: number description: 'Amount of the transaction. Min. amt.: $0.50' default: null format: float CardHolderName: type: string description: Cardholder’s name. Providing information in this field allows a user of the ConnexPay portal to search for a transaction using the cardholder name. default: Optional Status: type: string description: 'Return’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning' default: Optional TimeStampFrom: type: string description: Return’s TimeStamp. default: Optional format: date TimeStampTo: type: string description: Return’s TimeStamp. default: Optional format: date examples: Example Request: value: merchantGuid: 19344275-985e-4dff-81ee-cb84b8ad356c status: Transaction - Approved responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"pageCurrent\": 1,\n \"pageCurrentResults\": 1,\n \"pageTotal\": 1,\n \"pageSize\": 1,\n \"totalResults\": 1,\n \"cardSummary\": null,\n \"searchResultDTO\": [\n {\n \"status\": \"Transaction - Approved\",\n \"amount\": 150,\n \"card\": {\n \"cardHolderName\": null,\n \"cardType\": \"Visa\",\n \"last4\": \"0267\"\n },\n \"timeStamp\": \"2018-11-14T09:26:58.42\",\n \"processorStatusCode\": \"A0000\",\n \"batchStatus\": \"Batch - Closed\",\n \"guid\": \"451dd720-18e6-48b2-a8fa-b9ae4579c3fc\",\n \"relatedVoid\": null,\n \"deviceGuid\": \"8ec1c40b-0c00-4a57-a9c7-7800bd52c308\",\n \"type\": \"CreditReturn\",\n \"cardDataSource\": \"\",\n \"allowCardEmv\": true\n }\n ]\n}\n" schema: type: object properties: pageCurrent: type: integer example: 1 default: 0 pageCurrentResults: type: integer example: 1 default: 0 pageTotal: type: integer example: 1 default: 0 pageSize: type: integer example: 1 default: 0 totalResults: type: integer example: 1 default: 0 cardSummary: {} searchResultDTO: type: array items: type: object properties: status: type: string example: Transaction - Approved amount: type: integer example: 150 default: 0 card: type: object properties: cardHolderName: {} cardType: type: string example: Visa last4: type: string example: '0267' timeStamp: type: string example: '2018-11-14T09:26:58.42' processorStatusCode: type: string example: A0000 batchStatus: type: string example: Batch - Closed guid: type: string example: 451dd720-18e6-48b2-a8fa-b9ae4579c3fc relatedVoid: {} deviceGuid: type: string example: 8ec1c40b-0c00-4a57-a9c7-7800bd52c308 type: type: string example: CreditReturn cardDataSource: type: string example: '' allowCardEmv: type: boolean example: true default: true '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Search servers: - url: https://sandboxsalesapi.connexpay.com /api/v1/Search/Verify/{exportable}/{pageNumber}/{pageSize}: post: summary: Search verify description: This endpoint search a verify. operationId: search-verify parameters: - name: Exportable in: path description: True or False. It means if you want results exportable to CSV. schema: type: string default: Mandatory required: true - name: PageNumber in: path description: Int. Number of page of the results. Default is 1 (Page size default is 500). schema: type: integer format: int32 default: null required: true - name: PageSize in: path description: Int. Size of each page of the results. Default is 500. schema: type: string default: Optional required: true - name: Content-Type in: header schema: type: string default: '"application/json"' - name: Authorization in: header schema: type: string default: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."' requestBody: content: application/json: schema: type: object properties: MerchantGuid: type: string description: Merchant’s Guid. default: Mandatory CardLastFour: type: string description: Card last four number. default: Optional CardHolderName: type: string description: Cardholder’s name. Providing information in this field allows a user of the ConnexPay portal to search for a transaction using the cardholder name. default: Optional CardType: type: string description: Card Type. default: Optional TimeStampFrom: type: string description: Verify’s TimeStamp From. default: Optional format: date TimeStampTo: type: string description: Verify’s TimeStamp To. default: Optional format: date Status: type: string description: 'Verify’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning' default: Optional examples: Example Request: value: merchantGuid: 19344275-985e-4dff-81ee-cb84b8ad356c status: Transaction - Approved responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"pageCurrent\": 1,\n \"pageCurrentResults\": 1,\n \"pageTotal\": 1,\n \"pageSize\": 1,\n \"totalResults\": 1,\n \"cardSummary\": null,\n \"searchResultDTO\": [\n {\n \"status\": \"Transaction - Approved\",\n \"card\": {\n \"cardHolderName\": null,\n \"cardType\": \"Mastercard\",\n \"last4\": \"0759\"\n },\n \"timeStamp\": \"2018-11-09T15:34:49.91\",\n \"processorStatusCode\": \"A0000\"\n }\n ]\n}\n" schema: type: object properties: pageCurrent: type: integer example: 1 default: 0 pageCurrentResults: type: integer example: 1 default: 0 pageTotal: type: integer example: 1 default: 0 pageSize: type: integer example: 1 default: 0 totalResults: type: integer example: 1 default: 0 cardSummary: {} searchResultDTO: type: array items: type: object properties: status: type: string example: Transaction - Approved card: type: object properties: cardHolderName: {} cardType: type: string example: Mastercard last4: type: string example: 0759 timeStamp: type: string example: '2018-11-09T15:34:49.91' processorStatusCode: type: string example: A0000 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Search servers: - url: https://sandboxsalesapi.connexpay.com components: securitySchemes: sec0: type: http scheme: basic x-refined-from: - connexpay-purchases-openapi.yml - connexpay-sales-openapi.yml x-readme: headers: - key: Authorization value: Basic explorer-enabled: false proxy-enabled: true x-readme-fauxas: true