Documentation Powered by ReDoc

Finiata API (2.0.1)

Download OpenAPI specification:Download

API for integrating with Finiata's credit line services.

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: Authorization

Check if customer is registered

Authorizations:
ApiKeyAuth
query Parameters
tax_id
number

Polish NIP of the customer. Either tax_id or organization_id is required. Will be strpped for digits only.

organization_id
string <uuid>
Example: organization_id=123e4567-e89b-12d3-a456-426655440000

UUID of the organization. Either tax_id or organization_id is required.

Responses

Response samples

Content type
application/json
{
  • "status": "active",
  • "organization_id": "123e4567-e89b-12d3-a456-426655440000",
  • "available_credit_limit_cents": 5000000,
  • "total_credit_limit_cents": 5000000
}

Create a new Seller

Authorizations:
ApiKeyAuth
Request Body schema: application/json
city
string
country
string
Default: "PL"
currency
string
Default: "PLN"
email
string
iban
string
name
string
postcode
string
street
string

Responses

Request samples

Content type
application/json
{
  • "city": "Warsaw",
  • "country": "PL",
  • "currency": "PLN",
  • "email": "seller@example.com",
  • "iban": "PL67109024029424941226832767",
  • "name": "XYZ Corporation",
  • "postcode": "00-001",
  • "street": "Main Street 1"
}

Response samples

Content type
application/json
{
  • "seller_id": "123e4567-e89b-12d3-a456-426655440001",
  • "city": "Warsaw",
  • "country": "PL",
  • "currency": "PLN",
  • "email": "seller@example.com",
  • "iban": "PL67109024029424941226832767",
  • "name": "XYZ Corporation",
  • "postcode": "00-001",
  • "street": "Main Street 1"
}

Retrieve all Sellers

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a Seller by ID

Authorizations:
ApiKeyAuth
path Parameters
seller_id
required
string

The ID of the seller

Responses

Response samples

Content type
application/json
{
  • "seller_id": "28f4dc41-8499-4ead-9976-f2fa20a45fd1",
  • "city": "Warsaw",
  • "country": "PL",
  • "currency": "PLN",
  • "email": "seller@example.com",
  • "iban": "PL67109024029424941226832767",
  • "name": "XYZ Corporation",
  • "postcode": "00-001",
  • "street": "Main Street 1"
}

Update a Seller by ID

Authorizations:
ApiKeyAuth
path Parameters
seller_id
required
string

The ID of the seller

Request Body schema: application/json
city
string
country
string
currency
string
email
string
iban
string
name
string
postcode
string
street
string

Responses

Request samples

Content type
application/json
{
  • "city": "string",
  • "country": "PL",
  • "currency": "PLN",
  • "email": "string",
  • "iban": "PL67109024029424941226832767",
  • "name": "string",
  • "postcode": "string",
  • "street": "string"
}

Response samples

Content type
application/json
{
  • "seller_id": "28f4dc41-8499-4ead-9976-f2fa20a45fd1",
  • "city": "string",
  • "country": "PL",
  • "currency": "PLN",
  • "email": "string",
  • "iban": "PL67109024029424941226832767",
  • "name": "string",
  • "postcode": "string",
  • "street": "string"
}

Delete a Seller by ID

Authorizations:
ApiKeyAuth
path Parameters
seller_id
required
string <uuid>

The ID of the seller

Responses

Create schedule preview

Authorizations:
ApiKeyAuth
Request Body schema: application/json
organization_id
string <uuid>
drawdown_cents
integer

Responses

Request samples

Content type
application/json
{
  • "organization_id": "123e4567-e89b-12d3-a456-426655440000",
  • "drawdown_cents": 0
}

Response samples

Content type
application/json
{
  • "installments": [
    ]
}

Process the disbursement

Authorizations:
ApiKeyAuth
Request Body schema: application/json
organization_id
string <uuid>
seller_id
string <uuid>
drawdown_cents
integer

Responses

Request samples

Content type
application/json
{
  • "organization_id": "123e4567-e89b-12d3-a456-426655440000",
  • "seller_id": "123e4567-e89b-12d3-a456-426655440001",
  • "drawdown_cents": 0
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "payment_id": "123e4567-e89b-12d3-a456-426655440003"
}

Retreive payment status

Authorizations:
ApiKeyAuth
Request Body schema: application/json
payment_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "payment_id": "123e4567-e89b-12d3-a456-426655440004"
}

Response samples

Content type
application/json
{
  • "status": "booked"
}