Skip to content

Weavr Simulator (v2)

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

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
http://weavr.io
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/simulator/openapi
https://sandbox.weavr.io/simulate/api"

Accounts

Operations

Cards

Operations

Simulate expiry of card

Request

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

Security
API_Secret_Key
Path
card_idinteger(int64)required
Headers
call-refstring

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

curl -i -X POST \
  'https://api.weavr.io/_mock/products/simulator/openapi/cards/{card_id}/expire' \
  -H 'call-ref: string' \
  -H 'programme-key: YOUR_API_KEY_HERE'

Responses

Success - No Content

Response
No content

Simulate card about to expire

Request

Simulate a card about to expire by Card ID. Provide card id and the card will be set to about to expire.

Security
API_Secret_Key
Path
card_idinteger(int64)required
Headers
call-refstring

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

curl -i -X POST \
  'https://api.weavr.io/_mock/products/simulator/openapi/cards/{card_id}/about_to_expire' \
  -H 'call-ref: string' \
  -H 'programme-key: YOUR_API_KEY_HERE'

Responses

Success - No Content

Response
No content

Simulate card purchase using card id

Request

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

Security
API_Secret_Key
Path
card_idinteger(int64)required
Headers
call-refstring

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

Bodyapplication/jsonrequired
merchantNamestring[ 1 .. 50 ] charactersrequired

The merchant name

merchantIdstring[ 1 .. 15 ] characters

The merchant id (MID). If not specified, a random value will be used

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

transactionAmountobjectrequired

A message representing a monetary amount in a particular currency.

transactionAmount.​currencystring= 3 characters^[A-Z]*$required

The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

transactionAmount.​amountinteger(int64)

The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

transactionCountrystring= 3 characters^[A-Z]*$

The transaction country in ISO 3166 - alpha-3 format

atmWithdrawalboolean

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

additionalMerchantDataobject

Additional merchant data

cardHolderPresentstring

Optional detail indicating if the card holder was present when the authorisation occurred.

Enum"PRESENT""NOT_PRESENT""PRESENCE_UNKNOWN"
cardPresentboolean

Optional detail indicating if the card was present when the authorisation occurred.

initiateBiometricThreeDSecureboolean

If the card is enrolled for Biometric Authentication, a 3DS Flow is initiated before the Purchase can resume.

transactionTimestampinteger(int64)

Epoch timestamp using millisecond precision.

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

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

curl -i -X POST \
  'https://api.weavr.io/_mock/products/simulator/openapi/cards/{card_id}/purchase' \
  -H 'Content-Type: application/json' \
  -H 'call-ref: string' \
  -H 'programme-key: YOUR_API_KEY_HERE' \
  -d '{
    "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,
    "transactionTimestamp": 0
  }'

Responses

Success

Bodyapplication/json
codestring(PurchaseResponsePurchaseResponseCode)
Enum"APPROVED""DENIED_NOT_ENOUGH_FUNDS""DENIED_CARD_NOT_FOUND""DENIED_INCORRECT_CVV""DENIED_CARD_EXPIRY""DENIED_AMOUNT_NOT_POSITIVE""DENIED_CARD_INACTIVE""DENIED_OTHER""DENIED_SPEND_CONTROL""PENDING_BIOMETRIC_THREEDS_VERIFICATION"
threeDSecureChallengeIdobject(NullableInt64)
Response
application/json
{
  "code": "APPROVED",
  "threeDSecureChallengeId": {
    "value": 0,
    "hasValue": true
  }
}

Simulate renewal of card

Request

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

Security
API_Secret_Key
Path
card_idinteger(int64)required
Headers
call-refstring

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

curl -i -X POST \
  'https://api.weavr.io/_mock/products/simulator/openapi/cards/{card_id}/renew' \
  -H 'call-ref: string' \
  -H 'programme-key: YOUR_API_KEY_HERE'

Responses

Success - No Content

Response
No content

Simulate card merchant refund using card id

Request

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

Security
API_Secret_Key
Path
card_idinteger(int64)required
Headers
call-refstring

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

Bodyapplication/jsonrequired
merchantNamestring[ 1 .. 50 ] charactersrequired

The merchant name

merchantIdstring[ 1 .. 15 ] characters

The merchant id (MID). If not specified, a random value will be used

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

transactionAmountobjectrequired

A message representing a monetary amount in a particular currency.

transactionAmount.​currencystring= 3 characters^[A-Z]*$required

The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

transactionAmount.​amountinteger(int64)

The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

transactionCountrystring= 3 characters^[A-Z]*$

The transaction country in ISO 3166 - alpha-3 format

atmWithdrawalboolean

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

additionalMerchantDataobject

Additional merchant data

cardHolderPresentstring

Optional detail indicating if the card holder was present when the authorisation occurred.

Enum"PRESENT""NOT_PRESENT""PRESENCE_UNKNOWN"
cardPresentboolean

Optional detail indicating if the card was present when the authorisation occurred.

initiateBiometricThreeDSecureboolean

If the card is enrolled for Biometric Authentication, a 3DS Flow is initiated before the Purchase can resume.

transactionTimestampinteger(int64)

Epoch timestamp using millisecond precision.

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

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

curl -i -X POST \
  'https://api.weavr.io/_mock/products/simulator/openapi/cards/{card_id}/merchant_refund' \
  -H 'Content-Type: application/json' \
  -H 'call-ref: string' \
  -H 'programme-key: YOUR_API_KEY_HERE' \
  -d '{
    "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,
    "transactionTimestamp": 0
  }'

Responses

Success

