v1

latestOpenAPI 3.1.02026-07-26270268.6 KB

Fetch All or Search Payment invoices

get/payment-intent/api/v1/direct/eInvoice

Query parameters

FromDatestring date

Start Date

ToDatestring date

End Date

FromAmountnumber double

Amount range begin, min amount

ToAmountnumber double

Amount range end, max amount

Currency'SAR' | 'EGP' | 'AED' | 'QAR' | 'OMR' | 'BHD' | 'KWD' | 'USD' | 'GBP' | 'EUR'

Currency in which payment invoice is created

SortOrderstring

Order of sorting of payment invoices (ASC, DESC)

SortBy'Name'

Indicates the field to sort by

Skipinteger

Takeinteger

TotalCountOnlyboolean

EInvoiceUploadIdstring

StaticPayinvoiceIdstring

Statusstring

Numberinteger

HasOrdersboolean

FromPaidDatestring date

ToPaidDatestring date

CustomerNamestring

Referencestring

SubscriptionIdstring

ID of subscription used for recurring payments

Response

200

totalCountinteger

responseMessagestring

detailedResponseMessagestring

languagestring

responseCodestring

detailedResponseCodestring

Example response

{
  "paymentIntents": [
    {
      "invoiceId": "INV-202604-071247030279",
      "customer": {
        "customerId": "2fdeb991-fc85-4f44-1437-08daf7e8daf6",
        "email": "test2@gmail.com",
        "phoneNumber": "511111111",
        "phoneCountryCode": "+966",
        "name": "John",
        "updatedDate": "2023-01-24T06:44:41.215432Z"
      },
      "eInvoiceDetails": {
        "type": "Detailed",
        "collectCustomersBillingShippingAddress": true,
        "preAuthorizeAmount": true,
        "subtotalWithoutTax": 20,
        "subtotal": 20,
        "grandTotal": 20,
        "extraChargesType": "Amount",
        "chargeDescription": "string",
        "merchantReferenceId": "string",
        "invoiceDiscountType": "Amount",
        "language": "EN",
        "eInvoiceItems": [
          {
            "eInvoiceItemId": "4d20400e-ad21-42b3-6020-08daf7e7b64d",
            "description": "string",
            "price": 10,
            "priceWithDiscount": 10,
            "priceTotal": 10,
            "quantity": 2,
            "sku": "string",
            "itemDiscountType": "Amount",
            "taxType": "Amount",
            "totalWithoutTax": 20,
            "total": 20
          }
        ]
      },
      "paymentIntentId": "26c8f032-6789-466a-7909-08daf7e7b637",
      "number": "803262445358",
      "urlSlug": "cte-dyr-1o1-bms",
      "type": "EInvoice",
      "amount": 20,
      "currency": "SAR",
      "merchantId": "e80ece7e-fb2a-4c0b-de94-08d8a29a107b",
      "merchantPublicKey": "a087f4ca-9890-407b-9c2f-7630836cc020",
      "expiryDate": "2023-02-10T08:54:33.617Z",
      "activationDate": "2023-02-10T08:54:33.617Z",
      "status": "Created",
      "customerId": "2fdeb991-fc85-4f44-1437-08daf7e8daf6",
      "isPending": true,
      "createdDate": "2023-01-24T06:44:41.2846272Z",
      "createdBy": "e80ece7e-fb2a-4c0b-de94-08d8a29a107b"
    }
  ],
  "totalCount": 3,
  "responseMessage": "Success",
  "detailedResponseMessage": "The operation was successful",
  "language": "EN",
  "responseCode": "000",
  "detailedResponseCode": "000"
}