Embedded Capture

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

Captures funds from a previously authorized payment (auth: Y on Direct Sale).

📘

Use this endpoint after an authorization-only transaction to complete the payment and transfer the authorized funds.

🚧

Authorization required: Capture can only be used for payments created with auth: Y. Standard sale transactions (auth: N) are already captured automatically.


Request

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

Body Parameters

ParameterRequiredDescription
transactionIdYesTransaction ID returned from the authorization request
amountYesAmount to capture
❗️

Important: The capture amount cannot exceed the original authorized amount.


Request example

{
  "transactionId": "c09fba3c-59e2-434a-9ec1-5d2e71a44a8d",
  "amount": 100
}

Transaction flow

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

    Note over Merchant,Gateway: Authorization already completed

    Merchant->>API: POST /payment/s2s/capture
    API->>Gateway: Capture authorized funds
    Gateway-->>API: Capture accepted
    API-->>Merchant: result=ACCEPTED

Responses

{
  "success": {
    "status": 200,
    "body": {
      "code": 200,
      "message": "Success",
      "errorCode": null,
      "data": {
        "result": "ACCEPTED",
        "action": "CAPTURE",
        "rrn": "609211307265",
        "order_id": "817922228",
        "trans_id": "0808779145497567115585",
        "card_brand": "MASTER",
        "decline_reason": null
      }
    }
  }
}

Response fields

FieldDescription
resultCapture result
actionAlways CAPTURE
rrnGateway reference number
trans_idGateway payment reference
card_brandCard brand used for the payment

Once captured, the authorization becomes a completed payment and can later be refunded if required.

📘

If you only need to release the authorization without charging the customer, use the Void API instead.


Body Params
string
required
number
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