Cards

cards_card_id_merchant_refund

Simulate card merchant refunds by Card ID. Provide card id and transaction amount and the transaction will be processed through the system.

SecurityAPI_Secret_Key

Request

path Parameters

card_id

required

integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required

merchantName required	string [ 1 .. 50 ] characters The merchant name
merchantId	string [ 1 .. 15 ] characters The merchant id (MID). If not specified, a random value will be used
merchantCategoryCode	string [ 1 .. 4 ] characters The merchant category code (MCC). If unspecified or an invalid MCC is specified, the Merchant Code 5399 (Misc. General Merchandise) will be used instead
required	object A message representing a monetary amount in a particular currency.
transactionCountry	string = 3 characters ^[A-Z]*$ The transaction country in ISO 3166 - alpha-3 format
forexFee	integer <int64> Deprecated If this is a cross-currency transaction, the forex fee amount in the card currency. Deprecated; the forex fee percentage configured at the card profile will be applied if this field is not provided
forexPadding	integer <int64> Deprecated If this is a cross-currency transaction, the forex padding amount in the card currency. Deprecated; a 2% forex padding will be applied if this field is not provided
atmWithdrawal	boolean If set to true, this purchase simulates and ATM Withdrawal transaction. MCC will automatically be set to 6011
	object Additional merchant data
cardHolderPresent	string Optional detail indicating if the card holder was present when the authorisation occurred. Enum: "PRESENT" "NOT_PRESENT" "PRESENCE_UNKNOWN"
cardPresent	boolean Optional detail indicating if the card was present when the authorisation occurred.
initiateBiometricThreeDSecure	boolean If the card is enrolled for Biometric Authentication, a 3DS Flow is initiated before the Purchase can resume.

Responses

200

Success

400

Invalid Request

default

Error

post/cards/{card_id}/merchant_refund

Request samples

Payload

application/json

{"merchantName": "string",
"merchantId": "string",
"merchantCategoryCode": "stri",
"transactionAmount": {"currency": "str",
"amount": 0
},
"transactionCountry": "str",
"forexFee": 0,
"forexPadding": 0,
"atmWithdrawal": true,
"additionalMerchantData": {"merchantStreet": "string",
"merchantCity": "string",
"merchantState": "string",
"merchantPostalCode": "string",
"merchantCountry": "str",
"merchantTelephone": "string",
"merchantURL": "string",
"merchantNameOther": "string",
"merchantNetworkId": "string",
"merchantContact": "string"
},
"cardHolderPresent": "PRESENT",
"cardPresent": true,
"initiateBiometricThreeDSecure": true
}

Response samples

200
400
default

application/json

{"code": "APPROVED",
"threeDSecureChallengeId": {"value": 0,
"hasValue": true
}
}

cards_card_id_renew

SecurityAPI_Secret_Key

Request

path Parameters

card_id

required

integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/cards/{card_id}/renew

Response samples

400
409
default

application/json

{"message": "string",
"validation": {"invalid": true,
"fields": [{"name": "string",
"errors": [{"type": "REQUIRED",
"params": ["string"
]
}
]
}
]
}
}

cards_card_id_expire

SecurityAPI_Secret_Key

Request

path Parameters

card_id

required

integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/cards/{card_id}/expire

Response samples

400
409
default

application/json

{"message": "string",
"validation": {"invalid": true,
"fields": [{"name": "string",
"errors": [{"type": "REQUIRED",
"params": ["string"
]
}
]
}
]
}
}

cards_card_id_about_to_expire

SecurityAPI_Secret_Key

Request

path Parameters

card_id

required

integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

204

Success - No Content

400

Invalid Request

default

Error

post/cards/{card_id}/about_to_expire

Response samples

400
default

application/json

{"message": "string",
"validation": {"invalid": true,
"fields": [{"name": "string",
"errors": [{"type": "REQUIRED",
"params": ["string"
]
}
]
}
]
}
}

cards_card_id_purchase

Simulate card purchases by Card ID. Provide card id and transaction amount and the transaction will be processed through the system.

SecurityAPI_Secret_Key

Request

path Parameters

card_id

required

integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required

