Checkout.com API logo

Card testing

Simulate transactions using a card on the sandbox environment.

Simulate authorization

Simulate an authorization request with a card you issued previously.

SecurityOAuth2: OAuth
Request
Request Body schema: application/json
required
object (IssuingSimulateCard)

The card to simulate an authorization with.

object (IssuingSimulateTransaction)

The transaction to simulate with the specified card. For example, a purchase.

Responses
201

Authorization processed successfully

401

Unauthorized

422

Invalid data was sent

500

Internal Server Error

post/issuing/simulate/authorizations
Request samples
application/json
{
  • "card": {
    },
  • "transaction": {
    }
}
Response samples
application/json
{
  • "id": "trx_aaqc4uaaybigcaaqc4uaayfiga",
  • "status": "Authorized"
}

Simulate incrementing an authorization

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.

SecurityOAuth2: OAuth
Request
path Parameters
id
required
string (IssuingTransactionId) = 30 characters ^trx_[a-z0-9]{26}$

The transaction's unique identifier.

Example: trx_aayhhfwbdyxwcaeyhhfwbd4xga
Request Body schema: application/json
required
amount
integer >= 0

You must provide the amount in the transaction currency's minor currency units.

Responses
201

Authorization processed successfully

401

Unauthorized

404

Authorization not found

422

Invalid data was sent

500

Internal Server Error

post/issuing/simulate/authorizations/{id}/authorizations
Request samples
application/json
{
  • "amount": 3500
}
Response samples
application/json
{
  • "status": "Authorized"
}

Simulate clearing

Simulate the clearing of an existing approved authorization.

SecurityOAuth2: OAuth
Request
path Parameters
id
required
string (IssuingTransactionId) = 30 characters ^trx_[a-z0-9]{26}$

The transaction's unique identifier.

Example: trx_aayhhfwbdyxwcaeyhhfwbd4xga
Request Body schema: application/json
required
amount
integer >= 0

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.

Responses
202

Presentment accepted

401

Unauthorized

404

Authorization not found

422

Invalid data was sent

500

Internal Server Error

post/issuing/simulate/authorizations/{id}/presentments
Request samples
application/json
{
  • "amount": 2500
}
Response samples
application/json
{
  • "request_id": "0HLHPN8802NUF:00000003",
  • "error_type": "request_invalid",
  • "error_codes": [
    ]
}

Simulate refund

Simulate the refund of an existing approved authorization, after it has been cleared.

SecurityOAuth2: OAuth
Request
path Parameters
id
required
string (IssuingTransactionId) = 30 characters ^trx_[a-z0-9]{26}$

The transaction's unique identifier.

Example: trx_aayhhfwbdyxwcaeyhhfwbd4xga
Request Body schema: application/json
required
amount
integer >= 0

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 .

Responses
202

Refund accepted

401

Unauthorized

404

Presentment not found

422

Invalid data was sent

500

Internal Server Error

post/issuing/simulate/authorizations/{id}/refunds
Request samples
application/json
{
  • "amount": 2500
}
Response samples
application/json
{
  • "request_id": "0HLHPN8802NUF:00000003",
  • "error_type": "request_invalid",
  • "error_codes": [
    ]
}

Simulate reversal

Simulate the reversal of an existing approved authorization.

SecurityOAuth2: OAuth
Request
path Parameters
id
required
string (IssuingTransactionId) = 30 characters ^trx_[a-z0-9]{26}$

The transaction's unique identifier.

Example: trx_aayhhfwbdyxwcaeyhhfwbd4xga
Request Body schema: application/json
required
amount
integer >= 0

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.

Responses
201

Reversal processed successfully

401

Unauthorized

404

Authorization not found

422

Invalid data was sent

500

Internal Server Error

post/issuing/simulate/authorizations/{id}/reversals
Request samples
application/json
{
  • "amount": 2500
}
Response samples
application/json
{
  • "status": "Reversed"
}
➔ Next to Applicants