Simulate transactions using a card on the sandbox environment.
Simulate transactions using a card on the sandbox environment.
Simulate an authorization request with a card you issued previously.
The card to simulate an authorization with.
The transaction to simulate with the specified card. For example, a purchase.
The transaction type.
The payment amount, in minor currency units.
To perform a card verification, set amount to 0, or omit the field entirely.
The currency to use for the transaction, as a three-letter ISO currency code. If this currency differs from the cardholder's billing currency, the billing amount will be adjusted according to the applicable conversion rate. If no currency is provided, the transaction will default to the cardholder's billing currency.
The merchant related data to use for the transaction.
Use authorization for a known final amount or pre_authorization for an estimated amount.
Unauthorized
Internal Server Error
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/simulate/authorizations' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"card": {
"id": "crd_fa6psq242dcd6fdn5gifcq1491",
"expiry_month": 5,
"expiry_year": 2025
},
"transaction": {
"type": "purchase",
"amount": 2500,
"currency": "GBP",
"merchant": {
"category_code": "7399"
}
}
}'
{
"id": "trx_aaqc4uaaybigcaaqc4uaayfiga",
"status": "Authorized"
}Simulate an incremental authorization request for an existing approved transaction.
Incremental authorizations increase the total authorized amount of the transaction. For example, adding a restaurant bill to an existing hotel booking.
Pattern: ^trx_[a-z0-9]{26}$The transaction's unique identifier.
You must provide the amount in the transaction currency's minor currency units.
Unauthorized
Authorization not found
Internal Server Error
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/simulate/authorizations/trx_aayhhfwbdyxwcaeyhhfwbd4xga/authorizations' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"amount": 3500
}'
{
"status": "Authorized"
}Simulate the clearing of an existing approved authorization.
Pattern: ^trx_[a-z0-9]{26}$The transaction's unique identifier.
The amount to clear. If not specified, the full authorized amount will be cleared.
You must provide the amount in the transaction currency's minor currency units.
Presentment accepted
Unauthorized
Authorization not found
Internal Server Error
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/simulate/authorizations/trx_aayhhfwbdyxwcaeyhhfwbd4xga/presentments' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"amount": 2500
}'
Simulate the refund of an existing approved authorization, after it has been cleared.
Pattern: ^trx_[a-z0-9]{26}$The transaction's unique identifier.
The amount to refund. If not specified, the full cleared amount will be refunded.
You must provide the amount in the transaction currency's minor currency units .
Refund accepted
Unauthorized
Presentment not found
Internal Server Error
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/simulate/authorizations/trx_aayhhfwbdyxwcaeyhhfwbd4xga/refunds' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"amount": 2500
}'
Simulate the reversal of an existing approved authorization.
Pattern: ^trx_[a-z0-9]{26}$The transaction's unique identifier.
The amount to reverse. If unspecified, the full transaction amount will be reversed.
You must provide the amount in the transaction currency's minor currency units.
Unauthorized
Authorization not found
Internal Server Error
curl 'https://{prefix}.api.sandbox.checkout.com/issuing/simulate/authorizations/trx_aayhhfwbdyxwcaeyhhfwbd4xga/reversals' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"amount": 2500
}'
{
"status": "Reversed"
}