Simulate authorization #
Simulate an authorization request with a card you issued previously.
Authorizations: #
bearer
| authorizationrequired | string |
| Authorizationrequired | string |
Request Body schema: application/json
card required object (SimulateCardDto)
| idrequired | string = 30 characters ^crd_[a-z0-9]{26}$The card’s unique identifier. |
| expiry_monthrequired | number [ 1 .. 12 ] The card’s expiration month. |
| expiry_yearrequired | number = 4 characters The card’s expiration year. |
transaction required object (SimulateTransactionDto)
| typerequired | string Value:”purchase”The transaction type. |
| amount | number >= 0 The payment amount, in minor currency units. |
| currency | string = 3 characters The currency to use for the transaction. |
merchant required object (The merchant related data.
| category_coderequired | string = 4 characters The merchant category code (MCC). |
| authorization_type | string Default: “authorization” Enum:”authorization””pre_authorization”The authorization type. |
Responses #
201 Authorization processed successfully
Response Schema: application/json #
| statusrequired | string Enum:”Authorized””Declined” |
| idrequired | stringThe transaction’s unique identifier. |
401 Unauthorized
422 Invalid data was sent
500 Internal Server Error
Simulate incrementing an authorization #
Simulate an incremental authorization request for an existing approved transaction.
Authorizations:
bearer
path Parameters #
| authorizationrequired | string |
| Authorizationrequired | string |
Request Body schema: application/json #
| amountrequired | number >= 0 The amount to increment, in minor currency units. |
Responses #
201 Authorization processed successfully
Response Schema: application/json #
| status required | string Enum: “Authorized” “Declined” |
401 Unauthorized
422 Invalid data was sent
500 Internal Server Error
Simulate clearing #
Simulate the clearing of an existing approved authorization.
Authorization
bearer
HTTP: bearer #
HTTP Authorization Scheme: bearer
Bearer format: JWT
path Parameters #
| authorizationrequired | string |
| Authorizationrequired | string |
Request Body schema: application/json #
| amountrequired | number >= 0 The amount to clear, in minor currency units. |
Responses #
202 Presentment accepted
202 Presentment accepted
401 Unauthorized
404 Authorization not found
422 Invalid data was sent
500 Internal Server Error
Simulate refund #
Simulate the refund of an existing approved authorization, after it has been cleared.
Authorizations
bearer
HTTP: bearer #
HTTP Authorization Scheme: bearer
Bearer format: JWT
path Parameters #
| authorizationrequired | string |
| Authorizationrequired | string |
Request Body schema: application/json #
| amountrequired | number >= 0 The amount to refund, in minor currency units. |
Responses #
202 Presentment accepted
401 Unauthorized
404 Authorization not found
422 Invalid data was sent
500 Internal Server Error
Simulate reversal #
Simulate the reversal of an existing approved authorization.
Authorizations
bearer
HTTP: bearer #
HTTP Authorization Scheme: bearer
Bearer format: JWT
path Parameters #
| authorizationrequired | string |
| Authorizationrequired | string |
Request Body schema: application/json #
| amountrequired | number >= 0 The amount to reverse, in minor currency units. |
Responses #
202 Presentment accepted
401 Unauthorized
404 Authorization not found
422 Invalid data was sent
500 Internal Server Error