Skip to main content
POST
/
v1
/
debtors
/
{id}
/
communicationchannels
/
Add debtor Communication Channel
curl --request POST \
  --url https://api.paywise.de/v1/debtors/{id}/communicationchannels/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "email",
  "value": "<string>"
}'
{
  "href": "<string>",
  "id": "<string>",
  "your_reference": "<string>",
  "person": {
    "salutation": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "birth_date": "2023-12-25",
    "death_date": "2023-12-25"
  },
  "organization": {
    "name": "<string>"
  },
  "acting_as": "consumer",
  "addresses": [
    {
      "street": "<string>",
      "zip": "<string>",
      "city": "<string>",
      "country": "AF"
    }
  ],
  "communication_channels": [
    {
      "type": "email",
      "value": "<string>"
    }
  ],
  "bank_accounts": [
    {
      "iban": "<string>",
      "bic": "<string>"
    }
  ],
  "metadata": [
    {
      "type": "user:reference",
      "value": "<string>"
    }
  ],
  "events": [
    {
      "type": "registration",
      "title": "<string>",
      "occurence": "2023-11-07T05:31:56Z",
      "your_reference": "<string>",
      "description": "<string>",
      "location": "<string>"
    }
  ],
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

​
type
enum<string>
required
  • email - E-Mail
  • phone - Telefon
  • mobile_phone - Mobiltelefon
  • fax - Fax
  • skype - Skype
  • facebook_messenger - Facebook Messenger
  • imessage - iMessage
  • whatsapp - WhatAapp
  • facebook - Facebook
  • twitter - Twitter
  • linkedin - Linkedin
  • xing - Xing
  • social_various - Anderes Social Medium
  • website_url - Website URL
  • web_various - Andere Web-Quelle
Available options:
email,
phone,
mobile_phone,
fax,
skype,
facebook_messenger,
imessage,
whatsapp,
facebook,
twitter,
linkedin,
xing,
social_various,
website_url,
web_various
​
value
string
required
Required string length: 1 - 255

Response

201 - application/json
​
href
string<uri>
required
​
acting_as
required

Tell us if the debtor is either a consumer or a business/other organization. Single-person-business debtors must have the value business

  • consumer - Verbraucher
  • business - Unternehmer
Available options:
consumer,
business
​
addresses
object[]
required
​
created
string<date-time>
required
​
updated
string<date-time>
required
​
id
string
​
your_reference
string | null
Maximum length: 255
​
person
object

If the debtor is a natural person or a single-person-business please provide this object. In case of a single-person-business, please set acting_as to business

​
organization
object

If the debtor is an organization (no single-person-business), please provide this object. For single-person-business debtors see the person field.

​
communication_channels
object[]
​
bank_accounts
object[]
​
metadata
object[]
​
events
object[]