Trade Finance (1.0)

Download OpenAPI specification:Download

Business Trade Finance

Create Trade Finance application

Creates an application for a trade credit line for the business specified in the request URL. Solarisbank will process the application manually. Use the GET endpoint to retrieve information about the application's status.

Request
path Parameters
business_id
required
string

ID of the business requesting the trade credit line.

Request Body schema: application/json
optional

Information related to the Trade Finance application.

required
object (MoneyEur)

The amount of money requested for the business's trade credit line (in Euro cents).

recipient_iban
required
string

IBAN of the account where the trade loans should be paid out.

partner_score
required
string

An optional scoring value to apply to the Trade Finance application.

partner_reference_number
required
string

An internal reference number for the Trade Finance application.

partner_contact_number
required
string

The telephone number of a contact person in your organization.

partner_contact_name
required
string

The name of a contact person in your organization.

nominal_interest_rate
required
number ( -1 .. 1 )

The nominal interest rate to apply to the trade credit line, expressed as a value between 0.0 (i.e., 0%) and 1.0 (i.e., 100%) with up to four decimal places. For example, 0.01 would apply a nominal interest rate of 1% to the trade credit line.

identification_id
required
string

ID of the relevant business identification.

creditreform_score
required
number

The score calculated for the business by a credit risk agency (e.g., Credit Reform).

creditreform_pd
required
number

The probability of default calculated for the business by a credit risk agency (e.g., Credit Reform).

application_date
required
string <date>

The date when the business submitted the application.

Responses
201

The application was successfully created.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

post/v1/businesses/{business_id}/trade_finance_applications
Request samples
application/json
{
  • "requested_credit_line": {
    },
  • "recipient_iban": "DE32110101001000000029",
  • "partner_score": "B",
  • "partner_reference_number": "3738dbd0-a547-4c11-99e7-770066a39292",
  • "partner_contact_number": "+49303003000",
  • "partner_contact_name": "Magda Musterfrau",
  • "nominal_interest_rate": 0.02,
  • "identification_id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  • "creditreform_score": 0.02,
  • "creditreform_pd": 0.3,
  • "application_date": "2022-05-31"
}
Response samples
application/json
{
  • "status_detail": "Application is created",
  • "status": "PENDING",
  • "requested_credit_line": {
    },
  • "recipient_iban": "DE11200144559095555555",
  • "partner_score": "B",
  • "partner_reference_number": "3738dbd0-a547-4c11-99e7-770066a39292",
  • "partner_contact_number": "+49303003000",
  • "partner_contact_name": "Magda Musterfrau",
  • "nominal_interest_rate": 0.02,
  • "identification_id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  • "id": "fb7e312ee0e24148b2bc90c0cbe565bc",
  • "creditreform_score": 0.02,
  • "creditreform_pd": 0.3,
  • "application_date": "2022-05-31"
}

Retrieve a Trade Finance application

Returns the Trade Finance application specified in the request URL. Use this endpoint to display the status of the application to the customer.

Request
path Parameters
business_id
required
string

ID of the business that submitted the application.

id
required
string

ID of the application.

Responses
200

Successful result of the operation.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

get/v1/businesses/{business_id}/trade_finance_applications/{id}
Request samples 
Response samples 
application/json
{
  • "status_detail": "Application is created",
  • "status": "PENDING",
  • "requested_credit_line": {
    },
  • "recipient_iban": "DE11200144559095555555",
  • "partner_score": "B",
  • "partner_reference_number": "3738dbd0-a547-4c11-99e7-770066a39292",
  • "partner_contact_number": "+49303003000",
  • "partner_contact_name": "Magda Musterfrau",
  • "nominal_interest_rate": 0.02,
  • "identification_id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  • "id": "fb7e312ee0e24148b2bc90c0cbe565bc",
  • "creditreform_score": 0.02,
  • "creditreform_pd": 0.3,
  • "application_date": "2022-05-31"
}
Add document to a Trade Finance application
Attaches a previously uploaded document to the business's Trade Finance application. Note that you must upload the document using the POST Upload a document for a business endpoint.


Request 
path Parameters
business_id
required
string
ID of the business that submitted the application.


 
id
required
string
ID of the Trade Finance application.


 
Request Body schema: application/json
optional
Information related to the document.


type
required
string
The type of document.


 Enum: "pdf/bwa_susa" "pdf/complete_annual_statements" "pdf/signed_contract" "xml/credit_summary" "xml/creditreform_wirtschaftsauskunft"  
document_id
required
string
ID of the previously uploaded document.


 
Responses 
204
No Content


400
Invalid request.


403
You are not authorized to perform this action.


404
The resource could not be found.


