GOgovernment-digital-service
Agreements

Create an agreement

Changed on
post/v1/api/accounts/{accountId}/agreements

Request

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

Path parameters

accountIdinteger required

Gateway account ID

Request body

descriptionstring required
referencestring required
user_identifierstring

Example request

{
  "description": "Description for the paying user describing the purpose of the agreement",
  "reference": "Service agreement reference",
  "user_identifier": "reference for the paying user"
}

Response

OK

agreement_idstring
created_datestring date-time
descriptionstring
liveboolean
referencestring
service_idstring
user_identifierstring

Example response

{
  "agreement_id": "iaouobo39hiv0m2560q45j3p04",
  "created_date": "2022-06-27T13:07:57.58Z",
  "description": "Description for the paying user describing the purpose of the agreement",
  "reference": "Service agreement reference",
  "service_id": "Service external ID",
  "user_identifier": "reference for the paying user"
}

Changes

  • 042ba06d9017Revision changes
    • info

      removed the AMOUNT_BELOW_MINIMUM enum value from the response property for the response status

  • 4e93196bd6aaRevision changes
    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_ADYEN enum value to the response property for the response status

    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_STRIPE enum value to the response property for the response status