Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Inquiries

List inquiries

List and filter inquiries.

get/inquiries

Query parameters

limitinteger
starting_afterstring

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

The creation date of the inquiry.

end_datestring date

The creation date of the inquiry.

connected_account_idstring

The ID of the connected account used to receive the inquiry.

status'created' | 'processing' | 'sent' | 'received' | 'denied' | 'archived'
Example:received

The status of the inquiry.

related_request_type'return_request'

The type of the request related to the inquiry. Only return_request and claim are supported.

related_request_id'return_request'

The ID of the request related to the inquiry.

file_idstring

The ID of the file including the inquiry.

Response

List of filtered inquiries.

Example response

{
  "records": [
    {
      "object": "inquiry",
      "status": "received",
      "status_details": "AC04",
      "bank_data": {
        "message_id": "zNhzzPND67KMfbOs5U0d47dLRB",
        "status_request_id": "dtL9AGFHbeWQVABPcTt4oWIeTgFI"
      }
    }
  ]
}