v1

latestOpenAPI 3.1.02026-07-26270268.6 KB

Pay

post/v2/direct/pay

Request body

sessionIdstring required

A session ID, is a unique identifier that a server generates as part of the create session API call and assigns to a merchant transaction for the duration of the session (15 min).

orderIdstring required

This is a unique identifier for this order to discern it from others order you created. If orderId is not sent with the request, an orderId is created by the server and returned in the response. The orderid can be used to refer to this order in subsequent transactions and in retrieving meta data about the order. The orderId must always be unique for every order created under your merchant profile. This must be a valid GUID.

threeDSecureIdstring required

3D Secure ID of the order created through the Authenticate Payer operation.

source'HPP' | 'MobileApp' | 'DirectAPI'

Source of capturing the transaction. Use "DirectAPI" for this call.

paymentOperation'PreAuthorize' | 'AuthorizeCapture' | 'Pay'

Type of payment operation that is carried out with this transaction

customerPhoneNumberstring

Customer's phone number eg: "511111111". If phoneCountryCode is passed, phoneNumber must be passed.

customerPhoneCountryCodestring

Country code of customer's phone number eg: "+971". If phoneNumber is passed, phoneCountryCode must be passed

ReturnUrlstring

The URL where the client will be automatically redirected to once the Authentication process has been successful. Must be dynamic, based on the order being created. Must be a URL with a HTTPS protocol.

Response

200

responseMessagestring

detailedResponseMessagestring

languagestring

responseCodestring

detailedResponseCodestring

Example response

{
  "order": {
    "orderId": "d56026ac-2784-4524-eef7-08dc33b7e268",
    "amount": 1850,
    "totalAmount": 1850,
    "settleAmount": 1850,
    "currency": "EGP",
    "settleCurrency": "EGP",
    "language": "en",
    "detailedStatus": "Paid",
    "status": "Success",
    "threeDSecureId": "5e3cf62a-9ec7-4d26-ca24-08dc33b7e269",
    "merchantId": "4907f9f6-af43-434a-340a-08da8933ece3",
    "merchantPublicKey": "40225a89-be31-4f2e-a10a-27b2bbc4e3b3",
    "mcc": "4011",
    "callbackUrl": "https://omnytr.free.beeceptor.com",
    "returnUrl": "https://webhook.site/92c440a0-4b17-4f96-ad72-bb8c91080f05",
    "initiatedBy": "Internet",
    "paymentOperation": "Pay",
    "restrictPaymentMethods": true,
    "transactions": [
      {
        "transactionId": "5e3cf62a-9ec7-4d26-ca24-08dc33b7e269",
        "type": "Authentication",
        "status": "Success",
        "amount": 1850,
        "currency": "EGP",
        "source": "MobileApp",
        "stan": "0",
        "paymentMethod": {
          "type": "Card",
          "brand": "mastercard",
          "cardholderName": "kanti",
          "maskedCardNumber": "512345******0008",
          "expiryDate": {
            "month": 1,
            "year": 39
          }
        },
        "codes": {
          "responseCode": "000",
          "responseMessage": "Success",
          "detailedResponseCode": "000",
          "detailedResponseMessage": "The operation was successful"
        },
        "authenticationDetails": {
          "acsEci": "02",
          "authenticationToken": "kHyn+7YFi1EUAREAAAAvNUe6Hv8=",
          "xid": "6ac70f42-f347-419d-b2b6-ee13b2b9bf7a",
          "acsTransactionId": "dc1d9f8c-41d8-4553-9c86-26d3d19d1ce6",
          "directoryServerId": "A999999999",
          "dsTransactionId": "6ac70f42-f347-419d-b2b6-ee13b2b9bf7a",
          "methodSupported": "SUPPORTED",
          "protocolVersion": "2.1.0",
          "requestorId": "MAS00001_INT_MPGS_MTTESTGEIDEATESTE",
          "requestorName": "Geidea Technology",
          "transactionStatus": "Y"
        },
        "correlationId": "01016686-b45a-41c3-8b36-04e2971bfde6",
        "paymentAttemptId": "e8cbc40e-21cd-4c47-8b7f-d4df44c342c7",
        "acquirer": {
          "merchantId": "001222222222"
        },
        "extensionDate": "2024-03-04T13:36:08.5778312",
        "deviceId": "f4767e8c-6806-4ac5-e345-08dbfbc233db",
        "createdDate": "2024-03-04T13:33:33.9731001",
        "createdBy": "PGW",
        "updatedDate": "2024-03-04T13:36:08.5784054",
        "updatedBy": "PGW"
      }
    ],
    "paymentMethod": {
      "type": "Card",
      "brand": "mastercard",
      "cardholderName": "otst-PUT",
      "maskedCardNumber": "512345******0008",
      "expiryDate": {
        "month": 1,
        "year": 39
      }
    },
    "totalAuthorizedAmount": 1850,
    "totalCapturedAmount": 1850,
    "orderSource": "GeideaGateway",
    "paymentBrands": [
      "mastercard"
    ],
    "multiCurrency": {
      "authCurrency": "EGP",
      "authAmount": 1850,
      "settleCurrency": "EGP",
      "settleAmount": 1850
    },
    "isTest": true,
    "deviceId": "f4767e8c-6806-4ac5-e345-08dbfbc233db",
    "gatewayDecision": "ContinueToPay",
    "bankId": "1003",
    "createdDate": "2024-03-04T13:33:33.9731001",
    "createdBy": "PGW",
    "updatedDate": "2024-03-04T13:34:03.1484588",
    "updatedBy": "PGW"
  },
  "responseMessage": "Success",
  "detailedResponseMessage": "The operation was successful",
  "language": "en",
  "responseCode": "000",
  "detailedResponseCode": "000"
}