Currency cloud Benificiairy | bunq API Documentation

bunq API Documentation

Postman Collection

get

Endpoint to manage CurrencyCloud beneficiaries.

Path parameters

userIDintegerRequired

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

GET /v1/user/{userID}/currency-cloud-beneficiary/{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",
  "name": "text",
  "account_number": "text",
  "currency": "text",
  "external_identifier": "text"
}

get

Endpoint to manage CurrencyCloud beneficiaries.

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

X-Bunq-RegionstringOptional

X-Bunq-Client-Request-IdstringOptional

X-Bunq-GeolocationstringOptional

X-Bunq-Client-AuthenticationstringRequired

Responses

get

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

[
  {
    "id": 1,
    "created": "text",
    "updated": "text",
    "name": "text",
    "account_number": "text",
    "currency": "text",
    "external_identifier": "text"
  }
]

get

Endpoint to list requirements for CurrencyCloud beneficiaries.

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

X-Bunq-RegionstringOptional

X-Bunq-Client-Request-IdstringOptional

X-Bunq-GeolocationstringOptional

X-Bunq-Client-AuthenticationstringRequired

Responses

get

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

[
  {
    "payment_type": "text",
    "legal_entity_type": "text",
    "all_field": [
      {
        "label": "text",
        "name": "text",
        "validation_expression": "text",
        "input_type": "text"
      }
    ]
  }
]

post

Endpoint to manage CurrencyCloud beneficiaries.

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

X-Bunq-RegionstringOptional

X-Bunq-Client-Request-IdstringOptional

X-Bunq-GeolocationstringOptional

X-Bunq-Client-AuthenticationstringRequired

Body

namestringRequired

The name of the beneficiary.

countrystringWrite-onlyRequired

The country of the beneficiary.

currencystringRequired

The currency of the beneficiary.

payment_typestringWrite-onlyRequired

The payment type this requirement is for.

legal_entity_typestringWrite-onlyRequired

The legal entity type of the beneficiary.

all_fieldstring[]Write-onlyRequired

All fields that were required by CurrencyCloud. Obtained through the CurrencyCloudBeneficiaryRequirement listing.

Responses

post

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

{
  "name": "text",
  "country": "text",
  "currency": "text",
  "payment_type": "text",
  "legal_entity_type": "text",
  "all_field": [
    "text"
  ]
}

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