{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/RequestInquiry",
"title": "RequestInquiry",
"type": "object",
"properties": {
"amount_inquired": {
"type": "object",
"description": "The requested amount.",
"readOnly": false,
"writeOnly": false,
"$ref": "#/components/schemas/Amount"
},
"counterparty_alias": {
"type": "object",
"description": "The LabelMonetaryAccount with the public information of the MonetaryAccount the money was requested from.",
"readOnly": false,
"writeOnly": false,
"$ref": "#/components/schemas/LabelMonetaryAccount"
},
"description": {
"type": "string",
"description": "The description of the inquiry.",
"readOnly": false,
"writeOnly": false
},
"attachment": {
"type": "array",
"description": "The attachments attached to the payment.",
"readOnly": false,
"writeOnly": false,
"items": {
"$ref": "#/components/schemas/BunqId"
}
},
"merchant_reference": {
"type": "string",
"description": "The client's custom reference that was attached to the request and the mutation.",
"readOnly": false,
"writeOnly": false
},
"status": {
"type": "string",
"description": "The status of the request.",
"readOnly": false,
"writeOnly": false
},
"minimum_age": {
"type": "integer",
"description": "The minimum age the user accepting the RequestInquiry must have.",
"readOnly": false,
"writeOnly": false
},
"require_address": {
"type": "string",
"description": "Whether or not an address must be provided on accept.",
"readOnly": false,
"writeOnly": false
},
"want_tip": {
"type": "boolean",
"description": "[DEPRECATED] Whether or not the accepting user can give an extra tip on top of the requested Amount. Defaults to false.",
"readOnly": false,
"writeOnly": true
},
"allow_amount_lower": {
"type": "boolean",
"description": "[DEPRECATED] Whether or not the accepting user can choose to accept with a lower amount than requested. Defaults to false.",
"readOnly": false,
"writeOnly": true
},
"allow_amount_higher": {
"type": "boolean",
"description": "[DEPRECATED] Whether or not the accepting user can choose to accept with a higher amount than requested. Defaults to false.",
"readOnly": false,
"writeOnly": true
},
"allow_bunqme": {
"type": "boolean",
"description": "Whether or not sending a bunq.me request is allowed.",
"readOnly": false,
"writeOnly": true
},
"redirect_url": {
"type": "string",
"description": "The URL which the user is sent to after accepting or rejecting the Request.",
"readOnly": false,
"writeOnly": false
},
"event_id": {
"type": "integer",
"description": "The ID of the associated event if the request was made using 'split the bill'.",
"readOnly": false,
"writeOnly": true
},
"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_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"
},
"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
},
"bunqme_share_url": {
"type": "string",
"description": "The url that points to the bunq.me 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"
}
},
"required": [
"allow_bunqme"
]
}