Sign in

v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-01-20203250.6 KB
Agreements

Find agreement by ID

get/v1/agreement/{agreementExternalId}

Path parameters

agreementExternalIdstring required

The unique external id for the agreement

Query parameters

account_idstring

The gateway account id linked to the agreement

service_idstring

The service id linked to the agreement

override_account_or_service_id_restrictionboolean

If false, the account_id or service_id must be specified

Headers

X-Consistentboolean

If true, an additional check will be carried out to ensure that ledger database is up-to-date with latest events before responding

Response

OK

cancelled_by_user_emailstring
cancelled_datestring date-time
created_datestring date-time
descriptionstring
external_idstring
liveboolean
referencestring
service_idstring
status'CREATED' | 'ACTIVE' | 'INACTIVE' | 'CANCELLED'
user_identifierstring

Example response

{
  "payment_instrument": {
    "card_details": {
      "billing_address": {
        "city": "London",
        "country": "GB",
        "county": "county",
        "line1": "address line 1",
        "line2": "address line 2",
        "postcode": "Ex 8RR"
      },
      "card_brand": "Visa",
      "card_type": "credit",
      "cardholder_name": "J Doe",
      "expiry_date": "11/43",
      "first_digits_card_number": "424242",
      "last_digits_card_number": "4242"
    }
  }
}