Simulations

Simulate Card Authorization/Capture

Simulate a card authorization/capture request.

This endpoint aggregates the Simulate Card Authorization and Simulate Card Capture endpoints.

This endpoint is available for Card Rails (Virtual Debit Cards) only.

Refer to Merchant API Guide for more information.

post/api/v1/simulation/{paymentId}/card/auth-capture

Request

Path parameters

paymentIdstring uuid required

Payment ID

Example:123e4567-e89b-12d3-a456-426614174000

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Request body

Response

OK

successboolean required

Indicates whether the authorization/capture was successful.

errorstring nullable required

Error message if the authorization/capture was not successful.

Example response

{
  "success": true,
  "error": "Error message"
}

Changes

No recorded changes to this operation across all 1 revision of this API.