Click here to view details about the response payload.
Valid statuses can be: "OFFERS_AVAILABLE", "NO_OFFERS", "INVALID_DATA" or
"INCOMPLETE_SEARCH".
"INVALID_DATA" is returned if any mandatory field or validation errors occur. The
"INCOMPLETE_SEARCH" response will be returned if for some reason the request fails
internally.
Example Success Response:
{
"partner_reference": "1234567",
"aro_reference": "abe60167-1ed2-4b2a-b934-d1cdff1cdba2",
"status": "OFFERS_AVAILABLE",
"status_messages": {
"error_messages": [],
"warning_messages": [],
"info_messages": []
},
"response_timestamp": "2023-11-23T13:08:21.001+00:00",
"unsecured_offers": [
{
"uuid": "d5ae9778-7704-4255-839f-c2fbbb41e999",
"product_type": "Unsecured",
"product_code": "**PRODUCT_CODE**",
"product_name": "**PRODUCT_NAME**",
"lender_name": "**LENDER_NAME**",
"loan_offered": 100000,
"term_offered": 24,
"card_limit": null,
"apr": 16.40,
"rate_type": "REAL",
"term_requested": 60,
"total_fees": 100.00,
"total_credit_charge": 400.00,
"monthly_repayment": 486.21,
"total_repayment": 11669.04,
"approval_percentage": 90,
"product_logo_url": "https://assets.aro-sandbox.co.uk/product-logos/abc.png",
"rep_example_text": "Rep Example...",
"auto_approved": "Y",
"proceed_url_redirect": "https://apig.aro-sandbox.co.uk/partner/v1/quote/all-offers/
proceed?aro_reference=abe60167-1ed2-4b2a-b934-d1cdff1cdba2&offer_uuid
=d5ae9778-7704-4255-839f-c2fbbb41e999&expires=1711454101&signature=
e55531259dff6ecc7919c8ecd262699f4cea269c86502d091de13506cf0d830d"
}
],
"credit_card_offers": [
{
"uuid": "fbba07cc-5f4d-4bb3-bbd9-feb58ab0226b",
"product_type": "CreditCard",
"product_code": "**PRODUCT_CODE**",
"product_name": "**PRODUCT_NAME**",
"lender_name": "**LENDER_NAME**",
"card_limit": 800.00,
"apr": 39.00,
"rate_type": "REP",
"product_logo_url": "https://assets.aro-sandbox.co.uk/product-logos/abc.png",
"rep_example_text": "Rep Example...",
"approval_percentage": 100,
"proceed_url_redirect": "https://apig.aro-sandbox.co.uk/partner/v1/quote/all-offers/
proceed?aro_reference=abe60167-1ed2-4b2a-b934-d1cdff1cdba2&offer_uuid
=fbba07cc-5f4d-4bb3-bbd9-feb58ab0226b&expires=1711454101&signature=
e4a281259dff6ecc7919c8ecd262699f4cea269c86502d091de13506cf0d830d"
},
{
"uuid": "d7c131c4-3d82-4a7c-a954-5f5902ef2b25",
"product_type": "CreditCard",
"product_code": "**PRODUCT_CODE**",
"product_name": "**PRODUCT_NAME**",
"lender_name": "**LENDER_NAME**",
"card_limit": 855.00,
"apr": 49.00,
"rate_type": "REP",
"approval_percentage": 100,
"product_logo_url": "https://assets.aro-sandbox.co.uk/product-logos/abc.png",
"rep_example_text": "Rep Example...",
"proceed_url_redirect": "https://apig.aro-sandbox.co.uk/partner/v1/quote/all-offers/
proceed?aro_reference=abe60167-1ed2-4b2a-b934-d1cdff1cdba2&offer_uuid
=d7c131c4-3d82-4a7c-a954-5f5902ef2b25&expires=1711454101&signature=
b33a81259dff6ecc7919c8ecd262699f4cea269c86502d091de13506cf0d830d"
}
],
"auto_finance_offers": [
{
"uuid": "5a69f786-2465-4e09-9969-7ac3ac64a844",
"product_type": "AutoFinance",
"product_code": "**PRODUCT_CODE**",
"product_name": "**PRODUCT_NAME**",
"lender_name": "**LENDER_NAME**",
"loan_offered": 15000.00,
"term_offered": 60,
"apr": 4.2,
"rate_type": "REAL",
"term_requested": 60,
"total_fees": 100.00,
"total_credit_charge": 400.00,
"product_logo_url": "https://assets.aro-sandbox.co.uk/product-logos/abc.png",
"rep_example_text": "Rep Example...",
"monthly_repayment": 500.00,
"total_repayment": 18000.00,
"approval_percentage": 100,
"proceed_url_redirect": "https://apig.aro-sandbox.co.uk/partner/v1/quote/all-offers/
proceed?aro_reference=abe60167-1ed2-4b2a-b934-d1cdff1cdba2&offer_uuid
=5a69f786-2465-4e09-9969-7ac3ac64a844&expires=1711454101&signature=
c9f481259dff6ecc7919c8ecd262699f4cea269c86502d091de13506cf0d830d"
}
],
"secured_offers": [
{
"uuid": "701bac42-7918-48f6-ad53-b84ab8bd43db",
"product_type": "Secured",
"product_code": "**PRODUCT_CODE**",
"product_name": "**PRODUCT_NAME**",
"lender_name": "**LENDER_NAME**",
"loan_offered": 30000.00,
"term_offered": 72,
"aprc": 14.5,
"approval_percentage": 95,
"annual_rate": 14.0,
"fixed_rate_term": 12,
"rate_type": "REAL",
"term_requested": 60.00,
"total_fees": 100.00,
"total_credit_charge": 400.00,
"monthly_repayment": 450.00,
"total_repayment": 38400.00,
"product_logo_url": "https://assets.aro-sandbox.co.uk/product-logos/abc.png",
"rep_example_text": "Rep Example...",
"proceed_url_redirect": "https://apig.aro-sandbox.co.uk/partner/v1/quote/all-offers/
proceed?aro_reference=abe60167-1ed2-4b2a-b934-d1cdff1cdba2&offer_uuid
=701bac42-7918-48f6-ad53-b84ab8bd43db&expires=1711454101&signature=
d43381259dff6ecc7919c8ecd262699f4cea269c86502d091de13506cf0d830d"
}
]
}
Example Invalid Data Response:
{
"partner_reference":"1234567",
"status": "INVALID_DATA",
"status_messages":{
"error_messages":[
{
"level":"ERROR",
"location":"Credit_Card.cash_advance",
"associated_fields":null,
"reason":"REQUIRED_FOR_EC_CREATION",
"message":"Field is required for the creation of an EC"
}
],
"info_messages":[]
},
"response_timestamp":"2023-10-15T08:40:31.932+00:00"
}
