Bunq · Schema

RequestInquiryRead

Banking

Properties

Name Type Description
id integer The id of the created RequestInquiry.
created string The timestamp of the payment request's creation.
updated string The timestamp of the payment request's last update.
time_responded string The timestamp of when the payment request was responded to.
time_expiry string The timestamp of when the payment request expired.
monetary_account_id integer The id of the monetary account the request response applies to.
amount_inquired object The requested amount.
amount_responded object The responded amount.
user_alias_created object The label that's displayed to the counterparty with the mutation. Includes user.
user_alias_revoked object The label that's displayed to the counterparty with the mutation. Includes user.
counterparty_alias object The LabelMonetaryAccount with the public information of the MonetaryAccount the money was requested from.
description string The description of the inquiry.
merchant_reference string The client's custom reference that was attached to the request and the mutation.
attachment array The attachments attached to the payment.
status string The status of the request.
batch_id integer The id of the batch if the request was part of a batch.
scheduled_id integer The id of the scheduled job if the request was scheduled.
minimum_age integer The minimum age the user accepting the RequestInquiry must have.
require_address string Whether or not an address must be provided on accept.
bunqme_share_url string The url that points to the bunq.me request.
redirect_url string The URL which the user is sent to after accepting or rejecting the Request.
address_shipping object The shipping address provided by the accepting user if an address was requested.
address_billing object The billing address provided by the accepting user if an address was requested.
geolocation object The geolocation where the payment was done.
reference_split_the_bill object The reference to the object used for split the bill. Can be Payment, PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction
View JSON Schema on GitHub

JSON Schema

bunq-requestinquiryread-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RequestInquiryRead",
  "title": "RequestInquiryRead",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The id of the created RequestInquiry.",
      "readOnly": true,
      "writeOnly": false
    },
    "created": {
      "type": "string",
      "description": "The timestamp of the payment request's creation.",
      "readOnly": true,
      "writeOnly": false
    },
    "updated": {
      "type": "string",
      "description": "The timestamp of the payment request's last update.",
      "readOnly": true,
      "writeOnly": false
    },
    "time_responded": {
      "type": "string",
      "description": "The timestamp of when the payment request was responded to.",
      "readOnly": true,
      "writeOnly": false
    },
    "time_expiry": {
      "type": "string",
      "description": "The timestamp of when the payment request expired.",
      "readOnly": true,
      "writeOnly": false
    },
    "monetary_account_id": {
      "type": "integer",
      "description": "The id of the monetary account the request response applies to.",
      "readOnly": true,
      "writeOnly": false
    },
    "amount_inquired": {
      "type": "object",
      "description": "The requested amount.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "amount_responded": {
      "type": "object",
      "description": "The responded amount.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "user_alias_created": {
      "type": "object",
      "description": "The label that's displayed to the counterparty with the mutation. Includes user.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/LabelUser"
    },
    "user_alias_revoked": {
      "type": "object",
      "description": "The label that's displayed to the counterparty with the mutation. Includes user.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/LabelUser"
    },
    "counterparty_alias": {
      "type": "object",
      "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount the money was requested from.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/LabelMonetaryAccount"
    },
    "description": {
      "type": "string",
      "description": "The description of the inquiry.",
      "readOnly": true,
      "writeOnly": false
    },
    "merchant_reference": {
      "type": "string",
      "description": "The client's custom reference that was attached to the request and the mutation.",
      "readOnly": true,
      "writeOnly": false
    },
    "attachment": {
      "type": "array",
      "description": "The attachments attached to the payment.",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/BunqId"
      }
    },
    "status": {
      "type": "string",
      "description": "The status of the request.",
      "readOnly": true,
      "writeOnly": false
    },
    "batch_id": {
      "type": "integer",
      "description": "The id of the batch if the request was part of a batch.",
      "readOnly": true,
      "writeOnly": false
    },
    "scheduled_id": {
      "type": "integer",
      "description": "The id of the scheduled job if the request was scheduled.",
      "readOnly": true,
      "writeOnly": false
    },
    "minimum_age": {
      "type": "integer",
      "description": "The minimum age the user accepting the RequestInquiry must have.",
      "readOnly": true,
      "writeOnly": false
    },
    "require_address": {
      "type": "string",
      "description": "Whether or not an address must be provided on accept.",
      "readOnly": true,
      "writeOnly": false
    },
    "bunqme_share_url": {
      "type": "string",
      "description": "The url that points to the bunq.me request.",
      "readOnly": true,
      "writeOnly": false
    },
    "redirect_url": {
      "type": "string",
      "description": "The URL which the user is sent to after accepting or rejecting the Request.",
      "readOnly": true,
      "writeOnly": false
    },
    "address_shipping": {
      "type": "object",
      "description": "The shipping address provided by the accepting user if an address was requested.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Address"
    },
    "address_billing": {
      "type": "object",
      "description": "The billing address provided by the accepting user if an address was requested.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Address"
    },
    "geolocation": {
      "type": "object",
      "description": "The geolocation where the payment was done.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Geolocation"
    },
    "reference_split_the_bill": {
      "type": "object",
      "description": "The reference to the object used for split the bill. Can be Payment, PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/RequestReferenceSplitTheBillAnchorObject"
    }
  }
}