Skip to content
Download OpenAPI description
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/lending/trade-finance/

Operations

Request

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.

Path
business_idstringrequired

ID of the business requesting the trade credit line.

Bodyapplication/json

Information related to the Trade Finance application.

identification_idstringrequired

The ID of the associated business identification

Example: "e876f41e9b8642bdaaff883ec2f0e144bid"
requested_credit_lineobject(MoneyEur)required

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

Example: {"value":1000,"unit":"cents","currency":"EUR"}
requested_credit_line.​valueintegerrequired

The amount value

Example: 1000
requested_credit_line.​currencystringrequired

The currency of the given value

Value"EUR"
Example: "EUR"
requested_credit_line.​unitstringrequired

The unit of the given value

Value"cents"
Example: "cents"
nominal_interest_ratenumber( -1 .. 1 )required

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

Example: 0.02
recipient_ibanstringrequired

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

Example: "DE32110101001000000029"
creditreform_pdstringrequired

The creditreform probability of default

Example: "1.2"
creditreform_scoreintegerrequired

The creditreform score

Example: 150
partner_contact_namestringrequired

The name of a contact person in your organization.

Example: "Contact Name"
partner_contact_numberstringrequired

The telephone number of a contact person in your organization.

Example: "+49303003000"
partner_reference_numberstringrequired

Reference identifier at partner

Example: "3738dbd0-a547-4c11-99e7-770066a39292"
partner_scorestringrequired

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

Example: "B"
application_datestring(date)required

The date of the application

Example: "2019-08-24"
application/json
{ "requested_credit_line": { "value": 100000, "currency": "EUR", "unit": "cents" }, "recipient_iban": "DE32110101001000000029", "partner_score": "B", "partner_reference_number": "3738dbd0-a547-4c11-99e7-770066a39292", "partner_contact_number": "+49303003000", "partner_contact_name": "Contact Name", "nominal_interest_rate": 0.02, "identification_id": "e876f41e9b8642bdaaff883ec2f0e144bid", "creditreform_score": 150, "creditreform_pd": "1.2", "application_date": "2019-08-24" }

Responses

The application was successfully created.

Bodyapplication/json
status_detailstring

Status details of the application

Example: ""
statusstring

Status of the application

Enum"pending""waiting_for_bussiness_identification""cdd_pending""successful_finished""rejected""deleted"
Example: "pending"
requested_credit_lineobject(MoneyEur)

The request credit line amount in EUR

Example: {"value":1000,"unit":"cents","currency":"EUR"}
recipient_ibanstring

The IBAN of the recipient's account

Example: "DE92370601930002130041"
partner_scorestring

Partner score

Example: "4"
partner_reference_numberstring

Reference identifier at partner

Example: "3738dbd0-a547-4c11-99e7-770066a39292"
partner_contact_numberstring

Number of the partner contact

Example: "123456789"
partner_contact_namestring

Name of the partner contact

