LOloket
Payment information

change the details of a payment information sepa

Activity name : <a href="https://developer.loket.nl/Activities/PutPaymentInformationSepaByPaymentInformationSepaId" target="_blank">PutPaymentInformationSepaByPaymentInformationSepaId</a>

Edit an existing SEPA payment-record (for an employment). For each unique payroll component there can only be one payment record per employment. Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL

put/v2/providers/employers/employees/employments/paymentinformationsepa/{paymentInformationSepaId}

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/paymentinformationsepa/{paymentInformationSepaId}
  • Auth
    none required

Path parameters

paymentInformationSepaIdstring uuid required

The unique identifier of the SEPA payment record

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

ibanstring

International Bank Account Number (IBAN). Only IBAN without spaces are accepted.

bicstring nullable

BIC /SWIFT code. Only applicable for a non-Dutch IBAN

visibleOnPayslipboolean

Indicates whether the payment-component is visible on a payslip.

nameBeneficiarystring nullable

Name of beneficiary.

cityBeneficiarystring nullable

City name of beneficiary.

description1string nullable

Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.

description2string nullable

Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "payrollComponent": {
    "key": 260,
    "value": "NETTOLOON"
  },
  "iban": "NL52ABNA0424968264",
  "bic": "AUDFDE21",
  "visibleOnPayslip": true,
  "nameBeneficiary": "Ben Hur",
  "cityBeneficiary": "Rome",
  "description1": "xx",
  "description2": "x"
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "payrollComponent": {
      "key": 260,
      "value": "NETTOLOON"
    },
    "iban": "NL52ABNA0424968264",
    "bic": "AUDFDE21",
    "visibleOnPayslip": true,
    "nameBeneficiary": "Ben Hur",
    "cityBeneficiary": "Rome",
    "description1": "xx",
    "description2": "x"
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.