# Update batch group status

Update a batch group's status to complete or cancel it.

Complete a batch group: Set status to COMPLETED to close the group for modifications and allow funding to proceed. Once completed, payInDetails will be populated with funding instructions.

Cancel a batch group: Set status to CANCELLED to cancel all transfers in the batch. Only batches that are not funded can be cancelled. Cancellation is final and cannot be undone.

The version parameter is required for concurrency control. The operation will be rejected if the provided version does not match the server's current version.

Endpoint: PATCH /v3/profiles/{profileId}/batch-groups/{batchGroupId}
Security: UserToken, PersonalToken

## Path parameters:

  - `profileId` (integer, required)
    The ID of the profile that the batch group is associated with.
    Example: 12345678

  - `batchGroupId` (string, required)
    The batch group ID.
    Example: "54a6bc09-cef9-49a8-9041-f1f0c654cd88"

## Request fields (application/json):

  - `status` (string, required)
    Status to update to:
- COMPLETED — Close the group and allow funding
- CANCELLED — Cancel the group and all transfers
    Enum: "COMPLETED", "CANCELLED"

  - `version` (integer, required)
    The expected batch group version for concurrency control. Must match the server's current version.
    Example: 1234

## Response 200 fields (application/json):

  - `id` (string)
    Batch group ID.
    Example: "54a6bc09-cef9-49a8-9041-f1f0c654cd88"

  - `version` (integer)
    Batch version, used for concurrency control. This number is updated whenever there is a change to the batch group state (its status, the identity of the transfers in the batch, etc).

Some API operations require this version in requests, and operations may be rejected when the requested version does not match the server's version.

The version is a signed integer and is not ordered with respect to any previous version.
    Example: 123

  - `name` (string)
    Descriptive name for the batch group.
    Example: "My batch group"

  - `sourceCurrency` (string)
    Source currency code (ISO 4217 Alphabetic Code). This currency is expected to be used for funding the batch group.
    Example: "GBP"

  - `status` (string)
    Current batch group status:
- NEW — New batch group with zero or more transfers. Able to have more transfers added to it. Transfers in a NEW group cannot yet be funded and paid out.
- COMPLETED — The batch group has had all desired transfers added and is now closed to further changes. Transfers in the group can now be funded and paid out. Note: COMPLETED does not imply payouts have been successfully completed.
- MARKED_FOR_CANCELLATION — Cancellation of the transfers in the batch group was requested.
- PROCESSING_CANCEL — Transfers in the group are being cancelled.
- CANCELLED — Transfers in the group have been cancelled.
    Enum: "NEW", "COMPLETED", "MARKED_FOR_CANCELLATION", "PROCESSING_CANCEL", "CANCELLED"

  - `transferIds` (array)
    The IDs of all transfers successfully added to the group.
    Example: [234,456]

  - `payInDetails` (array)
    List of pay-in details describing how the batch group can be funded. Provided only when the batch group is in the COMPLETED state.

Currently supported types: bank_transfer.

  - `payInDetails.type` (string)
    Method of payment.
    Enum: "bank_transfer"

  - `payInDetails.reference` (string)
    The reference that should be used when funding the transfers in the batch group. This reference should be treated as an opaque value and there should be no attempt to decode or decompose it.
    Example: "B5323"

  - `payInDetails.amount` (number)
    The total pay-in amount for all transactions in the batch when paying in with this reference and method.
    Example: 12504.54

  - `payInDetails.currency` (string)
    Three-character ISO 4217 currency code.
    Example: "NOK"

  - `payInDetails.name` (string)
    Name of the bank account holder.
    Example: "TransferWise Ltd"

  - `payInDetails.branchName` (string,null)
    Name of the bank branch. Provided only when the currency route requires it (such as JPY).

  - `payInDetails.accountNumber` (string,null)
    Bank account number.
    Example: "9910728"

  - `payInDetails.accountType` (string,null)
    Bank account type. Provided only when the currency route requires it.

  - `payInDetails.bankCode` (string,null)
    Bank identifier or routing number, depending on pay-in type and currency.
    Example: "8301"

  - `payInDetails.bankAddress` (object,null)
    Address for the receiving bank. Provided only when the currency route requires it.

  - `payInDetails.bankAddress.name` (string)
    Bank name.
    Example: "CitiBank Europe Plc"

  - `payInDetails.bankAddress.firstLine` (string)
    Street address.
    Example: "Bolette brygge 1"

  - `payInDetails.bankAddress.postCode` (string)
    Postcode or ZIP code.
    Example: "0252"

  - `payInDetails.bankAddress.city` (string)
    City.
    Example: "Oslo"

  - `payInDetails.bankAddress.stateCode` (string,null)
    State, province, or region code.

  - `payInDetails.bankAddress.country` (string)
    Country name.
    Example: "Norway"

  - `payInDetails.transferWiseAddress` (object,null)
    Wise's address. Provided only when the currency route requires it.

  - `payInDetails.transferWiseAddress.name` (string)
    Wise's company name.
    Example: "TransferWise Ltd"

  - `payInDetails.iban` (string,null)
    ISO 13616 International Bank Account Number (when available).

  - `payInDetails.bban` (string,null)
    Basic Bank Account Number (BBAN). Provided only when the currency route requires it (such as NOK).
    Example: "83019910728"

  - `payInDetails.institutionNumber` (string,null)
    Financial Institution number (3 digits). Provided only when the currency route requires it (such as CAD).

  - `payInDetails.transitNumber` (string,null)
    Branch Transit Number (5 digits). Provided only when the currency route requires it (such as CAD).

  - `payInDetails.beneficiaryBankBIC` (string,null)
    Beneficiary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).

  - `payInDetails.intermediaryBankBIC` (string,null)
    Intermediary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).

  - `payInDetails.fpsIdentifier` (string,null)
    Faster Payment System identifier. Provided only when the currency route requires it (such as HKD).

  - `payInDetails.clearingNumber` (string,null)
    Clearing number. Provided only when the currency route requires it (such as SEK).