v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB

Captures

Shows capture details

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">capture:read</code>

get/capture/{id}

Path parameters

idstring uuid required

Resource Identification

Response

transaction_keystring

A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.

capture_datestring

The date when the action should be executed. This field specifies the exact day for capturing the transaction, formatted as "YYYY-MM-DD" (e.g., "2024-06-30"). It is optional and defaults to the current date if not specified.

descriptivestring

A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as "Payment of Invoice Nº 1982652" or "Ticket for Queen".

valuenumber double

The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., "100.00"). The value must be greater than or equal to 0.5.

Indicates the current status of the capture. Possible values include:

delayed: The capture attempt is scheduled for a future date and does not require further user interaction due to prior consent (e.g., authorization or frequent).
waiting: The payment instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized.
pending: The capture is pending user completion.
success: The capture has been completed successfully.
failed: The capture could not be completed due to an error or issue.
refunded: The capture has been refunded.

This field provides a clear indication of the current state of the capture, helping users understand its progress and outcome.

idstring uuid

A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.

payment_type'single' | 'frequent' | 'subscription'

Specifies the type of payment processed. Possible values include:

Single: A one-time payment transaction.
Frequent: A payment that occurs regularly but is not part of a subscription (e.g., recurring manual payments).
Subscription: A recurring payment that is part of a subscription plan, automatically processed at regular intervals. This field helps to categorize and manage different payment methods based on their frequency and nature.

payment_idstring uuid

force_3dsboolean

A boolean field indicating whether to enforce 3D Secure (3DS) authentication for the transaction. If set to true, 3DS authentication will be required, adding an additional layer of security by verifying the cardholder's identity during the transaction process. If set to false, 3DS authentication will not be enforced. This field helps enhance security and reduce fraud in online payments.

Example response

{
  "capture_date": "2025-07-10",
  "account": {
    "id": "c0151524-79e6-437a-a549-2ddd7c95e245"
  },
  "value": 38.98,
  "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
  "refunds": [
    {
      "id": "c0151524-79e6-437a-a549-2ddd7c95e245",
      "transaction_key": "example key"
    }
  ],
  "splits": [
    {
      "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
      "split_key": "Example Key",
      "split_descriptive": "Descriptive Example",
      "value": 10.89,
      "margin_value": 10,
      "reward": {
        "account": {
          "id": "c0151524-79e6-437a-a549-2ddd7c95e245"
        },
        "value": 1,
        "expiration_date": "2027-04-02"
      }
    }
  ],
  "reward_redemption": {
    "account": {
      "id": "c0151524-79e6-437a-a549-2ddd7c95e245"
    },
    "value": 2.5
  }
}