BatchGroup

A batch group of transfers: create, get or update one, add a transfer, or fund it from a balance.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

batch_group, err := client.BatchGroup(nil).Load(map[string]any{"id": "example_id", "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(batch_group)
created, err := client.BatchGroup(nil).Create(map[string]any{"profile_id": 1, "name": "example", "sourceCurrency": "example", "type": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)
updated, err := client.BatchGroup(nil).Update(map[string]any{"id": "example_id", "profile_id": 1, "status": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(updated)

Lua

Construct client as shown in the Lua setup, then call the operations:

local batch_group, err = client:BatchGroup():load({ id = "example_id", profile_id = 1 })
local created, err = client:BatchGroup():create({ profile_id = 1, name = "example", sourceCurrency = "example", type = "example" })
local updated, err = client:BatchGroup():update({ id = "example_id", profile_id = 1, status = "example" })

PHP

Construct client as shown in the PHP setup, then call the operations:

$batch_group = $client->BatchGroup()->load(["id" => "example_id", "profile_id" => 1]);
$created = $client->BatchGroup()->create(["profile_id" => 1, "name" => "example", "sourceCurrency" => "example", "type" => "example"]);
$updated = $client->BatchGroup()->update(["id" => "example_id", "profile_id" => 1, "status" => "example"]);

Python

Construct client as shown in the Python setup, then call the operations:

batch_group = client.BatchGroup().load({"id": "example_id", "profile_id": 1})
created = client.BatchGroup().create({ "profile_id": 1, "name": "example", "sourceCurrency": "example", "type": "example" })
updated = client.BatchGroup().update({"id": "example_id", "profile_id": 1, "status": "example"})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

batch_group = client.BatchGroup.load({ "id" => "example_id", "profile_id" => 1 })
created = client.BatchGroup.create({ "profile_id" => 1, "name" => "example", "sourceCurrency" => "example", "type" => "example" })
updated = client.BatchGroup.update({ "id" => "example_id", "profile_id" => 1, "status" => "example" })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const batch_group = await client.BatchGroup().load({ id: "example_id", profile_id: 1 })
const created = await client.BatchGroup().create({ profile_id: 1, name: "example", sourceCurrency: "example", type: "example" })
const updated = await client.BatchGroup().update({ id: "example_id", profile_id: 1, status: "example" })

Fields

create

POST /profiles/{profileId}/batch-payments/{batchGroupId}/payments

Operation ID: batchGroupFund.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Request body

application/json

Responses

200: Batch group funded successfully

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

POST /profiles/{profileId}/batch-groups/{batchGroupId}/transfers

Operation ID: batchGroupTransferCreate.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Request body

application/json

Responses

200: Transfer created successfully. Returns a transfer object

application/json

The response is object.

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

POST /profiles/{profileId}/batch-groups

Operation ID: batchGroupCreate.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Request body

application/json

Responses

201: Batch group created successfully. Note that payInDetails is empty for newly created batch groups.

application/json

Example response:

{
  "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88",
  "name": "My batch group",
  "payInDetails": [],
  "payinSessionId": null,
  "sourceCurrency": "GBP",
  "status": "NEW",
  "transferIds": [],
  "version": 0
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /profiles/{profileId}/batch-groups/{batchGroupId}

Operation ID: batchGroupGet.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Responses

200: Batch group retrieved successfully

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

update

PATCH /profiles/{profileId}/batch-groups/{batchGroupId}

Operation ID: batchGroupUpdate.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Request body

application/json

Responses

200: Batch group updated successfully

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.