--- updatedAt: 2025-06-25T21:34:32.000Z agentTools: projectIndex: https://docs.geidea.net/llms.txt --- # Fetch All or Search Payment Links # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Pay By Link", "version": "2.0" }, "servers": [ { "url": "https://api.ksamerchant.geidea.net", "description": "Saudi Arabia - Production" }, { "url": "https://api.merchant.geidea.net", "description": "Egypt - Production" }, { "url": "https://api.geidea.ae", "description": "UAE - Production" } ], "components": { "securitySchemes": { "sec0": { "type": "http", "scheme": "basic" } } }, "security": [ { "sec0": [] } ], "paths": { "/payment-intent/api/v1/direct/eInvoice": { "get": { "summary": "Fetch All or Search Payment Links", "description": "", "operationId": "find-list-of-payment-links", "parameters": [ { "name": "FromDate", "in": "query", "description": "Start Date", "schema": { "type": "string", "format": "date" } }, { "name": "ToDate", "in": "query", "description": "End Date", "schema": { "type": "string", "format": "date" } }, { "name": "FromAmount", "in": "query", "description": "Amount range begin, min amount", "schema": { "type": "number", "format": "double" } }, { "name": "ToAmount", "in": "query", "description": "Amount range end, max amount", "schema": { "type": "number", "format": "double" } }, { "name": "Currency", "in": "query", "description": "Currency in which payment link is created", "schema": { "type": "string", "enum": [ "SAR", "EGP", "AED", "QAR", "OMR", "BHD", "KWD", "USD", "GBP", "EUR" ] } }, { "name": "SortOrder", "in": "query", "description": "Order of sorting of payment links (ASC, DESC)", "schema": { "type": "string", "default": "ASC" } }, { "name": "SortBy", "in": "query", "description": "Indicates the field to sort by", "schema": { "type": "string", "enum": [ "Name" ], "default": "Name" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "TotalCountOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "EInvoiceUploadId", "in": "query", "schema": { "type": "string" } }, { "name": "StaticPaylinkId", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Number", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "HasOrders", "in": "query", "schema": { "type": "boolean" } }, { "name": "FromPaidDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ToPaidDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "CustomerName", "in": "query", "schema": { "type": "string" } }, { "name": "Reference", "in": "query", "schema": { "type": "string" } }, { "name": "SubscriptionId", "in": "query", "description": "ID of subscription used for recurring payments", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"paymentIntents\": [\n {\n \"link\": \"https://merchant.geidea.net/payByLink/cte-dyr-1o1-bms\",\n \"customer\": {\n \"customerId\": \"2fdeb991-fc85-4f44-1437-08daf7e8daf6\",\n \"email\": \"test2@gmail.com\",\n \"phoneNumber\": \"511111111\",\n \"phoneCountryCode\": \"+966\",\n \"name\": \"John\",\n \"updatedBy\": null,\n \"updatedDate\": \"2023-01-24T06:44:41.215432Z\",\n \"addresses\": []\n },\n \"eInvoiceDetails\": {\n \"type\": \"Detailed\",\n \"collectCustomersBillingShippingAddress\": true,\n \"preAuthorizeAmount\": true,\n \"subtotalWithoutTax\": 20.00,\n \"subtotalTax\": 0.00,\n \"subtotal\": 20.00,\n \"grandTotal\": 20.00,\n \"extraCharges\": 0.00,\n \"extraChargesType\": \"Amount\",\n \"chargeDescription\": \"string\",\n \"merchantReferenceId\": \"string\",\n \"invoiceDiscount\": 0.00,\n \"invoiceDiscountType\": \"Amount\",\n \"language\": \"EN\",\n \"eInvoiceItems\": [\n {\n \"eInvoiceItemId\": \"4d20400e-ad21-42b3-6020-08daf7e7b64d\",\n \"description\": \"string\",\n \"price\": 10.00,\n \"priceWithDiscount\": 10.00,\n \"priceTax\": 0.00,\n \"priceTotal\": 10.00,\n \"quantity\": 2,\n \"sku\": \"string\",\n \"itemDiscount\": 0.00,\n \"itemDiscountType\": \"Amount\",\n \"tax\": 0.00,\n \"taxType\": \"Amount\",\n \"totalWithoutTax\": 20.00,\n \"totalTax\": 0.00,\n \"total\": 20.00\n }\n ]\n },\n \"eInvoiceSentLinks\": [],\n \"paymentIntentId\": \"26c8f032-6789-466a-7909-08daf7e7b637\",\n \"number\": \"803262445358\",\n \"urlSlug\": \"cte-dyr-1o1-bms\",\n \"type\": \"EInvoice\",\n \"amount\": 20.00,\n \"currency\": \"SAR\",\n \"merchantId\": \"e80ece7e-fb2a-4c0b-de94-08d8a29a107b\",\n \"merchantPublicKey\": \"a087f4ca-9890-407b-9c2f-7630836cc020\",\n \"expiryDate\": \"2023-02-10T08:54:33.617Z\",\n \"activationDate\": \"2023-02-10T08:54:33.617Z\",\n \"status\": \"Created\",\n \"customerId\": \"2fdeb991-fc85-4f44-1437-08daf7e8daf6\",\n \"eInvoiceUploadId\": null,\n \"staticPaylinkId\": null,\n \"subscriptionId\": null,\n \"subscriptionOccurrenceId\": null,\n \"orders\": [],\n \"isPending\": true,\n \"createdDate\": \"2023-01-24T06:44:41.2846272Z\",\n \"createdBy\": \"e80ece7e-fb2a-4c0b-de94-08d8a29a107b\",\n \"updatedDate\": null,\n \"updatedBy\": null\n },\n {\n \"link\": \"https://merchant.geidea.net/payByLink/84u-jqk-jl9-qye\",\n \"customer\": {\n \"customerId\": \"85a60e5c-cfe3-4740-7a29-08daf7e7b5df\",\n \"email\": \"test2@gmail.com\",\n \"phoneNumber\": \"511111111\",\n \"phoneCountryCode\": \"+966\",\n \"name\": \"John\",\n \"updatedBy\": null,\n \"updatedDate\": \"2023-01-24T06:37:46.2975566Z\",\n \"addresses\": []\n },\n \"eInvoiceDetails\": {\n \"type\": \"Detailed\",\n \"collectCustomersBillingShippingAddress\": true,\n \"preAuthorizeAmount\": true,\n \"subtotalWithoutTax\": 20.00,\n \"subtotalTax\": 0.00,\n \"subtotal\": 20.00,\n \"grandTotal\": 20.00,\n \"extraCharges\": 0.00,\n \"extraChargesType\": \"Amount\",\n \"chargeDescription\": \"string\",\n \"merchantReferenceId\": \"string\",\n \"invoiceDiscount\": 0.00,\n \"invoiceDiscountType\": \"Amount\",\n \"language\": \"EN\",\n \"eInvoiceItems\": [\n {\n \"eInvoiceItemId\": \"a0e2f9c2-5f52-4d85-34fa-08daf7f29d81\",\n \"description\": \"string\",\n \"price\": 10.00,\n \"priceWithDiscount\": 10.00,\n \"priceTax\": 0.00,\n \"priceTotal\": 10.00,\n \"quantity\": 2,\n \"sku\": \"string\",\n \"itemDiscount\": 0.00,\n \"itemDiscountType\": \"Amount\",\n \"tax\": 0.00,\n \"taxType\": \"Amount\",\n \"totalWithoutTax\": 20.00,\n \"totalTax\": 0.00,\n \"total\": 20.00\n }\n ]\n },\n \"eInvoiceSentLinks\": [],\n \"paymentIntentId\": \"299b0253-b811-4e99-0794-08daf7ec2bc4\",\n \"number\": \"949182445131\",\n \"urlSlug\": \"84u-jqk-jl9-qye\",\n \"type\": \"EInvoice\",\n \"amount\": 20.00,\n \"currency\": \"SAR\",\n \"merchantId\": \"e80ece7e-fb2a-4c0b-de94-08d8a29a107b\",\n \"merchantPublicKey\": \"a087f4ca-9890-407b-9c2f-7630836cc020\",\n \"expiryDate\": \"2023-02-10T08:54:33.617Z\",\n \"activationDate\": \"2023-02-10T08:54:33.617Z\",\n \"status\": \"Created\",\n \"customerId\": \"85a60e5c-cfe3-4740-7a29-08daf7e7b5df\",\n \"eInvoiceUploadId\": null,\n \"staticPaylinkId\": null,\n \"subscriptionId\": null,\n \"subscriptionOccurrenceId\": null,\n \"orders\": [],\n \"isPending\": true,\n \"createdDate\": \"2023-01-24T06:37:46.3649772Z\",\n \"createdBy\": \"e80ece7e-fb2a-4c0b-de94-08d8a29a107b\",\n \"updatedDate\": null,\n \"updatedBy\": null\n },\n {\n \"link\": \"https://merchant.geidea.net/payByLink/62s-g9t-o8i-9cp\",\n \"customer\": {\n \"customerId\": \"ed46791d-22da-41f4-7a1c-08daf7e7b5df\",\n \"email\": \"test@gmail.com\",\n \"phoneNumber\": \"511111111\",\n \"phoneCountryCode\": \"+966\",\n \"name\": \"John\",\n \"updatedBy\": \"PGW\",\n \"updatedDate\": \"2023-01-23T21:51:29.2698764Z\",\n \"addresses\": []\n },\n \"eInvoiceDetails\": {\n \"type\": \"Detailed\",\n \"collectCustomersBillingShippingAddress\": true,\n \"preAuthorizeAmount\": true,\n \"subtotalWithoutTax\": 100.00,\n \"subtotalTax\": 0.00,\n \"subtotal\": 100.00,\n \"grandTotal\": 100.00,\n \"extraCharges\": 0.00,\n \"extraChargesType\": \"Amount\",\n \"chargeDescription\": \"string\",\n \"merchantReferenceId\": \"string\",\n \"invoiceDiscount\": 0.00,\n \"invoiceDiscountType\": \"Amount\",\n \"language\": \"EN\",\n \"eInvoiceItems\": [\n {\n \"eInvoiceItemId\": \"eeeead6c-db54-4906-34eb-08daf7f29d81\",\n \"description\": \"string\",\n \"price\": 10.00,\n \"priceWithDiscount\": 10.00,\n \"priceTax\": 0.00,\n \"priceTotal\": 10.00,\n \"quantity\": 10,\n \"sku\": \"string\",\n \"itemDiscount\": 0.00,\n \"itemDiscountType\": \"Amount\",\n \"tax\": 0.00,\n \"taxType\": \"Amount\",\n \"totalWithoutTax\": 100.00,\n \"totalTax\": 0.00,\n \"total\": 100.00\n }\n ]\n },\n \"eInvoiceSentLinks\": [],\n \"paymentIntentId\": \"82249793-ef36-4478-0776-08daf7ec2bc4\",\n \"number\": \"901996084874\",\n \"urlSlug\": \"62s-g9t-o8i-9cp\",\n \"type\": \"EInvoice\",\n \"amount\": 100.00,\n \"currency\": \"SAR\",\n \"merchantId\": \"e80ece7e-fb2a-4c0b-de94-08d8a29a107b\",\n \"merchantPublicKey\": \"a087f4ca-9890-407b-9c2f-7630836cc020\",\n \"expiryDate\": \"2023-02-10T08:54:33.617Z\",\n \"activationDate\": \"2023-02-10T08:54:33.617Z\",\n \"status\": \"SentToCustomer\",\n \"customerId\": \"ed46791d-22da-41f4-7a1c-08daf7e7b5df\",\n \"eInvoiceUploadId\": null,\n \"staticPaylinkId\": null,\n \"subscriptionId\": null,\n \"subscriptionOccurrenceId\": null,\n \"orders\": [],\n \"isPending\": true,\n \"createdDate\": \"2023-01-23T20:32:53.765755Z\",\n \"createdBy\": \"e80ece7e-fb2a-4c0b-de94-08d8a29a107b\",\n \"updatedDate\": \"2023-01-23T21:47:03.318728Z\",\n \"updatedBy\": \"e80ece7e-fb2a-4c0b-de94-08d8a29a107b\"\n }\n ],\n \"totalCount\": 3,\n \"responseMessage\": \"Success\",\n \"detailedResponseMessage\": \"The operation was successful\",\n \"language\": \"EN\",\n \"responseCode\": \"000\",\n \"detailedResponseCode\": \"000\"\n}" } }, "schema": { "type": "object", "properties": { "paymentIntents": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string", "example": "https://merchant.geidea.net/payByLink/cte-dyr-1o1-bms" }, "customer": { "type": "object", "properties": { "customerId": { "type": "string", "example": "2fdeb991-fc85-4f44-1437-08daf7e8daf6" }, "email": { "type": "string", "example": "test2@gmail.com" }, "phoneNumber": { "type": "string", "example": "511111111" }, "phoneCountryCode": { "type": "string", "example": "+966" }, "name": { "type": "string", "example": "John" }, "updatedBy": {}, "updatedDate": { "type": "string", "example": "2023-01-24T06:44:41.215432Z" }, "addresses": { "type": "array" } } }, "eInvoiceDetails": { "type": "object", "properties": { "type": { "type": "string", "example": "Detailed" }, "collectCustomersBillingShippingAddress": { "type": "boolean", "example": true, "default": true }, "preAuthorizeAmount": { "type": "boolean", "example": true, "default": true }, "subtotalWithoutTax": { "type": "integer", "example": 20, "default": 0 }, "subtotalTax": { "type": "integer", "example": 0, "default": 0 }, "subtotal": { "type": "integer", "example": 20, "default": 0 }, "grandTotal": { "type": "integer", "example": 20, "default": 0 }, "extraCharges": { "type": "integer", "example": 0, "default": 0 }, "extraChargesType": { "type": "string", "example": "Amount" }, "chargeDescription": { "type": "string", "example": "string" }, "merchantReferenceId": { "type": "string", "example": "string" }, "invoiceDiscount": { "type": "integer", "example": 0, "default": 0 }, "invoiceDiscountType": { "type": "string", "example": "Amount" }, "language": { "type": "string", "example": "EN" }, "eInvoiceItems": { "type": "array", "items": { "type": "object", "properties": { "eInvoiceItemId": { "type": "string", "example": "4d20400e-ad21-42b3-6020-08daf7e7b64d" }, "description": { "type": "string", "example": "string" }, "price": { "type": "integer", "example": 10, "default": 0 }, "priceWithDiscount": { "type": "integer", "example": 10, "default": 0 }, "priceTax": { "type": "integer", "example": 0, "default": 0 }, "priceTotal": { "type": "integer", "example": 10, "default": 0 }, "quantity": { "type": "integer", "example": 2, "default": 0 }, "sku": { "type": "string", "example": "string" }, "itemDiscount": { "type": "integer", "example": 0, "default": 0 }, "itemDiscountType": { "type": "string", "example": "Amount" }, "tax": { "type": "integer", "example": 0, "default": 0 }, "taxType": { "type": "string", "example": "Amount" }, "totalWithoutTax": { "type": "integer", "example": 20, "default": 0 }, "totalTax": { "type": "integer", "example": 0, "default": 0 }, "total": { "type": "integer", "example": 20, "default": 0 } } } } } }, "eInvoiceSentLinks": { "type": "array" }, "paymentIntentId": { "type": "string", "example": "26c8f032-6789-466a-7909-08daf7e7b637" }, "number": { "type": "string", "example": "803262445358" }, "urlSlug": { "type": "string", "example": "cte-dyr-1o1-bms" }, "type": { "type": "string", "example": "EInvoice" }, "amount": { "type": "integer", "example": 20, "default": 0 }, "currency": { "type": "string", "example": "SAR" }, "merchantId": { "type": "string", "example": "e80ece7e-fb2a-4c0b-de94-08d8a29a107b" }, "merchantPublicKey": { "type": "string", "example": "a087f4ca-9890-407b-9c2f-7630836cc020" }, "expiryDate": { "type": "string", "example": "2023-02-10T08:54:33.617Z" }, "activationDate": { "type": "string", "example": "2023-02-10T08:54:33.617Z" }, "status": { "type": "string", "example": "Created" }, "customerId": { "type": "string", "example": "2fdeb991-fc85-4f44-1437-08daf7e8daf6" }, "eInvoiceUploadId": {}, "staticPaylinkId": {}, "subscriptionId": {}, "subscriptionOccurrenceId": {}, "orders": { "type": "array" }, "isPending": { "type": "boolean", "example": true, "default": true }, "createdDate": { "type": "string", "example": "2023-01-24T06:44:41.2846272Z" }, "createdBy": { "type": "string", "example": "e80ece7e-fb2a-4c0b-de94-08d8a29a107b" }, "updatedDate": {}, "updatedBy": {} } } }, "totalCount": { "type": "integer", "example": 3, "default": 0 }, "responseMessage": { "type": "string", "example": "Success" }, "detailedResponseMessage": { "type": "string", "example": "The operation was successful" }, "language": { "type": "string", "example": "EN" }, "responseCode": { "type": "string", "example": "000" }, "detailedResponseCode": { "type": "string", "example": "000" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true } } ```