The inquiry object

An inquiry is a request for status update on a previous message. Only inquiries that relate to return requests are processed.

AttributeDescription
id
string
The UUID of the inquiry.
object
string
The object, here inquiry.
connected_account
string
The ID of the connected account used to receive the inquiry.
related_request
string
The ID of the request related to the inquiry.
related_request_type
string
The type of the request related to the inquiry. Always a return request.
deny_reason
string
The reason for denying the inquiry. Authorised reasons are the following:
  • CUST
  • LEGL
  • ARDT
  • AC04
  • AM04
  • NOAS
  • NOOR
metadata
object
Additional data in JSON key:value format. See Metadata.
bank_data
string
Bank data, such as message and transaction IDs, in JSON key:value format.
denied_at
datetime
The UTC timestamp of the denial of this inquiry. denied_at is null if inquiry wasn't denied.
date
date
The date of the inquiry.
created_at
datetime
The UTC timestamp of the creation of this inquiry.
updated_at
datetime
The UTC timestamp of the last update of this inquiry.
{
  "id": "8f9ea7a1-dcc2-48ef-afa3-757fcd9ef67f",
  "object": "inquiry",
  "connected_account": "a37cca86-527e-4165-961e-6ac60ff5bcf0",
  "related_request_type": "return_request",
  "related_request": "33d11c1f-f3b5-46a3-ad53-37d0d6245040",
  "bank_data": {},
  "created_at": "2007-10-22T15:30:30Z",
  "date": "2022-04-01",
  "denied_at": "2022-04-05T11:39:34.562065Z",
  "deny_reason": "CUST"
}