GOgocardless
agreements

POST /api/v2/agreements/enduser/

API endpoints related to end-user agreements.

Request

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

Request body

institution_idstring required

an Institution ID for this EUA

max_historical_daysinteger

Maximum number of days of transaction data to retrieve.

access_valid_for_daysinteger

Number of days from acceptance that the access can be used.

reconfirmationboolean

if this agreement can be extended. Supported by GB banks only.

Response

Create enduser agreement

idstring uuid

The ID of this End User Agreement, used to refer to this end user agreement in other API calls.

createdstring date-time

The date & time at which the end user agreement was created.

institution_idstring required

an Institution ID for this EUA

max_historical_daysinteger

Maximum number of days of transaction data to retrieve.

access_valid_for_daysinteger

Number of days from acceptance that the access can be used.

acceptedstring date-time nullable

The date & time at which the end user accepted the agreement.

reconfirmationboolean

if this agreement can be extended. Supported by GB banks only.

Changes

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