Transfer

A transfer: create, list, get or cancel one, and its receipts and payout information.

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:

transfers, err := client.Transfer(nil).List(nil, nil)
if err != nil {
    panic(err)
}
fmt.Println(transfers)
transfer, err := client.Transfer(nil).Load(map[string]any{"id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(transfer)
created, err := client.Transfer(nil).Create(map[string]any{"customerTransactionId": "example", "quoteUuid": "example", "targetAccount": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)
updated, err := client.Transfer(nil).Update(map[string]any{"id": 1, "business": 1, "created": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(updated)

Lua

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

local transfers, err = client:Transfer():list()
local transfer, err = client:Transfer():load({ id = 1 })
local created, err = client:Transfer():create({ customerTransactionId = "example", quoteUuid = "example", targetAccount = 1 })
local updated, err = client:Transfer():update({ id = 1, business = 1, created = "example" })

PHP

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

$transfers = $client->Transfer()->list();
$transfer = $client->Transfer()->load(["id" => 1]);
$created = $client->Transfer()->create(["customerTransactionId" => "example", "quoteUuid" => "example", "targetAccount" => 1]);
$updated = $client->Transfer()->update(["id" => 1, "business" => 1, "created" => "example"]);

Python

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

transfers = client.Transfer().list()
transfer = client.Transfer().load({"id": 1})
created = client.Transfer().create({ "customerTransactionId": "example", "quoteUuid": "example", "targetAccount": 1 })
updated = client.Transfer().update({"id": 1, "business": 1, "created": "example"})

Ruby

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

transfers = client.Transfer.list()
transfer = client.Transfer.load({ "id" => 1 })
created = client.Transfer.create({ "customerTransactionId" => "example", "quoteUuid" => "example", "targetAccount" => 1 })
updated = client.Transfer.update({ "id" => 1, "business" => 1, "created" => "example" })

TypeScript

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

const transfers = await client.Transfer().list()
const transfer = await client.Transfer().load({ id: 1 })
const created = await client.Transfer().create({ customerTransactionId: "example", quoteUuid: "example", targetAccount: 1 })
const updated = await client.Transfer().update({ id: 1, business: 1, created: "example" })

Fields

create

POST /transfers

Operation ID: transferCreate.

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

Parameters

Request body

application/json

Responses

200: Transfer successfully created

application/json

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

application/json

The response is object.

list

GET /transfers

Operation ID: transferList.

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

Parameters

Responses

200: Returns an array of transfer objects, with or without an originator block depending on the type of each transfer

application/json

The response is array of object or object.

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

application/json

The response is object.

load

GET /transfers/{transferId}

Operation ID: transferGet.

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

Parameters

Responses

200: Returns the transfer object, with or without an originator block depending on the type of transfer

application/json

The response is object or object.

404: Transfer not found

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

application/json

The response is object.

GET /transfers/{transferId}/documents/noc

Operation ID: transferNocGet.

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

Parameters

Responses

200: Non objection certificate in PDF format

application/pdf

The response is string (binary).

404: Transfer not found

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

application/json

The response is object.

GET /transfers/{transferId}/invoices/bankingpartner

Operation ID: transferPayoutInfoGet.

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

Parameters

Responses

200: Returns payout information for the transfer

application/json

Example response:

{
  "bankingPartnerName": "Global Bank Corp.",
  "bankingPartnerReference": "ABCD1234",
  "deliveryMode": "SWIFT",
  "mt103": "{1:F01XXXXGBXXAXXX0000000000}{2:I103XXXXGBXXXXXXN}{3:{108:1234567}{111:001}{121:00000000-0000-0000-0000-000000000000}}{4:\n:20:1234567\n:23B:CRED\n:32A:221212USD12345,\n:33B:USD12345,\n:50K:/11111111\nSOME COMPANY INC.\n1 SOME STREET MIAMI 33132 US\n:59:/GB00000000000000\nCOMPANY NAME LTD\nUK LONDON 1234 GB\n:70:REFERENCE\n:71A:OUR\n:71G:USD11,\n-}\n",
  "processorName": "Acme Bank Ltd."
}

404: Transfer not found (this error can also occur if querying the endpoint before the transfer has finished processing)

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

application/json

The response is object.

GET /transfers/{transferId}/receipt.pdf

Operation ID: transferReceiptGet.

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

Parameters

Responses

200: Transfer confirmation receipt in Wise branded PDF format

application/pdf

The response is string (binary).

404: Transfer not found

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

application/json

The response is object.

GET /transfers/{transferId}/us-combined-receipt.pdf

Operation ID: transferUsCombinedReceiptGet.

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

Parameters

Responses

200: The US Combined Receipt in Wise branded PDF format

application/pdf

The response is string (binary).

404: Transfer not found

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

application/json

The response is object.

update

PUT /transfers/{transferId}/cancel

Operation ID: transferCancel.

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

Parameters

Responses

200: Returns the transfer object with status set to cancelled. If the original transfer was a third-party transfer, the response includes the originator object

application/json

The response is object or object.

404: Transfer not found

409: Transfer cannot be cancelled because it is in a non-cancellable state or has other restrictions. The error response includes the code transfer.cancellation.not.allowed

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

application/json

The response is object.