post/v1/businesses/{business_id}/trade_finance_applications/{id}/documents
Request samples 
application/json
{
  • "type": "xml/credit_summary",
  • "document_id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc"
}
Response samples 
application/json
{
  • "title": "Failed to build pagination headers.",
  • "status": "400",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "detail": "Cannot connect to database.",
  • "code": "build_pagination_headers_failure"
}
Create trade
Creates a trade. Note that you must upload the documents related to the trade using the POST Upload business document endpoint and then attach them to the trade using the POST Add document to trade endpoint. 


Request 
path Parameters
business_id
required
string
Business ID


 
Request Body schema: application/json
optional
Information about the trade.


trade_purpose
required
string
The purpose of the trade.


 
trade_origin_country
required
string  = 2 characters 
The seller's ISO 3166-1 alpha-2 country code.


 
trade_company_website
required
string
The seller's website.


 
trade_company_registration
required
string
The seller's company registration number.


 
trade_company_name
required
string
The company name of the seller.


 
trade_company_address
required
string
The seller's address.


 
seller_bank_account_details
object or null
The seller's bank account details.


 
requested_trade_currency
string or null
The currency requested for the trade by the customer.


 
required
object (Money) 
The amount to be paid out to the customer (i.e., the value of the trade), in Euro cents.


 
reason_for_extension
string or null
A reason to postpone the payback process beyond the original deadline.


 
partner_score
string or null
A score that you calculate for the customer, which controls auto-approval behavior.


 Enum: "A" "B"  
partner_reviewer
required
string
The individual in your organization who reviewed the trade.


 
original_invoice_number
required
string
An alphanumeric identifier generated by the seller for the invoice.


 
required
object (Money) 
The original amount listed on the invoice of the trade.


 
order_reference
string or null
(For non-Euro trades) A reference for you to match the trade with the generated currency conversion order.


 
invoice_date
required
string <date> 
The date when the invoice must be paid.


 
incoterm
required
string (Incoterm) 
The relevant incoterm that applies to the trade.


 Enum: "EXW" "FCA" "CPT" "CIP" "DAT" "DAP" "DDP" "FAS" "FOB" "CFR" "CIF" "Other"  
fx_rate
number or null
(For non-Euro trades) The foreign exchange (FX) rate to apply to the trade.


 
financing_term
required
integer <int32> 
The number of days from the payout of the loan when the customer must pay it back.


 
business_trade_no
required
string
A serial number you may generate to identify the trade.


 
Responses 
201
The trade was successfully created.


400
Invalid request.


403
You are not authorized to perform this action.


404
The resource could not be found.


post/v1/businesses/{business_id}/trade_credit_line/trades
Request samples 
application/json
{
  • "trade_purpose": "Buying machinery",
  • "trade_origin_country": "DE",
  • "trade_company_website": "docs.solarisbank.com",
  • "trade_company_registration": "HRB 168180 B",
  • "trade_company_name": "SolarisDealz GmbH",
  • "trade_company_address": "Cuvrystraße 53, 10997 Berlin",
  • "seller_bank_account_details": {
    },
  • "requested_trade_currency": "EUR",
  • "requested_payout_amount": {
    },
  • "reason_for_extension": "No moneys",
  • "partner_score": "A",
  • "partner_reviewer": "Ray Liotta",
  • "original_invoice_number": "AAA1223731",
  • "original_invoice_amount": {
    },
  • "order_reference": "string",
  • "invoice_date": "2022-05-31",
  • "incoterm": "CFR",
  • "fx_rate": 0.03,
  • "financing_term": 30,
  • "business_trade_no": "e3b3ecd1-72b5-4786-9588-15671b035b42"
}
Response samples 
application/json
{
  • "trade_purpose": "Buying machinery",
  • "trade_origin_country": "DE",
  • "trade_company_website": "docs.solarisbank.com",
  • "trade_company_registration": "HRB 168180 B",
  • "trade_company_name": "SolarisDealz GmbH",
  • "trade_company_address": "Cuvrystraße 53, 10997 Berlin",
  • "status_detail": "string",
  • "status": "PENDING",
  • "seller_bank_account_details": {
    },
  • "requested_payout_amount": {
    },
  • "reason_for_extension": "No moneys",
  • "partner_score": "A",
  • "partner_reviewer": "Max Mustermann",
  • "original_invoice_number": "AAA1223731",
  • "original_invoice_amount": {
    },
  • "order_reference": "string",
  • "invoice_date": "2022-05-31",
  • "incoterm": "CFR",
  • "id": "80620f0c57594a2cac337f401889bf6f",
  • "fx_rate": 0.03,
  • "financing_term": 30,
  • "documents": [
    ],
  • "business_trade_no": "e3b3ecd1-72b5-4786-9588-15671b035b42",
  • "beneficiary_id": "e0277fae750a4c849660da873f94cbiz"
}
Retrieve a trade
Returns the trade specified in the request URL. Use this endpoint to display the status of the trade to the customer.


Request 
path Parameters
business_id
required
string
ID of the business who requested the trade.


 
id
required
string
ID of the trade.


 
Responses 
200
Successful result of the operation.


