Update a counterparty's payment method

You can use this endpoint to update the address of a counterparty's payment method.

What is a payment method?

A payment method is an individual account or card linked to a counterparty. When you retrieve a counterparty, the response includes an accounts array and a cards array — each entry in these arrays is a payment method with its own id.

As only bank account payment methods have an address, you can use this endpoint to update the address of a counterparty's bank account.

This is useful when:

A counterparty was created without an address, and you later need to add one (for example, when a payment fails stating that the address is required).
The counterparty's address has changed and needs to be corrected.

Prerequisites

To update a counterparty's payment method, you need:

Counterparty ID: The id returned when you create or retrieve a counterparty.
Payment method ID: The id from the accounts array in the Retrieve a counterparty response. This identifies the specific bank account whose address you want to update.

Address fields

To get the payment_method_id for the bank account, retrieve the counterparty and use the id from the accounts array in the response.

You must provide the full address in the request. All required fields must be present.

Field	Required	Description
`country`	Yes	2-letter ISO 3166 country code.
`street_line1`	Yes	The first line of the address.
`street_line2`	No	An additional line for the address, if needed.
`region`	No	The region, state, or province (e.g. Ontario for Canada).
`city`	Yes	The city.
`postcode`	Yes	The postcode.

Address field recommendations

We recommend that you use all available address fields (including region) when updating an address. This reduces the risk of any disruption to payments made via the API.