Captures a Single Auth, Frequent and Frequent Auth

Request

Required scope: capture:create

Security

accountId and apiKey

Path

idstring, (uuid)required

Resource Identification

Bodyapplication/jsonrequired

Created

transaction_keystring, <= 50 characters

Your internal key identifying this capture

Example:"key example"

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.

Example:"2022-11-11"

accountobject

For multi-account clients.

splitsArray of objects(capture-split-create)

Used in split payments.

reward_redemptionobject(reward-redemption)

Apply accumulated reward credits to reduce the payment value. Supports full or partial redemption of available reward balance. Only available on the payment methods CC, MBW, AP, GP, SW, and IPP. See the Rewards & Redemptions guide for the full flow.

force_3dsboolean

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

Default:false

descriptivestring, <= 255 characters

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

Example:"descriptive example"

valuenumber, (double), >= 0.5

Value will be rounded to 2 decimals.

Example:20.55

curl -i -X POST \
  'https://api.test.easypay.pt/2.0/capture/{id}' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92' \
  -H 'Content-Type: application/json' \
  -d '{
    "transaction_key": "key example",
    "capture_date": "2022-11-11",
    "account": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "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
    },
    "force_3ds": false,
    "descriptive": "descriptive example",
    "value": 20.55
  }'

Responses

Created

Bodyapplication/json

statusstring

Example:"ok"

messageArray of strings

Example:

[
  "Your request was successfully created"
]

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:"677dbec9-ec19-4a78-9e08-3d2901c7a32b"

Response

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