Skip to main content

Operations in bulk

End-customer businesses (i.e. CorporatesCorporates (Corporate Identity). Business entities that can be onboarded as customers on Weavr. Corporate customers represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees.) often have to perform actions in bulk or batches-for example, when an employer onboards their employees into a new employee benefits program. Although your app can call a Weavr API endpoint as many times as necessary, our inbuilt support for bulk operationsBulk OperationsThe capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application. is often more convenient.

A list of payees with amounts and a Bulk Pay action button
Available on request

Bulk operationsBulk OperationsThe capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application. is available to try out, on request (via support ticket or your account manager).

Using bulk operationsBulk OperationsThe capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application. gives you a few advantages:

  • Increase throughput: there are API rate limits that control the number of times, and how frequently, your app can call the Weavr API endpoints. With the bulk operationsBulk OperationsThe capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application. facility, your app can execute hundreds or thousands of operations by making only one or two API calls.
  • Accomplish actions in a secure session: the bulk operationsBulk OperationsThe capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application. take place under a single secure session rather than a string of separate calls, avoiding the chance of interruption.
  • Reduce complexity in your app: instead of tracking many independent calls, performing operations in bulk provides a new layer to track the overall execution state and success of bulk operationsBulk OperationsThe capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application..

Definitions

Bulk operationsBulk OperationsThe capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application. refers to the capability of grouping multiple individual API-based actions into a batch. The available operations section lists the operations that can be bulk executed.

Bulk processBulk ProcessA task created when initiating a group of bulk operations. The Bulk Process has a consistent lifecycle (statuses) and management method, regardless of the type of operation being performed. It can be in states such as SUBMITTED, RUNNING, PAUSED, CANCELLED, or completed states.: initiation of a group of bulk operationsBulk OperationsThe capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application. creates a Bulk ProcessBulk ProcessA task created when initiating a group of bulk operations. The Bulk Process has a consistent lifecycle (statuses) and management method, regardless of the type of operation being performed. It can be in states such as SUBMITTED, RUNNING, PAUSED, CANCELLED, or completed states., a task with a consistent lifecycle (statuses) and management method, regardless of the type of operation being performed.

Available operations

The Weavr API currently supports the following bulk operationsBulk OperationsThe capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application..

Create corporate authorized users in bulk

POST/bulks/usersOpen API reference
/bulks/users
[  {    "requestBody": {      "name": "Alex",      "surname": "Smith",      "email": "[email protected]",      "mobile": {        "countryCode": "+44",        "number": "7700900123"      },      "dateOfBirth": {        "year": 1990,        "month": 1,        "day": 1      },      "tag": "customer-123",      "countryOfResidence": "string",      "locale": "en-GB",      "brand": "Acme",      "roles": [        "CARD_ASSIGNEE"      ]    }  }]

Invite corporate authorized users in bulk

POST/bulks/users/{user_id}/inviteOpen API reference
/bulks/users/{user_id}/invite
[  {    "pathParams": {      "_user_id_": "987654321"    }  }]

Block cards in bulk

POST/bulks/managed_cards/{id}/blockOpen API reference
/bulks/managed_cards/{id}/block
[  {    "pathParams": {      "_id_": "234567890"    }  }]

Unblock cards in bulk

POST/bulks/managed_cards/{id}/unblockOpen API reference
/bulks/managed_cards/{id}/unblock
[  {    "pathParams": {      "_id_": "234567890"    }  }]

Remove cards in bulk

POST/bulks/managed_cards/{id}/removeOpen API reference
/bulks/managed_cards/{id}/remove
[  {    "pathParams": {      "_id_": "234567890"    }  }]

Update spend rules for a managed card in bulk

PATCH/bulks/managed_cards/{id}/spend_rulesOpen API reference
/bulks/managed_cards/{id}/spend_rules
[  {    "pathParams": {      "_id_": "234567890"    },    "requestBody": {      "allowedMerchantCategories": [        "string"      ],      "blockedMerchantCategories": [        "string"      ],      "allowedMerchantIds": [        "string"      ],      "blockedMerchantIds": [        "string"      ],      "allowedMerchantCountries": [        "string"      ],      "blockedMerchantCountries": [        "string"      ],      "allowContactless": true,      "allowAtm": true,      "allowECommerce": true,      "allowCashback": true,      "allowCreditAuthorisations": true,      "rolloverPolicy": {        "rolloverNegative": false      },      "spendLimit": [        {          "startTimestamp": 1767225600000,          "value": {            "currency": "GBP",            "amount": 1250          },          "interval": "DAILY"        }      ],      "minTransactionAmount": 100,      "maxTransactionAmount": 50000,      "updateSpendLimitMethod": "OVERWRITE"    }  }]

Create SendSendA transaction type that allows sending funds to another customer's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. transactions in bulk

POST/bulks/sendsOpen API reference
/bulks/sends
[  {    "requestBody": {      "profileId": "10001",      "tag": "customer-123",      "source": {        "id": "123456789",        "type": "managed_accounts"      },      "destination": {        "id": "123456789",        "type": "managed_accounts"      },      "destinationAmount": {        "currency": "GBP",        "amount": 1250      },      "description": "Invoice 1042",      "scheduledTimestamp": "1786118400000"    }  }]

Create TransferTransferA transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same customer. Transfers can be scheduled for future execution and can be performed in bulk operations. transactions in bulk

POST/bulks/transfersOpen API reference
/bulks/transfers
[  {    "requestBody": {      "description": "Invoice 1042",      "destination": {        "type": "example",        "id": "123456789"      },      "destinationAmount": {        "currency": "GBP",        "amount": 1250      },      "profileId": "10001",      "source": {        "type": "example",        "id": "123456789"      },      "tag": "customer-123",      "scheduledTimestamp": "1786118400000"    }  }]

Create outgoing wire transfers in bulk

POST/bulks/outgoing_wire_transfersOpen API reference
/bulks/outgoing_wire_transfers
[  {    "requestBody": {      "profileId": "10001",      "tag": "customer-123",      "sourceInstrument": {        "type": "managed_accounts",        "id": "123456789"      },      "transferAmount": {        "currency": "GBP",        "amount": 1250      },      "purpose": "Invoice payment",      "description": "Invoice 1042",      "destinationBeneficiary": {        "name": "Alex Smith",        "type": "PERSONAL",        "address": "1 High Street, London W1A 1AA",        "bankName": "National Westminster Bank PLC",        "bankAddress": "250 Bishopsgate, London EC2M 4AA",        "bankCountry": "GB",        "bankAccountDetails": {          "iban": "GB29NWBK60161331926819",          "bankIdentifierCode": "NWBKGB2L"        },        "nationality": "GB",        "dateOfBirth": "1990-01-01"      },      "scheduledTimestamp": "1786118400000"    }  }]