400
Invalid request.


403
You are not authorized to perform this action.


404
The resource could not be found.


get/v1/businesses/{business_id}/trade_credit_line/trades/{id}
Request samples 
Response samples 
application/json
{
  • "trade_purpose": "Buying machinery",
  • "trade_origin_country": "DE",
  • "trade_company_website": "docs.solarisbank.com",
  • "trade_company_registration": "HRB 168180 B",
  • "trade_company_name": "SolarisDealz GmbH",
  • "trade_company_address": "Cuvrystraße 53, 10997 Berlin",
  • "status_detail": "string",
  • "status": "PENDING",
  • "seller_bank_account_details": {
    },
  • "requested_payout_amount": {
    },
  • "reason_for_extension": "No moneys",
  • "partner_score": "A",
  • "partner_reviewer": "Max Mustermann",
  • "original_invoice_number": "AAA1223731",
  • "original_invoice_amount": {
    },
  • "order_reference": "string",
  • "invoice_date": "2022-05-31",
  • "incoterm": "CFR",
  • "id": "80620f0c57594a2cac337f401889bf6f",
  • "fx_rate": 0.03,
  • "financing_term": 30,
  • "documents": [
    ],
  • "business_trade_no": "e3b3ecd1-72b5-4786-9588-15671b035b42",
  • "beneficiary_id": "e0277fae750a4c849660da873f94cbiz"
}
Add document to trade
Adds a supporting document (e.g., the trade invoice) to a trade. Note that you must first upload these documents using the POST Upload a document for a business endpoint.


Request 
path Parameters
business_id
required
string
ID of the business who requested the trade.


 
trade_id
required
string
ID of the trade.


 
Request Body schema: application/json
optional
Information related to the document.


type
required
string
The type of document to add to the trade.


 Enum: "invoice" "other"  
document_id
required
string
ID of the previously uploaded document.


 
Responses 
204
No Content


400
Invalid request.


403
You are not authorized to perform this action.


404
The resource could not be found.


post/v1/businesses/{business_id}/trade_credit_line/trades/{trade_id}/documents
Request samples 
application/json
{
  • "type": "invoice",
  • "document_id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc"
}
Response samples 
application/json
{
  • "title": "Failed to build pagination headers.",
  • "status": "400",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "detail": "Cannot connect to database.",
  • "code": "build_pagination_headers_failure"
}
Add payback plan to trade
Adds a payback plan to a trade, which determines when the loan will be paid out to the business and when the business must pay it back.


Request 
path Parameters
business_id
required
string
ID of the business that requested the trade.


 
trade_id
required
string
ID of the trade.


 
Request Body schema: application/json
optional
Information related to the payback plan.


payout_date
required
string <date> 
The date on which the payout is expected to happen.


 
payback_date
required
string <date> 
The date on which the business is expected to pay back the full amount. You should calculate this date by taking the payout_date and adding the number of days specified in the financing_term of the trade.


 
required
object (MoneyEur) 
Object representing the total amount of transaction charges you expect to collect for the trade.


 
required
object (MoneyEur) 
Object representing the total amount of other charges you expect to collect for the trade.


 
required
object (MoneyEur) 
Object representing the total amount of customer fees expected for this trade.


 
beneficiary_id
string or null
ID of the beneficiary of the trade.


 
Responses 
204
No Content


400
Invalid request.


403
You are not authorized to perform this action.


404
The resource could not be found.


409
Conflict


put/v1/businesses/{business_id}/trade_credit_line/trades/{trade_id}/payback_plan
Request samples 
application/json
{
  • "payout_date": "2020-01-01",
  • "payback_date": "2020-01-31",
  • "partner_transaction_charges_expected": {
    },
  • "other_charges": {
    },
  • "customer_fees_expected": {
    }
}
Response samples 
application/json
{
  • "title": "Failed to build pagination headers.",
  • "status": "400",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "detail": "Cannot connect to database.",
  • "code": "build_pagination_headers_failure"
}
Attach account to business trade credit line
Attaches a business account to the trade credit line for the business specified in the request URL.


Request 
path Parameters
business_id
required
string
Business ID


 
Request Body schema: application/json
optional
The credit line attributes


account_id
required
string
ID of the Solarisbank account where the credit line will be attached.


 
Responses 
200
The account was successfully attached.


400
Invalid request.


403
You are not authorized to perform this action.


404
The resource could not be found.


409
The trade credit line already has an attached account.


patch/v1/businesses/{business_id}/trade_credit_line
Request samples 
application/json
{
  • "account_id": "efdd8c5e7ec0b4e36768c6de39e6cfc0cacc"
}
Response samples 
application/json
{
  • "requested_credit_line": {
    },
  • "nominal_interest_rate": 0.02,
  • "business_id": "e0277fae750a4c849660da873f94cbiz",
  • "account_id": "5526853938474f3e92b22a03ea57a544cacc"
}