GOgocardless
agreements

POST /api/v2/agreements/enduser/{id}/reconfirm/

Create EUA reconfirmation

Request

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

Path parameters

idstring uuid required

A UUID string identifying this end user agreement.

Request body

redirectstring uri nullable

Optional redirect URL for reconfirmation to override requisition's redirect.

Response

Reconfirmation created

reconfirmation_urlstring uri

Reconfirmation URL to be provided to PSU.

createdstring date-time

Reconfirmation creation time

url_valid_fromstring date-time

Datetime from when PSU will be able to access reconfirmation URL.

url_valid_tostring date-time

Datetime until when PSU will be able to access reconfirmation URL.

redirectstring uri nullable

Optional redirect URL for reconfirmation to override requisition's redirect.

last_accessedstring date-time nullable

Last time when reconfirmation was accessed (this does not mean that it was accessed by PSU).

last_submittedstring date-time nullable

Last time reconfirmation was submitted (it can be submitted multiple times).

accountsobject

Dictionary of accounts and their reconfirm and reject timestamps

Example response

{
  "accounts": {
    "64a985ae-4427-4a27-bd36-fd625fe6e1fc": {
      "reconfirmed": "2025-01-14T15:20:56.942817Z",
      "rejected": ""
    },
    "cd2fbd71-15f7-4607-bea2-fbd80311a013": {
      "reconfirmed": "",
      "rejected": ""
    }
  }
}

Changes

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