merchantName required	string [ 1 .. 50 ] characters The merchant name
merchantId	string [ 1 .. 15 ] characters The merchant id (MID). If not specified, a random value will be used
merchantCategoryCode	string [ 1 .. 4 ] characters The merchant category code (MCC). If unspecified or an invalid MCC is specified, the Merchant Code 5399 (Misc. General Merchandise) will be used instead
required	object A message representing a monetary amount in a particular currency.
transactionCountry	string = 3 characters ^[A-Z]*$ The transaction country in ISO 3166 - alpha-3 format
forexFee	integer <int64> Deprecated If this is a cross-currency transaction, the forex fee amount in the card currency. Deprecated; the forex fee percentage configured at the card profile will be applied if this field is not provided
forexPadding	integer <int64> Deprecated If this is a cross-currency transaction, the forex padding amount in the card currency. Deprecated; a 2% forex padding will be applied if this field is not provided
atmWithdrawal	boolean If set to true, this purchase simulates and ATM Withdrawal transaction. MCC will automatically be set to 6011
	object Additional merchant data
cardHolderPresent	string Optional detail indicating if the card holder was present when the authorisation occurred. Enum: "PRESENT" "NOT_PRESENT" "PRESENCE_UNKNOWN"
cardPresent	boolean Optional detail indicating if the card was present when the authorisation occurred.
initiateBiometricThreeDSecure	boolean If the card is enrolled for Biometric Authentication, a 3DS Flow is initiated before the Purchase can resume.

Responses

200

Success

400

Invalid Request

default

Error

post/cards/{card_id}/purchase

Request samples

Payload

application/json

{"merchantName": "string",
"merchantId": "string",
"merchantCategoryCode": "stri",
"transactionAmount": {"currency": "str",
"amount": 0
},
"transactionCountry": "str",
"forexFee": 0,
"forexPadding": 0,
"atmWithdrawal": true,
"additionalMerchantData": {"merchantStreet": "string",
"merchantCity": "string",
"merchantState": "string",
"merchantPostalCode": "string",
"merchantCountry": "str",
"merchantTelephone": "string",
"merchantURL": "string",
"merchantNameOther": "string",
"merchantNetworkId": "string",
"merchantContact": "string"
},
"cardHolderPresent": "PRESENT",
"cardPresent": true,
"initiateBiometricThreeDSecure": true
}

Response samples

200
400
default

application/json

{"code": "APPROVED",
"threeDSecureChallengeId": {"value": 0,
"hasValue": true
}
}

cards_merchant_refund

Simulate card merchant refunds. Provide card details and transaction amount and the transaction will be processed through the system.

SecurityAPI_Secret_Key

Request

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required

cardNumber required	string [ 16 .. 50 ] characters ^[0-9 ]*$ The 16-digit card number.
cvv required	string The 3-digit cvv
expiryDate required	string The expiry date in format MMYY
merchantName required	string [ 1 .. 50 ] characters The merchant name
merchantId	string [ 1 .. 15 ] characters The merchant id (MID). If not specified, a random value will be used
merchantCategoryCode	string [ 1 .. 4 ] characters The merchant category code (MCC). If unspecified or an invalid MCC is specified, the Merchant Code 5399 (Misc. General Merchandise) will be used instead
required	object A message representing a monetary amount in a particular currency.
forexFee	integer <int64> Deprecated If this is a cross-currency transaction, the forex fee amount in the card currency. Deprecated; the forex fee percentage configured at the card profile will be applied if this field is not provided
forexPadding	integer <int64> Deprecated If this is a cross-currency transaction, the forex padding amount in the card currency. Deprecated; a 2% forex padding will be applied if this field is not provided. Deprecated; a 2% forex padding will be applied if this field is not provided
atmWithdrawal	boolean If set to true, this purchase simulates and ATM Withdrawal transaction. MCC will automatically be set to 6011
	object Additional merchant data
cardHolderPresent	string Optional detail indicating if the card holder was present when the authorisation occurred. Enum: "PRESENT" "NOT_PRESENT" "PRESENCE_UNKNOWN"
cardPresent	boolean Optional detail indicating if the card was present when the authorisation occurred.
initiateBiometricThreeDSecure	boolean If the card is enrolled for Biometric Authentication, a 3DS Flow is initiated before the Purchase can resume.

Responses

200

Success

400

Invalid Request

default

Error

post/cards/merchant_refund

Request samples

Payload

application/json

