Organization

In Pliant an organization is a business that has a contractual relationship with us.

Data Model

FieldTypeDescription
organizationIduuid An identifier for the organization, unique to the company
namestringName of the organization as recorded in our system
statusstringThe current state of the organization:
ONBOARDING_STARTED
ONBOARDING_RISK_AND_COMPLIANCE
ONBOARDING_MANDATES_AND_TERMS
ACTIVE
DEACTIVATED
CANCELLED
syncTypestringType of Integration
FULL (all transactions synced)
PARTIAL (conditional syncing)
integrationTypestringA constant that evaluates to CUSTOMER.
creditLimitobjectAn array in regard to the overall limit for the current payment period of your organization (for all cards) containing
value (decimal) in EUR Cents
currency (string)
availableLimitobjectAn array in regard to the currently available amount for the current payment period of the organization (for all cards) containing
value (decimal) in EUR Cents
currency (string)
cardsAccountobjectAn array containing the creditor account as well as the payment account containing
number (string)
type (string)

There are two types available:
CREDITOR_ACCOUNT
PAYMENT_ACCOUNT
tradeNamestringThe name of the organization that is used to be printed on the cards if the company name is too long.
legalFormstringThe legal form of the organization
foundationDatedate-timeThe foundation date of the organization
countrystringThe county where the organization is located
accountTypestringIndicates if the organization does have a credit line at Pliant or simply tops up money that can then be spent with credit cards.

There are two types available:
CREDIT
PREFUNDED
partnersOrganizationIdstringOnce an organization is referred by a partner this indicates the id of the organization in partner's backend
paymentFrequencystringFrequency of credit card bill payments

There are multiple frequencies available:
DAILY
WEEKLY
BI_WEEKLY
MONTHLY
PREFUNDED
nationalRegisterCourtstringNational register court
nationalRegisterIdstringNational register ID
nationalRegisterTypestringNational register Type
tradeRegisterNumberstringThe trade register number
vatIdstringThe vat id of the organization
billingEmailstringThe monthly credit card bill is sent to this address
billingAdressobjectPostal address that is put on the monthly credit card bill
deliveryAdressobjectPostal address where any physical cards are shipped to
isCompanyNamePrintablebooleanIf the company name is too long to be printed on the cards this value is set to FALSE and the tradeName value is printed on the cards instead.
processingAccountobjectActual IBAN of the customer's bank account at Pliant. In pre-funded cases, this is the account where customers are able to top-up money.

Example Data

{
    "organizationId": "12e6e7e7-0c23-4a54-bccb-2d3ff2fd02df",
    "name": "Ada Lovelace Inc.",
    "status": "ACTIVE",
    "syncType": "FULL",
    "integrationType": "PARTNER",
    "creditLimit": {
        "value": 100000000,
        "currency": "EUR"
    },
    "availableLimit": {
        "value": 99870375,
        "currency": "EUR"
    },
    "cardsAccounts": [
        {
            "number": 1234,
            "type": "CREDITOR_ACCOUNT"
        },
        {
            "number": 5678,
            "type": "PAYMENT_ACCOUNT"
        }
    ],
    "tradeName": "Ada Lovelace Ltd.",
    "legalForm": "Ltd.",
    "foundationDate": "02.11.2020",
    "country": "DE",
    "accountType": "CREDIT",
    "partnersOrganizationId": "ada-lovelace-inc",
    "paymentFrequency": "MONTHLY",
    "nationalRegisterCourt": "HRB Berlin",
    "nationalRegisterId": "3432kk4",
    "nationalRegisterType": null,
    "tradeRegisterNumber": "2131241124211",
    "vatId": null,
    "billingEmail": "[email protected]",
    "billingAddress": {
        "id": "b2afeab3-0c94-45da-acb4-ac4ff3ece28a",
        "type": "BILLING",
        "country": "DE",
        "city": "Berlin",
        "streetFull": "Friedrichstraße 200",
        "streetName": "Friedrichstraße",
        "streetNumber": "200",
        "streetAdditional": "",
        "postalCode": "10115"
    },
    "deliveryAddress": {
        "id": "01c46c60-5542-4526-b6eb-26b0cfa3dd1b",
        "type": "DELIVERY",
        "country": "DE",
        "city": "Berlin",
        "streetFull": "Friedrichstraße, 200, ",
        "streetName": "Friedrichstraße",
        "streetNumber": "200",
        "streetAdditional": "",
        "postalCode": "10115"
    },
    "isCompanyNamePrintable": true,
    "processingAccount": {
        "beneficiary": "Ada Lovelace Inc.",
        "bankName": "Moonbank",
      	"iban": "DE12341234123412341234",
        "bic": "VGAGDEHHXXX"
    }
}

