API

Payment

A transfer's completed payments.

Operations

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

Method	Route	SDK operation	Returns
`GET`	`/transfers/{transferId}/payments`	`list`	Returns a list of completed payment objects

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:

payments, err := client.Payment(nil).List(map[string]any{"transfer_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(payments)

Lua

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

local payments, err = client:Payment():list({ transfer_id = 1 })

PHP

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

$payments = $client->Payment()->list(["transfer_id" => 1]);

Python

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

payments = client.Payment().list({"transfer_id": 1})

Ruby

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

payments = client.Payment.list({ "transfer_id" => 1 })

TypeScript

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

const payments = await client.Payment().list({ transfer_id: 1 })

Fields

Field	Type	Required	Description
`amount`	`number`	No	Transfer source amount
`currency`	`string`	No	Transfer source currency
`id`	`integer`	No	Payment ID
`method`	`string`	No	The payment method used to pay for the transfer
`pricingVariant`	`one,string,null`	No	The qualifier that allows to apply different pricing policy within the same payment method.
`timeCreated`	`string`	No	Date of when payment was created
`timeUpdated`	`string`	No	Date of when payment was updated

list

`GET` /transfers/{transferId}/payments

Operation ID: transferPaymentsList.

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

Parameters

Parameter	In	Type	Required	Description
`transferId`	`path`	`integer (int64)`	Yes	The transfer ID
`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: Returns a list of completed payment objects

application/json

Property	Type	Required	Description
`[].amount`	`number`	No	Transfer source amount
`[].currency`	`string`	No	Transfer source currency
`[].id`	`integer (int64)`	No	Payment ID
`[].method`	`string`	No	The payment method used to pay for the transfer
`[].pricingVariant`	`string,null`	No	The qualifier that allows to apply different pricing policy within the same payment method. Often the value might be the payment method itself
`[].timeCreated`	`string (date-time)`	No	Date of when payment was created
`[].timeUpdated`	`string (date-time)`	No	Date of when payment was updated

404: Transfer not found

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