Weavr
Powered by Redocly

Weavr Simulator (2.17.0)

Download OpenAPI specification:Download

URL: http://weavr.io

This is a Simulator API which is only available on the Weavr Sandbox Environment

Accounts

Simulate incoming wire transfer using account id

This tool is a quick and easy way to put funds on a Managed Account (previously called ‘deposit’), that you may need for testing elsewhere. Provide account id and transaction amount and the transaction will be processed through the system. This method skips some of the steps when processing IWTs. To test this fully, please use the accounts_deposit endpoint.

SecurityAPI_Secret_Key
Request
path Parameters
account_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
required
object

A message representing a monetary amount in a particular currency.

senderName
string

The name of the person or business sending the incoming wire transfer

reference
string

The reference is the transaction description

receiverName
string

The name of the recipient of the incoming wire transfer

txId
integer <int64>

Id used for the transaction if provided, otherwise one will be generated

senderIban
string <= 50 characters ^[a-zA-Z0-9_-]+$
object (SepaBankDetails)
object (FasterPaymentsBankDetails)
object (AccountDescriptorDetails)
paymentNetwork
string

Optional field which indicates the payment network to use. If not provided, a default payment network will be chosen based on the currency.

Enum: "SEPA" "FASTER_PAYMENTS" "SWIFT" "BACS" "CHAPS"
Responses
200

Success

400

Invalid Request

default

Error

post/accounts/{account_id}/deposit
Request samples
application/json
{
  • "depositAmount": {
    },
  • "senderName": "string",
  • "reference": "string",
  • "receiverName": "string",
  • "txId": 0,
  • "senderIban": "string",
  • "sepa": {
    },
  • "fasterPayments": {
    },
  • "accountDescriptor": {
    },
  • "paymentNetwork": "SEPA"
}
Response samples
application/json
{
  • "code": "COMPLETED"
}

Simulate an incoming wire transfer using IBAN

This tool is used to simulate incoming wire transfers (IWT) into managed accounts. IWTs are processed in line with the configuration of your application. For EUR and USD IWTs provide the destinationIbanDetails of your Managed Account, for GBP IWTs provide destinationFasterPaymentDetails or destinationIbanDetails of your Managed Account. Sender Details can also be added that is used to identify whether the IWT originated from a Linked Account (if configured) or a third party.

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
iban
string
Deprecated

The iban of the account the incoming wire transfer should be processed against

paymentReference
string

The payment reference is needed to identify which account, in cases where the same iban is used

required
object

A message representing a monetary amount in a particular currency.

senderName
string

The name of the person or business sending the incoming wire transfer

reference
string

A reference provided by the sender of the incoming wire transfer.

receiverName
string

The name of the recipient of the incoming wire transfer

txId
integer <int64>

Id used for the transaction if provided, otherwise one will be generated

object (IbanDetails)
object (FasterPaymentsDetails)
object (AccountDescriptorDetails)
object (IbanDetails)
object (FasterPaymentsDetails)
paymentNetwork
string

Optional field which indicates the payment network to use. If not provided, a default payment network will be chosen based on the currency.

Enum: "SEPA" "FASTER_PAYMENTS" "SWIFT" "BACS" "CHAPS"
Responses
200

Success

400

Invalid Request

default

Error

post/accounts/deposit
Request samples
application/json
{
  • "iban": "string",
  • "paymentReference": "string",
  • "depositAmount": {
    },
  • "senderName": "string",
  • "reference": "string",
  • "receiverName": "string",
  • "txId": 0,
  • "senderIbanDetails": {
    },
  • "senderFasterPaymentsDetails": {
    },
  • "senderAccountDescriptorDetails": {
    },
  • "destinationIbanDetails": {
    },
  • "destinationFasterPaymentsDetails": {
    },
  • "paymentNetwork": "SEPA"
}
Response samples
application/json
{
  • "code": "COMPLETED"
}

Cards

Simulate card purchase using card id

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.

transactionTimestamp
integer <int64>

Epoch timestamp using millisecond precision.

Responses
200

Success

400

Invalid Request

default

Error

post/cards/{card_id}/purchase
Request samples
application/json
{
  • "merchantName": "string",
  • "merchantId": "string",
  • "merchantCategoryCode": "stri",
  • "transactionAmount": {
    },
  • "transactionCountry": "str",
  • "forexFee": 0,
  • "forexPadding": 0,
  • "atmWithdrawal": true,
  • "additionalMerchantData": {
    },
  • "cardHolderPresent": "PRESENT",
  • "cardPresent": true,
  • "initiateBiometricThreeDSecure": true,
  • "transactionTimestamp": 0
}
Response samples
application/json
{
  • "code": "APPROVED",
  • "threeDSecureChallengeId": {
    }
}

Simulate renewal of card

