Request Response

PreviousRequest Inquiry Batch NextSandbox Users

Last updated 2 months ago

Was this helpful?

get

Get all RequestResponses for a MonetaryAccount.

Path parameters

userIDintegerRequired

monetary-accountIDintegerRequired

Header parameters

Cache-ControlstringOptional

The standard HTTP Cache-Control header is required for all signed requests.

User-AgentstringRequired

The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.

X-Bunq-LanguagestringOptional

The X-Bunq-Language header must contain a preferred language indication. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. Currently only the languages en_US and nl_NL are supported. Anything else will default to en_US.

X-Bunq-RegionstringOptional

The X-Bunq-Region header must contain the region (country) of the client device. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.

X-Bunq-Client-Request-IdstringOptional

This header must specify an ID with each request that is unique for the logged in user. There are no restrictions for the format of this ID. However, the server will respond with an error when the same ID is used again on the same DeviceServer.

X-Bunq-GeolocationstringOptional

This header must specify the geolocation of the device. The format of this value is longitude latitude altitude radius country. The country is expected to be formatted of an ISO 3166-1 alpha-2 country code. When no geolocation is available or known the header must still be included but can be zero valued.

X-Bunq-Client-AuthenticationstringRequired

The authentication token is used to authenticate the source of the API call. It is required by all API calls except for POST /v1/installation. It is important to note that the device and session calls are using the token from the response of the installation call, while all the other calls use the token from the response of the session-server call

Responses

200

A RequestResponse is what a user on the other side of a RequestInquiry gets when he is sent one. So a RequestInquiry is the initiator and visible for the user that sent it and that wants to receive the money. A RequestResponse is what the other side sees, i.e. the user that pays the money to accept the request. The content is almost identical.

application/json

400

This is how the error response looks like for 4XX response codes

application/json

get

GET /v1/user/{userID}/monetary-account/{monetary-accountID}/request-response HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*

[
  {
    "id": 1,
    "created": "text",
    "updated": "text",
    "time_responded": "text",
    "time_expiry": "text",
    "time_refund_requested": "text",
    "time_refunded": "text",
    "user_refund_requested": {
      "uuid": "text",
      "display_name": "text",
      "country": "text",
      "avatar": {
        "uuid": "text",
        "anchor_uuid": "text",
        "image": [
          {
            "attachment_public_uuid": "text",
            "content_type": "text",
            "height": 1,
            "width": 1
          }
        ],
        "style": "text"
      },
      "public_nick_name": "text"
    },
    "monetary_account_id": 1,
    "amount_inquired": {
      "value": "text",
      "currency": "text"
    },
    "amount_responded": {
      "value": "text",
      "currency": "text"
    },
    "status": "text",
    "description": "text",
    "alias": {
      "iban": "text",
      "display_name": "text",
      "avatar": {
        "uuid": "text",
        "anchor_uuid": "text",
        "image": [
          {
            "attachment_public_uuid": "text",
            "content_type": "text",
            "height": 1,
            "width": 1
          }
        ],
        "style": "text"
      },
      "label_user": {
        "uuid": "text",
        "display_name": "text",
        "country": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "text"
        },
        "public_nick_name": "text"
      },
      "country": "text",
      "bunq_me": {
        "type": "text",
        "value": "text",
        "name": "text"
      },
      "is_light": true,
      "swift_bic": "text",
      "swift_account_number": "text",
      "transferwise_account_number": "text",
      "transferwise_bank_code": "text",
      "merchant_category_code": "text"
    },
    "counterparty_alias": {
      "iban": "text",
      "display_name": "text",
      "avatar": {
        "uuid": "text",
        "anchor_uuid": "text",
        "image": [
          {
            "attachment_public_uuid": "text",
            "content_type": "text",
            "height": 1,
            "width": 1
          }
        ],
        "style": "text"
      },
      "label_user": {
        "uuid": "text",
        "display_name": "text",
        "country": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "text"
        },
        "public_nick_name": "text"
      },
      "country": "text",
      "bunq_me": {
        "type": "text",
        "value": "text",
        "name": "text"
      },
      "is_light": true,
      "swift_bic": "text",
      "swift_account_number": "text",
      "transferwise_account_number": "text",
      "transferwise_bank_code": "text",
      "merchant_category_code": "text"
    },
    "attachment": [
      {
        "description": "text",
        "content_type": "text",
        "urls": [
          {
            "type": "text",
            "url": "text"
          }
        ]
      }
    ],
    "minimum_age": 1,
    "require_address": "text",
    "geolocation": {
      "latitude": 1,
      "longitude": 1,
      "altitude": 1,
      "radius": 1
    },
    "type": "text",
    "sub_type": "text",
    "redirect_url": "text",
    "address_billing": {
      "street": "text",
      "house_number": "text",
      "po_box": "text",
      "postal_code": "text",
      "city": "text",
      "country": "text",
      "extra": "text",
      "mailbox_name": "text",
      "province": "text",
      "is_user_address_updated": true
    },
    "address_shipping": {
      "street": "text",
      "house_number": "text",
      "po_box": "text",
      "postal_code": "text",
      "city": "text",
      "country": "text",
      "extra": "text",
      "mailbox_name": "text",
      "province": "text",
      "is_user_address_updated": true
    },
    "credit_scheme_identifier": "text",
    "mandate_identifier": "text",
    "registration_action": "text",
    "eligible_whitelist_id": 1,
    "request_reference_split_the_bill": [
      {
        "type": "text",
        "id": 1
      }
    ],
    "event_id": 1,
    "monetary_account_preferred_id": 1
  }
]

