Payment Auto Allocate

post

Manage a users automatic payment auto allocated settings.

Path parameters
userIDintegerRequired
monetary-accountIDintegerRequired
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
payment_idintegerWrite-onlyRequired

The payment that should be used to define the triggers for the payment auto allocate.

typestringRequired

Whether a payment should be sorted ONCE or RECURRING.

Responses
200
Manage a users automatic payment auto allocated settings.
application/json
post
POST /v1/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "payment_id": 1,
  "type": "text",
  "definition": [
    {
      "type": "text",
      "counterparty_alias": {
        "type": "text",
        "value": "text",
        "name": "text",
        "service": "text"
      },
      "description": "text",
      "amount": {
        "value": "text",
        "currency": "text"
      },
      "fraction": 1
    }
  ]
}
{
  "Id": {
    "id": 1
  }
}
get

Manage a users automatic payment auto allocated settings.

Path parameters
userIDintegerRequired
monetary-accountIDintegerRequired
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
200
Manage a users automatic payment auto allocated settings.
application/json
get
GET /v1/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*
[
  {
    "id": 1,
    "created": "text",
    "updated": "text",
    "type": "text",
    "status": "text",
    "trigger_amount": {
      "value": "text",
      "currency": "text"
    },
    "payment": {
      "amount": {
        "value": "text",
        "currency": "text"
      },
      "counterparty_alias": {
        "iban": "text",
        "display_name": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "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"
        },
        "country": "text",
        "bunq_me": {
          "type": "text",
          "value": "text",
          "name": "text"
        },
        "is_light": true,
        "swift_bic": "text",
        "swift_account_number": "text",
        "transferwise_account_number": "text",
        "transferwise_bank_code": "text",
        "merchant_category_code": "text"
      },
      "description": "text",
      "attachment": [
        {
          "id": 1,
          "monetary_account_id": 1
        }
      ],
      "merchant_reference": "text",
      "id": 1,
      "created": "text",
      "updated": "text",
      "monetary_account_id": 1,
      "alias": {
        "iban": "text",
        "display_name": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "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"
        },
        "country": "text",
        "bunq_me": {
          "type": "text",
          "value": "text",
          "name": "text"
        },
        "is_light": true,
        "swift_bic": "text",
        "swift_account_number": "text",
        "transferwise_account_number": "text",
        "transferwise_bank_code": "text",
        "merchant_category_code": "text"
      },
      "type": "text",
      "sub_type": "text",
      "payment_arrival_expected": {
        "status": "text",
        "time": "text"
      },
      "bunqto_status": "text",
      "bunqto_sub_status": "text",
      "bunqto_share_url": "text",
      "bunqto_expiry": "text",
      "bunqto_time_responded": "text",
      "batch_id": 1,
      "scheduled_id": 1,
      "address_shipping": {
        "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_billing": {
        "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
      },
      "geolocation": {
        "latitude": 1,
        "longitude": 1,
        "altitude": 1,
        "radius": 1
      },
      "request_reference_split_the_bill": [
        {
          "type": "text",
          "id": 1
        }
      ],
      "balance_after_mutation": {
        "value": "text",
        "currency": "text"
      },
      "payment_auto_allocate_instance": {
        "id": 1,
        "created": "text",
        "updated": "text",
        "payment_auto_allocate_id": 1,
        "status": "text",
        "error_message": [
          [
            {
              "error_description": "text",
              "error_description_translated": "text"
            }
          ]
        ],
        "payment_batch": {
          "payments": {
            "Payment": "[Circular Reference]"
          }
        },
        "payment_id": 1,
        "all_ginmon_transaction_order": [
          {
            "status": "text",
            "status_description": "text",
            "status_description_translated": "text",
            "amount_billing": {
              "value": "text",
              "currency": "text"
            },
            "amount_billing_original": {
              "value": "text",
              "currency": "text"
            },
            "isin": "text",
            "external_identifier": "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"
            },
            "label_monetary_account": {
              "iban": "text",
              "display_name": "text",
              "avatar": {
                "uuid": "text",
                "anchor_uuid": "text",
                "image": [
                  {
                    "attachment_public_uuid": "text",
                    "content_type": "text",
                    "height": 1,
                    "width": 1
                  }
                ],
                "style": "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"
              },
              "country": "text",
              "bunq_me": {
                "type": "text",
                "value": "text",
                "name": "text"
              },
              "is_light": true,
              "swift_bic": "text",
              "swift_account_number": "text",
              "transferwise_account_number": "text",
              "transferwise_bank_code": "text",
              "merchant_category_code": "text"
            },
            "counter_label_monetary_account": {
              "iban": "text",
              "display_name": "text",
              "avatar": {
                "uuid": "text",
                "anchor_uuid": "text",
                "image": [
                  {
                    "attachment_public_uuid": "text",
                    "content_type": "text",
                    "height": 1,
                    "width": 1
                  }
                ],
                "style": "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"
              },
              "country": "text",
              "bunq_me": {
                "type": "text",
                "value": "text",
                "name": "text"
              },
              "is_light": true,
              "swift_bic": "text",
              "swift_account_number": "text",
              "transferwise_account_number": "text",
              "transferwise_bank_code": "text",
              "merchant_category_code": "text"
            },
            "event_id": 1
          }
        ]
      },
      "payment_suspended_outgoing": {
        "status": "text",
        "monetary_account_id": "text",
        "time_execution": "text"
      },
      "payment_fee": {
        "value": "text",
        "currency": "text",
        "invoice_id": 1
      }
    },
    "payment_original": {
      "amount": {
        "value": "text",
        "currency": "text"
      },
      "counterparty_alias": {
        "iban": "text",
        "display_name": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "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"
        },
        "country": "text",
        "bunq_me": {
          "type": "text",
          "value": "text",
          "name": "text"
        },
        "is_light": true,
        "swift_bic": "text",
        "swift_account_number": "text",
        "transferwise_account_number": "text",
        "transferwise_bank_code": "text",
        "merchant_category_code": "text"
      },
      "description": "text",
      "attachment": [
        {
          "id": 1,
          "monetary_account_id": 1
        }
      ],
      "merchant_reference": "text",
      "id": 1,
      "created": "text",
      "updated": "text",
      "monetary_account_id": 1,
      "alias": {
        "iban": "text",
        "display_name": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "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"
        },
        "country": "text",
        "bunq_me": {
          "type": "text",
          "value": "text",
          "name": "text"
        },
        "is_light": true,
        "swift_bic": "text",
        "swift_account_number": "text",
        "transferwise_account_number": "text",
        "transferwise_bank_code": "text",
        "merchant_category_code": "text"
      },
      "type": "text",
      "sub_type": "text",
      "payment_arrival_expected": {
        "status": "text",
        "time": "text"
      },
      "bunqto_status": "text",
      "bunqto_sub_status": "text",
      "bunqto_share_url": "text",
      "bunqto_expiry": "text",
      "bunqto_time_responded": "text",
      "batch_id": 1,
      "scheduled_id": 1,
      "address_shipping": {
        "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_billing": {
        "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
      },
      "geolocation": {
        "latitude": 1,
        "longitude": 1,
        "altitude": 1,
        "radius": 1
      },
      "request_reference_split_the_bill": [
        {
          "type": "text",
          "id": 1
        }
      ],
      "balance_after_mutation": {
        "value": "text",
        "currency": "text"
      },
      "payment_auto_allocate_instance": {
        "id": 1,
        "created": "text",
        "updated": "text",
        "payment_auto_allocate_id": 1,
        "status": "text",
        "error_message": [
          [
            {
              "error_description": "text",
              "error_description_translated": "text"
            }
          ]
        ],
        "payment_batch": {
          "payments": {
            "Payment": "[Circular Reference]"
          }
        },
        "payment_id": 1,
        "all_ginmon_transaction_order": [
          {
            "status": "text",
            "status_description": "text",
            "status_description_translated": "text",
            "amount_billing": {
              "value": "text",
              "currency": "text"
            },
            "amount_billing_original": {
              "value": "text",
              "currency": "text"
            },
            "isin": "text",
            "external_identifier": "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"
            },
            "label_monetary_account": {
              "iban": "text",
              "display_name": "text",
              "avatar": {
                "uuid": "text",
                "anchor_uuid": "text",
                "image": [
                  {
                    "attachment_public_uuid": "text",
                    "content_type": "text",
                    "height": 1,
                    "width": 1
                  }
                ],
                "style": "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"
              },
              "country": "text",
              "bunq_me": {
                "type": "text",
                "value": "text",
                "name": "text"
              },
              "is_light": true,
              "swift_bic": "text",
              "swift_account_number": "text",
              "transferwise_account_number": "text",
              "transferwise_bank_code": "text",
              "merchant_category_code": "text"
            },
            "counter_label_monetary_account": {
              "iban": "text",
              "display_name": "text",
              "avatar": {
                "uuid": "text",
                "anchor_uuid": "text",
                "image": [
                  {
                    "attachment_public_uuid": "text",
                    "content_type": "text",
                    "height": 1,
                    "width": 1
                  }
                ],
                "style": "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"
              },
              "country": "text",
              "bunq_me": {
                "type": "text",
                "value": "text",
                "name": "text"
              },
              "is_light": true,
              "swift_bic": "text",
              "swift_account_number": "text",
              "transferwise_account_number": "text",
              "transferwise_bank_code": "text",
              "merchant_category_code": "text"
            },
            "event_id": 1
          }
        ]
      },
      "payment_suspended_outgoing": {
        "status": "text",
        "monetary_account_id": "text",
        "time_execution": "text"
      },
      "payment_fee": {
        "value": "text",
        "currency": "text",
        "invoice_id": 1
      }
    },
    "payment_latest": {
      "amount": {
        "value": "text",
        "currency": "text"
      },
      "counterparty_alias": {
        "iban": "text",
        "display_name": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "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"
        },
        "country": "text",
        "bunq_me": {
          "type": "text",
          "value": "text",
          "name": "text"
        },
        "is_light": true,
        "swift_bic": "text",
        "swift_account_number": "text",
        "transferwise_account_number": "text",
        "transferwise_bank_code": "text",
        "merchant_category_code": "text"
      },
      "description": "text",
      "attachment": [
        {
          "id": 1,
          "monetary_account_id": 1
        }
      ],
      "merchant_reference": "text",
      "id": 1,
      "created": "text",
      "updated": "text",
      "monetary_account_id": 1,
      "alias": {
        "iban": "text",
        "display_name": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "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"
        },
        "country": "text",
        "bunq_me": {
          "type": "text",
          "value": "text",
          "name": "text"
        },
        "is_light": true,
        "swift_bic": "text",
        "swift_account_number": "text",
        "transferwise_account_number": "text",
        "transferwise_bank_code": "text",
        "merchant_category_code": "text"
      },
      "type": "text",
      "sub_type": "text",
      "payment_arrival_expected": {
        "status": "text",
        "time": "text"
      },
      "bunqto_status": "text",
      "bunqto_sub_status": "text",
      "bunqto_share_url": "text",
      "bunqto_expiry": "text",
      "bunqto_time_responded": "text",
      "batch_id": 1,
      "scheduled_id": 1,
      "address_shipping": {
        "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_billing": {
        "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
      },
      "geolocation": {
        "latitude": 1,
        "longitude": 1,
        "altitude": 1,
        "radius": 1
      },
      "request_reference_split_the_bill": [
        {
          "type": "text",
          "id": 1
        }
      ],
      "balance_after_mutation": {
        "value": "text",
        "currency": "text"
      },
      "payment_auto_allocate_instance": {
        "id": 1,
        "created": "text",
        "updated": "text",
        "payment_auto_allocate_id": 1,
        "status": "text",
        "error_message": [
          [
            {
              "error_description": "text",
              "error_description_translated": "text"
            }
          ]
        ],
        "payment_batch": {
          "payments": {
            "Payment": "[Circular Reference]"
          }
        },
        "payment_id": 1,
        "all_ginmon_transaction_order": [
          {
            "status": "text",
            "status_description": "text",
            "status_description_translated": "text",
            "amount_billing": {
              "value": "text",
              "currency": "text"
            },
            "amount_billing_original": {
              "value": "text",
              "currency": "text"
            },
            "isin": "text",
            "external_identifier": "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"
            },
            "label_monetary_account": {
              "iban": "text",
              "display_name": "text",
              "avatar": {
                "uuid": "text",
                "anchor_uuid": "text",
                "image": [
                  {
                    "attachment_public_uuid": "text",
                    "content_type": "text",
                    "height": 1,
                    "width": 1
                  }
                ],
                "style": "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"
              },
              "country": "text",
              "bunq_me": {
                "type": "text",
                "value": "text",
                "name": "text"
              },
              "is_light": true,
              "swift_bic": "text",
              "swift_account_number": "text",
              "transferwise_account_number": "text",
              "transferwise_bank_code": "text",
              "merchant_category_code": "text"
            },
            "counter_label_monetary_account": {
              "iban": "text",
              "display_name": "text",
              "avatar": {
                "uuid": "text",
                "anchor_uuid": "text",
                "image": [
                  {
                    "attachment_public_uuid": "text",
                    "content_type": "text",
                    "height": 1,
                    "width": 1
                  }
                ],
                "style": "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"
              },
              "country": "text",
              "bunq_me": {
                "type": "text",
                "value": "text",
                "name": "text"
              },
              "is_light": true,
              "swift_bic": "text",
              "swift_account_number": "text",
              "transferwise_account_number": "text",
              "transferwise_bank_code": "text",
              "merchant_category_code": "text"
            },
            "event_id": 1
          }
        ]
      },
      "payment_suspended_outgoing": {
        "status": "text",
        "monetary_account_id": "text",
        "time_execution": "text"
      },
      "payment_fee": {
        "value": "text",
        "currency": "text",
        "invoice_id": 1
      }
    }
  }
]
get