Bodyapplication/json
codestring(PurchaseResponsePurchaseResponseCode)
Enum"APPROVED""DENIED_NOT_ENOUGH_FUNDS""DENIED_CARD_NOT_FOUND""DENIED_INCORRECT_CVV""DENIED_CARD_EXPIRY""DENIED_AMOUNT_NOT_POSITIVE""DENIED_CARD_INACTIVE""DENIED_OTHER""DENIED_SPEND_CONTROL""PENDING_BIOMETRIC_THREEDS_VERIFICATION"
threeDSecureChallengeIdobject(NullableInt64)
Response
application/json
{
  "code": "APPROVED",
  "threeDSecureChallengeId": {
    "value": 0,
    "hasValue": true
  }
}

Simulate card purchase using card number

Request

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

Security
API_Secret_Key
Headers
call-refstring

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

Bodyapplication/jsonrequired
cardNumberstring[ 16 .. 50 ] characters^[0-9 ]*$required

The 16-digit card number.

cvvstringrequired

The 3-digit cvv

expiryDatestringrequired

The expiry date in format MMYY

merchantNamestring[ 1 .. 50 ] charactersrequired

The merchant name

merchantIdstring[ 1 .. 15 ] characters

The merchant id (MID). If not specified, a random value will be used

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

transactionAmountobjectrequired

A message representing a monetary amount in a particular currency.

transactionAmount.​currencystring= 3 characters^[A-Z]*$required

The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

transactionAmount.​amountinteger(int64)

The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

atmWithdrawalboolean

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

additionalMerchantDataobject

Additional merchant data

cardHolderPresentstring

Optional detail indicating if the card holder was present when the authorisation occurred.

Enum"PRESENT""NOT_PRESENT""PRESENCE_UNKNOWN"
cardPresentboolean

Optional detail indicating if the card was present when the authorisation occurred.

initiateBiometricThreeDSecureboolean

If the card is enrolled for Biometric Authentication, a 3DS Flow is initiated before the Purchase can resume.

transactionTimestampinteger(int64)

Epoch timestamp using millisecond precision.

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

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

curl -i -X POST \
  https://api.weavr.io/_mock/products/simulator/openapi/cards/purchase \
  -H 'Content-Type: application/json' \
  -H 'call-ref: string' \
  -H 'programme-key: YOUR_API_KEY_HERE' \
  -d '{
    "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,
    "transactionTimestamp": 0
  }'

Responses

Success

Bodyapplication/json
codestring(PurchaseResponsePurchaseResponseCode)
Enum"APPROVED""DENIED_NOT_ENOUGH_FUNDS""DENIED_CARD_NOT_FOUND""DENIED_INCORRECT_CVV""DENIED_CARD_EXPIRY""DENIED_AMOUNT_NOT_POSITIVE""DENIED_CARD_INACTIVE""DENIED_OTHER""DENIED_SPEND_CONTROL""PENDING_BIOMETRIC_THREEDS_VERIFICATION"
threeDSecureChallengeIdobject(NullableInt64)
Response
application/json
{
  "code": "APPROVED",
  "threeDSecureChallengeId": {
    "value": 0,
    "hasValue": true
  }
}

Simulate card merchant refund using card number

Request

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

Security
API_Secret_Key
Headers
call-refstring

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

Bodyapplication/jsonrequired
cardNumberstring[ 16 .. 50 ] characters^[0-9 ]*$required

The 16-digit card number.

cvvstringrequired

The 3-digit cvv

expiryDatestringrequired

The expiry date in format MMYY

merchantNamestring[ 1 .. 50 ] charactersrequired

The merchant name

merchantIdstring[ 1 .. 15 ] characters

The merchant id (MID). If not specified, a random value will be used

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

transactionAmountobjectrequired

A message representing a monetary amount in a particular currency.

transactionAmount.​currencystring= 3 characters^[A-Z]*$required

The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

transactionAmount.​amountinteger(int64)

The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

atmWithdrawalboolean

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

additionalMerchantDataobject

Additional merchant data

cardHolderPresentstring

Optional detail indicating if the card holder was present when the authorisation occurred.

Enum"PRESENT""NOT_PRESENT""PRESENCE_UNKNOWN"
cardPresentboolean

Optional detail indicating if the card was present when the authorisation occurred.

initiateBiometricThreeDSecureboolean

If the card is enrolled for Biometric Authentication, a 3DS Flow is initiated before the Purchase can resume.

transactionTimestampinteger(int64)

Epoch timestamp using millisecond precision.

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

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

curl -i -X POST \
  https://api.weavr.io/_mock/products/simulator/openapi/cards/merchant_refund \
  -H 'Content-Type: application/json' \
  -H 'call-ref: string' \
  -H 'programme-key: YOUR_API_KEY_HERE' \
  -d '{
    "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,
    "transactionTimestamp": 0
  }'

Responses

Success

Bodyapplication/json
codestring(PurchaseResponsePurchaseResponseCode)
Enum"APPROVED""DENIED_NOT_ENOUGH_FUNDS""DENIED_CARD_NOT_FOUND""DENIED_INCORRECT_CVV""DENIED_CARD_EXPIRY""DENIED_AMOUNT_NOT_POSITIVE""DENIED_CARD_INACTIVE""DENIED_OTHER""DENIED_SPEND_CONTROL""PENDING_BIOMETRIC_THREEDS_VERIFICATION"
threeDSecureChallengeIdobject(NullableInt64)
Response
application/json
{
  "code": "APPROVED",
  "threeDSecureChallengeId": {
    "value": 0,
    "hasValue": true
  }
}

Consumers

Operations

Corporates

Operations

Wiretransfers

Operations

Factors

Operations

Linked Accounts

Operations