API Endpoints/Identities

Create bank account for identity by identityReference

Authorization

AuthorizationBasic <token>

Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.Example: Authorization: Basic ZGVtbzpwQDU1dzByZA==

In: header

Path Parameters

identityReferencestring

Your identityReference

Header Parameters

Idempotency-Key?string

Set this optional header to the same value for idempotent requests. If the request is repeated with the same idempotency key, the server will return the same response as for the first request. Our servers retain the idempotency key and their result for 24 hours after the initial request, if not defined otherwise in your Abillify contract.

Request Body

account?string

IBAN Account number

bankcode?string

BIC of bank

holder?string

Name of the account holder

reference?string

For direct debit: Mandate reference number

validfrom?string

Valid from date-time, leave empty if no predefined validity start exists. RFC3339 date-time https://www.rfc-editor.org/rfc/rfc3339#section-5.6 effectively ISO8601.

Formatdate-time

validto?string

Valid to date-time, leave empty if no predefined validity end exists. RFC3339 date-time https://www.rfc-editor.org/rfc/rfc3339#section-5.6 effectively ISO8601.

Formatdate-time

Response Body

curl -X POST "https://staging1.abillify.dev/api/identities/string/bankaccount" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  -d '{}'

const body = JSON.stringify({})

fetch("https://staging1.abillify.dev/api/identities/string/bankaccount", {
  headers: {
    "Idempotency-Key": "string"
  },
  body
})

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://staging1.abillify.dev/api/identities/string/bankaccount"
  body := strings.NewReader(`{}`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Idempotency-Key", "string")
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://staging1.abillify.dev/api/identities/string/bankaccount"
body = {}
response = requests.request("POST", url, json = body, headers = {
  "Idempotency-Key": "string",
  "Content-Type": "application/json"
})

print(response.text)

{
  "account": "DE123456781234565",
  "bank": "Bank of Foo",
  "bankcode": "DEUTDE2HXXX",
  "holder": "John Doe",
  "id": "123456789",
  "reference": "M1234567890",
  "validfrom": "2025-01-31T00:00:00Z",
  "validto": "2025-12-31T00:00:00Z"
}

{
  "code": 400,
  "details": [
    {
      "error": "Value for field 'debtor' is of wrong type, expected bigint.",
      "fields": [
        "debtor"
      ],
      "hint": "Value must be a number or a string containing only a number."
    }
  ],
  "message": "InvalidValue, see error details",
  "name": "ClientError",
  "type": "ERR_INVALID_VALUE"
}

{
  "code": 400,
  "details": [
    {
      "error": "Value for field 'debtor' is of wrong type, expected bigint.",
      "fields": [
        "debtor"
      ],
      "hint": "Value must be a number or a string containing only a number."
    }
  ],
  "message": "InvalidValue, see error details",
  "name": "ClientError",
  "type": "ERR_INVALID_VALUE"
}

Create identities POST

Previous Page

Create creditnote for identity by identityReference POST

This will create a creditnote assigned to the given identity. The `netbased` flag is used to determine if the invoice should be calculated with net prices or gross prices. If `netbased` is set to `true`, the prices will be calculated with net prices. If `netbased` is set to `false`, the prices will be calculated with gross prices. The `paymentkind` is used to determine the payment method. The following payment methods are available: - `CT` - Credit Transfer - `DD` - Direct Debit - `CC` - Credit Card - `PP` - PayPal - `IN` - Invoice - `OT` - Other The `items` array contains the items of the invoice. Each item must have a `label`, `quantity`, `unit`, `unitprice`, and `detail` field. The `detail` field is an object that can contain additional information about the item, if tax jurisdiction is used this should contain the items `taxprofile`. The `addresses` array contains the addresses of the invoice. Each address must have a `kind`, `firstname`, `lastname`, `street`, `housenumber`, `zipcode`, `city`, and `country` field. The `extra` field is optional and can be used to provide additional information about the address.