Skip to main content

Capture Payment

POST 

https://api.cleverhub.co/api/v2/cards/capture_payment

This endpoint captures a previously authorised card payment created via the JavaScript SDK or API.

Use this only when the payment status is authorised. Once captured, the status will transition to waiting.

⚠️ Only full amount capture is supported. Partial capture is not allowed.

⚠️ Each payment can only be captured once. Attempting to capture a payment that is not in authorised state or already captured will return an error.

Request

Bodyrequired

    uuidstringrequired

    The unique ID of the authorised payment (e.g., VMMAOTFQ).

    Example: PSADT5CE

Responses

Capture successful

Schema
    uuidstring
    Example: 7PPPMXIGH
    namestring
    Example: Testing
    emailstring
    Example: test@helloclever.co
    external_idstring
    Example: wc_order_6C1hcvg4T7Pom
    statusstring

    Possible values: [pending, authorised, waiting, received, expired, return_pending, return_expired, partially_refunded, return_received, return_rejected, failed, in_dispute, dispute_lost]

    Example: waiting
    pay_code objectnullable
    3ds_urlstring
    Example: https://3ds-auth.example.com/verify
    currencystring
    Example: USD
    amountnumber
    Example: 10000
    totalnumber
    Example: 10000
    paid_amountnumber
    Example: 0
    is_refundableboolean
    Example: true
    payment_methodstring
    Example: card
    expired_atstring
    Example:
    webhook_notification object
    endpoint_urlstring
    Example: https://webhook.site/456adb8f-4407-4bce-90fe-2c431db19696
    authorization_headerstring
    Example: ****
    refund_information object
    total_amountnumber
    Example: 200
    refund_amountnumber
    Example: 50
    descriptionstring
    Example: Testing refund
    sender_details object
    card object
    card_typestring
    Example: card
    card_brandstring
    Example: visa
    card_last_4string
    Example: 4242
    created_atdate-time
    Example: 2025-05-28T04:22:21.567+0000

Authorization: app-id

name: app-idtype: apiKeydescription: The app-id is registered and secured inside Hello Clever system and only required when client has initiated or in the middle of the transaction.in: header
name: secret-keytype: apiKeydescription: The secret-key is our client's secret of the source. Required if a publishable key is used to retrieve the source.in: header
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.cleverhub.co/api/v2/cards/capture_payment");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("app-id", "<app-id>");
request.Headers.Add("secret-key", "<app-id>");
var content = new StringContent("{\n \"uuid\": \"PSADT5CE\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://api.cleverhub.co/api
Auth
Body required
{
  "uuid": "PSADT5CE"
}
ResponseClear

Click the Send API Request button above and see the response here!