get

Get the details for a specific existing RequestResponse.

Path parameters

userIDintegerRequired

monetary-accountIDintegerRequired

itemIdintegerRequired

Header parameters

Cache-ControlstringOptional

The standard HTTP Cache-Control header is required for all signed requests.

User-AgentstringRequired

The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.

X-Bunq-LanguagestringOptional

X-Bunq-RegionstringOptional

X-Bunq-Client-Request-IdstringOptional

X-Bunq-GeolocationstringOptional

X-Bunq-Client-AuthenticationstringRequired

Responses

200

application/json

400

This is how the error response looks like for 4XX response codes

application/json

get

GET /v1/user/{userID}/monetary-account/{monetary-accountID}/request-response/{itemId} HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*

{
  "id": 1,
  "created": "text",
  "updated": "text",
  "time_responded": "text",
  "time_expiry": "text",
  "time_refund_requested": "text",
  "time_refunded": "text",
  "user_refund_requested": {
    "uuid": "text",
    "display_name": "text",
    "country": "text",
    "avatar": {
      "uuid": "text",
      "anchor_uuid": "text",
      "image": [
        {
          "attachment_public_uuid": "text",
          "content_type": "text",
          "height": 1,
          "width": 1
        }
      ],
      "style": "text"
    },
    "public_nick_name": "text"
  },
  "monetary_account_id": 1,
  "amount_inquired": {
    "value": "text",
    "currency": "text"
  },
  "amount_responded": {
    "value": "text",
    "currency": "text"
  },
  "status": "text",
  "description": "text",
  "alias": {
    "iban": "text",
    "display_name": "text",
    "avatar": {
      "uuid": "text",
      "anchor_uuid": "text",
      "image": [
        {
          "attachment_public_uuid": "text",
          "content_type": "text",
          "height": 1,
          "width": 1
        }
      ],
      "style": "text"
    },
    "label_user": {
      "uuid": "text",
      "display_name": "text",
      "country": "text",
      "avatar": {
        "uuid": "text",
        "anchor_uuid": "text",
        "image": [
          {
            "attachment_public_uuid": "text",
            "content_type": "text",
            "height": 1,
            "width": 1
          }
        ],
        "style": "text"
      },
      "public_nick_name": "text"
    },
    "country": "text",
    "bunq_me": {
      "type": "text",
      "value": "text",
      "name": "text"
    },
    "is_light": true,
    "swift_bic": "text",
    "swift_account_number": "text",
    "transferwise_account_number": "text",
    "transferwise_bank_code": "text",
    "merchant_category_code": "text"
  },
  "counterparty_alias": {
    "iban": "text",
    "display_name": "text",
    "avatar": {
      "uuid": "text",
      "anchor_uuid": "text",
      "image": [
        {
          "attachment_public_uuid": "text",
          "content_type": "text",
          "height": 1,
          "width": 1
        }
      ],
      "style": "text"
    },
    "label_user": {
      "uuid": "text",
      "display_name": "text",
      "country": "text",
      "avatar": {
        "uuid": "text",
        "anchor_uuid": "text",
        "image": [
          {
            "attachment_public_uuid": "text",
            "content_type": "text",
            "height": 1,
            "width": 1
          }
        ],
        "style": "text"
      },
      "public_nick_name": "text"
    },
    "country": "text",
    "bunq_me": {
      "type": "text",
      "value": "text",
      "name": "text"
    },
    "is_light": true,
    "swift_bic": "text",
    "swift_account_number": "text",
    "transferwise_account_number": "text",
    "transferwise_bank_code": "text",
    "merchant_category_code": "text"
  },
  "attachment": [
    {
      "description": "text",
      "content_type": "text",
      "urls": [
        {
          "type": "text",
          "url": "text"
        }
      ]
    }
  ],
  "minimum_age": 1,
  "require_address": "text",
  "geolocation": {
    "latitude": 1,
    "longitude": 1,
    "altitude": 1,
    "radius": 1
  },
  "type": "text",
  "sub_type": "text",
  "redirect_url": "text",
  "address_billing": {
    "street": "text",
    "house_number": "text",
    "po_box": "text",
    "postal_code": "text",
    "city": "text",
    "country": "text",
    "extra": "text",
    "mailbox_name": "text",
    "province": "text",
    "is_user_address_updated": true
  },
  "address_shipping": {
    "street": "text",
    "house_number": "text",
    "po_box": "text",
    "postal_code": "text",
    "city": "text",
    "country": "text",
    "extra": "text",
    "mailbox_name": "text",
    "province": "text",
    "is_user_address_updated": true
  },
  "credit_scheme_identifier": "text",
  "mandate_identifier": "text",
  "registration_action": "text",
  "eligible_whitelist_id": 1,
  "request_reference_split_the_bill": [
    {
      "type": "text",
      "id": 1
    }
  ],
  "event_id": 1,
  "monetary_account_preferred_id": 1
}

