Inquiry object

Inquiries are requests for status updates related to return requests and claims.

AttributeDescription
id
string
The inquiry ID.
object
string
Always inquiry.
connected_account_id
string
The ID of the connected account used to send the inquiry.
status

string
The status of the inquiry.
status_details

string
Additional details related to the status of the inquiry.
related_request_type
string
The type of the request linked to the inquiry. Either return_request or claim.
related_request_id
string
The related return request or claim UUID.
date
date
The date.
reason
string
The reason for denying the inquiry. Authorised reasons include:
  • CUST
  • LEGL
  • ARDT
  • AC04
  • AM04
  • NOAS
  • NOOR
metadata
object
Additional data in JSON key:value format. See Metadata.
bank_data
string
Bank data in JSON key:value format.
created_at
datetime
The inquiry creation UTC timestamp.

You will find below an example of an inquiry object:

{
  "id": "8f9ea7a1-dcc2-48ef-afa3-757fcd9ef67f",
  "object": "inquiry",
  "status": "received",
  "status_details": "",
  "connected_account_id": "a37cca86-527e-4165-961e-6ac60ff5bcf0",
  "related_request_type": "return_request",
  "related_request_id": "33d11c1f-f3b5-46a3-ad53-37d0d6245040",
  "date": "2024-12-17",
  "reason": "",
  "metadata": {},
  "bank_data": {},
  "created_at": "2007-10-22T15:30:30Z" 
}