---
title: "Update a creditor"
method: PUT
path: "/creditors/{creditor_id}"
tags: ["Creditor"]
---

# Update a creditor

`PUT /creditors/{creditor_id}`

## Request

- Base URL: `https://api.gocardless.com`
- URL: `https://api.gocardless.com/creditors/{creditor_id}`
- Auth: HTTP bearer

Updates a creditor object. Supports all of the fields supported when creating a creditor.

## Path parameters

- `creditor_id` string, required

## Headers

- `GoCardless-Version` string, required

## Request body

- object
  - `creditors` object
    - `name` string: The creditor's trading name.
    - `address_line1` string, nullable: The first line of the creditor's address.
    - `address_line2` string, nullable: The second line of the creditor's address.
    - `address_line3` string, nullable: The third line of the creditor's address.
    - `city` string, nullable: The city of the creditor's address.
    - `region` string, nullable: The creditor's address region, county or department.
    - `postal_code` string, nullable: The creditor's postal code.
    - `country_code` string, nullable: [ISO 3166-1 alpha-2 code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
    - `bank_reference_prefix` string: Prefix for the bank reference of payouts sent to this creditor. For instance, if the creditor's `bank_reference_prefix` was `ACME`, the bank reference of a payout sent to that creditor could be `ACME-8G7Q8`. This prefix is also used for refunds in EUR and GBP.
    - `links` object
      - `default_aud_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in AUD.
      - `default_gbp_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in GBP.
      - `default_eur_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in EUR.
      - `default_sek_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in SEK.
      - `default_dkk_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in DKK.
      - `default_nzd_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in NZD.
      - `default_cad_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in CAD.
      - `default_usd_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in USD.

## Response `200`

Successful response

- CreditorSingleResourceResponse
  - `creditors` Creditor: Each [payment](https://docs.gocardless.com/docs/api-reference/payment) taken through the API is linked to a "creditor", to whom the payment is then paid out. In most cases your organisation will have a single "creditor", but the API also supports collecting payments on behalf of others. Currently, for Anti Money Laundering reasons, any creditors you add must be directly related to your organisation.
    - `id` string: Unique identifier, beginning with "CR".
    - `created_at` string, date-time: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created.
    - `name` string: The creditor's trading name.
    - `address_line1` string, nullable: The first line of the creditor's address.
    - `address_line2` string, nullable: The second line of the creditor's address.
    - `address_line3` string, nullable: The third line of the creditor's address.
    - `city` string, nullable: The city of the creditor's address.
    - `region` string, nullable: The creditor's address region, county or department.
    - `postal_code` string, nullable: The creditor's postal code.
    - `country_code` string, nullable: [ISO 3166-1 alpha-2 code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
    - `can_create_refunds` boolean: Boolean indicating whether the creditor is permitted to create refunds.
    - `bank_reference_prefix` string: Prefix for the bank reference of payouts sent to this creditor. For instance, if the creditor's `bank_reference_prefix` was `ACME`, the bank reference of a payout sent to that creditor could be `ACME-8G7Q8`. This prefix is also used for refunds in EUR and GBP.
    - `links` CreditorLinks
      - `default_aud_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in AUD.
      - `default_gbp_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in GBP.
      - `default_eur_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in EUR.
      - `default_sek_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in SEK.
      - `default_dkk_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in DKK.
      - `default_nzd_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in NZD.
      - `default_cad_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in CAD.
      - `default_usd_payout_account` string, nullable: ID of the [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which is set up to receive payouts in USD.
    - `scheme_identifiers` object[]: An array of the scheme identifiers this creditor can create mandates against. The support address, `phone_number` and `email` fields are for customers to contact the merchant for support purposes. They must be displayed on the payment page, please see our [compliance requirements](https://docs.gocardless.com/docs/api-reference/compliance-requirements) for more details.
      - `id` string: Unique identifier, usually beginning with "SU".
      - `created_at` string, date-time: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created.
      - `name` string: The name which appears on customers' bank statements. This should usually be the merchant's trading name.
      - `scheme` 'ach' | 'autogiro' | 'bacs' | 'becs' | 'becs_nz' | 'betalingsservice' | 'faster_payments' | 'pad' | 'pay_to' | 'sepa' | 'sepa_credit_transfer' | 'sepa_instant_credit_transfer': The scheme which this scheme identifier applies to.
      - `reference` string, nullable: The scheme-unique identifier against which payments are submitted.
      - `status` 'pending' | 'active': The status of the scheme identifier. Only `active` scheme identifiers will be applied to a creditor and used against payments.
      - `minimum_advance_notice` integer: The minimum interval, in working days, between the sending of a pre-notification to the customer, and the charge date of a payment using this scheme identifier. By default, GoCardless sends these notifications automatically. Please see our [compliance requirements](https://docs.gocardless.com/docs/api-reference/compliance-requirements) for more details.
      - `address_line1` string, nullable: The first line of the scheme identifier's support address.
      - `address_line2` string, nullable: The second line of the scheme identifier's support address.
      - `address_line3` string, nullable: The third line of the scheme identifier's support address.
      - `city` string, nullable: The city of the scheme identifier's support address.
      - `region` string, nullable: The scheme identifier's support address region, county or department.
      - `postal_code` string, nullable: The scheme identifier's support postal code.
      - `country_code` string, nullable: [ISO 3166-1 alpha-2 code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
      - `email` string, nullable: Scheme identifier's support email address.
      - `phone_number` string, nullable: Scheme identifier's support phone number.
      - `currency` 'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD': The currency of the scheme identifier.
      - `can_specify_mandate_reference` boolean: Whether a custom reference can be submitted for mandates using this scheme identifier.
    - `logo_url` string, nullable: URL for the creditor's logo, which may be shown on their payment pages.
    - `verification_status` 'successful' | 'in_review' | 'action_required': The creditor's verification status, indicating whether they can yet receive payouts. For more details on handling verification as a partner, see our ["Helping your users get verified" guide](https://docs.gocardless.com/docs/partner-integrations/getting-your-users-verified). One of: - `successful`: The creditor's account is fully verified, and they can receive payouts. Once a creditor has been successfully verified, they may in the future require further verification - for example, if they change their payout bank account, we will have to check that they own the new bank account before they can receive payouts again. - `in_review`: The creditor has provided all of the information currently requested, and it is awaiting review by GoCardless before they can be verified and receive payouts. - `action_required`: The creditor needs to provide further information to verify their account so they can receive payouts, and should visit the verification flow.
    - `merchant_responsible_for_notifications` boolean: Boolean value indicating whether the organisation is responsible for sending all customer notifications (note this is separate from the functionality described [here](https://docs.gocardless.com/docs/tutorials/handling-customer-notifications)). If you are a partner app, and this value is true, you should not send notifications on behalf of this organisation.
    - `mandate_imports_enabled` boolean: Boolean value indicating whether creditor has the [Mandate Imports](https://docs.gocardless.com/docs/api-reference/mandate-import) functionality enabled.
    - `custom_payment_pages_enabled` boolean: Boolean value indicating whether creditor has the [Custom Payment Pages](https://hub.gocardless.com/s/article/Custom-payment-pages) functionality enabled.
    - `fx_payout_currency` 'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD', nullable: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency in which amounts will be paid out (after foreign exchange). Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts will be (or were) made via foreign exchange.
    - `creditor_type` 'company' | 'individual' | 'charity' | 'partnership' | 'trust', nullable: The type of business of the creditor. Currently, `individual`, `company`, `charity`, `partnership`, and `trust` are supported.

## Other responses

- `400`: Bad Request
- `401`: Unauthorised
- `404`: Not found
- `422`: Validation Error
- `500`: Internal Error

---

[API](https://skmtc.dev/gocardless/apis/gocardless-api.md) - [All operations](https://skmtc.dev/gocardless/apis/gocardless-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gocardless/apis/gocardless-api/revisions/4dd3dae45364?raw)