Overview

The API is a RESTful API. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can test the API in the Sandbox environment, which does not affect your live data or interact with any banking networks. The environment that you use (Sandbox or Live) determines whether our platform treats the request as a test request or a live request. The API endpoints and API keys for the two environments are different.

When you register with the Weavr, you get an account in the Sandbox environment where you can configure your programme. We will give you access to the Live environment after we review your business (KYB) and your integration.

API environment URLs are as follows.

Environments

Environment	Endpoint
Sandbox	http://portal.weavr.io/register/?plugin=payment-run
Live	on request

Simulator operations

Our Sandbox environment includes a simulator that allows you to trigger simulated external events which would be actions done by your application users such as funding a payment run, or by business processes with Weavr such as confirming a KYB process is complete.

Handling errors​

When you invoke the Weavr API, you may encounter errors, which may be caused by the request or by the server. Our API returns errors according to the standard HTTP status code scheme. For example, you may receive the following codes:

• 4XX: Client error
  • 400: Bad request
  • 401: Unauthorised
  • 403: Not authenticated
  • 409: Conflict, together with an error code that identifies the issue
  • 429: Too many requests
• 5XX: Server error
  • 500: Internal server error
  • 503: Service unavailable