banks2ff/gocardless-bankaccount-data-api/docs/AgreementsApi.md

\AgreementsApi

All URIs are relative to https://bankaccountdata.gocardless.com

Method	HTTP request	Description
accept_eua	PUT /api/v2/agreements/enduser/{id}/accept/
create_eua	POST /api/v2/agreements/enduser/
delete_eua_by_id	DELETE /api/v2/agreements/enduser/{id}/
retrieve_all_euas_for_an_end_user	GET /api/v2/agreements/enduser/
retrieve_eua_by_id	GET /api/v2/agreements/enduser/{id}/

accept_eua

models::EndUserAgreement accept_eua(id, enduser_acceptance_details_request)

Accept an end-user agreement via the API

Parameters

Name	Type	Description	Required	Notes
id	uuid::Uuid	A UUID string identifying this end user agreement.	[required]
enduser_acceptance_details_request	EnduserAcceptanceDetailsRequest		[required]

Return type

models::EndUserAgreement

Authorization

jwtAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_eua

models::EndUserAgreement create_eua(end_user_agreement_request)

API endpoints related to end-user agreements.

Parameters

Name	Type	Description	Required	Notes
end_user_agreement_request	EndUserAgreementRequest		[required]

Return type

models::EndUserAgreement

Authorization

jwtAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_eua_by_id

delete_eua_by_id(id)

Delete an end user agreement

Parameters

Name	Type	Description	Required	Notes
id	uuid::Uuid	A UUID string identifying this end user agreement.	[required]

Return type

(empty response body)

Authorization

jwtAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_all_euas_for_an_end_user

models::PaginatedEndUserAgreementList retrieve_all_euas_for_an_end_user(limit, offset)

API endpoints related to end-user agreements.

Parameters

Name	Type	Description	Required	Notes
limit	Option<i32>	Number of results to return per page.		[default to 100]
offset	Option<i32>	The initial zero-based index from which to return the results.		[default to 0]

Return type

models::PaginatedEndUserAgreementList

Authorization

jwtAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_eua_by_id

models::EndUserAgreement retrieve_eua_by_id(id)

Retrieve end user agreement by ID

Parameters

Name	Type	Description	Required	Notes
id	uuid::Uuid	A UUID string identifying this end user agreement.	[required]

Return type

models::EndUserAgreement

Authorization

jwtAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]