Bunq · Schema

RequestResponse

Banking

Properties

Name Type Description
amount_responded object The Amount the RequestResponse was accepted with.
status string The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED.
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.
currency_conversion_quote_id integer When the request is accepted on a monetary account with a different currency, a quote is expected to convert.
id integer The id of the Request Response.
created string The timestamp when the Request Response was created.
updated string The timestamp when the Request Response was last updated (will be updated when chat messages are received).
time_responded string The timestamp of when the RequestResponse was responded to.
time_expiry string The timestamp of when the RequestResponse expired or will expire.
time_refund_requested string The timestamp of when a refund request for the RequestResponse was claimed.
time_refunded string The timestamp of when the RequestResponse was refunded.
user_refund_requested object The label of the user that requested the refund.
monetary_account_id integer The id of the MonetaryAccount the RequestResponse was received on.
amount_inquired object The requested Amount.
description string The description for the RequestResponse provided by the requesting party. Maximum 9000 characters.
alias object The LabelMonetaryAccount with the public information of the MonetaryAccount this RequestResponse was received on.
counterparty_alias object The LabelMonetaryAccount with the public information of the MonetaryAccount that is requesting money with this RequestResponse.
attachment array The Attachments attached to the RequestResponse.
minimum_age integer The minimum age the user accepting the RequestResponse must have.
require_address string Whether or not an address must be provided on accept.
geolocation object The Geolocation where the RequestResponse was created.
type string The type of the RequestInquiry. Can be DIRECT_DEBIT, DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL.
sub_type string The subtype of the RequestInquiry. Can be ONCE or RECURRING for DIRECT_DEBIT RequestInquiries and NONE for all other.
redirect_url string The URL which the user is sent to after accepting or rejecting the Request.
credit_scheme_identifier string The credit scheme id provided by the counterparty for DIRECT_DEBIT inquiries.
mandate_identifier string The mandate id provided by the counterparty for DIRECT_DEBIT inquiries.
eligible_whitelist_id integer The whitelist id for this action or null.
request_reference_split_the_bill array The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch
event_id integer The ID of the latest event for the request.
monetary_account_preferred_id integer The ID of the monetary account this user prefers to pay the request from.
View JSON Schema on GitHub

JSON Schema

bunq-requestresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RequestResponse",
  "title": "RequestResponse",
  "type": "object",
  "properties": {
    "amount_responded": {
      "type": "object",
      "description": "The Amount the RequestResponse was accepted with.",
      "readOnly": false,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "status": {
      "type": "string",
      "description": "The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED.",
      "readOnly": false,
      "writeOnly": false
    },
    "address_shipping": {
      "type": "object",
      "description": "The shipping address provided by the accepting user if an address was requested.",
      "readOnly": false,
      "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": false,
      "writeOnly": false,
      "$ref": "#/components/schemas/Address"
    },
    "currency_conversion_quote_id": {
      "type": "integer",
      "description": "When the request is accepted on a monetary account with a different currency, a quote is expected to convert.",
      "readOnly": false,
      "writeOnly": true
    },
    "id": {
      "type": "integer",
      "description": "The id of the Request Response.",
      "readOnly": true,
      "writeOnly": false
    },
    "created": {
      "type": "string",
      "description": "The timestamp when the Request Response was created.",
      "readOnly": true,
      "writeOnly": false
    },
    "updated": {
      "type": "string",
      "description": "The timestamp when the Request Response was last updated (will be updated when chat messages are received).",
      "readOnly": true,
      "writeOnly": false
    },
    "time_responded": {
      "type": "string",
      "description": "The timestamp of when the RequestResponse was responded to.",
      "readOnly": true,
      "writeOnly": false
    },
    "time_expiry": {
      "type": "string",
      "description": "The timestamp of when the RequestResponse expired or will expire.",
      "readOnly": true,
      "writeOnly": false
    },
    "time_refund_requested": {
      "type": "string",
      "description": "The timestamp of when a refund request for the RequestResponse was claimed.",
      "readOnly": true,
      "writeOnly": false
    },
    "time_refunded": {
      "type": "string",
      "description": "The timestamp of when the RequestResponse was refunded.",
      "readOnly": true,
      "writeOnly": false
    },
    "user_refund_requested": {
      "type": "object",
      "description": "The label of the user that requested the refund.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/LabelUser"
    },
    "monetary_account_id": {
      "type": "integer",
      "description": "The id of the MonetaryAccount the RequestResponse was received on.",
      "readOnly": true,
      "writeOnly": false
    },
    "amount_inquired": {
      "type": "object",
      "description": "The requested Amount.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "description": {
      "type": "string",
      "description": "The description for the RequestResponse provided by the requesting party. Maximum 9000 characters.",
      "readOnly": true,
      "writeOnly": false
    },
    "alias": {
      "type": "object",
      "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount this RequestResponse was received on.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/LabelMonetaryAccount"
    },
    "counterparty_alias": {
      "type": "object",
      "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount that is requesting money with this RequestResponse.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/LabelMonetaryAccount"
    },
    "attachment": {
      "type": "array",
      "description": "The Attachments attached to the RequestResponse.",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/Attachment"
      }
    },
    "minimum_age": {
      "type": "integer",
      "description": "The minimum age the user accepting the RequestResponse 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
    },
    "geolocation": {
      "type": "object",
      "description": "The Geolocation where the RequestResponse was created.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Geolocation"
    },
    "type": {
      "type": "string",
      "description": "The type of the RequestInquiry. Can be DIRECT_DEBIT, DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL.",
      "readOnly": true,
      "writeOnly": false
    },
    "sub_type": {
      "type": "string",
      "description": "The subtype of the RequestInquiry. Can be ONCE or RECURRING for DIRECT_DEBIT RequestInquiries and NONE for all other.",
      "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
    },
    "credit_scheme_identifier": {
      "type": "string",
      "description": "The credit scheme id provided by the counterparty for DIRECT_DEBIT inquiries.",
      "readOnly": true,
      "writeOnly": false
    },
    "mandate_identifier": {
      "type": "string",
      "description": "The mandate id provided by the counterparty for DIRECT_DEBIT inquiries.",
      "readOnly": true,
      "writeOnly": false
    },
    "eligible_whitelist_id": {
      "type": "integer",
      "description": "The whitelist id for this action or null.",
      "readOnly": true,
      "writeOnly": false
    },
    "request_reference_split_the_bill": {
      "type": "array",
      "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/RequestInquiryReference"
      }
    },
    "event_id": {
      "type": "integer",
      "description": "The ID of the latest event for the request.",
      "readOnly": true,
      "writeOnly": false
    },
    "monetary_account_preferred_id": {
      "type": "integer",
      "description": "The ID of the monetary account this user prefers to pay the request from.",
      "readOnly": true,
      "writeOnly": false
    }
  }
}