Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-134807111.3 MB
card

Return the details of a specific card.

get/user/{userID}/card/{itemId}

Path parameters

userIDinteger required
itemIdinteger required

Headers

Cache-Controlstring

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

User-Agentstring required

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-Languagestring

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-Regionstring

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-Idstring

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-Geolocationstring

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-Authenticationstring required

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

Response

Endpoint for retrieving details for the cards the user has access to.

idinteger

The id of the card.

createdstring

The timestamp of the card's creation.

updatedstring

The timestamp of the card's last update.

public_uuidstring

The public UUID of the card.

user_idinteger

DEPRECATED. ID of the user who is owner of the card.

user_owner_idinteger

ID of the user who is owner of the card.

user_holder_idinteger

ID of the user who is holder of the card.

typestring

The type of the card. Can be MAESTRO, MASTERCARD.

sub_typestring

The sub-type of the card.

product_typestring

The product type of the card.

product_sub_typestring

The product sub-type of the card.

first_linestring

The first line of text on the card

second_linestring

The second line of text on the card

statusstring

The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN, CANCELLED, EXPIRED or PIN_TRIES_EXCEEDED.

sub_statusstring

The sub-status of the card. Can be NONE or REPLACED.

order_statusstring

The order status of the card. Can be NEW_CARD_REQUEST_RECEIVED, CARD_REQUEST_PENDING, SENT_FOR_PRODUCTION, ACCEPTED_FOR_PRODUCTION, DELIVERED_TO_CUSTOMER, CARD_UPDATE_REQUESTED, CARD_UPDATE_PENDING, CARD_UPDATE_SENT, CARD_UPDATE_ACCEPTED, VIRTUAL_DELIVERY, NEW_CARD_REQUEST_PENDING_USER_APPROVAL, SENT_FOR_DELIVERY or NEW_CARD_REQUEST_CANCELLED.

expiry_datestring

Expiry date of the card.

name_on_cardstring

The user's name on the card.

preferred_name_on_cardstring

The user's preferred name on the card.

payment_account_referencestring

The payment account reference number associated with the card.

monetary_account_id_fallbackinteger

ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied.

countrystring

The country that is domestic to the card. Defaults to country of residence of user.

card_shipment_tracking_urlstring

A tracking link provided by our shipment provider.

is_card_eligible_for_free_replacementboolean

Whether this card is eligible for a free replacement.

is_limited_editionboolean

Whether this card is a limited edition metal card.

card_metal_member_since_datestring

The date for the member since field on the black metal card.