Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Inquiries

Retrieve inquiry

Retrieve the details of an inquiry.

get/inquiries/{id}

Path parameters

idstring uuid required

The ID of the inquiry.

Response

Successfully retrieved inquiry.

idstring uuid required

The UUID of the inquiry.

object'inquiry' required

Label used to identify this kind of object

status'created' | 'processing' | 'sent' | 'received' | 'denied' | 'archived' required

The status of the inquiry.

status_detailsstring required

The details of the status of the inquiry.

connected_account_idstring uuid required

The ID of the connected account.

related_request_type'return_request' | 'claim' required

The type of the request related to the inquiry.

related_request_idstring uuid required

The ID of the request related to the inquiry.

created_atstring date-time required

The UTC timestamp of the creation of the inquiry.

datestring date required

The date of the inquiry.

Example response

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