GOgocardless
Creditor

Update a creditor

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

put/creditors/{creditor_id}

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Path parameters

creditor_idstring required

The creditor id

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "creditors": {
    "name": "Acme",
    "address_line1": "338-346 Goswell Road",
    "address_line2": "Islington",
    "city": "London",
    "postal_code": "EC1V 7LQ",
    "country_code": "GB",
    "bank_reference_prefix": "ACME",
    "links": {
      "default_aud_payout_account": "BA234",
      "default_gbp_payout_account": "BA123",
      "default_eur_payout_account": "BA456",
      "default_sek_payout_account": "BA789",
      "default_dkk_payout_account": "BA790",
      "default_nzd_payout_account": "BA791",
      "default_cad_payout_account": "BA792",
      "default_usd_payout_account": "BA792"
    }
  }
}

Response

Successful response

Example response

{
  "creditors": {
    "id": "CR123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "name": "Acme",
    "address_line1": "338-346 Goswell Road",
    "address_line2": "Islington",
    "city": "London",
    "postal_code": "EC1V 7LQ",
    "country_code": "GB",
    "bank_reference_prefix": "ACME",
    "links": {
      "default_aud_payout_account": "BA234",
      "default_gbp_payout_account": "BA123",
      "default_eur_payout_account": "BA456",
      "default_sek_payout_account": "BA789",
      "default_dkk_payout_account": "BA790",
      "default_nzd_payout_account": "BA791",
      "default_cad_payout_account": "BA792",
      "default_usd_payout_account": "BA792"
    },
    "scheme_identifiers": [
      {
        "id": "SU123",
        "created_at": "2014-01-01T12:00:00.000Z",
        "scheme": "bacs",
        "status": "pending",
        "minimum_advance_notice": 3,
        "address_line1": "221B Baker Street",
        "address_line2": "Marylebone",
        "address_line3": "City of Westminster",
        "city": "London",
        "region": "Greater London",
        "postal_code": "NW1 6XE",
        "country_code": "GB",
        "email": "user@example.com",
        "phone_number": "+44 20 1234 1234",
        "currency": "EUR"
      }
    ],
    "logo_url": "https://uploads.gocardless.com/logo.png",
    "verification_status": "action_required",
    "merchant_responsible_for_notifications": true,
    "mandate_imports_enabled": true,
    "custom_payment_pages_enabled": true,
    "fx_payout_currency": "EUR",
    "creditor_type": "company"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.