---
title: "POST /user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate"
method: POST
path: "/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate"
tags: ["payment-auto-allocate"]
---

# POST /user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate

`POST /user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate`

## Request

- Base URL: `https://public-api.sandbox.bunq.com/v1`
- URL: `https://public-api.sandbox.bunq.com/v1/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate`
- Auth: none declared. Required headers: `User-Agent`, `X-Bunq-Client-Authentication`

Manage a users automatic payment auto allocated settings.

## Path parameters

- `userID` integer, required
- `monetary-accountID` integer, required

## Headers

- `Cache-Control` string
- `User-Agent` string, required
- `X-Bunq-Language` string
- `X-Bunq-Region` string
- `X-Bunq-Client-Request-Id` string
- `X-Bunq-Geolocation` string
- `X-Bunq-Client-Authentication` string, required

## Request body

- PaymentAutoAllocate
  - `payment_id` integer, required: The payment that should be used to define the triggers for the payment auto allocate.
  - `type` string, required: Whether a payment should be sorted ONCE or RECURRING.
  - `definition` PaymentAutoAllocateDefinition[], required: The definition of how the money should be allocated.
    - `type` string, required: The type of definition.
    - `counterparty_alias` Pointer
      - `type` string: The alias type, can be: EMAIL|PHONE_NUMBER|IBAN.
      - `value` string: The alias value.
      - `name` string: The alias name.
      - `service` string: The pointer service. Only required for external counterparties.
    - `description` string: The description for the payment.
    - `amount` Amount
      - `value` string: The amount formatted to two decimal places.
      - `currency` string: The currency of the amount. It is an ISO 4217 formatted currency code.
    - `fraction` integer: The percentage of the triggering payment's amount to allocate.
    - `id` integer: The id of the PaymentAutoAllocateDefinition.
    - `created` string: The timestamp when the PaymentAutoAllocateDefinition was created.
    - `updated` string: The timestamp when the PaymentAutoAllocateDefinition was last updated.

## Response `200`

Manage a users automatic payment auto allocated settings.

- PaymentAutoAllocateCreate
  - `Id` BunqId
    - `id` integer: An integer ID of an object. Unique per object type.

## Other responses

- `400`: This is how the error response looks like for 4XX response codes

## Changes

- **2024-12-11** `e80b8853e0f0`: 1 warning
  - removed the request property `definition/items/ginmon_cost_disclosure_id`
- **2024-11-27** `a3778193f9d4`: 1 info
  - added the new optional request property `definition/items/ginmon_cost_disclosure_id`

[Operation history](https://skmtc.dev/bunq/apis/bunq-api/changes/user/:userID/monetary-account/:monetary-accountID/payment-auto-allocate/post.md)

---

[API](https://skmtc.dev/bunq/apis/bunq-api.md) - [All operations](https://skmtc.dev/bunq/apis/bunq-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bunq/apis/bunq-api/revisions/369477c7bd26?raw)