Organization
In Pliant an organization is a business that has a contractual relationship with us.
Data Model
Field | Type | Description |
---|---|---|
organizationId | uuid | An identifier for the organization, unique to the company |
name | string | Name of the organization as recorded in our system |
status | string | The current state of the organization:ONBOARDING_STARTED ONBOARDING_RISK_AND_COMPLIANCE ONBOARDING_MANDATES_AND_TERMS ACTIVE DEACTIVATED CANCELLED |
syncType | string | Type of IntegrationFULL (all transactions synced)PARTIAL (conditional syncing) |
integrationType | string | A constant that evaluates to CUSTOMER . |
creditLimit | object | An array in regard to the overall limit for the current payment period of your organization (for all cards) containingvalue (decimal) in EUR Centscurrency (string) |
availableLimit | object | An array in regard to the currently available amount for the current payment period of the organization (for all cards) containingvalue (decimal) in EUR Centscurrency (string) |
cardsAccount | object | An array containing the creditor account as well as the payment account containingnumber (string)type (string)There are two types available: CREDITOR_ACCOUNT PAYMENT_ACCOUNT |
tradeName | string | The name of the organization that is used to be printed on the cards if the company name is too long. |
legalForm | string | The legal form of the organization |
foundationDate | date-time | The foundation date of the organization |
country | string | The county where the organization is located |
accountType | string | Indicates 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 |
partnersOrganizationId | string | Once an organization is referred by a partner this indicates the id of the organization in partner's backend |
paymentFrequency | string | Frequency of credit card bill payments There are multiple frequencies available: DAILY WEEKLY BI_WEEKLY MONTHLY PREFUNDED |
nationalRegisterCourt | string | National register court |
nationalRegisterId | string | National register ID |
nationalRegisterType | string | National register Type |
tradeRegisterNumber | string | The trade register number |
vatId | string | The vat id of the organization |
billingEmail | string | The monthly credit card bill is sent to this address |
billingAdress | object | Postal address that is put on the monthly credit card bill |
deliveryAdress | object | Postal address where any physical cards are shipped to |
isCompanyNamePrintable | boolean | If 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. |
processingAccount | object | Actual 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
creditLimit
The credit limit is the fixed amount a (credit / hybrid) organization can spend per month. For prefund organizations it is not set.
balance
balance
The balance starts at 0 EUR for each organization and changes with actions like a purchase or a top up (prefund / hybrid).
availableLimit
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 EURcreditLimit
= 0 EURavailableLimit
= 0 EUR
- After top up payment of 1.000 EUR
balance
= 1.000 EURcreditLimit
= 0 EURavailableLimit
= 1.000 EUR
- After spending 100 EUR with a purchase
balance
= 900 EURcreditLimit
= 0 EURavailableLimit
= 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 EURcreditLimit
= 1.000 EURavailableLimit
= 1.000 EUR
- After spending 100 EUR with a purchase
balance
= -100 EURcreditLimit
= 1.000 EURavailableLimit
= 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 EURcreditLimit
= 1.000 EURavailableLimit
= 1.000 EUR
- After top up payment of 200 EUR
balance
= 200 EURcreditLimit
= 1.000 EURavailableLimit
= 1.200 EUR
- After spending 300 EUR with a purchase
balance
= -100 EURcreditLimit
= 1.000 EURavailableLimit
= 900 EUR
UI Dashboard
Pliant shows the aforementioned values in its dashboard as shown below:
creditLimit
balance
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:
Code | Name |
---|---|
AL | Albania |
AT | Austria |
BE | Belgium |
BG | Bulgaria |
BA | Bosnia and Herzegovina |
BY | Belarus |
CH | Switzerland |
CZ | Czech Republic |
DK | Denmark |
ES | Spain |
EE | Estonia |
FI | Finland |
FR | France |
GB | Great Britain |
DE | Germany |
GR | Greece |
HR | Croatia |
HU | Hungary |
IE | Ireland |
IT | Italy |
LI | Liechtenstein |
LT | Lithuania |
LU | Luxembourg |
LV | Latvia |
MK | Macedonia |
NL | Netherlands |
NO | Norway |
PL | Poland |
PT | Portugal |
RO | Romania |
RU | Russia |
SM | San Marino |
RS | Serbia |
SK | Slovakia |
SI | Slovenia |
SE | Sweden |
TR | Turkey |
UA | Ukraine |
If you need to send cards to one of the following countries please reach out to us!
Code | Name |
---|---|
AD | Andorra |
CY | Cyprus |
FO | Faroe Islands |
GI | Gibraltar |
GG | Guernsey |
IS | Iceland |
JE | Jersey |
MT | Malta |
MC | Monaco |
SM | San Marino |
VA | Vatican City |
Other countries are currently not supported.
Updated 4 months ago