Simulate card management

in this tutorial, you'll learn how to ✅ simulate these card management actions clearing reversal incremental transaction single message clearing single message reversal if you are new to card issuing we recommend you read the card issuing overview docid\ pze4nyany9uiyfuoldqbf before starting this tutorial the tutorial assumes you have a knowledge of apis and how they work for more information on sending api calls, see the api basics docid\ hjr4y6ml96zuyj6trytom the tutorial uses these api endpoints api description post /v1/simulate/authorization simulates merchant authorization post /v1/simulate/clearing simulates replacement of a memo post with a core transaction post /v1/simulate/reversal simulates reversal of an authorization post /v1/simulate/incremental simulates an incremental transaction reflected in the deposit account activity post /v1/simulate/single message clearing simulations the message type for cardholder verification to authorize and clear a transaction post /v1/simulate/single message reversal simulates a single message clearing transaction for which you can create a reversal transaction before you begin make sure you have bank rails & accounts docid\ l9hxcroz7mfrdsih 8lrt client id register the relevant webhook events to receive the webhook events for this tutorial both partner accounts need to banking and payments docid\ dgnysfx9f7pnesmuxnwsp 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 simulate card management the simulate endpoints within card management allow you to simulate most of the transaction scenarios you would experience in a live environment to simulate authorization call post /v1/simulate/authorization this endpoint is used to simulate a merchant authorization that affects the available balance on the deposit account simulate authorization request post /cardmanagement/v1/simulate/authorization { "cardid" "00000000 0000 0000 0000 000000000000", "amount" 100, "merchantcountrycode" "us", "merchantname" "acme co", "merchantstreet" "123 main street", "merchantcity" "new york", "merchantstate" "ny", "merchantpostalcode" "10025" } 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 simulate authorization response { "retrievalreferencenumber" "string", "cardid" "00000000 0000 0000 0000 000000000000" } to simulate clearing 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 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 simulate clearing request post / cardmanagement /v1/simulate/reversal { "cardid" "00000000 0000 0000 0000 000000000000", "retrievalreferencenumber" "123", "amount" 123 } to simulate reversal this endpoint is used to reverse an existing authorization using the retrievalreferencenumber returned in the response to the authorization 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 simulate reversal request post / cardmanagement /v1/simulate/reversal { "cardid" "00000000 0000 0000 0000 000000000000", "retrievalreferencenumber" 123, "amount" 123 } to simulate a incremental transaction this endpoint, used with the retrievalreferencenumber returned by the authorization 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 simulate incremental request post / cardmanagement /v1/simulate/incremental { "cardid" "00000000 0000 0000 0000 000000000000", "retrievalreferencenumber" 123, "amount" 123 } to simulate single message clearing 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 a single message is an atm withdrawal simulate single message clearing request post /cardmanagement/v1/simulate/single message clearing { "cardid" "00000000 0000 0000 0000 000000000000", "amount" 100, "merchantcountrycode" "us", "merchantname" "acme co", "merchantstreet" "123 main street", "merchantcity" "new york", "merchantstate" "ny", "merchantpostalcode" "10025" } to simulate single message reversal this endpoint allows you to create a reversal transaction to a single message clearing transaction for example, use the single message clearing endpoint to simulate a purchase and then simulate a return with the single message reversal simulate single message reversal request post /cardmanagement/v1/simulate/single message reversal { "cardid" "00000000 0000 0000 0000 000000000000", "amount" 100, "merchantcountrycode" "us", "merchantname" "acme co", "merchantstreet" "123 main street", "merchantcity" "new york", "merchantstate" "ny", "merchantpostalcode" "10025" }