Weavr
Powered by Redocly

Simulator

Simulators enable you to trigger processes in Sandbox that in Production are triggered from an external action rather than from your application. this way you can test scenarios that otherwise you would only encounter in the Live environment.

Note: These endpoints are only available on Sandbox and won’t work in the Live environment.

Simulate Funding

Simulate funding a payment run using a linked account.

This endpoint will only function in Sandbox and should not be used in the Live environment.

SecurityapiKey
Request
path Parameters
payment_run_id
required
string^[0-9a-fA-F]{24}$
group_reference
required
string
Responses
201

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

404

Not found - The requested resource couldn't be found.

409

Conflict

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/simulate/v1/payment_runs/{payment_run_id}/fund_group/{group_reference}
Response samples
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}

Simulate Linked Account

Simulate linking an account via Open Banking to fund payments within a payment run.

This endpoint will only function in Sandbox and should not be used in the Live environment.

SecurityapiKey
Request
Request Body schema: application/json
required
institutionId
required
string
buyerId
required
string
createdBy
required
string
required
FasterPaymentsBankDetails (object) or SepaBankDetails (object)

The bank details that uniquely identify the account on the banking systems.

currency
string = 3 characters
Deprecated
Default: "GBP"

The currency expressed in ISO-4217 code.

Enum: "GBP" "EUR"
Responses
201

OK

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

409

Conflict

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/simulate/v1/linked_accounts
Request samples
application/json
{
  • "institutionId": "string",
  • "buyerId": "string",
  • "createdBy": "string",
  • "accountIdentification": {
    },
  • "currency": "GBP"
}
Response samples
application/json
{
  • "id": "652d25b73541d8084a88a38d",
  • "accountIdentification": {
    },
  • "currency": "GBP",
  • "institution": {
    },
  • "consent": {
    },
  • "status": "LINKED",
  • "createdAt": "string"
}

Simulate Buyer KYB Verify

Simulates due diligence (KYB) for Buyers.

This endpoint will only function in Sandbox and should not be used in the Live environment.

SecurityapiKey
Request
path Parameters
buyer_id
required
string
Responses
204

Success - No Content.

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

404

Not found - The requested resource couldn't be found.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/simulate/v1/buyers/{buyer_id}/verify
Response samples
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}

Simulate AIS consent status change

Simulate AIS consent status change.

This endpoint will only function in Sandbox and should not be used in the Live environment.

SecurityapiKey
Request
path Parameters
linked_account_id
required
string^[0-9a-fA-F]{24}$
Request Body schema: application/json
required
action
required
string
Enum: "REVOKED" "EXPIRED"
Responses
204

No Content

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

404

Not found - The requested resource couldn't be found.

409

Conflict

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/simulate/v1/consents/{linked_account_id}/change_status
Request samples
application/json
{
  • "action": "REVOKED"
}
Response samples
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}

Simulate issuing a Payment Run SCA Challenge

Simulates issuing the SCA challenge for a payment run.

This endpoint will only function in Sandbox and should not be used in the Live environment.

SecurityapiKey and authToken
Request
path Parameters
channel
required
string

The unique identifier for the channel.

Value: "SMS"
payment_run_id
required
string^[0-9a-fA-F]{24}$

The unique identifier for the payment run.

Responses
204

No Content

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

404

Not found - The requested resource couldn't be found.

409

Conflict

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}
Response samples
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}

Simulate verifying a payment run SCA Challenge

Simulates verifying the SCA challenge for a payment run.

This endpoint will only function in Sandbox and should not be used in the Live environment.

SecurityapiKey and authToken
Request
path Parameters
channel
required
string

The unique identifier for the channel.

Value: "SMS"
payment_run_id
required
string^[0-9a-fA-F]{24}$

The unique identifier for the payment run.

Request Body schema: application/json
required
verificationCode
required
string non-empty
Responses
204

No Content

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

404

Not found - The requested resource couldn't be found.

409

Conflict

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}/verify
Request samples
application/json
{
  • "verificationCode": "string"
}
Response samples
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
➔ Next to Buyers