State Machine

Account Limits and Balance

In the Pliant API, the availableLimit represents the total spending capacity of an account. It is calculated based on the creditLimit and balance, and applies across all account types — whether the account is prefunded, credit, or hybrid. The balance value varies based on the type of account and represents the current funds or remaining credit, depending on the organization's account type.

creditLimit

The credit limit is the fixed amount a (credit / hybrid) organization can spend per month. For prefund organizations it is not set.

balance

The balance starts at 0 EUR for each organization and changes with actions like a purchase or a top up (prefund / hybrid).

availableLimit

The available limit represents the amount of money which can be actually spend. This might be less, equal or more than the credit limit (if there is a credit limit). It can also be calculated by balance + creditLimit = availableLimit.

It is:

  • less, if a credit organization has spent some money,
  • equal, if nothing was spent yet,
  • more, if a credit organization topped up additional money to the credit limit (=hybrid).

Examples

Prefunded Account

The account is pre funded with funds:

  • Directly after organization onboarding
    • balance = 0 EUR
    • creditLimit = 0 EUR
    • availableLimit = 0 EUR
  • After top up payment of 1.000 EUR
    • balance = 1.000 EUR
    • creditLimit = 0 EUR
    • availableLimit = 1.000 EUR
  • After spending 100 EUR with a purchase
    • balance = 900 EUR
    • creditLimit = 0 EUR
    • availableLimit = 900 EUR

Credit Account

The account operates on a pure credit limit:

  • Directly after organization onboarding with a credit limit of 1.000 EUR assigned
    • balance = 0 EUR
    • creditLimit = 1.000 EUR
    • availableLimit = 1.000 EUR
  • After spending 100 EUR with a purchase
    • balance = -100 EUR
    • creditLimit = 1.000 EUR
    • availableLimit = 900 EUR

Hybrid Account

The account uses both a prefund balance and a credit limit:

  • Directly after organization onboarding with a credit limit of 1.000 EUR assigned
    • balance = 0 EUR
    • creditLimit = 1.000 EUR
    • availableLimit = 1.000 EUR
  • After top up payment of 200 EUR
    • balance = 200 EUR
    • creditLimit = 1.000 EUR
    • availableLimit = 1.200 EUR
  • After spending 300 EUR with a purchase
    • balance = -100 EUR
    • creditLimit = 1.000 EUR
    • availableLimit = 900 EUR

UI Dashboard

Pliant shows the aforementioned values in its dashboard as shown below:

  1. creditLimit
  2. balance
  3. availableLimit

Important remarks

Delivery of physical cards

The property deliveryAddress is used to determine where to send the physical cards. Based on the organisations configuration the following countries are eligible:

CodeName
ALAlbania
ATAustria
BEBelgium
BGBulgaria
BABosnia and Herzegovina
BYBelarus
CHSwitzerland
CZCzech Republic
DKDenmark
ESSpain
EEEstonia
FIFinland
FRFrance
GBGreat Britain
DEGermany
GRGreece
HRCroatia
HUHungary
IEIreland
ITItaly
LILiechtenstein
LTLithuania
LULuxembourg
LVLatvia
MKMacedonia
NLNetherlands
NONorway
PLPoland
PTPortugal
RORomania
RURussia
SMSan Marino
RSSerbia
SKSlovakia
SISlovenia
SESweden
TRTurkey
UAUkraine

If you need to send cards to one of the following countries please reach out to us!

CodeName
ADAndorra
CYCyprus
FOFaroe Islands
GIGibraltar
GGGuernsey
ISIceland
JEJersey
MTMalta
MCMonaco
SMSan Marino
VAVatican City

Other countries are currently not supported.