Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wise batch-group API

A batch group is a named collection of up to 1000 transfers that can be managed as a single unit. Batch groups are primarily used for funding multiple transfers with a single payment.**Workflow:**1. Create a batch group with a source currency2. Add transfers to the group (up to 1000)3. Complete the batch group to close it for modifications4. Fund the batch group from a balance or via direct debitIndividual transfers in the group follow standard transfer lifecycle and can be tracked separately.

Wise batch-group API is one of 47 APIs that Wise publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include batch-group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 7 operations across 6 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0.

Requests are made against 2 base URLs: https://api.wise.com, https://api.wise-sandbox.com.

7 operations 6 paths 3 schemas 2 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
Base URL
https://api.wise.com/v2
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 4

Wise batch-group API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (UserToken). It accepts HTTP bearer tokens (JWT) (PersonalToken). It accepts HTTP bearer tokens (JWT) (ClientCredentialsToken). It accepts HTTP basic authentication (BasicAuth).

  • UserToken — User Access Token for making API calls on behalf of a Wise user. Can be obtained via two OAuth 2.0 flows: - registrationcode grant: For partners creating users…
  • PersonalToken — Personal API Token for individual personal or small business users. Generated from Wise.com Settings Connect and manage apps API tokens. Has limited API access…
  • ClientCredentialsToken — Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls. Obtained via POST /…
  • BasicAuth — Basic Authentication using your Client ID and Client Secret as the username and password. Client credentials are provided by Wise when your partnership begins.…

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

batch-group 7

A batch group is a named collection of up to 1000 transfers that can be managed as a single unit. Batch groups are primarily used for funding multiple transfers with a single paym…

POST
/v3/profiles/{profileId}/batch-groups
Create a batch group
batchGroupCreate 2 params body → 201429
GET
/v3/profiles/{profileId}/batch-groups/{batchGroupId}
Retrieve a batch group
batchGroupGet 3 params → 200429
PATCH
/v3/profiles/{profileId}/batch-groups/{batchGroupId}
Update batch group status
batchGroupUpdate 3 params body → 200429
POST
/v3/profiles/{profileId}/batch-groups/{batchGroupId}/transfers
Create a batch group transfer
batchGroupTransferCreate 3 params body → 200429
POST
/v3/profiles/{profileId}/batch-payments/{batchGroupId}/payments
Fund a batch group
batchGroupFund 3 params body → 200429
POST
/v1/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations
Fund a batch group via direct debit
batchGroupPaymentInitiationCreate 3 params body → 200429
GET
/v1/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations/{paymentInitiationId}
Retrieve a payment initiation
batchGroupPaymentInitiationGet 4 params → 200429

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are PayInDetails (19 properties), PaymentInitiation (10 properties), BatchGroup (7 properties). Each schema is shown below with its type and property counts.

BatchGroup
object
7 properties
PaymentInitiation
object
Payment initiation for funding a batch group via direct debit.
10 properties
PayInDetails
object
Pay-in details describe how the batch group can be funded. Only populated when a batch group is in the COMPLETED state.
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wise-batch-group-api-openapi.yml Raw ↑

Other APIs Wise publishes across the network.

Wise 3ds API
Wise activity API
Wise address API
Wise balance API
Wise balance-statement API
Wise bank-account-details API
Wise bulk-settlement API
Wise card API
Wise card-kiosk-collection API
Wise card-order API
Wise card-sensitive-details API
Wise card-transaction API