Skip to content
/
Get all bulk processes

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
openapi.json
openapi.yaml
Overview
URL
https://weavr.io
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/multi-backoffice/openapi
Weavr Sandbox Environment
https://sandbox.weavr.io/multi/backoffice

Access Token

Acquire a token granting you access to perform sensitive operations on behalf of an identity.

Operations

User Impersonation

Operations

Corporates

Operations

Consumers

Operations

Authorised Users

Corporate and Consumer identities can invite authorised users to access their account. Once on-boarded, authorised users can create and manage instruments and transactions on behalf of the identity they are on-boarded with.
With the access_token representing the identity and the consent of the identity, you will be able to create and invite authorised users for the Identity.

Creating and inviting users on behalf of identities are restricted features; by default these endpoints are not available for use.

Operations

Managed Accounts

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

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

Transfers

Operations

Fees

Operations

Operations

Operations

Manage

Operations

Get all bulk processes

Request

Filter bulk processes.

Security
auth_token and api_key
Query
offsetinteger(int32)>= 0

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limitinteger(int32)[ 1 .. 100 ]

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

statusstring(BulkProcessStatus)
Enum"SUBMITTED""RUNNING""PARTIALLY_COMPLETED""COMPLETED""FAILED""PAUSED""CANCELLED"
curl -i -X GET \
  'https://api.weavr.io/_mock/products/multi-backoffice/openapi/bulks?offset=0&limit=1&status=SUBMITTED' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
countinteger(int32)

Total number of records (excluding limit)

bulkProcessesArray of objects(BulkProcess)
responseCountinteger(int32)

Total number of records returned in this response

Response
application/json
{
  "count": 0,
  "bulkProcesses": [
    { … }
  ],
  "responseCount": 0
}

Get bulk process

Request

Retrieves details on the bulk process identified by the bulk_id parameter.

Security
auth_token and api_key
Path
bulk_idstring(BulkId)^[0-9]+$required

The bulk id of the bulk process.

curl -i -X GET \
  'https://api.weavr.io/_mock/products/multi-backoffice/openapi/bulks/{bulk_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
bulkIdstring

The bulk id of the bulk process

statusstring

"SUBMITTED": the data for the bulk process operations has been persisted and bulk process is ready for execution. A bulk process in this status can be executed or submitted. This is the initial state for a bulk process

"RUNNING" : the bulk process is currently being executed by the system

"COMPLETED" : the execution of the bulk process is complete and all bulk operations of the bulk process were executed successfully. This is a final state for the bulk process

"PARTIALLY_COMPLETED" the execution of the bulk process is complete and some of the bulk operations of the bulk process failed. This is a final state for the bulk process

"FAILED" : none of the operations of the bulk process have executed. This is a final state for the bulk process

"PAUSED" : the execution of bulk process has been paused through the Pause bulk process operation Execution can be resumed through Resume bulk operation

"CANCELLED" : the execution of bulk process has been cancelled through Cancel bulk operation. This is a final state for the bulk process

submittedItemsCountinteger

The number of bulk operations in the bulk process

executionStartinteger(int64)

Timestamp of when the execution of the Bulk Process started

executionFinishinteger(int64)

Timestamp of when the execution of the Bulk Process finished.

operationstring

The underlying operations contained within the Bulk; shown as the endpoint for the equivalent single operation.

modestring(BulkProcessMode)

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"
operationStatusCountsArray of objects(BulkProcessOperationStatusCounts)
Response
application/json
{
  "bulkId": "string",
  "status": "string",
  "submittedItemsCount": 0,
  "executionStart": 0,
  "executionFinish": 0,
  "operation": "string",
  "mode": "ON_FAILURE_STOP",
  "operationStatusCounts": [
    { … }
  ]
}

Get all operations in a bulk

Request

Retrieves the bulk process operations that match the query parameters.

Security
auth_token and api_key
Path
bulk_idstring(BulkId)^[0-9]+$required

The bulk id of the bulk process.

Query
offsetinteger(int32)>= 0

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limitinteger(int32)[ 1 .. 100 ]

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

sequenceinteger(int64)
statusstring(BulkProcessOperationStatus)
Enum"SUBMITTED""RUNNING""COMPLETED""FAILED""CANCELLED"
curl -i -X GET \
  'https://api.weavr.io/_mock/products/multi-backoffice/openapi/bulks/{bulk_id}/operations?offset=0&limit=1&sequence=0&status=SUBMITTED' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
countinteger(int32)

Total number of records (excluding limit)

operationsArray of objects(BulkProcessOperation)
responseCountinteger(int32)

Total number of records returned in this response

Response
application/json
{
  "count": 0,
  "operations": [
    { … }
  ],
  "responseCount": 0
}