Business Trade Finance

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.

post/v1/businesses/{business_id}/trade_credit_line/trades

Path parameters

business_idstring required

Business ID

Request body

trade_purposestring required

Purpose of the trade.

trade_origin_countrystring required

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

trade_company_websitestring required

Website of the seller.

trade_company_registrationstring required

Registration of the seller.

trade_company_namestring required

Name of the seller.

trade_company_addressstring required

Address of the seller.

requested_trade_currencystring nullable

Requested currency by the customer.

reason_for_extensionstring nullable

Reason to postpone the payback.

partner_score'A' | 'B' nullable

Score calculated by partner controlling auto-approval behaviour

partner_reviewerstring required

Person from the partner side who reviewed the trade.

original_invoice_numberstring required

Alphanumeric identifier of the invoice generated by the seller.

order_referencestring nullable

Reference for partner to match trade with created order

invoice_datestring date required

The date invoice should be paid.

incoterm'EXW' | 'FCA' | 'CPT' | 'CIP' | 'DAT' | 'DAP' | 'DDP' | 'FAS' | 'FOB' | 'CFR' | 'CIF' | 'Other' required
fx_ratenumber nullable

Foreign Exchange (FX) rate

financing_terminteger required

The number of days until pay back.

business_trade_nostring required

Serial number generated by the partner to identify the trade.

Example request

{
  "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"
}

Response

The trade was successfully created.

trade_purposestring required

Purpose of the trade.

trade_origin_countrystring required

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

trade_company_websitestring required

Website of the seller.

trade_company_registrationstring required

Registration of the seller.

trade_company_namestring required

Name of the seller.

trade_company_addressstring required

Address of the seller.

status_detailstring nullable

Additional details about the trade's current status.

statusstring required

The status of the trade.

requested_trade_currencystring nullable

Requested currency by the customer.

reason_for_extensionstring nullable

Reason to postpone the payback.

partner_score'A' | 'B' nullable

Score calculated by partner controlling auto-approval behaviour

partner_reviewerstring required

Person from the partner side who reviewed the trade.

original_invoice_numberstring required

Alphanumeric identifier of the invoice generated by the seller.

order_referencestring nullable

Reference for partner to match trade with created order

invoice_datestring date required

The date invoice should be paid.

incoterm'EXW' | 'FCA' | 'CPT' | 'CIP' | 'DAT' | 'DAP' | 'DDP' | 'FAS' | 'FOB' | 'CFR' | 'CIF' | 'Other' required
idstring nullable required

ID of the trade

fx_ratenumber nullable

Foreign Exchange (FX) rate

financing_terminteger required

The number of days until pay back.

business_trade_nostring required

Serial number generated by the partner to identify the trade.

beneficiary_idstring nullable

ID of the benificiary of the trade

Example response

{
  "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": "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": [
    {
      "type": "invoice",
      "document_id": "string"
    }
  ],
  "business_trade_no": "f8978c7d14f7495f802a6cfd5c04fba7",
  "beneficiary_id": "ABCDEF"
}