GOgocardless
Payer Authorisation

Update a Payer Authorisation

Updates a Payer Authorisation. Updates the Payer Authorisation with the request data. Can be invoked as many times as needed. Only fields present in the request will be modified. An empty array of incomplete_fields means that the resource is valid. This endpoint has been designed this way so you do not need to save any payer data on your servers or the browser while still being able to implement a progressive solution, such a multi-step form. <p class="notice"> Note that in order to update the metadata attribute values it must be sent completely as it overrides the previously existing values. </p>

Deprecated: Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request API should be used for any new integrations.

put/payer_authorisations/{payer_authorisation_id}

Request

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

Path parameters

payer_authorisation_idstring required

The payer authorisation id

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "payer_authorisations": {
    "customer": {
      "email": "user@example.com",
      "given_name": "Frank",
      "family_name": "Osborne",
      "company_name": "Hamilton Trading Ltd.",
      "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",
      "locale": "en-GB",
      "swedish_identity_number": "556564-5404",
      "danish_identity_number": "2205506218"
    },
    "bank_account": {
      "account_holder_name": "Billie Jean",
      "account_number": "55779911",
      "account_number_ending": "1234",
      "account_number_suffix": "00",
      "branch_code": "20-00-00",
      "iban": "GB60BARC20000055779911",
      "country_code": "GB",
      "currency": "EUR",
      "account_type": "savings",
      "bank_name": "BARCLAYS BANK PLC"
    },
    "mandate": {
      "reference": "REF-123",
      "scheme": "bacs",
      "payer_ip_address": "127.0.0.1"
    }
  }
}

Response

Successful response

Example response

{
  "payer_authorisations": {
    "id": "PA123",
    "created_at": "2020-01-01T12:00:00.000Z",
    "customer": {
      "email": "user@example.com",
      "given_name": "Frank",
      "family_name": "Osborne",
      "company_name": "Hamilton Trading Ltd.",
      "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",
      "locale": "en-GB",
      "swedish_identity_number": "556564-5404",
      "danish_identity_number": "2205506218"
    },
    "bank_account": {
      "account_holder_name": "Billie Jean",
      "account_number": "55779911",
      "account_number_ending": "1234",
      "account_number_suffix": "00",
      "branch_code": "20-00-00",
      "iban": "GB60BARC20000055779911",
      "country_code": "GB",
      "currency": "EUR",
      "account_type": "savings",
      "bank_name": "BARCLAYS BANK PLC"
    },
    "mandate": {
      "reference": "REF-123",
      "scheme": "bacs",
      "payer_ip_address": "127.0.0.1"
    },
    "links": {
      "customer": "CU123",
      "bank_account": "BA123",
      "mandate": "MD123"
    },
    "status": "created"
  }
}

Changes

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