Skip to main content
POST
Create a debtor
This page documents a frozen v1 API. It receives only critical correctness or security corrections. For new integrations, use the current API and follow the linked migration guide.
If data stored on your paywise account or company profile is invalid, this endpoint answers 400 with a non_field_errors entry rather than a server error. The most common cause is an invalid contact email address on the paywise user your API token belongs to. Nothing is stored; correct the data in paywise and repeat the request unchanged.

Autorisierungen

Authorization
string
header
erforderlich

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

Body

acting_as
erforderlich

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
Verfügbare Optionen:
consumer,
business
addresses
object[]
erforderlich
your_reference
string | null
Maximum string 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[]

Antwort

201 - application/json
href
string<uri>
erforderlich
read-only
acting_as
erforderlich

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
Verfügbare Optionen:
consumer,
business
addresses
object[]
erforderlich
created
string<date-time>
erforderlich
read-only
updated
string<date-time>
erforderlich
read-only
id
string
your_reference
string | null
Maximum string 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[]