Skip to content

Shows capture details

Request

Required scope: capture:read

Security
accountId and apiKey
Path
idstring, (uuid)required

Resource Identification

curl -i -X GET \
  'https://api.test.easypay.pt/2.0/capture/{id}' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

OK

Bodyapplication/json
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.

Example:"2025-07-10"
accountobject

An object within the capture request that specifies the details of the account to which the funds should be routed, different from the initially requested account. This ensures that the captured funds are directed to the correct destination as per the specific routing requirements.

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.

Example:38.98
statusany

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.

Enum:"delayed""waiting""success""pending""failed""refunded"
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:"c6056234-a3f9-42de-b944-3ed793fcb6bb"
payment_typeany

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.
Enum:"single""frequent""subscription"
payment_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.

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.

refundsArray of objects

The refunds issued against this capture. Each Refund object contains information about a processed refund. For payment methods that do not support direct refunds, additional fields are present to facilitate a fallback to a bank transfer.

splitsArray of objects
reward_redemptionobject

Reward credits redeemed in this capture. Present only when the capture redeemed reward credits. See the Rewards & Redemptions guide for the full flow.

errorobject

Represents the reason why an operation failed. It includes a human-readable message describing the issue, which can help diagnose and resolve the failure.

Response
{ "transaction_key": "string", "capture_date": "2025-07-10", "account": { "id": "c0151524-79e6-437a-a549-2ddd7c95e245" }, "descriptive": "string", "value": 38.98, "status": "delayed", "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb", "payment_type": "single", "payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71", "force_3ds": true, "refunds": [ { … } ], "splits": [ { … } ], "reward_redemption": { "account": { … }, "value": 2.5 }, "error": { "message": "string" } }