Acquire a token granting you access to perform sensitive operations on behalf of an identity.
/
Pause bulk process
Weavr Multi Product BackOffice API (v3)
Weavr Multi Back Office API allows you, as an innovator, to perform various back office operations concerning identities and their instruments, without requiring the users to be logged in.
A token is to be obtained through the access_token method, and this will allow relevant operations to be performed on behalf of this same identity.
Download OpenAPI description
Overview
URL
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/multi-backoffice/openapi
Weavr Sandbox Environment
https://sandbox.weavr.io/multi/backoffice
Managed Accounts are a type of financial instrument offered by Weavr. They hold funds for their owner, and can be upgraded to IBANs so as to receive and send funds to instruments outside of the Weavr Platform, via Wire Transfers. These accounts can also be used as sources and destinations in the transfer transaction.
With the access_token representing the identity and the consent of the identity, you will be able to operations on the identity's managed accounts, such as getting a managed account's details and retrieving its statement.
Operations
Managed Cards are a type of financial instrument offered by Weavr. Cards created in prepaid mode have their own balance, whereas those created in debit mode tap into the balance of their parent Managed Accounts. Apart from being used at merchants for puchases, prepaid mode cards can also be used as sources and destinations in the transfer transaction.
With the access_token representing the identity and the consent of the identity, you will be able to perform operations on the identity's Managed Cards, such as getting a Managed Card's details and managing its spend rules.
Operations
Request
Launches execution of operations of any bulk process identified by the bulk_id parameter.
The status of the bulk process has to be in a ‘SUBMITTED’ state and after execution initiates, the bulk process state is set to ‘RUNNING’.
The final state of execution can be any of
COMPLETED: the execution of the bulk process is complete and all bulk operations of the bulk process were executed successfully
FAILED: none of the operations of the bulk process have executed.
PARTIALLY_COMPLETED: the execution of the bulk process is complete and some of the bulk operations of the bulk process failed.
This operation is asynchronous and will return immediately. You can track the status of the execution of the bulk process through Get bulk process. You can also pause execution through bulkIdPause
Security
auth_token and api_key
ON_FAILURE_STOP : the execution of the bulk process stops after the first bulk operation that fails (operation returns a 4xx or 5xx response code). ON_FAILURE_CONTINUE: the execution of the bulk process resumes as normal even when any of the bulk operations fail.
Enum"ON_FAILURE_STOP""ON_FAILURE_CONTINUE"
The count of operations after which a Bulk Process Progress will be sent. For example, if set to 10, a webhook will be sent after every 10th operation is attempted. The minimum value fo count is 25% of all operations. If a value below this is entered, a webhook will only be sent for each 25% of operations attempted (i.e. 4 webhooks per Bulk Process).
- Mock serverhttps://api.weavr.io/_mock/products/multi-backoffice/openapi/bulks/{bulk_id}/execute
- Weavr Sandbox Environmenthttps://sandbox.weavr.io/multi/backoffice/bulks/{bulk_id}/execute
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.weavr.io/_mock/products/multi-backoffice/openapi/bulks/{bulk_id}/execute' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'api-key: YOUR_API_KEY_HERE' \
-d '{
"mode": "ON_FAILURE_STOP",
"webhookInterval": 0
}'Response
No content- Mock serverhttps://api.weavr.io/_mock/products/multi-backoffice/openapi/bulks/{bulk_id}/pause
- Weavr Sandbox Environmenthttps://sandbox.weavr.io/multi/backoffice/bulks/{bulk_id}/pause
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.weavr.io/_mock/products/multi-backoffice/openapi/bulks/{bulk_id}/pause' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'api-key: YOUR_API_KEY_HERE'Response
No content- Mock serverhttps://api.weavr.io/_mock/products/multi-backoffice/openapi/bulks/{bulk_id}/resume
- Weavr Sandbox Environmenthttps://sandbox.weavr.io/multi/backoffice/bulks/{bulk_id}/resume
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.weavr.io/_mock/products/multi-backoffice/openapi/bulks/{bulk_id}/resume' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'api-key: YOUR_API_KEY_HERE'Response
No content