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

Reference identifier at partner

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

The ID of the associated business identification

creditreform_score
required
integer

The creditreform score

creditreform_pd
required
string

The creditreform probability of default

application_date
required
string <date>

The date of the application

Responses
200

The application was successfully created.

400

Bad Request

403

Forbidden

404

Not 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": "Contact Name",
  • "nominal_interest_rate": 0.02,
  • "identification_id": "e876f41e9b8642bdaaff883ec2f0e144bid",
  • "creditreform_score": 150,
  • "creditreform_pd": "1.2",
  • "application_date": "2019-08-24"
}
Response samples
application/json
{
  • "status_detail": "",
  • "status": "pending",
  • "requested_credit_line": {
    },
  • "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

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.

403

Forbidden

404

Not Found

get/v1/businesses/{business_id}/trade_finance_applications/{id}
Request samples 
Response samples 
application/json
{
  • "status_detail": "",
  • "status": "pending",
  • "requested_credit_line": {
    },
  • "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
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
MIME type of the file


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


 
Responses 
204
No Content


400
Invalid request.


403
Forbidden


404
Not Found


post/v1/businesses/{business_id}/trade_finance_applications/{id}/documents
Request samples 
application/json
{
  • "type": "xml/credit_summary",
  • "document_id": "5004c4c8f24b4c4990a646b740647e09cdoc"
}
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
Purpose of the trade.


 
trade_origin_country
required
string  = 2 characters 
ISO 3166-1 alpha-2 code of the country of the seller.


 
trade_company_website
required
string
Website of the seller.


 
trade_company_registration
required
string
Registration of the seller.


 
trade_company_name
required
string
Name of the seller.


 
trade_company_address
required
string
Address of the seller.


 
object or null
Seller bank account details


 
requested_trade_currency
string or null
Requested currency by the customer.


 
required
object (Money) 
The requested payout amount


 
reason_for_extension
string or null
Reason to postpone the payback.


 
partner_score
string or null
Score calculated by partner controlling auto-approval behaviour


 Enum: "A" "B"  
partner_reviewer
required
string
Person from the partner side who reviewed the trade.


 
original_invoice_number
required
string
Alphanumeric identifier of the invoice generated by the seller.


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


 
order_reference
string or null
Reference for partner to match trade with created order


 
invoice_date
required
string <date> 
The date invoice should be paid.


 
incoterm
required
string (Incoterm) 
 Enum: "EXW" "FCA" "CPT" "CIP" "DAT" "DAP" "DDP" "FAS" "FOB" "CFR" "CIF" "Other"  
fx_rate
number or null
Foreign Exchange (FX) rate


 
financing_term
required
integer <int32> 
The number of days until pay back.


 
business_trade_no
required
string
Serial number generated by the partner to identify the trade.


 
Responses 
200
The trade was successfully created.


400
Invalid request.


403
Forbidden


404
Not Found


post/v1/businesses/{business_id}/trade_credit_line/trades
Request samples 
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": {
    },
  • "requested_trade_currency": "USD",
  • "requested_payout_amount": {
    },
  • "reason_for_extension": "A reason",
  • "partner_score": "A",
  • "partner_reviewer": "Partner Reviewer",
  • "original_invoice_number": "ABC123",
  • "original_invoice_amount": {
    },
  • "order_reference": "32b4ad38e6984b65808c83c6633a5758",
  • "invoice_date": "2019-08-24",
  • "incoterm": "CFR",
  • "fx_rate": 10.32,
  • "financing_term": 30,
  • "business_trade_no": "f8978c7d14f7495f802a6cfd5c04fba7"
}
Response samples 
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": {
    },
  • "requested_trade_currency": "USD",
  • "requested_payout_amount": {
    },
  • "reason_for_extension": "A reason",
  • "partner_score": "A",
  • "partner_reviewer": "Partner Reviewer",
  • "original_invoice_number": "ABC123",
  • "original_invoice_amount": {
    },
  • "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"
}
Retrieve a trade
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 who requested the trade.


 
id
required
string
ID of the trade.


 
Responses 
200
Successful result of the operation.


403
Forbidden


404
Not Found


get/v1/businesses/{business_id}/trade_credit_line/trades/{id}
Request samples 
Response samples 
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": {
    },
  • "requested_trade_currency": "USD",
  • "requested_payout_amount": {
    },
  • "reason_for_extension": "A reason",
  • "partner_score": "A",
  • "partner_reviewer": "Partner Reviewer",
  • "original_invoice_number": "ABC123",
  • "original_invoice_amount": {
    },
  • "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"
}
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
Type of the document


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


 
Responses 
204
No Content


400
Invalid request.


403
Forbidden


404
Not Found


post/v1/businesses/{business_id}/trade_credit_line/trades/{trade_id}/documents
Request samples 
application/json
{
  • "type": "invoice",
  • "document_id": "5004c4c8f24b4c4990a646b740647e09cdoc"
}
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> 
Date on which the payout is expected to happen.


 
payback_date
required
string <date> 
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.


 
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 benificiary of the trade


 
Responses 
204
No Content


400
Invalid request.


403
Forbidden


404
Not 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 account


 
Responses 
200
The account was successfully attached.


400
Invalid request.


403
Forbidden


404
Not 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": "7751af565f994450831a15ff8b7d0d8ccacc"
}
Response samples 
application/json
{
  • "requested_credit_line": {
    },
  • "nominal_interest_rate": 0,
  • "business_id": "string",
  • "account_id": "string"
}