> For the complete documentation index, see [llms.txt](https://partner.doc.bunq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://partner.doc.bunq.com/documentation/bunq-as-a-service/chapter-5-payments/payment-links.md).
# Payment Links
## Create bunq.me Tab
> Create a bunq.me tab: a shareable payment request link for a provisioned user's\
> monetary account. The response includes a \`bunqme\_tab\_share\_url\` that anyone can open\
> to pay the inquired amount.\
> \
> \*\*Payment method:\*\*\
> \- By default the payer can choose any available top-up method.\
> \- Set \`payment\_method\` to restrict the link to a single method (for example \`IDEAL\`,\
> which is cheaper than the alternatives). The payer then sees only that method.\
> \- \`payment\_method\` is set on creation only and cannot be changed afterwards.
```json
{"openapi":"3.1.0","info":{"title":"bunq Partner API","version":"1.0.0"},"tags":[{"name":"bunq.me Management","description":"Create and manage bunq.me payment request tabs for provisioned users"}],"servers":[{"url":"https://partner-api.sandbox.bunq.com","description":"Sandbox Partner API Server"},{"url":"https://api.partner.bunq.com","description":"Production Partner API Server"}],"security":[{"SessionAuth":[]},{"ClientSignature":[]}],"components":{"securitySchemes":{"SessionAuth":{"type":"apiKey","in":"header","name":"X-Bunq-Client-Authentication","description":"Session token received from POST /session-server"},"ClientSignature":{"type":"apiKey","in":"header","name":"X-Bunq-Client-Signature","description":"HMAC-SHA256 signature of request body using private key"}},"parameters":{"CacheControl":{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},"UserAgent":{"name":"User-Agent","in":"header","required":false,"schema":{"type":"string"}},"BunqLanguage":{"name":"X-Bunq-Language","in":"header","required":false,"schema":{"type":"string","default":"en_US"}},"BunqRegion":{"name":"X-Bunq-Region","in":"header","required":false,"schema":{"type":"string","default":"NL"}},"BunqGeolocation":{"name":"X-Bunq-Geolocation","in":"header","required":false,"schema":{"type":"string"}},"BunqClientRequestId":{"name":"X-Bunq-Client-Request-Id","in":"header","required":false,"schema":{"type":"string"}},"BunqClientAuthentication":{"name":"X-Bunq-Client-Authentication","in":"header","required":true,"schema":{"type":"string","description":"Session token from POST /session-server"}},"BunqClientSignature":{"name":"X-Bunq-Client-Signature","in":"header","required":true,"schema":{"type":"string","description":"HMAC-SHA256 signature of request"}}},"schemas":{"Id":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the created resource"}}},"Error":{"type":"object","properties":{"Error":{"type":"array","items":{"type":"object","properties":{"error_description":{"type":"string"},"error_description_translated":{"type":"string"}}}}}}}},"paths":{"/user/{userId}/monetary-account/{accountId}/bunqme-tab":{"post":{"tags":["bunq.me Management"],"summary":"Create bunq.me Tab","description":"Create a bunq.me tab: a shareable payment request link for a provisioned user's\nmonetary account. The response includes a `bunqme_tab_share_url` that anyone can open\nto pay the inquired amount.\n\n**Payment method:**\n- By default the payer can choose any available top-up method.\n- Set `payment_method` to restrict the link to a single method (for example `IDEAL`,\n which is cheaper than the alternatives). The payer then sees only that method.\n- `payment_method` is set on creation only and cannot be changed afterwards.\n","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer"},"description":"ID of the provisioned user."},{"name":"accountId","in":"path","required":true,"schema":{"type":"integer"},"description":"ID of the monetary account the tab collects into."},{"$ref":"#/components/parameters/CacheControl"},{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/BunqLanguage"},{"$ref":"#/components/parameters/BunqRegion"},{"$ref":"#/components/parameters/BunqGeolocation"},{"$ref":"#/components/parameters/BunqClientRequestId"},{"$ref":"#/components/parameters/BunqClientAuthentication"},{"$ref":"#/components/parameters/BunqClientSignature"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bunqme_tab_entry"],"properties":{"bunqme_tab_entry":{"type":"object","description":"The details of the payment request shown to the payer.","required":["amount_inquired","description"],"properties":{"amount_inquired":{"type":"object","description":"The amount the payer is requested to pay.","required":["value","currency"],"properties":{"value":{"type":"string","description":"Amount in decimal format."},"currency":{"type":"string","description":"ISO 4217 currency code."}}},"description":{"type":"string","description":"Description of the payment request shown to the payer."},"redirect_url":{"type":"string","description":"Optional URL the payer is redirected to after paying."}}},"payment_method":{"type":"string","description":"The only top-up method the payer may use (for example `IDEAL`). When omitted,\nall available top-up methods are offered. Cannot be changed after creation.\n"}}}}}},"responses":{"200":{"description":"bunq.me tab created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"Response":{"type":"array","items":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"}}}}}}}}},"400":{"description":"Bad request - invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```
## List bunq.me Tabs
> List all bunq.me tabs for a provisioned user's monetary account.
```json
{"openapi":"3.1.0","info":{"title":"bunq Partner API","version":"1.0.0"},"tags":[{"name":"bunq.me Management","description":"Create and manage bunq.me payment request tabs for provisioned users"}],"servers":[{"url":"https://partner-api.sandbox.bunq.com","description":"Sandbox Partner API Server"},{"url":"https://api.partner.bunq.com","description":"Production Partner API Server"}],"security":[{"SessionAuth":[]},{"ClientSignature":[]}],"components":{"securitySchemes":{"SessionAuth":{"type":"apiKey","in":"header","name":"X-Bunq-Client-Authentication","description":"Session token received from POST /session-server"},"ClientSignature":{"type":"apiKey","in":"header","name":"X-Bunq-Client-Signature","description":"HMAC-SHA256 signature of request body using private key"}},"parameters":{"CacheControl":{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},"UserAgent":{"name":"User-Agent","in":"header","required":false,"schema":{"type":"string"}},"BunqLanguage":{"name":"X-Bunq-Language","in":"header","required":false,"schema":{"type":"string","default":"en_US"}},"BunqRegion":{"name":"X-Bunq-Region","in":"header","required":false,"schema":{"type":"string","default":"NL"}},"BunqGeolocation":{"name":"X-Bunq-Geolocation","in":"header","required":false,"schema":{"type":"string"}},"BunqClientRequestId":{"name":"X-Bunq-Client-Request-Id","in":"header","required":false,"schema":{"type":"string"}},"BunqClientAuthentication":{"name":"X-Bunq-Client-Authentication","in":"header","required":true,"schema":{"type":"string","description":"Session token from POST /session-server"}},"BunqClientSignature":{"name":"X-Bunq-Client-Signature","in":"header","required":true,"schema":{"type":"string","description":"HMAC-SHA256 signature of request"}}},"schemas":{"BunqMeTab":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the bunq.me tab."},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"time_expiry":{"type":"string","format":"date-time","description":"When the bunq.me tab expires."},"monetary_account_id":{"type":"integer","description":"The monetary account the tab collects into."},"status":{"type":"string","enum":["WAITING_FOR_PAYMENT","CANCELLED","EXPIRED"],"description":"Current status of the bunq.me tab."},"type":{"type":"string"},"bunqme_tab_share_url":{"type":"string","description":"The shareable URL the payer opens to pay."},"payment_method":{"type":["string","null"],"description":"The only top-up method the payer may use (for example `IDEAL`). Null when all\navailable top-up methods are offered.\n"},"event_id":{"type":["integer","null"],"description":"The ID of the latest event for the bunq.me tab."}}},"Pagination":{"type":"object","properties":{"future_url":{"type":["string","null"],"description":"URL to poll for results newer than the current real-time window (useful for long-polling; null if not applicable)."},"newer_url":{"type":["string","null"],"description":"URL to fetch the next newer page relative to the current result set (null if at newest page)."},"older_url":{"type":["string","null"],"description":"URL to fetch an older page (null if none)."}}}}},"paths":{"/user/{userId}/monetary-account/{accountId}/bunqme-tab":{"get":{"tags":["bunq.me Management"],"summary":"List bunq.me Tabs","description":"List all bunq.me tabs for a provisioned user's monetary account.","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer"},"description":"ID of the provisioned user."},{"name":"accountId","in":"path","required":true,"schema":{"type":"integer"},"description":"ID of the monetary account."},{"$ref":"#/components/parameters/CacheControl"},{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/BunqLanguage"},{"$ref":"#/components/parameters/BunqRegion"},{"$ref":"#/components/parameters/BunqGeolocation"},{"$ref":"#/components/parameters/BunqClientRequestId"},{"$ref":"#/components/parameters/BunqClientAuthentication"},{"$ref":"#/components/parameters/BunqClientSignature"}],"responses":{"200":{"description":"List of bunq.me tabs for the account","content":{"application/json":{"schema":{"type":"object","properties":{"Response":{"type":"array","items":{"type":"object","properties":{"BunqMeTab":{"$ref":"#/components/schemas/BunqMeTab"}}}},"Pagination":{"$ref":"#/components/schemas/Pagination"}}}}}}}}}}}
```
## Get bunq.me Tab
> Get the details of a specific bunq.me tab, including its share URL and status.
```json
{"openapi":"3.1.0","info":{"title":"bunq Partner API","version":"1.0.0"},"tags":[{"name":"bunq.me Management","description":"Create and manage bunq.me payment request tabs for provisioned users"}],"servers":[{"url":"https://partner-api.sandbox.bunq.com","description":"Sandbox Partner API Server"},{"url":"https://api.partner.bunq.com","description":"Production Partner API Server"}],"security":[{"SessionAuth":[]},{"ClientSignature":[]}],"components":{"securitySchemes":{"SessionAuth":{"type":"apiKey","in":"header","name":"X-Bunq-Client-Authentication","description":"Session token received from POST /session-server"},"ClientSignature":{"type":"apiKey","in":"header","name":"X-Bunq-Client-Signature","description":"HMAC-SHA256 signature of request body using private key"}},"parameters":{"CacheControl":{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},"UserAgent":{"name":"User-Agent","in":"header","required":false,"schema":{"type":"string"}},"BunqLanguage":{"name":"X-Bunq-Language","in":"header","required":false,"schema":{"type":"string","default":"en_US"}},"BunqRegion":{"name":"X-Bunq-Region","in":"header","required":false,"schema":{"type":"string","default":"NL"}},"BunqGeolocation":{"name":"X-Bunq-Geolocation","in":"header","required":false,"schema":{"type":"string"}},"BunqClientRequestId":{"name":"X-Bunq-Client-Request-Id","in":"header","required":false,"schema":{"type":"string"}},"BunqClientAuthentication":{"name":"X-Bunq-Client-Authentication","in":"header","required":true,"schema":{"type":"string","description":"Session token from POST /session-server"}},"BunqClientSignature":{"name":"X-Bunq-Client-Signature","in":"header","required":true,"schema":{"type":"string","description":"HMAC-SHA256 signature of request"}}},"schemas":{"BunqMeTab":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the bunq.me tab."},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"time_expiry":{"type":"string","format":"date-time","description":"When the bunq.me tab expires."},"monetary_account_id":{"type":"integer","description":"The monetary account the tab collects into."},"status":{"type":"string","enum":["WAITING_FOR_PAYMENT","CANCELLED","EXPIRED"],"description":"Current status of the bunq.me tab."},"type":{"type":"string"},"bunqme_tab_share_url":{"type":"string","description":"The shareable URL the payer opens to pay."},"payment_method":{"type":["string","null"],"description":"The only top-up method the payer may use (for example `IDEAL`). Null when all\navailable top-up methods are offered.\n"},"event_id":{"type":["integer","null"],"description":"The ID of the latest event for the bunq.me tab."}}},"Error":{"type":"object","properties":{"Error":{"type":"array","items":{"type":"object","properties":{"error_description":{"type":"string"},"error_description_translated":{"type":"string"}}}}}}}},"paths":{"/user/{userId}/monetary-account/{accountId}/bunqme-tab/{itemId}":{"get":{"tags":["bunq.me Management"],"summary":"Get bunq.me Tab","description":"Get the details of a specific bunq.me tab, including its share URL and status.","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer"},"description":"ID of the provisioned user."},{"name":"accountId","in":"path","required":true,"schema":{"type":"integer"},"description":"ID of the monetary account."},{"name":"itemId","in":"path","required":true,"schema":{"type":"integer"},"description":"ID of the bunq.me tab."},{"$ref":"#/components/parameters/CacheControl"},{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/BunqLanguage"},{"$ref":"#/components/parameters/BunqRegion"},{"$ref":"#/components/parameters/BunqGeolocation"},{"$ref":"#/components/parameters/BunqClientRequestId"},{"$ref":"#/components/parameters/BunqClientAuthentication"},{"$ref":"#/components/parameters/BunqClientSignature"}],"responses":{"200":{"description":"bunq.me tab details","content":{"application/json":{"schema":{"type":"object","properties":{"Response":{"type":"array","items":{"type":"object","properties":{"BunqMeTab":{"$ref":"#/components/schemas/BunqMeTab"}}}}}}}}},"404":{"description":"bunq.me tab not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```
## Update bunq.me Tab
> Update a bunq.me tab. Typically used to close an open tab by setting \`status\` to\
> \`CANCELLED\`. The \`payment\_method\` cannot be changed after creation.
```json
{"openapi":"3.1.0","info":{"title":"bunq Partner API","version":"1.0.0"},"tags":[{"name":"bunq.me Management","description":"Create and manage bunq.me payment request tabs for provisioned users"}],"servers":[{"url":"https://partner-api.sandbox.bunq.com","description":"Sandbox Partner API Server"},{"url":"https://api.partner.bunq.com","description":"Production Partner API Server"}],"security":[{"SessionAuth":[]},{"ClientSignature":[]}],"components":{"securitySchemes":{"SessionAuth":{"type":"apiKey","in":"header","name":"X-Bunq-Client-Authentication","description":"Session token received from POST /session-server"},"ClientSignature":{"type":"apiKey","in":"header","name":"X-Bunq-Client-Signature","description":"HMAC-SHA256 signature of request body using private key"}},"parameters":{"CacheControl":{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},"UserAgent":{"name":"User-Agent","in":"header","required":false,"schema":{"type":"string"}},"BunqLanguage":{"name":"X-Bunq-Language","in":"header","required":false,"schema":{"type":"string","default":"en_US"}},"BunqRegion":{"name":"X-Bunq-Region","in":"header","required":false,"schema":{"type":"string","default":"NL"}},"BunqGeolocation":{"name":"X-Bunq-Geolocation","in":"header","required":false,"schema":{"type":"string"}},"BunqClientRequestId":{"name":"X-Bunq-Client-Request-Id","in":"header","required":false,"schema":{"type":"string"}},"BunqClientAuthentication":{"name":"X-Bunq-Client-Authentication","in":"header","required":true,"schema":{"type":"string","description":"Session token from POST /session-server"}},"BunqClientSignature":{"name":"X-Bunq-Client-Signature","in":"header","required":true,"schema":{"type":"string","description":"HMAC-SHA256 signature of request"}}},"schemas":{"Id":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the created resource"}}},"Error":{"type":"object","properties":{"Error":{"type":"array","items":{"type":"object","properties":{"error_description":{"type":"string"},"error_description_translated":{"type":"string"}}}}}}}},"paths":{"/user/{userId}/monetary-account/{accountId}/bunqme-tab/{itemId}":{"put":{"tags":["bunq.me Management"],"summary":"Update bunq.me Tab","description":"Update a bunq.me tab. Typically used to close an open tab by setting `status` to\n`CANCELLED`. The `payment_method` cannot be changed after creation.\n","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer"},"description":"ID of the provisioned user."},{"name":"accountId","in":"path","required":true,"schema":{"type":"integer"},"description":"ID of the monetary account."},{"name":"itemId","in":"path","required":true,"schema":{"type":"integer"},"description":"ID of the bunq.me tab."},{"$ref":"#/components/parameters/CacheControl"},{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/BunqLanguage"},{"$ref":"#/components/parameters/BunqRegion"},{"$ref":"#/components/parameters/BunqGeolocation"},{"$ref":"#/components/parameters/BunqClientRequestId"},{"$ref":"#/components/parameters/BunqClientAuthentication"},{"$ref":"#/components/parameters/BunqClientSignature"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["WAITING_FOR_PAYMENT","CANCELLED"],"description":"New status of the bunq.me tab. Set to `CANCELLED` to close it."}}}}}},"responses":{"200":{"description":"bunq.me tab updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"Response":{"type":"array","items":{"type":"object","properties":{"Id":{"$ref":"#/components/schemas/Id"}}}}}}}}},"400":{"description":"Bad request - invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```