Renew a managed card by Card ID. Provide card id and the card will be renewed.

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
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate card about to expire

Simulate a card about to expire by Card ID. Provide card id and the card will be set to 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
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate card merchant refund using card id

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.

transactionTimestamp
integer <int64>

Epoch timestamp using millisecond precision.

Responses
200

Success

400

Invalid Request

default

Error

post/cards/{card_id}/merchant_refund
Request samples
application/json
{
  • "merchantName": "string",
  • "merchantId": "string",
  • "merchantCategoryCode": "stri",
  • "transactionAmount": {
    },
  • "transactionCountry": "str",
  • "forexFee": 0,
  • "forexPadding": 0,
  • "atmWithdrawal": true,
  • "additionalMerchantData": {
    },
  • "cardHolderPresent": "PRESENT",
  • "cardPresent": true,
  • "initiateBiometricThreeDSecure": true,
  • "transactionTimestamp": 0
}
Response samples
application/json
{
  • "code": "APPROVED",
  • "threeDSecureChallengeId": {
    }
}

Simulate expiry of card

Expire a managed card by Card ID. Provide card id and the card will be expired.

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
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate card purchase using card number

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.

transactionTimestamp
integer <int64>

Epoch timestamp using millisecond precision.

Responses
200

Success

400

Invalid Request

default

Error

post/cards/purchase
Request samples
application/json
{
  • "cardNumber": "stringstringstri",
  • "cvv": "string",
  • "expiryDate": "string",
  • "merchantName": "string",
  • "merchantId": "string",
  • "merchantCategoryCode": "stri",
  • "transactionAmount": {
    },
  • "forexFee": 0,
  • "forexPadding": 0,
  • "atmWithdrawal": true,
  • "additionalMerchantData": {
    },
  • "cardHolderPresent": "PRESENT",
  • "cardPresent": true,
  • "initiateBiometricThreeDSecure": true,
  • "transactionTimestamp": 0
}
Response samples
application/json
{
  • "code": "APPROVED",
  • "threeDSecureChallengeId": {
    }
}

Simulate card merchant refund using card number

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.

transactionTimestamp
integer <int64>

Epoch timestamp using millisecond precision.

Responses
200

Success

400

Invalid Request

default

Error

post/cards/merchant_refund
Request samples
application/json
{
  • "cardNumber": "stringstringstri",
  • "cvv": "string",
  • "expiryDate": "string",
  • "merchantName": "string",
  • "merchantId": "string",
  • "merchantCategoryCode": "stri",
  • "transactionAmount": {
    },
  • "forexFee": 0,
  • "forexPadding": 0,
  • "atmWithdrawal": true,
  • "additionalMerchantData": {
    },
  • "cardHolderPresent": "PRESENT",
  • "cardPresent": true,
  • "initiateBiometricThreeDSecure": true,
  • "transactionTimestamp": 0
}
Response samples
application/json
{
  • "code": "APPROVED",
  • "threeDSecureChallengeId": {
    }
}

Consumers

Simulate verification of a consumer identity

Fully verify a consumer identity. Will set emailVerified, mobileVerified, isPep (as false), isSanctioned (as false) and fullDueDiligence (as APPROVED).

SecurityAPI_Secret_Key
Request
path Parameters
consumer_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/consumers/{consumer_id}/verify
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Corporates

Simulate verification of corporate identity

Fully verify a corporate identity. Will set rootEmailVerified, rootMobileVerified, directorsVerified, UBOsVerified, basicCompanyChecksVerified and fullCompanyChecksVerified, while also setting dummy KYB Company Details

SecurityAPI_Secret_Key
Request
path Parameters
corporate_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/corporates/{corporate_id}/verify
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Wiretransfers

Simulate completion of an Outgoing Wire Transfer

This endpoint is used to simulate the completion of an Outgoing Wire Transfer that has been submitted in the system and sent over our payment network.

SecurityAPI_Secret_Key
Request
path Parameters
outgoing_wire_transfer_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
200

Success

400

Invalid Request

default

Error

post/wiretransfers/outgoing/{outgoing_wire_transfer_id}/accept
Response samples
application/json
{
  • "code": "COMPLETED"
}

Simulate rejection of an Outgoing Wire Transfer

This endpoint is used to simulate the rejection of an Outgoing Wire Transfer that has been submitted in the system and sent over our payment network.

SecurityAPI_Secret_Key
Request
path Parameters
outgoing_wire_transfer_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
200

Success

400

Invalid Request

default

Error

post/wiretransfers/outgoing/{outgoing_wire_transfer_id}/reject
Response samples
application/json
{
  • "code": "COMPLETED"
}

Factors

Simulate successful verification of specified challenge

SecurityAuth_Token and API_Secret_Key
Request
path Parameters
credentials_id
required
integer <int64>
challenge_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
200

Success

400

