Simulate card management

✅ How to simulate these card management actions:

The tutorial uses these API endpoints:

Make sure you have:

To receive the webhook events for this tutorial both partner accounts need to register each specific webhook event type. Once you are registered, the event objects are sent to the registered URLs.

The event object contains a list of resource identifiers used to download details on each event.

The simulate endpoints within Card Management allow you to simulate most of the transaction scenarios you would experience in a live environment.

Call POST /v1/simulate/authorization. This endpoint simulates a merchant authorization that affects the available balance on the deposit account.

The response includes the retrievalReferenceNumber and the cardId. You need these values to replace the memo post with a core transaction to post the activity record to the account, using the endpoint POST /v1/simulate/clearing as explained below.

In a real transaction, when the authorization request is made, a memo post reflects the account and impacts the available balance. However, the memo post remains until the clearing endpoint is called. Calling the POST /v1/simulate/clearing endpoint replaces the memo post with a core transaction to post the activity record to the account. In this simulation, authorization is not complete and the transaction does not post on the account until the simulate/clearing endpoint is called using the retrievalReferenceNumber and cardId.

This endpoint is used to reverse an existing authorization using the retrievalReferenceNumber returned in the response to the POST /v1/simulate/reversal endpoint. This reverses the original authorization placed on the account and removes it from the deposit account activity. The amount in this request can be any value and does not have to be the same amount as the original clearing transaction, which allows for a partial amount reversal.

This endpoint, used with the retrievalReferenceNumber returned by the POST /v1/simulate/incremental endpoint, creates an incremental transaction reflected in the deposit account activity. An example of an incremental transaction is when a hotel adds an additional charge for an item charged to your room.

A single message is a message type that uses real-time verification and requires the cardholder to enter their PIN to authorize and clear their transaction. An example of a transaction that uses the POST /v1/simulate/single-message-clearing enpoint is an ATM withdrawal.

This endpoint allows you to create a reversal transaction to a single message clearing transaction. For example, use the POST /v1/simulate/single-message-reversal endpoint to simulate a purchase and then simulate a return with the single-message-reversal.