API

DeliveryEstimate

The delivery estimate for a transfer.

Operations

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

Method	Route	SDK operation	Returns
`GET`	`/delivery-estimates/{transferId}`	`load`	Delivery estimate for the transfer

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:

delivery_estimate, err := client.DeliveryEstimate(nil).Load(map[string]any{"id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(delivery_estimate)

Lua

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

local delivery_estimate, err = client:DeliveryEstimate():load({ id = 1 })

PHP

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

$delivery_estimate = $client->DeliveryEstimate()->load(["id" => 1]);

Python

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

delivery_estimate = client.DeliveryEstimate().load({"id": 1})

Ruby

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

delivery_estimate = client.DeliveryEstimate.load({ "id" => 1 })

TypeScript

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

const delivery_estimate = await client.DeliveryEstimate().load({ id: 1 })

Fields

Field	Type	Required	Description
`estimatedDeliveryDate`	`string`	No	Estimated time when funds will arrive in the recipient's bank account.
`formattedEstimatedDeliveryDate`	`string`	No	A string to display to users for the estimated delivery date.
`id`	`string`	No	Id

load

`GET` /delivery-estimates/{transferId}

Operation ID: deliveryEstimateGet.

Authentication: bearer token (UserToken).

Parameters

Parameter	In	Type	Required	Description
`transferId`	`path`	`integer (int64)`	Yes	The ID of the transfer.
`timezone`	`query`	`string`	No	Timezone ID for the formatted text. Defaults to `UTC` if not provided.
`X-External-Correlation-Id`	`header`	`string (uuid)`	No	Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Responses

200: Delivery estimate for the transfer

application/json

Property	Type	Required	Description
`estimatedDeliveryDate`	`string (date-time)`	No	Estimated time when funds will arrive in the recipient's bank account.
`formattedEstimatedDeliveryDate`	`string`	No	A string to display to users for the estimated delivery date.

Example response:

{
  "estimatedDeliveryDate": "2018-01-10T12:15:00.000+0000",
  "formattedEstimatedDeliveryDate": "in seconds"
}

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