put

Update the status to accept or reject the RequestResponse.

Path parameters

userIDintegerRequired

monetary-accountIDintegerRequired

itemIdintegerRequired

Header parameters

Cache-ControlstringOptional

The standard HTTP Cache-Control header is required for all signed requests.

User-AgentstringRequired

The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.

X-Bunq-LanguagestringOptional

X-Bunq-RegionstringOptional

X-Bunq-Client-Request-IdstringOptional

X-Bunq-GeolocationstringOptional

X-Bunq-Client-AuthenticationstringRequired

Body

statusstringOptional

The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED.

currency_conversion_quote_idintegerWrite-onlyOptional

When the request is accepted on a monetary account with a different currency, a quote is expected to convert.

idintegerRead-onlyOptional

The id of the Request Response.

createdstringRead-onlyOptional

The timestamp when the Request Response was created.

updatedstringRead-onlyOptional

The timestamp when the Request Response was last updated (will be updated when chat messages are received).

time_respondedstringRead-onlyOptional

The timestamp of when the RequestResponse was responded to.

time_expirystringRead-onlyOptional

The timestamp of when the RequestResponse expired or will expire.

time_refund_requestedstringRead-onlyOptional

The timestamp of when a refund request for the RequestResponse was claimed.

time_refundedstringRead-onlyOptional

The timestamp of when the RequestResponse was refunded.

monetary_account_idintegerRead-onlyOptional

The id of the MonetaryAccount the RequestResponse was received on.

descriptionstringRead-onlyOptional

The description for the RequestResponse provided by the requesting party. Maximum 9000 characters.

minimum_ageintegerRead-onlyOptional

The minimum age the user accepting the RequestResponse must have.

require_addressstringRead-onlyOptional

Whether or not an address must be provided on accept.

typestringRead-onlyOptional

The type of the RequestInquiry. Can be DIRECT_DEBIT, DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL.

sub_typestringRead-onlyOptional

The subtype of the RequestInquiry. Can be ONCE or RECURRING for DIRECT_DEBIT RequestInquiries and NONE for all other.

redirect_urlstringRead-onlyOptional

The URL which the user is sent to after accepting or rejecting the Request.

credit_scheme_identifierstringRead-onlyOptional

The credit scheme id provided by the counterparty for DIRECT_DEBIT inquiries.

mandate_identifierstringRead-onlyOptional

The mandate id provided by the counterparty for DIRECT_DEBIT inquiries.

registration_actionstringRead-onlyOptional

Recommended registration action after IdealIssuerTransaction from iDEAL issuer transaction.

eligible_whitelist_idintegerRead-onlyOptional

The whitelist id for this action or null.

event_idintegerRead-onlyOptional

The ID of the latest event for the request.

monetary_account_preferred_idintegerRead-onlyOptional

The ID of the monetary account this user prefers to pay the request from.

Responses

200

application/json

400

This is how the error response looks like for 4XX response codes

application/json

put

PUT /v1/user/{userID}/monetary-account/{monetary-accountID}/request-response/{itemId} HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 431

{
  "amount_responded": {
    "value": "text",
    "currency": "text"
  },
  "status": "text",
  "address_shipping": {
    "street": "text",
    "house_number": "text",
    "po_box": "text",
    "postal_code": "text",
    "city": "text",
    "country": "text",
    "extra": "text",
    "mailbox_name": "text"
  },
  "address_billing": {
    "street": "text",
    "house_number": "text",
    "po_box": "text",
    "postal_code": "text",
    "city": "text",
    "country": "text",
    "extra": "text",
    "mailbox_name": "text"
  },
  "currency_conversion_quote_id": 1
}

{
  "Id": {
    "id": 1
  }
}