SettlementAllocation

A settlement allocation request.

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:

settlement_allocation, err := client.SettlementAllocation(nil).Load(map[string]any{"id": "example_id"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(settlement_allocation)
created, err := client.SettlementAllocation(nil).Create(map[string]any{"command": map[string]any{}, "createdAt": "example", "currency": "example", "expectedTotalAmount": 1, "file": "example", "id": "example", "paymentReference": "example", "state": "example", "updatedAt": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

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

local settlement_allocation, err = client:SettlementAllocation():load({ id = "example_id" })
local created, err = client:SettlementAllocation():create({ command = {}, createdAt = "example", currency = "example", expectedTotalAmount = 1, file = "example", id = "example", paymentReference = "example", state = "example", updatedAt = "example" })

PHP

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

$settlement_allocation = $client->SettlementAllocation()->load(["id" => "example_id"]);
$created = $client->SettlementAllocation()->create(["command" => [], "createdAt" => "example", "currency" => "example", "expectedTotalAmount" => 1, "file" => "example", "id" => "example", "paymentReference" => "example", "state" => "example", "updatedAt" => "example"]);

Python

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

settlement_allocation = client.SettlementAllocation().load({"id": "example_id"})
created = client.SettlementAllocation().create({ "command": {}, "createdAt": "example", "currency": "example", "expectedTotalAmount": 1, "file": "example", "id": "example", "paymentReference": "example", "state": "example", "updatedAt": "example" })

Ruby

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

settlement_allocation = client.SettlementAllocation.load({ "id" => "example_id" })
created = client.SettlementAllocation.create({ "command" => {}, "createdAt" => "example", "currency" => "example", "expectedTotalAmount" => 1, "file" => "example", "id" => "example", "paymentReference" => "example", "state" => "example", "updatedAt" => "example" })

TypeScript

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

const settlement_allocation = await client.SettlementAllocation().load({ id: "example_id" })
const created = await client.SettlementAllocation().create({ command: {}, createdAt: "example", currency: "example", expectedTotalAmount: 1, file: "example", id: "example", paymentReference: "example", state: "example", updatedAt: "example" })

Fields

create

POST /settlement/allocations

Operation ID: createFundsAllocationRequest.

Authentication: bearer token (ClientCredentialsToken) or API key in the header (HmacSignature) or API key in the header (HmacSignatureTimestamp).

Parameters

Request body

multipart/form-data

Responses

202: Settlement allocation request accepted

application/json

400: Invalid request. Signature failures are returned with this status and a detail field identifying the cause: | detail | Cause | | -------- | ----- | | Missing required X-Signature header | The X-Signature header was absent or blank. | | Missing required X-Signature-Timestamp header | The X-Signature-Timestamp header was absent or blank. | | Invalid timestamp format | X-Signature-Timestamp is not a whole number of seconds. | | Signature timestamp expired | The timestamp is more than 300 seconds from Wise server time, in either direction. | | Invalid signature encoding | X-Signature is not valid lowercase hexadecimal. | | Invalid signature | The signature did not match the request content. |

401: Unauthorized - missing or invalid authentication

403: Forbidden - insufficient permissions

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

application/json

The response is object.

load

GET /settlement/allocations/{allocationId}

Operation ID: GetSettlementAllocation.

Authentication: bearer token (ClientCredentialsToken).

Parameters

Responses

200: Settlement allocation details 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.