Fetch Transaction or Order Details by Merchant Reference

Fetch details about a specific transaction

You can retrieve the payment intent details with the help of our Fetch Transaction or Order Details by Merchant Reference API. You can use this feature to retrieve the transaction details, check the status and share the status by running automated message delivery jobs and so on.

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

Parameter	Datatype	Description	Mandatory
`merchantReferenceId`	string	This is a unique identifier for this order to discern it from other orders. This Id is created by the merchant.	Yes

Sample API Request

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

API Response

Some of the fields in the order response include the following:

Parameter	Description
orderId	This is a unique identifier for this order to discern it from the other orders you created. This value is echoed from the request.
responseMessage	Detailed message associated with response from gateway
detailedResponseMessage	Message associated with response from gateway
language	Language used for API request
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 Transaction or Order Details API call is as follows:

curl --request GET \
     --url 'https://api.merchant.geidea.net/pgw/api/v1/direct/order?MerchantReferenceId=1234' \
     --header 'accept: application/json' \
     --header 'authorization: Basic YTA4N2Y0Y2EtOTg5MC00MDdiLTljMmYtNzYzMDgzNmNjMDIwOjI2ZDMxOTE3LTcxNWUtNDhhYy1iMDcyLWRhOTczODAxNmFmNQ=='

{
  "orders": [
    {
      "orderId": "c15d153f-a9bc-4c48-7445-08d9c4953b33",
      "amount": 123.45,
      "tipAmount": 0,
      "convenienceFeeAmount": 0,
      "totalAmount": 123.45,
      "settleAmount": 123.45,
      "currency": "SAR",
      "settleCurrency": "SAR",
      "language": "en",
      "detailedStatus": "OrderFailed",
      "status": "Failed",
      "threeDSecureId": "946d1e0b-1dea-48a1-256a-08d9c4953b53",
      "merchantId": "e80ece7e-fb2a-4c0b-de94-08d8a29a107b",
      "merchantPublicKey": "8af5c859-7324-4826-bbf3-fb5520906ee0",
      "parentOrderId": null,
      "merchantReferenceId": "1234",
      "mcc": null,
      "callbackUrl": "https://website.hook/calbackurl",
      "billingAddress": null,
      "shippingAddress": null,
      "returnUrl": "geidea://paymentsdk/return",
      "cardOnFile": false,
      "tokenId": null,
      "initiatedBy": "Internet",
      "agreementId": null,
      "agreementType": null,
      "amountVariability": null,
      "paymentOperation": "Pay",
      "custom": null,
      "paymentIntent": null,
      "restrictPaymentMethods": false,
      "paymentMethods": null,
      "platform": null,
      "statementDescriptor": null,
      "description": null,
      "setDefaultPaymentMethod": false,
      "recurrence": null,
      "transactions": [],
      "orderItems": [],
      "isTokenPayment": false,
      "paymentMethod": null,
      "totalAuthorizedAmount": 0,
      "totalCapturedAmount": 0,
      "totalRefundedAmount": 0,
      "orderSource": "GeideaGateway",
      "paymentBrands": [],
      "multiCurrency": {
        "authCurrency": "SAR",
        "authAmount": 123.45,
        "settleCurrency": "SAR",
        "settleAmount": 123.45,
        "exchangeRate": null,
        "exchangeFeePercentage": null,
        "exchangeFeeAmount": null
      },
      "isTest": false,
      "cashOnDelivery": false,
      "amountToCollect": null,
      "isDownPayment": false,
      "exchangeRate": null,
      "exchangeFeePercentage": null,
      "exchangeFeeAmount": null,
      "deviceId": null,
      "gatewayDecision": "ContinueToPayer",
      "subscriptionId": null,
      "subscriptionOccurrenceId": null,
      "refundType": null,
      "refundStatus": null,
      "bankId": null,
      "isPayWithToken": false,
      "customerName": null,
      "customerEmail": "[email protected]",
      "createCustomer": false,
      "customerReferenceId": null,
      "customerId": null,
      "customerPhoneNumber": null,
      "customerPhoneCountryCode": null,
      "customerCustomValue": null,
      "airLine": null,
      "createdDate": "2022-01-04T14:19:13.6506119",
      "createdBy": "PGW",
      "updatedDate": "2022-01-04T15:20:00.700197",
      "updatedBy": "PGW"
    },
    {
      "orderId": "13a7d814-36d1-4792-6f4b-08d9c4977723",
      "amount": 123.45,
      "tipAmount": 0,
      "convenienceFeeAmount": 0,
      "totalAmount": 123.45,
      "settleAmount": 123.45,
      "currency": "SAR",
      "settleCurrency": "SAR",
      "language": "en",
      "detailedStatus": "Paid",
      "status": "Success",
      "threeDSecureId": "3248615d-dbfc-4686-c192-08d9c4977724",
      "merchantId": "e80ece7e-fb2a-4c0b-de94-08d8a29a107b",
      "merchantPublicKey": "8af5c859-7324-4826-bbf3-fb5520906ee0",
      "parentOrderId": null,
      "merchantReferenceId": "1234",
      "mcc": null,
      "callbackUrl": "https://website.hook/calbackurl",
      "billingAddress": null,
      "shippingAddress": null,
      "returnUrl": "geidea://paymentsdk/return",
      "cardOnFile": false,
      "tokenId": null,
      "initiatedBy": "Internet",
      "agreementId": null,
      "agreementType": null,
      "amountVariability": null,
      "paymentOperation": "Pay",
      "custom": null,
      "paymentIntent": null,
      "restrictPaymentMethods": false,
      "paymentMethods": null,
      "platform": null,
      "statementDescriptor": null,
      "description": null,
      "setDefaultPaymentMethod": false,
      "recurrence": null,
      "transactions": [],
      "orderItems": [],
      "isTokenPayment": false,
      "paymentMethod": null,
      "totalAuthorizedAmount": 0,
      "totalCapturedAmount": 0,
      "totalRefundedAmount": 0,
      "orderSource": "GeideaGateway",
      "paymentBrands": [],
      "multiCurrency": {
        "authCurrency": "SAR",
        "authAmount": 123.45,
        "settleCurrency": "SAR",
        "settleAmount": 123.45,
        "exchangeRate": null,
        "exchangeFeePercentage": null,
        "exchangeFeeAmount": null
      },
      "isTest": false,
      "cashOnDelivery": false,
      "amountToCollect": null,
      "isDownPayment": false,
      "exchangeRate": null,
      "exchangeFeePercentage": null,
      "exchangeFeeAmount": null,
      "deviceId": null,
      "gatewayDecision": "ContinueToPayer",
      "subscriptionId": null,
      "subscriptionOccurrenceId": null,
      "refundType": null,
      "refundStatus": null,
      "bankId": null,
      "isPayWithToken": false,
      "customerName": null,
      "customerEmail": "[email protected]",
      "createCustomer": false,
      "customerReferenceId": null,
      "customerId": null,
      "customerPhoneNumber": null,
      "customerPhoneCountryCode": null,
      "customerCustomValue": null,
      "airLine": null,
      "createdDate": "2022-01-04T09:56:17.3835876",
      "createdBy": "PGW",
      "updatedDate": "2022-01-04T09:56:28.8315046",
      "updatedBy": "PGW"
    },
    {
      "orderId": "80bbe533-dd40-4c67-6ebd-08d9c4977723",
      "amount": 123.45,
      "tipAmount": 0,
      "convenienceFeeAmount": 0,
      "totalAmount": 123.45,
      "settleAmount": 123.45,
      "currency": "SAR",
      "settleCurrency": "SAR",
      "language": "en",
      "detailedStatus": "Paid",
      "status": "Success",
      "threeDSecureId": "39cdc84f-4698-4a51-c0b9-08d9c4977724",
      "merchantId": "e80ece7e-fb2a-4c0b-de94-08d8a29a107b",
      "merchantPublicKey": "8af5c859-7324-4826-bbf3-fb5520906ee0",
      "parentOrderId": null,
      "merchantReferenceId": "1234",
      "mcc": null,
      "callbackUrl": "https://website.hook/calbackurl",
      "billingAddress": {
        "countryCode": "BGR",
        "street": "Vitosha",
        "city": "Sofia",
        "postCode": "1000"
      },
      "shippingAddress": {
        "countryCode": "BGR",
        "street": "Vitosha",
        "city": "Sofia",
        "postCode": "1000"
      },
      "returnUrl": "geidea://paymentsdk/return",
      "cardOnFile": false,
      "tokenId": null,
      "initiatedBy": "Internet",
      "agreementId": null,
      "agreementType": null,
      "amountVariability": null,
      "paymentOperation": "Pay",
      "custom": null,
      "paymentIntent": null,
      "restrictPaymentMethods": false,
      "paymentMethods": null,
      "platform": null,
      "statementDescriptor": null,
      "description": null,
      "setDefaultPaymentMethod": false,
      "recurrence": null,
      "transactions": [],
      "orderItems": [],
      "isTokenPayment": false,
      "paymentMethod": null,
      "totalAuthorizedAmount": 0,
      "totalCapturedAmount": 0,
      "totalRefundedAmount": 0,
      "orderSource": "GeideaGateway",
      "paymentBrands": [],
      "multiCurrency": {
        "authCurrency": "SAR",
        "authAmount": 123.45,
        "settleCurrency": "SAR",
        "settleAmount": 123.45,
        "exchangeRate": null,
        "exchangeFeePercentage": null,
        "exchangeFeeAmount": null
      },
      "isTest": false,
      "cashOnDelivery": false,
      "amountToCollect": null,
      "isDownPayment": false,
      "exchangeRate": null,
      "exchangeFeePercentage": null,
      "exchangeFeeAmount": null,
      "deviceId": null,
      "gatewayDecision": "ContinueToPayer",
      "subscriptionId": null,
      "subscriptionOccurrenceId": null,
      "refundType": null,
      "refundStatus": null,
      "bankId": null,
      "isPayWithToken": false,
      "customerName": null,
      "customerEmail": "[email protected]",
      "createCustomer": false,
      "customerReferenceId": null,
      "customerId": null,
      "customerPhoneNumber": null,
      "customerPhoneCountryCode": null,
      "customerCustomValue": null,
      "airLine": null,
      "createdDate": "2022-01-03T12:15:41.3940106",
      "createdBy": "PGW",
      "updatedDate": "2022-01-03T12:16:10.2352725",
      "updatedBy": "PGW"
    }
  ],
  "totalCount": 3,
  "totalAmount": 0,
  "responseCode": "000",
  "detailedResponseCode": "000"
}

Fetch details about a specific transaction

Sample API Request

👍GET

API Response

👍
GET