Example: "Contact Name"
nominal_interest_ratenumber( -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.

Example: 0.02
identification_idstring

The ID of the associated business identification

Example: "e876f41e9b8642bdaaff883ec2f0e144bid"
idstring

The ID of the trade finance application

Example: "55f39e2d78424ac9a9ad5b09adffece2btfa"
creditreform_scoreinteger

The creditreform score

Example: 150
creditreform_pdstring

The creditreform probability of default

Example: "1.2"
application_datestring(date)

The date of the application

Example: "2019-08-24"
Response
application/json
{ "status_detail": "", "status": "pending", "requested_credit_line": { "value": 1000, "unit": "cents", "currency": "EUR" }, "recipient_iban": "DE92370601930002130041", "partner_score": "4", "partner_reference_number": "3738dbd0-a547-4c11-99e7-770066a39292", "partner_contact_number": "123456789", "partner_contact_name": "Contact Name", "nominal_interest_rate": 0.02, "identification_id": "e876f41e9b8642bdaaff883ec2f0e144bid", "id": "55f39e2d78424ac9a9ad5b09adffece2btfa", "creditreform_score": 150, "creditreform_pd": "1.2", "application_date": "2019-08-24" }

Retrieve a Trade Finance application

Request

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

Path
business_idstringrequired

ID of the business that submitted the application.

idstringrequired

ID of the application.

No request payload

Responses

Successful result of the operation.

Bodyapplication/json
status_detailstring

Status details of the application

Example: ""
statusstring

Status of the application

Enum"pending""waiting_for_bussiness_identification""cdd_pending""successful_finished""rejected""deleted"
Example: "pending"
requested_credit_lineobject(MoneyEur)

The request credit line amount in EUR

Example: {"value":1000,"unit":"cents","currency":"EUR"}
recipient_ibanstring

The IBAN of the recipient's account

Example: "DE92370601930002130041"
partner_scorestring

Partner score

Example: "4"
partner_reference_numberstring

Reference identifier at partner

Example: "3738dbd0-a547-4c11-99e7-770066a39292"
partner_contact_numberstring

Number of the partner contact

Example: "123456789"
partner_contact_namestring

Name of the partner contact

Example: "Contact Name"
nominal_interest_ratenumber( -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.

Example: 0.02
identification_idstring

The ID of the associated business identification

Example: "e876f41e9b8642bdaaff883ec2f0e144bid"
idstring

The ID of the trade finance application

Example: "55f39e2d78424ac9a9ad5b09adffece2btfa"
creditreform_scoreinteger

The creditreform score

Example: 150
creditreform_pdstring

The creditreform probability of default

Example: "1.2"
application_datestring(date)

The date of the application

Example: "2019-08-24"
Response
application/json
{ "status_detail": "", "status": "pending", "requested_credit_line": { "value": 1000, "unit": "cents", "currency": "EUR" }, "recipient_iban": "DE92370601930002130041", "partner_score": "4", "partner_reference_number": "3738dbd0-a547-4c11-99e7-770066a39292", "partner_contact_number": "123456789", "partner_contact_name": "Contact Name", "nominal_interest_rate": 0.02, "identification_id": "e876f41e9b8642bdaaff883ec2f0e144bid", "id": "55f39e2d78424ac9a9ad5b09adffece2btfa", "creditreform_score": 150, "creditreform_pd": "1.2", "application_date": "2019-08-24" }

Add document to a Trade Finance application

Request

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.

Path
business_idstringrequired

ID of the business that submitted the application.

idstringrequired

ID of the Trade Finance application.

Bodyapplication/json

Information related to the document.

document_idstringrequired

The ID of the uploaded document

Example: "5004c4c8f24b4c4990a646b740647e09cdoc"
typestringrequired

MIME type of the file

Enum"pdf/bwa_susa""pdf/complete_annual_statements""pdf/signed_contract""xml/credit_summary""xml/creditreform_wirtschaftsauskunft"
Example: "xml/credit_summary"
application/json
{ "type": "xml/credit_summary", "document_id": "5004c4c8f24b4c4990a646b740647e09cdoc" }

Responses

No Content

Response
No content

Request

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.

Path
business_idstringrequired

Business ID

Bodyapplication/json

Information about the trade.

business_trade_nostringrequired

Serial number generated by the partner to identify the trade.

Example: "f8978c7d14f7495f802a6cfd5c04fba7"
financing_terminteger(int32)required

The number of days until pay back.

Example: 30
incotermstring(Incoterm)required
Enum"EXW""FCA""CPT""CIP""DAT""DAP""DDP""FAS""FOB""CFR"
Example: "CFR"
invoice_datestring(date)required

The date invoice should be paid.

Example: "2019-08-24"
original_invoice_amountobject(Money)required

The original amount listed on the invoice of the trade.

Example: {"value":1000,"unit":"cents","currency":"EUR"}
original_invoice_amount.​valueintegerrequired

The amount value

Example: 1000
original_invoice_amount.​currencystringrequired

The currency of the given value

Example: "EUR"
original_invoice_amount.​unitstringrequired

The unit of the given value

Example: "cents"
original_invoice_numberstringrequired

Alphanumeric identifier of the invoice generated by the seller.

Example: "ABC123"
partner_reviewerstringrequired

Person from the partner side who reviewed the trade.

Example: "Partner Reviewer"
requested_payout_amountobject(Money)required

The requested payout amount

Example: {"value":1000,"unit":"cents","currency":"EUR"}
requested_payout_amount.​valueintegerrequired

The amount value

Example: 1000
requested_payout_amount.​currencystringrequired

The currency of the given value

Example: "EUR"
requested_payout_amount.​unitstringrequired

The unit of the given value

Example: "cents"
trade_company_addressstringrequired

Address of the seller.

Example: "Fake street 1A, 10178 Berlin"
trade_company_namestringrequired

Name of the seller.

Example: "Acme"
trade_company_registrationstringrequired

Registration of the seller.

Example: "ACME-123"
trade_company_websitestringrequired

Website of the seller.

Example: "example.com"
trade_origin_countrystring= 2 charactersrequired

ISO 3166-1 alpha-2 code of the country of the seller.

Example: "DE"
trade_purposestringrequired

Purpose of the trade.

Example: "Buy machinery"
seller_bank_account_detailsobject or null

Seller bank account details

requested_trade_currencystring or null

Requested currency by the customer.

Example: "USD"
reason_for_extensionstring or null

Reason to postpone the payback.

Example: "A reason"
partner_scorestring or null

Score calculated by partner controlling auto-approval behaviour

Enum"A""B"
Example: "A"
order_referencestring or null

Reference for partner to match trade with created order

Example: "32b4ad38e6984b65808c83c6633a5758"
fx_ratenumber or null

Foreign Exchange (FX) rate

Example: 10.32
application/json
{ "trade_purpose": "Buy machinery", "trade_origin_country": "DE", "trade_company_website": "example.com", "trade_company_registration": "ACME-123", "trade_company_name": "Acme", "trade_company_address": "Fake street 1A, 10178 Berlin", "seller_bank_account_details": { "iban": "DE82110101004206642492", "description": "seller description" }, "requested_trade_currency": "USD", "requested_payout_amount": { "value": 1000, "unit": "cents", "currency": "EUR" }, "reason_for_extension": "A reason", "partner_score": "A", "partner_reviewer": "Partner Reviewer", "original_invoice_number": "ABC123", "original_invoice_amount": { "value": 1000, "unit": "cents", "currency": "EUR" }, "order_reference": "32b4ad38e6984b65808c83c6633a5758", "invoice_date": "2019-08-24", "incoterm": "CFR", "fx_rate": 10.32, "financing_term": 30, "business_trade_no": "f8978c7d14f7495f802a6cfd5c04fba7" }

Responses

The trade was successfully created.

Bodyapplication/json
idstring or nullrequired

ID of the trade

Example: "722e12c6f2254972a1b70de6b07f6dacbtra"
statusstringrequired

The status of the trade.

Example: "approved"
documentsArray of objects(Document)required

Array of documents attached to the trade.

Example: [{"type":"invoice","document_id":"string","created_at":"2018-10-18T15:57:01.000000Z"}]
documents[].​document_idstringrequired
Example: "string"
documents[].​typestringrequired
Enum"invoice""other"
Example: "invoice"
business_trade_nostringrequired

Serial number generated by the partner to identify the trade.

Example: "f8978c7d14f7495f802a6cfd5c04fba7"
financing_terminteger(int32)required

The number of days until pay back.

Example: 30
incotermstring(Incoterm)required
Enum"EXW""FCA""CPT""CIP""DAT""DAP""DDP""FAS""FOB""CFR"
Example: "CFR"
invoice_datestring(date)required

The date invoice should be paid.

Example: "2019-08-24"
original_invoice_amountobject(Money)required

The original invoice amount

Example: {"value":1000,"unit":"cents","currency":"EUR"}
original_invoice_amount.​valueintegerrequired

The amount value

Example: 1000
original_invoice_amount.​currencystringrequired

The currency of the given value

Example: "EUR"
original_invoice_amount.​unitstringrequired

The unit of the given value

Example: "cents"
original_invoice_numberstringrequired

Alphanumeric identifier of the invoice generated by the seller.

Example: "ABC123"
partner_reviewerstringrequired

Person from the partner side who reviewed the trade.

Example: "Partner Reviewer"
requested_payout_amountobject(Money)required

The requested payout amount

Example: {"value":1000,"unit":"cents","currency":"EUR"}
requested_payout_amount.​valueintegerrequired

The amount value

Example: 1000
requested_payout_amount.​currencystringrequired

The currency of the given value

Example: "EUR"
requested_payout_amount.​unitstringrequired

The unit of the given value

Example: "cents"
trade_company_addressstringrequired

Address of the seller.

Example: "Fake street 1A, 10178 Berlin"
trade_company_namestringrequired

Name of the seller.

Example: "Acme"
trade_company_registrationstringrequired

Registration of the seller.

Example: "ACME-123"
trade_company_websitestringrequired

Website of the seller.

Example: "example.com"
trade_origin_countrystring= 2 charactersrequired

ISO 3166-1 alpha-2 code of the country of the seller.

Example: "DE"
trade_purposestringrequired

Purpose of the trade.

Example: "Buy machinery"
status_detailstring or null

Additional details about the trade's current status.

Example: ""
seller_bank_account_detailsobject or null

Seller bank account details

requested_trade_currencystring or null

Requested currency by the customer.

Example: "USD"
reason_for_extensionstring or null

Reason to postpone the payback.

Example: "A reason"
partner_scorestring or null

Score calculated by partner controlling auto-approval behaviour

Enum"A""B"
Example: "A"
order_referencestring or null

Reference for partner to match trade with created order

Example: "32b4ad38e6984b65808c83c6633a5758"
fx_ratenumber or null

Foreign Exchange (FX) rate

Example: 10.32
beneficiary_idstring or null

ID of the benificiary of the trade

Example: "ABCDEF"
Response
application/json
{ "trade_purpose": "Buy machinery", "trade_origin_country": "DE", "trade_company_website": "example.com", "trade_company_registration": "ACME-123", "trade_company_name": "Acme", "trade_company_address": "Fake street 1A, 10178 Berlin", "status_detail": "", "status": "approved", "seller_bank_account_details": { "iban": "DE82110101004206642492", "description": "seller description" }, "requested_trade_currency": "USD", "requested_payout_amount": { "value": 1000, "unit": "cents", "currency": "EUR" }, "reason_for_extension": "A reason", "partner_score": "A", "partner_reviewer": "Partner Reviewer", "original_invoice_number": "ABC123", "original_invoice_amount": { "value": 1000, "unit": "cents", "currency": "EUR" }, "order_reference": "32b4ad38e6984b65808c83c6633a5758", "invoice_date": "2019-08-24", "incoterm": "CFR", "id": "722e12c6f2254972a1b70de6b07f6dacbtra", "fx_rate": 10.32, "financing_term": 30, "documents": [ {} ], "business_trade_no": "f8978c7d14f7495f802a6cfd5c04fba7", "beneficiary_id": "ABCDEF" }

Request

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

Path
business_idstringrequired

ID of the business who requested the trade.

idstringrequired

ID of the trade.

No request payload

Responses

Successful result of the operation.

Bodyapplication/json
idstring or nullrequired

ID of the trade

Example: "722e12c6f2254972a1b70de6b07f6dacbtra"
statusstringrequired

The status of the trade.

Example: "approved"
documentsArray of objects(Document)required

Array of documents attached to the trade.

Example: [{"type":"invoice","document_id":"string","created_at":"2018-10-18T15:57:01.000000Z"}]
documents[].​document_idstringrequired
Example: "string"
documents[].​typestringrequired
Enum"invoice""other"
Example: "invoice"
business_trade_nostringrequired

Serial number generated by the partner to identify the trade.

Example: "f8978c7d14f7495f802a6cfd5c04fba7"
financing_terminteger(int32)required

The number of days until pay back.

Example: 30
incotermstring(Incoterm)required
Enum"EXW""FCA""CPT""CIP""DAT""DAP""DDP""FAS""FOB""CFR"
Example: "CFR"
invoice_datestring(date)required

The date invoice should be paid.

Example: "2019-08-24"
original_invoice_amountobject(Money)required

The original invoice amount

Example: {"value":1000,"unit":"cents","currency":"EUR"}
original_invoice_amount.​valueintegerrequired

The amount value

Example: 1000
original_invoice_amount.​currencystringrequired

The currency of the given value

Example: "EUR"
original_invoice_amount.​unitstringrequired

The unit of the given value

Example: "cents"
original_invoice_numberstringrequired

Alphanumeric identifier of the invoice generated by the seller.

Example: "ABC123"
partner_reviewerstringrequired

Person from the partner side who reviewed the trade.

Example: "Partner Reviewer"
requested_payout_amountobject(Money)required

The requested payout amount

Example: {"value":1000,"unit":"cents","currency":"EUR"}
requested_payout_amount.​valueintegerrequired

The amount value

Example: 1000
requested_payout_amount.​currencystringrequired

The currency of the given value

Example: "EUR"
requested_payout_amount.​unitstringrequired

The unit of the given value

Example: "cents"
trade_company_addressstringrequired

Address of the seller.

Example: "Fake street 1A, 10178 Berlin"
trade_company_namestringrequired

Name of the seller.

Example: "Acme"
trade_company_registrationstringrequired

Registration of the seller.

Example: "ACME-123"
trade_company_websitestringrequired

Website of the seller.

Example: "example.com"
trade_origin_countrystring= 2 charactersrequired

ISO 3166-1 alpha-2 code of the country of the seller.

Example: "DE"
trade_purposestringrequired

Purpose of the trade.

Example: "Buy machinery"
status_detailstring or null

Additional details about the trade's current status.

Example: ""
seller_bank_account_detailsobject or null

Seller bank account details

requested_trade_currencystring or null

Requested currency by the customer.

Example: "USD"
reason_for_extensionstring or null

Reason to postpone the payback.

Example: "A reason"
partner_scorestring or null

Score calculated by partner controlling auto-approval behaviour

Enum"A""B"
Example: "A"
order_referencestring or null

Reference for partner to match trade with created order

Example: "32b4ad38e6984b65808c83c6633a5758"
fx_ratenumber or null

Foreign Exchange (FX) rate

Example: 10.32
beneficiary_idstring or null

ID of the benificiary of the trade

Example: "ABCDEF"
Response
application/json
{ "trade_purpose": "Buy machinery", "trade_origin_country": "DE", "trade_company_website": "example.com", "trade_company_registration": "ACME-123", "trade_company_name": "Acme", "trade_company_address": "Fake street 1A, 10178 Berlin", "status_detail": "", "status": "approved", "seller_bank_account_details": { "iban": "DE82110101004206642492", "description": "seller description" }, "requested_trade_currency": "USD", "requested_payout_amount": { "value": 1000, "unit": "cents", "currency": "EUR" }, "reason_for_extension": "A reason", "partner_score": "A", "partner_reviewer": "Partner Reviewer", "original_invoice_number": "ABC123", "original_invoice_amount": { "value": 1000, "unit": "cents", "currency": "EUR" }, "order_reference": "32b4ad38e6984b65808c83c6633a5758", "invoice_date": "2019-08-24", "incoterm": "CFR", "id": "722e12c6f2254972a1b70de6b07f6dacbtra", "fx_rate": 10.32, "financing_term": 30, "documents": [ {} ], "business_trade_no": "f8978c7d14f7495f802a6cfd5c04fba7", "beneficiary_id": "ABCDEF" }

Request

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.

Path
business_idstringrequired

ID of the business who requested the trade.

trade_idstringrequired

ID of the trade.

Bodyapplication/json

Information related to the document.

document_idstringrequired

The ID of the uploaded document

Example: "5004c4c8f24b4c4990a646b740647e09cdoc"
typestringrequired

Type of the document

Enum"invoice""other"
Example: "invoice"
application/json
{ "type": "invoice", "document_id": "5004c4c8f24b4c4990a646b740647e09cdoc" }

Responses

No Content

Response
No content

Request

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.

Path
business_idstringrequired

ID of the business that requested the trade.

trade_idstringrequired

ID of the trade.

Bodyapplication/json

Information related to the payback plan.

payout_datestring(date)required

Date on which the payout is expected to happen.

Example: "2020-01-01"
payback_datestring(date)required

Date on which the business is expected to payback the full bullet amount. Generally payout_date + financing_term should be equal to payback_date, so if payout_date moves, payback_date also moves.

Example: "2020-01-31"
customer_fees_expectedobject(MoneyEur)required

Object representing the total amount of customer fees expected for this trade.

Example: {"value":1000,"unit":"cents","currency":"EUR"}
customer_fees_expected.​valueintegerrequired

The amount value

Example: 1000
customer_fees_expected.​currencystringrequired

The currency of the given value

Value"EUR"
Example: "EUR"
customer_fees_expected.​unitstringrequired

The unit of the given value

Value"cents"
Example: "cents"
partner_transaction_charges_expectedobject(MoneyEur)required

Object representing the total amount of transaction charges you expect to collect for the trade.

Example: {"value":1000,"unit":"cents","currency":"EUR"}
partner_transaction_charges_expected.​valueintegerrequired

The amount value

Example: 1000
partner_transaction_charges_expected.​currencystringrequired

The currency of the given value

Value"EUR"
Example: "EUR"
partner_transaction_charges_expected.​unitstringrequired

The unit of the given value

Value"cents"
Example: "cents"
other_chargesobject(MoneyEur)required

Object representing the total amount of other charges you expect to collect for the trade.

Example: {"value":1000,"unit":"cents","currency":"EUR"}
other_charges.​valueintegerrequired

The amount value

Example: 1000
other_charges.​currencystringrequired

The currency of the given value

Value"EUR"
Example: "EUR"
other_charges.​unitstringrequired

The unit of the given value

Value"cents"
Example: "cents"
beneficiary_idstring or null

ID of the benificiary of the trade

Example: "ABCDEF"
application/json
{ "payout_date": "2020-01-01", "payback_date": "2020-01-31", "partner_transaction_charges_expected": { "value": 1250, "unit": "cents", "currency": "EUR" }, "other_charges": { "value": 6700, "unit": "cents", "currency": "EUR" }, "customer_fees_expected": { "value": 10000, "unit": "cents", "currency": "EUR" } }

Responses

No Content

Response
No content

Attach account to business trade credit line

Request

Attaches a business account to the trade credit line for the business specified in the request URL.

Path
business_idstringrequired

Business ID

Bodyapplication/json

The credit line attributes

account_idstringrequired

ID of the account

Example: "7751af565f994450831a15ff8b7d0d8ccacc"
application/json
{ "account_id": "7751af565f994450831a15ff8b7d0d8ccacc" }

Responses

The account was successfully attached.

Bodyapplication/json
requested_credit_lineobject(MoneyEur)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
nominal_interest_ratenumber
business_idstring
account_idstring
Response
application/json
{ "requested_credit_line": { "value": 1000, "unit": "cents", "currency": "EUR" }, "nominal_interest_rate": 0, "business_id": "string", "account_id": "string" }