Embedded Status Poll

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns the current status of an Embedded (S2S) transaction using the DigetPay internal transaction ID.

📘

Use this endpoint to verify the latest payment status after a Direct Sale request, especially when the transaction is pending or requires 3-D Secure authentication.

🚧

Hosted Checkout merchants: This endpoint is only for Embedded (S2S) integrations. Hosted Checkout integrations must use GET /payment/checkout/status.


Request

MethodPOST
URL{baseUrl}/payment/s2s/status/{transactionId}
AuthHeader x-api-key (required)

Path Parameters

ParameterRequiredDescription
transactionIdYesDigetPay internal transaction ID returned by the Direct Sale API
❗️

Critical: Use the Embedded transaction ID returned from the Direct Sale response. Do not use the Hosted Checkout gateway transaction ID.


Request example

{
  "headers": {
    "x-api-key": "YOUR_API_KEY"
  },
  "path": {
    "transactionId": "c09fba3c-59e2-434a-9ec1-5d2e71a44a8d"
  }
}

Transaction flow

sequenceDiagram
    autonumber
    participant Merchant as Your Server
    participant API as DigetPay API
    participant Gateway as Payment Gateway

    Note over Merchant: Use after Direct Sale returns PENDING or 3DS

    Merchant->>API: POST /payment/s2s/status/{transactionId}
    API->>Gateway: Retrieve latest transaction status
    Gateway-->>API: APPROVED / DECLINED / PENDING
    API-->>Merchant: status, result, paymentId

Responses

{
  "success": {
    "status": 200,
    "body": {
      "code": 200,
      "message": "Success",
      "errorCode": null,
      "data": {
        "status": "APPROVED",
        "result": "SUCCESS",
        "paymentId": "c09fba3c-59e2-434a-9ec1-5d2e71a44a8d"
      }
    }
  }
}

Response fields

FieldDescription
statusCurrent gateway status (APPROVED, DECLINED, PENDING)
resultOverall transaction result (SUCCESS or FAILED)
paymentIdDigetPay payment reference

Payment confirmed: Consider the transaction successful only when status is APPROVED and result is SUCCESS.

📘

For transactions requiring 3-D Secure, continue polling this endpoint or wait for the webhook notification before fulfilling the order.

🚧

Different ID types: Embedded Integration uses the internal transactionId, while Hosted Checkout uses the gateway transaction ID with GET /payment/checkout/status.


Path Params
uuid
required
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json