Payment Initiation Service Provider (PISP)

Heya! Before checking this page, make sure that you registered yourself as a TPP in our API first.

As a PISP, you are allowed to authenticate in a user’s account with the following permissions:

1. read account information:

   • legal name;

   • IBAN;

2. initiate draft payments and read their statuses;

3. confirm that the account balance is sufficient for covering the payment.

The bunq API provides endpoints for different scenarios of the implementation of the payment initiation functionality. In particular, as a PISP user, you can build applications that initiate and authorize one-off or multiple incoming payments. Depending on the use case you are intending to deploy, you might need to initiate the OAuth authorization either before or after the payment initiation.

Authorization of multiple (scheduled) payments

It is possible to initiate payments from a bunq user's account having previously established an OAuth connection between your application and the bunq user's account. The bunq user will receive push notifications for each initiated payment.

Once a bunq user has confirmed they want to make payments via your application, you can initiate the payment confirmation flow.

1. Create a draft payment via POST /user/{userID}/monetary-account/{monetary-accountID}/draft-payment

   passing the following parameters:

   1. monetary-accountId and userId (userApiKey's id; see OAuth for more information) in the endpoint URL;

   2. the customer’s email address, phone number, or IBAN in the counterparty_alias field of the request body.

2. If the user confirms their intent to make the payment, bunq carries out the transaction.

3. Check the status of the payment via GET /user/{userID}/monetary-account/{monetary-accountID}/draft-payment

   using the draft payment id parameter returned in the previous step.

Single payment authorization

It is possible to initiate payments having only the IBAN of the payer using POST /user/{userID}/payment-service-provider-draft-payment. In this case, the bunq user will accept the payment along with the authorization request. No additional push notifications are sent to the user.

1. Collect the bunq user's IBAN (and name) in the UI of your application.

2. Create a draft payment via POST /user/{userID}/payment-service-provider-draft-payment.

3. Initiate an authorization request. Upon the QR-code scan, the bunq user will see and be able to either accept or reject the payment authorization request.
4. Check the status of the payment.

Get the end user information

You can get the user information by sending a calling the following endpoint with the user_id

If you have an open session on behalf of the user, just call GET /v1/user (with no user_id) to retrieve their info.

get

Get a specific user.

Path parameters

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

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

get

HTTPcURLJavaScriptPython

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

{
  "UserPerson": {
    "first_name": "text",
    "middle_name": "text",
    "last_name": "text",
    "public_nick_name": "text",
    "address_main": {
      "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_postal": {
      "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
    },
    "tax_resident": [
      {
        "country": "text",
        "tax_number": "text",
        "status": "text",
        "id": 1
      }
    ],
    "date_of_birth": "text",
    "nationality": "text",
    "all_nationality": [
      "text"
    ],
    "language": "text",
    "region": "text",
    "gender": "text",
    "status": "text",
    "sub_status": "text",
    "session_timeout": 1,
    "daily_limit_without_confirmation_login": {
      "value": "text",
      "currency": "text"
    },
    "display_name": "text",
    "id": 1,
    "created": "text",
    "updated": "text",
    "public_uuid": "text",
    "legal_name": "text",
    "alias": [
      {
        "type": "text",
        "value": "text",
        "name": "text"
      }
    ],
    "place_of_birth": "text",
    "country_of_birth": "text",
    "avatar": {
      "uuid": "text",
      "anchor_uuid": "text",
      "image": [
        {
          "attachment_public_uuid": "text",
          "content_type": "text",
          "height": 1,
          "width": 1
        }
      ],
      "style": "text"
    },
    "version_terms_of_service": "text",
    "notification_filters": [
      {
        "notification_delivery_method": "text",
        "notification_target": "text",
        "category": "text"
      }
    ],
    "relations": [
      {
        "user_id": "text",
        "counter_user_id": "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"
        },
        "counter_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"
        },
        "relationship": "text",
        "status": "text",
        "user_status": "text",
        "counter_user_status": "text"
      }
    ]
  },
  "UserCompany": {
    "name": "text",
    "public_nick_name": "text",
    "address_main": {
      "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_postal": {
      "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
    },
    "language": "text",
    "region": "text",
    "country": "text",
    "ubo": [
      {
        "name": "text",
        "date_of_birth": "text",
        "nationality": "text"
      }
    ],
    "chamber_of_commerce_number": "text",
    "legal_form": "text",
    "status": "text",
    "sub_status": "text",
    "session_timeout": 1,
    "daily_limit_without_confirmation_login": {
      "value": "text",
      "currency": "text"
    },
    "id": 1,
    "created": "text",
    "updated": "text",
    "public_uuid": "text",
    "display_name": "text",
    "alias": [
      {
        "type": "text",
        "value": "text",
        "name": "text"
      }
    ],
    "type_of_business_entity": "text",
    "sector_of_industry": "text",
    "counter_bank_iban": "text",
    "avatar": {
      "uuid": "text",
      "anchor_uuid": "text",
      "image": [
        {
          "attachment_public_uuid": "text",
          "content_type": "text",
          "height": 1,
          "width": 1
        }
      ],
      "style": "text"
    },
    "version_terms_of_service": "text",
    "directors": [
      {
        "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"
      }
    ],
    "notification_filters": [
      {
        "notification_delivery_method": "text",
        "notification_target": "text",
        "category": "text"
      }
    ],
    "customer": {
      "billing_account_id": "text",
      "invoice_notification_preference": "text",
      "id": 1,
      "created": "text",
      "updated": "text"
    },
    "customer_limit": {
      "limit_monetary_account": 1,
      "limit_monetary_account_remaining": 1,
      "limit_card_debit_maestro": 1,
      "limit_card_debit_mastercard": 1,
      "limit_card_debit_wildcard": 1,
      "limit_card_wildcard": 1,
      "limit_card_replacement": 1,
      "limit_amount_monthly": {
        "value": "text",
        "currency": "text"
      },
      "spent_amount_monthly": {
        "value": "text",
        "currency": "text"
      }
    },
    "billing_contract": [
      {
        "subscription_type": "text",
        "id": 1,
        "created": "text",
        "updated": "text",
        "contract_date_start": "text",
        "contract_date_end": "text",
        "contract_version": 1,
        "subscription_type_downgrade": "text",
        "status": "text",
        "sub_status": "text"
      }
    ],
    "deny_reason": "text",
    "relations": [
      {
        "user_id": "text",
        "counter_user_id": "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"
        },
        "counter_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"
        },
        "relationship": "text",
        "status": "text",
        "user_status": "text",
        "counter_user_status": "text"
      }
    ],
    "tax_resident": [
      {
        "country": "text",
        "tax_number": "text",
        "status": "text",
        "id": 1
      }
    ]
  },
  "UserApiKey": {
    "id": 1,
    "created": "text",
    "updated": "text",
    "requested_by_user": {
      "UserPerson": {
        "first_name": "text",
        "middle_name": "text",
        "last_name": "text",
        "public_nick_name": "text",
        "address_main": {
          "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_postal": {
          "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
        },
        "tax_resident": [
          {
            "country": "text",
            "tax_number": "text",
            "status": "text",
            "id": 1
          }
        ],
        "date_of_birth": "text",
        "nationality": "text",
        "all_nationality": [
          "text"
        ],
        "language": "text",
        "region": "text",
        "gender": "text",
        "status": "text",
        "sub_status": "text",
        "session_timeout": 1,
        "daily_limit_without_confirmation_login": {
          "value": "text",
          "currency": "text"
        },
        "display_name": "text",
        "id": 1,
        "created": "text",
        "updated": "text",
        "public_uuid": "text",
        "legal_name": "text",
        "alias": [
          {
            "type": "text",
            "value": "text",
            "name": "text"
          }
        ],
        "place_of_birth": "text",
        "country_of_birth": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "text"
        },
        "version_terms_of_service": "text",
        "notification_filters": [
          {
            "notification_delivery_method": "text",
            "notification_target": "text",
            "category": "text"
          }
        ],
        "relations": [
          {
            "user_id": "text",
            "counter_user_id": "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"
            },
            "counter_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"
            },
            "relationship": "text",
            "status": "text",
            "user_status": "text",
            "counter_user_status": "text"
          }
        ]
      },
      "UserCompany": {
        "name": "text",
        "public_nick_name": "text",
        "address_main": {
          "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_postal": {
          "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
        },
        "language": "text",
        "region": "text",
        "country": "text",
        "ubo": [
          {
            "name": "text",
            "date_of_birth": "text",
            "nationality": "text"
          }
        ],
        "chamber_of_commerce_number": "text",
        "legal_form": "text",
        "status": "text",
        "sub_status": "text",
        "session_timeout": 1,
        "daily_limit_without_confirmation_login": {
          "value": "text",
          "currency": "text"
        },
        "id": 1,
        "created": "text",
        "updated": "text",
        "public_uuid": "text",
        "display_name": "text",
        "alias": [
          {
            "type": "text",
            "value": "text",
            "name": "text"
          }
        ],
        "type_of_business_entity": "text",
        "sector_of_industry": "text",
        "counter_bank_iban": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "text"
        },
        "version_terms_of_service": "text",
        "directors": [
          {
            "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"
          }
        ],
        "notification_filters": [
          {
            "notification_delivery_method": "text",
            "notification_target": "text",
            "category": "text"
          }
        ],
        "customer": {
          "billing_account_id": "text",
          "invoice_notification_preference": "text",
          "id": 1,
          "created": "text",
          "updated": "text"
        },
        "customer_limit": {
          "limit_monetary_account": 1,
          "limit_monetary_account_remaining": 1,
          "limit_card_debit_maestro": 1,
          "limit_card_debit_mastercard": 1,
          "limit_card_debit_wildcard": 1,
          "limit_card_wildcard": 1,
          "limit_card_replacement": 1,
          "limit_amount_monthly": {
            "value": "text",
            "currency": "text"
          },
          "spent_amount_monthly": {
            "value": "text",
            "currency": "text"
          }
        },
        "billing_contract": [
          {
            "subscription_type": "text",
            "id": 1,
            "created": "text",
            "updated": "text",
            "contract_date_start": "text",
            "contract_date_end": "text",
            "contract_version": 1,
            "subscription_type_downgrade": "text",
            "status": "text",
            "sub_status": "text"
          }
        ],
        "deny_reason": "text",
        "relations": [
          {
            "user_id": "text",
            "counter_user_id": "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"
            },
            "counter_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"
            },
            "relationship": "text",
            "status": "text",
            "user_status": "text",
            "counter_user_status": "text"
          }
        ],
        "tax_resident": [
          {
            "country": "text",
            "tax_number": "text",
            "status": "text",
            "id": 1
          }
        ]
      },
      "UserPaymentServiceProvider": {
        "id": 1,
        "created": "text",
        "updated": "text",
        "certificate_distinguished_name": "text",
        "alias": [
          {
            "type": "text",
            "value": "text",
            "name": "text"
          }
        ],
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "text"
        },
        "status": "text",
        "sub_status": "text",
        "public_uuid": "text",
        "display_name": "text",
        "public_nick_name": "text",
        "language": "text",
        "region": "text",
        "session_timeout": 1
      }
    },
    "granted_by_user": {
      "UserPerson": {
        "first_name": "text",
        "middle_name": "text",
        "last_name": "text",
        "public_nick_name": "text",
        "address_main": {
          "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_postal": {
          "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
        },
        "tax_resident": [
          {
            "country": "text",
            "tax_number": "text",
            "status": "text",
            "id": 1
          }
        ],
        "date_of_birth": "text",
        "nationality": "text",
        "all_nationality": [
          "text"
        ],
        "language": "text",
        "region": "text",
        "gender": "text",
        "status": "text",
        "sub_status": "text",
        "session_timeout": 1,
        "daily_limit_without_confirmation_login": {
          "value": "text",
          "currency": "text"
        },
        "display_name": "text",
        "id": 1,
        "created": "text",
        "updated": "text",
        "public_uuid": "text",
        "legal_name": "text",
        "alias": [
          {
            "type": "text",
            "value": "text",
            "name": "text"
          }
        ],
        "place_of_birth": "text",
        "country_of_birth": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "text"
        },
        "version_terms_of_service": "text",
        "notification_filters": [
          {
            "notification_delivery_method": "text",
            "notification_target": "text",
            "category": "text"
          }
        ],
        "relations": [
          {
            "user_id": "text",
            "counter_user_id": "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"
            },
            "counter_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"
            },
            "relationship": "text",
            "status": "text",
            "user_status": "text",
            "counter_user_status": "text"
          }
        ]
      },
      "UserCompany": {
        "name": "text",
        "public_nick_name": "text",
        "address_main": {
          "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_postal": {
          "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
        },
        "language": "text",
        "region": "text",
        "country": "text",
        "ubo": [
          {
            "name": "text",
            "date_of_birth": "text",
            "nationality": "text"
          }
        ],
        "chamber_of_commerce_number": "text",
        "legal_form": "text",
        "status": "text",
        "sub_status": "text",
        "session_timeout": 1,
        "daily_limit_without_confirmation_login": {
          "value": "text",
          "currency": "text"
        },
        "id": 1,
        "created": "text",
        "updated": "text",
        "public_uuid": "text",
        "display_name": "text",
        "alias": [
          {
            "type": "text",
            "value": "text",
            "name": "text"
          }
        ],
        "type_of_business_entity": "text",
        "sector_of_industry": "text",
        "counter_bank_iban": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "text"
        },
        "version_terms_of_service": "text",
        "directors": [
          {
            "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"
          }
        ],
        "notification_filters": [
          {
            "notification_delivery_method": "text",
            "notification_target": "text",
            "category": "text"
          }
        ],
        "customer": {
          "billing_account_id": "text",
          "invoice_notification_preference": "text",
          "id": 1,
          "created": "text",
          "updated": "text"
        },
        "customer_limit": {
          "limit_monetary_account": 1,
          "limit_monetary_account_remaining": 1,
          "limit_card_debit_maestro": 1,
          "limit_card_debit_mastercard": 1,
          "limit_card_debit_wildcard": 1,
          "limit_card_wildcard": 1,
          "limit_card_replacement": 1,
          "limit_amount_monthly": {
            "value": "text",
            "currency": "text"
          },
          "spent_amount_monthly": {
            "value": "text",
            "currency": "text"
          }
        },
        "billing_contract": [
          {
            "subscription_type": "text",
            "id": 1,
            "created": "text",
            "updated": "text",
            "contract_date_start": "text",
            "contract_date_end": "text",
            "contract_version": 1,
            "subscription_type_downgrade": "text",
            "status": "text",
            "sub_status": "text"
          }
        ],
        "deny_reason": "text",
        "relations": [
          {
            "user_id": "text",
            "counter_user_id": "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"
            },
            "counter_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"
            },
            "relationship": "text",
            "status": "text",
            "user_status": "text",
            "counter_user_status": "text"
          }
        ],
        "tax_resident": [
          {
            "country": "text",
            "tax_number": "text",
            "status": "text",
            "id": 1
          }
        ]
      },
      "UserPaymentServiceProvider": {
        "id": 1,
        "created": "text",
        "updated": "text",
        "certificate_distinguished_name": "text",
        "alias": [
          {
            "type": "text",
            "value": "text",
            "name": "text"
          }
        ],
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "text"
        },
        "status": "text",
        "sub_status": "text",
        "public_uuid": "text",
        "display_name": "text",
        "public_nick_name": "text",
        "language": "text",
        "region": "text",
        "session_timeout": 1
      }
    }
  },
  "UserPaymentServiceProvider": {
    "id": 1,
    "created": "text",
    "updated": "text",
    "certificate_distinguished_name": "text",
    "alias": [
      {
        "type": "text",
        "value": "text",
        "name": "text"
      }
    ],
    "avatar": {
      "uuid": "text",
      "anchor_uuid": "text",
      "image": [
        {
          "attachment_public_uuid": "text",
          "content_type": "text",
          "height": 1,
          "width": 1
        }
      ],
      "style": "text"
    },
    "status": "text",
    "sub_status": "text",
    "public_uuid": "text",
    "display_name": "text",
    "public_nick_name": "text",
    "language": "text",
    "region": "text",
    "session_timeout": 1
  }
}

Confirm user account funds

You can check the availability of funds via POST /user/{userID}/confirmation-of-funds passing the following information:

• your user_id;

• the amount of money needed for the payment;

• the name of the bunq user and the IBAN of the account (email address or phone number pointing at the user are also possible).

Here the full specs of this endpoint:

post

Used to confirm availability of funds on an account.

Path parameters

userIDintegerRequired

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

Body

Responses

post

HTTPcURLJavaScriptPython

POST /v1/user/{userID}/confirmation-of-funds HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "pointer_iban": {
    "type": "text",
    "value": "text",
    "name": "text",
    "service": "text"
  },
  "amount": {
    "value": "text",
    "currency": "text"
  }
}

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