Fetch Transaction or Order
get/pgw/api/v1/direct/order/{orderId}
Request
- Base URLhttps://api.ksamerchant.geidea.net
- URLhttps://api.ksamerchant.geidea.net/pgw/api/v1/direct/order/{orderId}
- AuthHTTP basic
Path parameters
orderIdstring required
Unique ID for the order. If orderId is not provided, then all orders for the merchant account are returned in the response.
Response
200
Example response
{
"order": {
"orderId": "79eb2427-49fe-427e-79b3-08db080e276f",
"amount": 20,
"totalAmount": 20,
"settleAmount": 20,
"currency": "SAR",
"settleCurrency": "SAR",
"language": "en",
"detailedStatus": "OrderFailed",
"status": "Failed",
"threeDSecureId": "552e17c6-ef87-451d-1021-08db080d001e",
"merchantId": "e80ece7e-fb2a-4c0b-de94-08d8a29a107b",
"merchantPublicKey": "a087f4ca-9890-407b-9c2f-7630836cc020",
"merchantReferenceId": "string",
"callbackUrl": "https://some-return-url.com",
"billingAddress": {
"countryCode": "IND",
"street": "Street 1",
"city": "Hyderabad",
"postCode": "500081"
},
"shippingAddress": {
"countryCode": "IND",
"street": "Street 1",
"city": "Hyderabad",
"postCode": "500081"
},
"returnUrl": "https://some-return-url.com",
"cardOnFile": true,
"initiatedBy": "Internet",
"agreementId": "PG231",
"agreementType": "Recurring",
"paymentOperation": "Pay",
"custom": "Payment for Subscription",
"restrictPaymentMethods": true,
"platform": {
"integrationType": "API integration",
"name": "GPG",
"version": "2.0.9",
"pluginVersion": "0.1.1",
"partnerId": "G25021"
},
"statementDescriptor": {
"name": "Electronics",
"phone": "8123456789"
},
"description": "Payment for electronics",
"setDefaultPaymentMethod": true,
"customerReferenceId": "string",
"customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recurrence": {
"recurrenceId": "26bb404f-7e10-4ccc-98c7-08db0ab244d3",
"orderId": "79eb2427-49fe-427e-79b3-08db080e276f",
"amount": 10,
"currency": "SAR",
"cycleInterval": "Day",
"cycleFrequency": 2,
"numberOfPayments": 2,
"startDate": "2023-02-13T00:00:00",
"endDate": "2023-02-24T00:00:00",
"minimumDaysBetweenPayments": 5,
"description": "For Subscription ID - Appu Tech",
"createdDate": "0001-01-01T00:00:00"
},
"transactions": [
{
"transactionId": "552e17c6-ef87-451d-1021-08db080d001e",
"type": "Authentication",
"status": "Failed",
"amount": 20,
"currency": "SAR",
"source": "HPP",
"paymentMethod": {
"type": "Card",
"brand": "visa",
"cardholderName": "Name",
"maskedCardNumber": "495530******2083",
"expiryDate": {
"month": 11,
"year": 23
},
"issuingCountry": "USA",
"fundingType": "CREDIT"
},
"codes": {
"responseCode": "100",
"responseMessage": "General error",
"detailedResponseCode": "999",
"detailedResponseMessage": "Transaction could not be completed due to invalid request"
},
"correlationId": "6aa71e53-9463-4da6-9e52-ef583c0495a8",
"createdDate": "2023-02-13T06:33:53.4240553",
"createdBy": "PGW",
"updatedDate": "2023-02-13T06:36:18.1177687",
"updatedBy": "PGW"
}
],
"paymentMethod": {
"type": "Card",
"brand": "visa",
"cardholderName": "Name",
"maskedCardNumber": "495530******2083",
"expiryDate": {
"month": 11,
"year": 23
},
"issuingCountry": "USA",
"fundingType": "CREDIT"
},
"orderSource": "GeideaGateway",
"paymentBrands": [
"visa"
],
"multiCurrency": {
"authCurrency": "SAR",
"authAmount": 20,
"settleCurrency": "SAR",
"settleAmount": 20
},
"isTest": true,
"deviceId": "deea6803-3360-4b65-c3c3-08db0a88a53d",
"gatewayDecision": "Reject",
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdDate": "2023-02-13T06:33:53.4240553",
"createdBy": "PGW",
"updatedDate": "2023-02-13T06:52:01.1934668",
"updatedBy": "PGW"
},
"responseCode": "000",
"detailedResponseCode": "000"
}Changes
No recorded changes to this operation across all 1 revision of this API.