Card order simulations

Use the Simulation APIs to simulate card order actions.

Notes

freeze funds:

  • freeze funds refers to when a cardholder gives permission for a merchant or service provider to take a certain amount from their account. During this time, the bank temporarily holds this amount to make sure there are enough funds to complete the transaction. This hold is usually temporary until the transaction is either completed or canceled.

release funds:

  • release funds refers to the completion of a transaction, confirming and releasing the previously frozen funds. If there were no frozen funds, the transaction amount will be settled directly. Please note that the released amount may differ from the initially frozen amount.

Reversal of funds:

  • Reversal refers to the cancellation of a previous settlement or authorization. This cancellation can be for the entire amount or just a portion of it. It is equivalent to reversing the previously frozen or released funds. This can happen for various reasons, such as a transaction error or the return of goods.

Actions

freeze funds simulation

  • To simulate freezing funds, call /v1/card/simulate-authorization.
  • This returns an authorization_id which can be used in simulating release funds or reversals and this authorization_id is related to a card order sended to your system.

Reversal simulation

  • To simulate reversals, call /v1/card/simulate-reversal.
  • Either original_authorization_id or original_transaction_id should be filled in the request this will change the reversal_amount of the related card order.

release funds simulation

  • To simulate releasing funds, call /v1/card/simulate-transaction.
  • You can simulate a release funds with or without an authorization_id
  • if without an authorization_id this will create a new card order.
  • if with an authorization_id this will change the settle_amount of the related card order.

Incremental freeze funds

  • To simulate an incremental freeze funds, fill the original_authorization_id field with the initial authorization ID.
  • this will change the order_amount of the related card order.

Partial reversal

  • To perform a partial reversal on a freeze funds, fill the original_authorization_id field with the initial authorization ID. Also, set partial=1 and specify the partial amount in the amount.
  • this will change the reversal_amount of the related card order.

Appendix

Valid type codes:

  • PURCHASE
  • REFUND
  • WITHDRAW
  • CHARGEBACK

Valid partnerTransactionType codes:

  • LOAD
  • WITHDRAW