Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Captures

Captures a Single Auth, Frequent and Frequent Auth

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

post/capture/{id}

Path parameters

idstring uuid required

Resource Identification

Request body

transaction_keystring

Your internal key identifying this capture

capture_datestring date

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.

force_3dsboolean

Whether or not you want to force the 3DS authentication on Credit Cards (used only on Frequent capture without authorisation).

descriptivestring

This will appear in the bank statement/MB WAY application.

valuenumber double

Value will be rounded to 2 decimals.

Example request

{
  "transaction_key": "key example",
  "capture_date": "2022-11-11",
  "splits": [
    {
      "split_key": "Payment of Invoice Nº 1982652",
      "split_descriptive": "Payment of Invoice Nº 1982652",
      "account": {
        "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb"
      },
      "value": 17.5,
      "clearing_period": "30D",
      "margin_account": {
        "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb"
      },
      "margin_value": 0.25,
      "reward": {
        "account": {
          "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb"
        },
        "value": 1,
        "expiration_date": "2027-04-02"
      }
    }
  ],
  "reward_redemption": {
    "account": {
      "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb"
    },
    "value": 2.5
  },
  "descriptive": "descriptive example",
  "value": 20.55
}

Response

Created

statusstring
messagestring[]
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.

Example response

{
  "status": "ok",
  "message": [
    "Your request was successfully created"
  ],
  "id": "677dbec9-ec19-4a78-9e08-3d2901c7a32b"
}