Agreements
Search agreements by query params
get/v1/agreement
Query parameters
service_idstring[]
Service id(s)
liveboolean
Limit the results to agreement(s) relating to live (not test) accounts
account_idstring[]
Gateway account id(s)
override_account_or_service_id_restrictionboolean
Unless set to true, either service_id or account_id field must be completed
status'CREATED' | 'ACTIVE' | 'INACTIVE' | 'CANCELLED'
Status of agreement
exact_reference_matchboolean
Limit the results to exact matches for the given reference
referencestring
The reference provided by the service when creating the agreement(s)
pageinteger
Page number of results
display_sizeinteger
Number of results to be displayed
Response
OK
Example response
{
"_links": {
"first_page": {
"href": "https://an.example.link"
},
"last_page": {
"href": "https://an.example.link"
},
"next_page": {
"href": "https://an.example.link"
},
"prev_page": {
"href": "https://an.example.link"
},
"self": {
"href": "https://an.example.link"
}
},
"results": [
{
"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"
}
}
}
]
}