Fetch All or Search Transactions or Orders

Fetch all Transactions or Search Transactions

You can retrieve the transaction details with the help of our [Fetch or Search all Transactions API] (https://docs.geidea.net/reference/fetch-or-search-all-transactions). You can use this feature to retrieve the completed or in progress payments, check the status of any payment and fulfil use cases like running automated message delivery jobs and so on.

📘
You can programmatically loop through and search through all the payments or orders returned as the response for this API call and act on an individual or group of or all payments or orders according to your use case.

You need to pass the following parameter(s) as path parameter(s) in the API request

Parameter	Datatype	Description	Mandatory
`FromDate`	datetime	Start Date	No
`ToDate`	datetime	End Date	No
`FromAmount`	double	Amount range begin, min amount	No
`ToAmount`	double	Amount range end, max amount	No
`Currency`	string	Currency in which payment link is created	No
`SortOrder`	string	Order of sorting of payment links (ASC, DESC)	No
`SortBy`	string	Indicates the field to sort by	No
`Skip`	integer		No
`Take`	integer		No
`TotalCountOnly`	boolean		No
`EInvoiceUploadId`	string		No
`StaticPaylinkId`	string		No
`Number`	integer		No
`HasOrders`	boolean		No
`FromPaidDate`	datetime		No
`ToPaidDate`	datetime		No
`CustomerName`	string		No
`Reference`	string		No
`SubscriptionId`	string		No
`DetailedStatus`	boolean		No
`Status`	string		No

Sample API Request

👍
GET
https://api.merchant.geidea.net/pgw/api/v1/direct/order
You must use the GET HTTP method when executing this API call.

API Response

The parameters returned in the API response are as follows:

Parameter	Description
`orders`	Orders object. List of orders with the filter criteria
`totalAmount`	Amount for which payment is carried out
`totalCount`	Number of payment links in the `paymentIntents` object
`responseCode`	Code associated with response message returned by the gateway
`detailedResponseCode`	Detailed Code associated with response message returned by the gateway

A sample response for a Fetch payment link API call is as follows:

"orders": [
        {
            "orderId": "007b1230-e063-47b7-7936-08db004750e0",
            "amount": 1.00,
            "tipAmount": 0.00,
            "convenienceFeeAmount": 0.00,
            "totalAmount": 1.00,
            "settleAmount": 1.00,
            "currency": "SAR",
            "settleCurrency": "SAR",
            "language": "en",
            "detailedStatus": "OrderFailed",
            "status": "Failed",
            "threeDSecureId": "eb0c7e1b-b66a-4acf-5659-08db004734b9",
            "merchantId": "e80ece7e-fb2a-4c0b-de94-08d8a29a107b",
            "merchantPublicKey": "a087f4ca-9890-407b-9c2f-7630836cc020",
            "parentOrderId": null,
            "merchantReferenceId": "340",
            "mcc": null,
            "callbackUrl": "https://woocommerce.avalab.io/?wc-api=geidea",
            "customerEmail": null,
            "billingAddress": {
                "countryCode": null,
                "street": null,
                "city": null,
                "postCode": null
            },
            "shippingAddress": {
                "countryCode": null,
                "street": null,
                "city": null,
                "postCode": null
            },
            "returnUrl": null,
            "cardOnFile": false,
            "tokenId": null,
            "initiatedBy": "Internet",
            "agreementId": null,
            "agreementType": null,
            "paymentOperation": "Pay",
            "custom": null,
            "paymentIntent": null,
            "restrictPaymentMethods": false,
            "paymentMethods": null,
            "platform": null,
            "statementDescriptor": null,
            "description": null,
            "createCustomer": false,
            "setDefaultPaymentMethod": false,
            "customerReferenceId": null,
            "customerId": null,
            "recurrence": null,
            "transactions": [],
            "orderItems": [],
            "isTokenPayment": false,
            "paymentMethod": null,
            "totalAuthorizedAmount": 0,
            "totalCapturedAmount": 0,
            "totalRefundedAmount": 0,
            "orderSource": "GeideaGateway",
            "paymentBrands": [],
            "multiCurrency": {
                "authCurrency": "SAR",
                "authAmount": 1.00,
                "settleCurrency": "SAR",
                "settleAmount": 1.00,
                "exchangeRate": null,
                "exchangeFeePercentage": null,
                "exchangeFeeAmount": null
            },
            "isTest": true,
            "cashOnDelivery": false,
            "amountToCollect": null,
            "isDownPayment": false,
            "exchangeRate": null,
            "exchangeFeePercentage": null,
            "exchangeFeeAmount": null,
            "deviceId": "4b9cb866-7ce6-4872-69fc-08dafface957",
            "gatewayDecision": "ContinueToPayer",
            "subscriptionId": null,
            "subscriptionOccurrenceId": null,
            "customerPhoneNumber": null,
            "customerPhoneCountryCode": null,
            "createdDate": "2023-01-30T10:58:14.2163599",
            "createdBy": "PGW",
            "updatedDate": "2023-01-30T11:14:01.0834332",
            "updatedBy": "PGW"
        },
        {
            "orderId": "cdffc192-fb52-44e6-7907-08db004750e0",
            "amount": 2.00,
            "tipAmount": 0.00,
            "convenienceFeeAmount": 0.00,
            "totalAmount": 2.00,
            "settleAmount": 2.00,
            "currency": "SAR",
            "settleCurrency": "SAR",
            "language": "en",
            "detailedStatus": "Paid",
            "status": "Success",
            "threeDSecureId": "efc2d22d-1233-431f-5611-08db004734b9",
            "merchantId": "e80ece7e-fb2a-4c0b-de94-08d8a29a107b",
            "merchantPublicKey": "a087f4ca-9890-407b-9c2f-7630836cc020",
            "parentOrderId": null,
            "merchantReferenceId": "339",
            "mcc": null,
            "callbackUrl": "https://woocommerce.avalab.io/?wc-api=geidea",
            "customerEmail": null,
            "billingAddress": {
                "countryCode": "SAU",
                "street": "a",
                "city": "a",
                "postCode": "12243"
            },
            "shippingAddress": {
                "countryCode": "SAU",
                "street": "a",
                "city": "a",
                "postCode": "12243"
            },
            "returnUrl": null,
            "cardOnFile": false,
            "tokenId": null,
            "initiatedBy": "Internet",
            "agreementId": null,
            "agreementType": null,
            "paymentOperation": "Pay",
            "custom": null,
            "paymentIntent": null,
            "restrictPaymentMethods": false,
            "paymentMethods": null,
            "platform": null,
            "statementDescriptor": null,
            "description": null,
            "createCustomer": false,
            "setDefaultPaymentMethod": false,
            "customerReferenceId": null,
            "customerId": null,
            "recurrence": null,
            "transactions": [],
            "orderItems": [],
            "isTokenPayment": false,
            "paymentMethod": null,
            "totalAuthorizedAmount": 0,
            "totalCapturedAmount": 0,
            "totalRefundedAmount": 0,
            "orderSource": "GeideaGateway",
            "paymentBrands": [],
            "multiCurrency": {
                "authCurrency": "SAR",
                "authAmount": 2.00,
                "settleCurrency": "SAR",
                "settleAmount": 2.00,
                "exchangeRate": null,
                "exchangeFeePercentage": null,
                "exchangeFeeAmount": null
            },
            "isTest": true,
            "cashOnDelivery": false,
            "amountToCollect": null,
            "isDownPayment": false,
            "exchangeRate": null,
            "exchangeFeePercentage": null,
            "exchangeFeeAmount": null,
            "deviceId": "4b9cb866-7ce6-4872-69fc-08dafface957",
            "gatewayDecision": "ContinueToPay",
            "subscriptionId": null,
            "subscriptionOccurrenceId": null,
            "customerPhoneNumber": null,
            "customerPhoneCountryCode": null,
            "createdDate": "2023-01-30T10:23:18.2023383",
            "createdBy": "PGW",
            "updatedDate": "2023-01-30T10:23:42.0339625",
            "updatedBy": "PGW"
        }
  ],
    "totalCount": 3,
    "totalAmount": 0,
    "responseCode": "000",
    "detailedResponseCode": "000"
}

Search Payment or Order

You can search for a Payment with the [Fetch or Search all Transactions API] (https://docs.geidea.net/reference/fetch-or-search-all-transactions). Using this API, you can search for Payments or orders with varied criteria such as date ranges, statuses, and so on.

Fetch all Transactions or Search Transactions

📘

Sample API Request

👍GET

API Response

Search Payment or Order

👍
GET