Agreement (GoCardLess)

Changed on
post/auth/gocardless/agreement

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

institutionIdstring required
transactionTotalDaysnumber required

Example request

{
  "institutionId": "REVOLUT_REVOGB21",
  "transactionTotalDays": 90
}

Response

Retrieve Agreement

Example response

{
  "data": {
    "id": "2dea1b84-97b0-4cb4-8805-302c227587c8",
    "created": "2024-01-01",
    "access_valid_for_days": 90,
    "max_historical_days": 90,
    "institution_id": "REVOLUT_REVOGB21",
    "accepted": true
  }
}

Changes

    • breaking

      added the new required request property

    • warning

      removed the request property

    • breaking

      the response's property type changed from number to string for status

    • warning

      removed the optional property from the response with the status