Weavr
Powered by Redocly

Weavr Simulator (2.14.6)

Download OpenAPI specification:Download

URL: https://weavr.io

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

Accounts

accounts_deposit

This tool is used to simulate deposits into managed accounts. Provide bank details for the deposit 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
iban
required
string

The iban of the account where the funds should be deposited to.

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 deposit sender

reference
string

The reference is the transaction description

Responses
200

Success

400

Invalid Request

default

Error

post/accounts/deposit
Request samples
application/json
{
  • "iban": "string",
  • "paymentReference": "string",
  • "depositAmount": {
    },
  • "senderName": "string",
  • "reference": "string"
}
Response samples
application/json
{
  • "code": "COMPLETED"
}

accounts_account_id_deposit

This tool is used to simulate deposits into managed accounts by Account ID. Provide account id and transaction amount and the transaction will be processed through the system.

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
object

A message representing a monetary amount in a particular currency.

senderName
string
reference
string

The reference is the transaction description

Responses
200

Success

400

Invalid Request

default

Error

post/accounts/{account_id}/deposit
Request samples
application/json
{
  • "depositAmount": {
    },
  • "senderName": "string",
  • "reference": "string"
}
Response samples
application/json
{
  • "code": "COMPLETED"
}

Cards

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
cardNumber
required
string

The 16-digit card number. No spaces.

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>

If this is a cross-currency transaction, the forex fee amount in the card currency

forexPadding
integer <int64>

If this is a cross-currency transaction, the forex padding amount in the card currency

atmWithdrawal
boolean

If set to true, this purchase simulates and ATM Withdrawal transaction. MCC will automatically be set to 6011

Responses
200

Success

400

Invalid Request

default

Error

post/cards/purchase
Request samples
application/json
{
  • "cardNumber": "string",
  • "cvv": "string",
  • "expiryDate": "string",
  • "merchantName": "string",
  • "merchantId": "string",
  • "merchantCategoryCode": "stri",
  • "transactionAmount": {
    },
  • "forexFee": 0,
  • "forexPadding": 0,
  • "atmWithdrawal": true
}
Response samples
application/json
{
  • "code": "APPROVED"
}

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
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>

If this is a cross-currency transaction, the forex fee amount in the card currency

forexPadding
integer <int64>

If this is a cross-currency transaction, the forex padding amount in the card currency

atmWithdrawal
boolean

If set to true, this purchase simulates and ATM Withdrawal transaction. MCC will automatically be set to 6011

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
}
Response samples
application/json
{
  • "code": "APPROVED"
}

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
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>

If this is a cross-currency transaction, the forex fee amount in the card currency

forexPadding
integer <int64>

If this is a cross-currency transaction, the forex padding amount in the card currency

atmWithdrawal
boolean

If set to true, this purchase simulates and ATM Withdrawal transaction. MCC will automatically be set to 6011

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
}
Response samples
application/json
{
  • "code": "APPROVED"
}

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
cardNumber
required
string

The 16-digit card number. No spaces.

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>

If this is a cross-currency transaction, the forex fee amount in the card currency

forexPadding
integer <int64>

If this is a cross-currency transaction, the forex padding amount in the card currency

atmWithdrawal
boolean

If set to true, this purchase simulates and ATM Withdrawal transaction. MCC will automatically be set to 6011

Responses
200

Success

400

Invalid Request

default

Error

post/cards/merchant_refund
Request samples
application/json
{
  • "cardNumber": "string",
  • "cvv": "string",
  • "expiryDate": "string",
  • "merchantName": "string",
  • "merchantId": "string",
  • "merchantCategoryCode": "stri",
  • "transactionAmount": {
    },
  • "forexFee": 0,
  • "forexPadding": 0,
  • "atmWithdrawal": true
}
Response samples
application/json
{
  • "code": "APPROVED"
}

Consumers

consumers_consumer_id_verify

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
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "validation": {
    }
}
Corporates
corporates_corporate_id_verify
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
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "validation": {
    }
}
Wiretransfers
wiretransfers_outgoing_outgoing_wire_transfer_id_accept
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
Request samples 
Response samples 
application/json
{
  • "code": "COMPLETED"
}
wiretransfers_outgoing_outgoing_wire_transfer_id_reject
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
Request samples 
Response samples 
application/json
{
  • "code": "COMPLETED"
}
Directdebits
directdebits_mandates_create
This endpoint is used to simulate the creation of a Mandate by a merchant on behalf of its customer


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
merchantName
required
string
 
merchantAccountNumber
required
string
 
merchantSortCode
required
string
 
merchantReference
required
string
 
object (TypeId) 
 
object (AccountDetails) 
 
Responses 
200
Success


400
Invalid Request


409
Conflict


default
Error


post/directdebits/mandates/create
Request samples 
application/json
{
  • "merchantName": "string",
  • "merchantAccountNumber": "string",
  • "merchantSortCode": "string",
  • "merchantReference": "string",
  • "accountId": {
    },
  • "accountDetails": {
    }
}
Response samples 
application/json
{
  • "ddiId": "string",
  • "merchantName": "string",
  • "merchantAccountNumber": "string",
  • "merchantSortCode": "string",
  • "merchantReference": "string",
  • "accountDetails": {
    }
}
directdebits_mandates_dd_id_cancel
This endpoint is used to simulate the cancellation of a Mandate by a merchant.


