Skip to main content

Sandbox simulator endpoints

· One min read

Effective:

  • 27 March 2024 on Sandbox
  • 2 April 2024 on Live

We have exposed simulator endpoints that will help you 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.

Simulator API Endpoints​

  • Link account:
    • This endpoint will allow you to simulate linking an account via open bankingOpen BankingA service that allows customers to securely share their bank account information and authorize payments directly from their bank account. In Payment Run,Open banking can be used to link accounts and fund payment runs, providing a seamless experience for buyers. to fund payments within a payment runPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution..
  • Fund payment run:
    • This endpoint will allow you to simulate a funding of a payment runPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution. using a linked accountLinked AccountAn entity in the Weavr system that represents an external bank account or payment service provider (PSP) account that a customer has verified they own and control. This feature enables users to perform transactions, such as outgoing and incoming wire transfers, between their Linked Accounts and their Managed Accounts as 'self-to-self' transfers..
  • Verify KYB:
    • This endpoint will allow you to simulate due diligence (KYBKYB (Know Your Business). Know Your Business - the identity verification process for corporate customers. This process allows you to securely verify your business customer's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers.) for your BuyersBuyerA business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator..

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

More details on simulators is available in our documentation