Clear a transaction
This endpoint can be used to test clearing a transaction on a simulated card network
- application/json
Request Body required
- oneOf
- ClearWithoutAuthorization
- ClearWithAuthorization
transactionType string requiredPossible values: [
purchase]Transaction type
transactionAmount string requiredTransaction amount as an integer in the smallest denomination of USD.
cardPan string requiredPossible values: Value must match regular expression
^[0-9]{16}$Card number
cardExpiry string requiredPossible values: Value must match regular expression
^[0-9]{6}$Card expiry in YYYYMM format
cardCvv string requiredPossible values: Value must match regular expression
^[0-9]{3}$Card CVV
fxAmount object
fxAmount can be specified to process the transaction in a currency other than USD
amount string requiredTransaction amount as an integer in the smallest denomination for the given currency. Convert the
transactionAmountfrom USD to the desired currency.currencyCode string requiredISO 4217 currency code
authorizationRequestMsg string requiredrequestMsg returned by the Authorize a transaction endpoint
authorizationResponseMsg string requiredresponseMsg returned by the Authorize a transaction endpoint
transactionType string requiredPossible values: [
purchase]Transaction type
transactionAmount string requiredTransaction amount as an integer in the smallest denomination of USD.
cardPan string requiredPossible values: Value must match regular expression
^[0-9]{16}$Card number
cardExpiry string requiredPossible values: Value must match regular expression
^[0-9]{6}$Card expiry in YYYYMM format
cardCvv string requiredPossible values: Value must match regular expression
^[0-9]{3}$Card CVV
fxAmount object
fxAmount can be specified to process the transaction in a currency other than USD
amount string requiredTransaction amount as an integer in the smallest denomination for the given currency. Convert the
transactionAmountfrom USD to the desired currency.currencyCode string requiredISO 4217 currency code
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
- requestMsg string
XML formatted ISO 8583 message sent to the simulated card scheme
- responseMsg string
XML formatted ISO 8583 message returned from the simulated card scheme
- transactionId number
ID of the transaction
{
"requestMsg": "string",
"responseMsg": "string",
"transactionId": 0
}
Request fields are invalid
- application/json
- Schema
- Example (from schema)
Schema
- statusCode integer required
- statusName string required
- errorCode string required
- errors string[]
{
"statusCode": 400,
"statusName": "Bad Request",
"errorCode": "BAD_REQUEST",
"errors": [
"Expected string, received number"
]
}
No Authorization to access resource.
- application/json
- Schema
- Example (from schema)
Schema
- statusCode integer required
- statusName string required
- errorCode string required
- reason string
{
"statusCode": 403,
"statusName": "Forbidden",
"errorCode": "FORBIDDEN",
"reason": "Unauthorized"
}