Skip to main content

Operations in bulk

End-customer businesses (i.e. CorporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities 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 Operations The 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
info

Bulk operationsBulk Operations The 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 Operations The 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 Operations The 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 Operations The 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 Operations The 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 Operations The 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 Process A 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 Operations The 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 Process A 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 Operations The 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/usersTry it 
[
  {
    "pathParams": {},
    "requestBody": {
      "name": "string",
      "surname": "string",
      "email": "[email protected]",
      "mobile": {
        "countryCode": "stri",
        "number": "string"
      },
      "dateOfBirth": {
        "year": 1900,
        "month": 1,
        "day": 1
      },
      "tag": "string"
    }
  }
]

Invite corporate authorized users in bulk​

POST/bulks/users/{user_id}/inviteTry it 
[
  {
    "pathParams": {
      "_user_id_": "string"
    }
  }
]

Block cards in bulk​

POST/bulks/managed_cards/{id}/blockTry it 
[
  {
    "pathParams": {
      "_id_": "string"
    }
  }
]

Unblock cards in bulk​

POST/bulks/managed_cards/{id}/unblockTry it 
[
  {
    "pathParams": {
      "_id_": "string"
    }
  }
]

Remove cards in bulk​

POST/bulks/managed_cards/{id}/removeTry it 
[
  {
    "pathParams": {
      "_id_": "string"
    }
  }
]

Update spend rules for a managed card in bulk​

PATCH/bulks/managed_cards/{id}/spend_rulesTry it 
[
  {
    "pathParams": {
      "_id_": "string"
    },
    "requestBody": {
      "allowedMerchantCategories": [
        "string"
      ],
      "blockedMerchantCategories": [
        "string"
      ],
      "allowedMerchantIds": [
        "string"
      ],
      "blockedMerchantIds": [
        "string"
      ],
      "allowedMerchantCountries": [
        "st"
      ],
      "blockedMerchantCountries": [
        "st"
      ],
      "allowContactless": true,
      "allowAtm": true,
      "allowECommerce": true,
      "allowCashback": true,
      "allowCreditAuthorisations": true,
      "rolloverPolicy": {
        "rolloverNegative": true
      },
      "spendLimit": [
        {
          "startTimestamp": 0,
          "value": {
            "currency": "str",
            "amount": 0
          },
          "interval": "DAILY"
        }
      ],
      "minTransactionAmount": 0,
      "maxTransactionAmount": 0,
      "updateSpendLimitMethod": "OVERWRITE"
    }
  }
]

Create SendSend A transaction type that allows sending funds to another identity'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/sendsTry it 
[
  {
    "pathParams": {},
    "requestBody": {
      "profileId": "string",
      "tag": "string",
      "source": {
        "id": "string",
        "type": "managed_cards"
      },
      "destination": {
        "id": "string",
        "type": "managed_cards"
      },
      "destinationAmount": {
        "currency": "str",
        "amount": 0
      },
      "description": "string",
      "scheduledTimestamp": "string"
    }
  }
]

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

POST/bulks/transfersTry it 
[
  {
    "pathParams": {},
    "requestBody": {
      "profileId": "string",
      "tag": "string",
      "source": {
        "id": "string",
        "type": "managed_cards"
      },
      "description": "string",
      "destination": {
        "id": "string",
        "type": "managed_cards"
      },
      "destinationAmount": {
        "currency": "str",
        "amount": 0
      },
      "scheduledTimestamp": "string"
    }
  }
]

Create outgoing wire transfers in bulk​

POST/bulks/outgoing_wire_transfersTry it 
[
  {
    "pathParams": {},
    "requestBody": {
      "profileId": "string",
      "tag": "string",
      "sourceInstrument": {
        "type": "managed_accounts",
        "id": "string"
      },
      "transferAmount": {
        "currency": "str",
        "amount": 0
      },
      "description": "string",
      "destinationBeneficiary": {
        "name": "string",
        "type": "PERSONAL",
        "address": "string",
        "bankName": "string",
        "bankAddress": "string",
        "bankCountry": "st",
        "bankAccountDetails": {
          "iban": "stringstringstr",
          "bankIdentifierCode": "stringst"
        },
        "nationality": "st",
        "dateOfBirth": "2019-08-24"
      },
      "scheduledTimestamp": "string"
    }
  }
]