SecurityAPI_Secret_Key 
Request 
path Parameters
dd_id
required
string
 
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/directdebits/mandates/{dd_id}/cancel
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "validation": {
    }
}
directdebits_mandates_dd_id_expire
This endpoint is used to simulate the expiry of a Mandate.


SecurityAPI_Secret_Key 
Request 
path Parameters
dd_id
required
string
 
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/directdebits/mandates/{dd_id}/expire
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "validation": {
    }
}
directdebits_mandates_dd_id_collections_create
This endpoint is used to simulate the creation of a Mandate by a merchant on behalf of its customer


SecurityAPI_Secret_Key 
Request 
path Parameters
dd_id
required
string
 
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
object
A message representing a monetary amount in a particular currency.


 
Responses 
200
Success


400
Invalid Request


409
Conflict


default
Error


post/directdebits/mandates/{dd_id}/collections/create
Request samples 
application/json
{
  • "amount": {
    }
}
Response samples 
application/json
{
  • "cid": "string",
  • "mandateDdiId": "string",
  • "amount": {
    },
  • "status": "NOTICE_SENT"
}
directdebits_mandates_dd_id_collections_cid_collect
This endpoint is used to simulate the collection of funds from the mandated account


SecurityAPI_Secret_Key 
Request 
path Parameters
dd_id
required
string
 
cid
required
string
 
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


409
Conflict


default
Error


post/directdebits/mandates/{dd_id}/collections/{cid}/collect
Request samples 
Response samples 
application/json
{
  • "cid": "string",
  • "mandateDdiId": "string",
  • "amount": {
    },
  • "status": "NOTICE_SENT"
}
directdebits_mandates_dd_id_collections_cid_resolve_unpaid
This endpoint is used to simulate the cancellation of a Mandate by a merchant.


SecurityAPI_Secret_Key 
Request 
path Parameters
dd_id
required
string
 
cid
required
string
 
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


409
Conflict


default
Error


post/directdebits/mandates/{dd_id}/collections/{cid}/resolve_unpaid
Request samples 
Response samples 
application/json
{
  • "cid": "string",
  • "mandateDdiId": "string",
  • "amount": {
    },
  • "status": "NOTICE_SENT"
}
Factors
factors_credentials_id_challenges_challenge_id_get
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}/get
Request samples 
Response samples 
application/json
{
  • "payload": "string"
}
factors_credentials_id_challenges_challenge_id_verify_success
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
Request samples 
Response samples 
application/json
{
  • "code": "COMPLETED"
}
factors_credentials_id_challenges_challenge_id_verify_invalid
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
Request samples 
Response samples 
application/json
{
  • "code": "COMPLETED"
}
factors_credentials_id_challenges_challenge_id_verify_expired
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
Request samples 
Response samples 
application/json
{
  • "code": "COMPLETED"
}
factors_credentials_id_challenges_latest_get
SecurityAuth_Token and API_Secret_Key 
Request 
path Parameters
credentials_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/latest/get
Request samples 
Response samples 
application/json
{
  • "payload": "string"
}
factors_credentials_id_challenges_latest_verify_success
SecurityAuth_Token and API_Secret_Key 
Request 
path Parameters
credentials_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/latest/verify_success
Request samples 
Response samples 
application/json
{
  • "code": "COMPLETED"
}
factors_credentials_id_challenges_latest_verify_invalid
SecurityAuth_Token and API_Secret_Key 
Request 
path Parameters
credentials_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/latest/verify_invalid
Request samples 
Response samples 
application/json
{
  • "code": "COMPLETED"
}
factors_credentials_id_challenges_latest_verify_expired
SecurityAuth_Token and API_Secret_Key 
Request 
path Parameters
credentials_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/latest/verify_expired
Request samples 
Response samples 
application/json
{
  • "code": "COMPLETED"
}
Authy
authy_enrol_credential_id_accept
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
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "validation": {
    }
}
authy_enrol_credential_id_reject
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
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "validation": {
    }
}
authy_owt_owt_id_accept
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
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "validation": {
    }
}
authy_owt_owt_id_reject
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
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "validation": {
    }
}
authy_step_up_session_id_accept
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
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "validation": {
    }
}
authy_step_up_session_id_reject
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
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "validation": {
    }
}
authy_live_get
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


 
Responses 
200
Success


400
Invalid Request


409
Conflict


default
Error


post/authy/live/get
Request samples 
Response samples 
application/json
{
  • "enabled": true
}
authy_live_enable
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


 
Responses 
200
Success


400
Invalid Request


409
Conflict


default
Error


post/authy/live/enable
Request samples 
Response samples 
application/json
{
  • "enabled": true
}
authy_live_disable
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


 
Responses 
200
Success


400
Invalid Request


409
Conflict


default
Error


post/authy/live/disable
Request samples 
Response samples 
application/json
{
  • "enabled": true
}