Invalid Request

default

Error

post/factors/{credentials_id}/challenges/{challenge_id}/verify_success
Response samples
application/json
{
  • "code": "COMPLETED"
}

Simulate invalid verification of specified challenge

SecurityAuth_Token and API_Secret_Key
Request
path Parameters
credentials_id
required
integer <int64>
challenge_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
200

Success

400

Invalid Request

default

Error

post/factors/{credentials_id}/challenges/{challenge_id}/verify_invalid
Response samples
application/json
{
  • "code": "COMPLETED"
}

Simulate expiry of specified challenge

SecurityAuth_Token and API_Secret_Key
Request
path Parameters
credentials_id
required
integer <int64>
challenge_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
200

Success

400

Invalid Request

default

Error

post/factors/{credentials_id}/challenges/{challenge_id}/verify_expired
Response samples
application/json
{
  • "code": "COMPLETED"
}

Linked Accounts

linked_accounts_account_id_set

Allows the verification or rejection of a linked account run by specifying the account ID. This operation updates the status of a linked account to either VERIFIED or REJECTED.

SecurityAPI_Secret_Key
Request
path Parameters
account_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
state
string (LinkedAccountRunRequestState)
Enum: "VERIFIED" "REJECTED"
Responses
204

Success - No Content

400

Invalid Request

default

Error

post/linked_accounts/{account_id}/set
Request samples
application/json
{
  • "state": "VERIFIED"
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

linked_accounts_account_id_verify

This tool is used to simulate internal verification for linked accounts by Account ID.

SecurityAPI_Secret_Key
Request
path Parameters
account_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
steps
Array of strings (VerifyRequestByAccountIdVerificationStep)
Items Enum: "INTERNAL_CHECKS" "TRANSFER_INSTRUCTION" "USER_DECLARATION_SCA_CHALLENGE" "MICRO_DEPOSIT"
result
string (VerifyRequestByAccountIdVerificationState)
Enum: "COMPLETED" "REJECTED"
Responses
204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/linked_accounts/{account_id}/verify
Request samples
application/json
{
  • "steps": [
    ],
  • "result": "COMPLETED"
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Authy

Simulate issuance of a 3DS challenge

SecurityAPI_Secret_Key
Request
path Parameters
credential_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
merchant
required
string
maskedCardNo
required
string
required
object

A message representing a monetary amount in a particular currency.

Responses
200

Success

400

Invalid Request

409

Conflict

default

Error

post/authy/three_ds/user/{credential_id}/issue
Request samples
application/json
{
  • "merchant": "string",
  • "maskedCardNo": "string",
  • "transactionAmount": {
    }
}
Response samples
application/json
{
  • "challengeId": 0,
  • "factorType": "PASSWORD"
}

Simulate acceptance of a 3DS challenge

SecurityAPI_Secret_Key
Request
path Parameters
challenge_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/authy/three_ds/challenge/{challenge_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate rejection of a 3DS challenge

SecurityAPI_Secret_Key
Request
path Parameters
challenge_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/authy/three_ds/challenge/{challenge_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate acceptance of beneficiary challenge

SecurityAPI_Secret_Key
Request
path Parameters
beneficiary_batch_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/authy/beneficiary_management/{beneficiary_batch_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate rejection of beneficiary challenge

SecurityAPI_Secret_Key
Request
path Parameters
beneficiary_batch_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/authy/beneficiary_management/{beneficiary_batch_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate acceptance of authy enrolment

SecurityAPI_Secret_Key
Request
path Parameters
credential_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/authy/enrol/{credential_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate rejection of authy enrolment

SecurityAPI_Secret_Key
Request
path Parameters
credential_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/authy/enrol/{credential_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate acceptance of OWT challenge

SecurityAPI_Secret_Key
Request
path Parameters
owt_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/authy/owt/{owt_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate rejection of OWT challenge

SecurityAPI_Secret_Key
Request
path Parameters
owt_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/authy/owt/{owt_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate acceptance of a step-up request

SecurityAPI_Secret_Key
Request
path Parameters
session_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/authy/step_up/{session_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate rejection of a step-up request

SecurityAPI_Secret_Key
Request
path Parameters
session_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/authy/step_up/{session_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate acceptance of send transaction challenge

SecurityAPI_Secret_Key
Request
path Parameters
send_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/authy/send/{send_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate rejection of send transaction challenge

SecurityAPI_Secret_Key
Request
path Parameters
send_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/authy/send/{send_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate acceptance of specified Authy challenge

SecurityAPI_Secret_Key
Request
path Parameters
challenge_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/authy/challenge/{challenge_id}/accept
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

Simulate rejection of specified Authy challenge

SecurityAPI_Secret_Key
Request
path Parameters
challenge_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/authy/challenge/{challenge_id}/reject
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}