List all the definitions in a payment auto allocate.

Path parameters
userIDintegerRequired
monetary-accountIDintegerRequired
payment-auto-allocateIDintegerRequired
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
200
List all the definitions in a payment auto allocate.
application/json
get
GET /v1/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{payment-auto-allocateID}/definition HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*
[
  {
    "id": 1,
    "created": "text",
    "updated": "text",
    "counterparty_alias": {
      "type": "text",
      "value": "text",
      "name": "text"
    },
    "description": "text",
    "amount": {
      "value": "text",
      "currency": "text"
    },
    "fraction": 1
  }
]
put

Manage a users automatic payment auto allocated settings.

Path parameters
userIDintegerRequired
monetary-accountIDintegerRequired
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

Body
payment_idintegerWrite-onlyRequired

The payment that should be used to define the triggers for the payment auto allocate.

typestringRequired

Whether a payment should be sorted ONCE or RECURRING.

Responses
200
Manage a users automatic payment auto allocated settings.
application/json
put
PUT /v1/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{itemId} HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "payment_id": 1,
  "type": "text",
  "definition": [
    {
      "type": "text",
      "counterparty_alias": {
        "type": "text",
        "value": "text",
        "name": "text",
        "service": "text"
      },
      "description": "text",
      "amount": {
        "value": "text",
        "currency": "text"
      },
      "fraction": 1
    }
  ]
}
{
  "Id": {
    "id": 1
  }
}
delete

Manage a users automatic payment auto allocated settings.

Path parameters
userIDintegerRequired
monetary-accountIDintegerRequired
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
200
Manage a users automatic payment auto allocated settings.
application/json
Responseobject
delete
DELETE /v1/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{itemId} HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*
{}
get

List a users automatic payment auto allocated settings.

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

Responses
200
List a users automatic payment auto allocated settings.
application/json
get
GET /v1/user/{userID}/payment-auto-allocate HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*
[
  {
    "PaymentAutoAllocate": {
      "type": "text"
    }
  }
]

Last updated

Was this helpful?