{"cardNumber": "stringstringstri",
"cvv": "string",
"expiryDate": "string",
"merchantName": "string",
"merchantId": "string",
"merchantCategoryCode": "stri",
"transactionAmount": {"currency": "str",
"amount": 0
},
"forexFee": 0,
"forexPadding": 0,
"atmWithdrawal": true,
"additionalMerchantData": {"merchantStreet": "string",
"merchantCity": "string",
"merchantState": "string",
"merchantPostalCode": "string",
"merchantCountry": "str",
"merchantTelephone": "string",
"merchantURL": "string",
"merchantNameOther": "string",
"merchantNetworkId": "string",
"merchantContact": "string"
},
"cardHolderPresent": "PRESENT",
"cardPresent": true,
"initiateBiometricThreeDSecure": true
}

Response samples

200
400
default

application/json

{"code": "APPROVED",
"threeDSecureChallengeId": {"value": 0,
"hasValue": true
}
}

cards_purchase

Simulate card purchases. Provide card details and transaction amount and the transaction will be processed through the system.

SecurityAPI_Secret_Key

Request

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required

cardNumber required	string [ 16 .. 50 ] characters ^[0-9 ]*$ The 16-digit card number.
cvv required	string The 3-digit cvv
expiryDate required	string The expiry date in format MMYY
merchantName required	string [ 1 .. 50 ] characters The merchant name
merchantId	string [ 1 .. 15 ] characters The merchant id (MID). If not specified, a random value will be used
merchantCategoryCode	string [ 1 .. 4 ] characters The merchant category code (MCC). If unspecified or an invalid MCC is specified, the Merchant Code 5399 (Misc. General Merchandise) will be used instead
required	object A message representing a monetary amount in a particular currency.
forexFee	integer <int64> Deprecated If this is a cross-currency transaction, the forex fee amount in the card currency. Deprecated; the forex fee percentage configured at the card profile will be applied if this field is not provided
forexPadding	integer <int64> Deprecated If this is a cross-currency transaction, the forex padding amount in the card currency. Deprecated; a 2% forex padding will be applied if this field is not provided. Deprecated; a 2% forex padding will be applied if this field is not provided
atmWithdrawal	boolean If set to true, this purchase simulates and ATM Withdrawal transaction. MCC will automatically be set to 6011
	object Additional merchant data
cardHolderPresent	string Optional detail indicating if the card holder was present when the authorisation occurred. Enum: "PRESENT" "NOT_PRESENT" "PRESENCE_UNKNOWN"
cardPresent	boolean Optional detail indicating if the card was present when the authorisation occurred.
initiateBiometricThreeDSecure	boolean If the card is enrolled for Biometric Authentication, a 3DS Flow is initiated before the Purchase can resume.

Responses

200

Success

400

Invalid Request

default

Error

post/cards/purchase

Request samples

Payload

application/json

{"cardNumber": "stringstringstri",
"cvv": "string",
"expiryDate": "string",
"merchantName": "string",
"merchantId": "string",
"merchantCategoryCode": "stri",
"transactionAmount": {"currency": "str",
"amount": 0
},
"forexFee": 0,
"forexPadding": 0,
"atmWithdrawal": true,
"additionalMerchantData": {"merchantStreet": "string",
"merchantCity": "string",
"merchantState": "string",
"merchantPostalCode": "string",
"merchantCountry": "str",
"merchantTelephone": "string",
"merchantURL": "string",
"merchantNameOther": "string",
"merchantNetworkId": "string",
"merchantContact": "string"
},
"cardHolderPresent": "PRESENT",
"cardPresent": true,
"initiateBiometricThreeDSecure": true
}

Response samples

200
400
default

application/json

{"code": "APPROVED",
"threeDSecureChallengeId": {"value": 0,
"hasValue": true
}
}

➔ Next to Consumers

Cards

cards_card_id_merchant_refund

path Parameters

header Parameters

Request Body schema: application/jsonrequired

cards_card_id_renew

path Parameters

header Parameters

cards_card_id_expire

path Parameters

header Parameters

cards_card_id_about_to_expire

path Parameters

header Parameters

cards_card_id_purchase

path Parameters

header Parameters

Request Body schema: application/jsonrequired

cards_merchant_refund

header Parameters

Request Body schema: application/jsonrequired

cards_purchase

header Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required