API van Advanta voor financiers

GET/v1/health

Of de API werkt. Openbaar: geen sleutel, geen gegevens, geen databasetoegang.

Scope

Geen: openbaar, zonder sleutel

Antwoord

200{ status, api_version, time }

Fouten

Geen

Advanta vraagt deze route elke 5 minuten op; de resultaten staan op de openbare statuspagina.

curl -s "$BASE/v1/health"

GET/v1/me

Wie er aanroept: de sleutel, zijn financier, zijn omgeving en zijn scopes.

Scope

Elke geldige sleutel

Antwoord

200{ api_version, environment, funder, key }

Fouten

405method_not_allowed

key.prefix zijn de eerste 12 tekens van de sleutel. key.expires_at is null voor een sleutel die niet verloopt; key.prospect noemt aan wie een sandboxsleutel is uitgegeven.

curl -s "$BASE/v1/me" \
  -H "Authorization: Bearer $ADVANTA_KEY"

{
  "api_version": "2026-09-23",
  "environment": "sandbox",
  "funder": {
    "bank_id": "6d164c92-02cc-4f9a-ae8d-3f7f5ef043d3",
    "name": "Compartment Demo (LU)"
  },
  "key": {
    "id": "0b3c6a52-5d0e-4b53-9d0e-1c2b3a4d5e6f",
    "name": "sandbox · Example prospect",
    "prefix": "adv_fk_1a2b3",
    "scopes": ["requests:read", "limits:read", "webhooks:write"],
    "created_at": "2026-09-23T18:00:00Z",
    "expires_at": "2026-10-07T18:00:00Z",
    "prospect": "Example prospect"
  }
}

GET/v1/requests

De aanvragen die naar u zijn doorgestuurd (u kunt erop handelen) en die waarop u al hebt gehandeld (alleen lezen, ook na een herverdeling), nieuwste eerst, elk met uw eigen aanbod in my_offer als u er een hebt gedaan.

Scope

requests:read

Antwoord

200{ funder, count, requests[] }

Fouten

Alleen de algemene (401, 403, 500).

Een aanvraag bevat id, request_ref, type (factoring of confirming), status, total_amount, advance_amount, de verkoper in company_name en company_nif, invoice_count, assigned_bank_id, consent_level_required (wat elke debiteur moet ondertekenen voordat ze gefinancierd kan worden, vastgelegd bij het doorsturen), haar tijdstempels en, per debiteur, debtor_consent. De specificatie noemt elk veld.

curl -s "$BASE/v1/requests?status=all&limit=50" \
  -H "Authorization: Bearer $ADVANTA_KEY"

const BASE = 'https://bzsengbmlzzhztjfvcag.supabase.co/functions/v1/funder-api';
const headers = { Authorization: `Bearer ${process.env.ADVANTA_KEY}` };

const res = await fetch(`${BASE}/v1/requests?status=open&limit=200`, { headers });
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const { funder, requests } = await res.json();

// Routed to you (you can act on them) and not priced by you yet
const toPrice = requests.filter((r) => r.assigned_bank_id === funder.bank_id && !r.my_offer);
for (const r of toPrice) console.log(r.request_ref, r.type, r.total_amount, r.company_name);

{
  "funder": {
    "bank_id": "6d164c92-02cc-4f9a-ae8d-3f7f5ef043d3",
    "name": "Compartment Demo (LU)"
  },
  "count": 1,
  "requests": [
    {
      "id": "4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87",
      "request_ref": "FR-2026-0042",
      "type": "factoring",
      "status": "terms_sent",
      "total_amount": 18450.00,
      "company_name": "Example Seller, S.L.",
      "invoice_count": 3,
      "assigned_bank_id": "6d164c92-02cc-4f9a-ae8d-3f7f5ef043d3",
      "consent_level_required": "acknowledgment",
      "created_at": "2026-09-22T09:12:00Z",
      "my_offer": {
        "funding_request_id": "4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87",
        "rate": 2.4,
        "advance_pct": 90,
        "days": 60,
        "status": "pending",
        "submitted_at": "2026-09-23T10:30:00Z",
        "accepted_at": null
      },
      "debtor_consent": [
        {
          "debtor_name": "Example Buyer, S.A.",
          "debtor_tax_id": "A00000000",
          "status": "pending",
          "level_required": "acknowledgment",
          "level_achieved": null,
          "meets_requirement": false
        }
      ]
    }
  ]
}

GET/v1/requests/{id}

Het beoordelingsdossier van één aanvraag: de aanvraag, haar vorderingen, de meest recente Advanta Score van de verkoper, uw eigen aanbod en risk, de fraudesignalen en geschillen van de aanvraag, zoals uw portaal ze toont.

Scope

requests:read

Antwoord

200{ request, debtor_consent[], receivables[], score, my_offer, risk }

Fouten

404not_found

score loopt van 300 tot 850, met een klasse van A tot E en de onderliggende dimensies. Hij wordt ter plekke berekend als de verkoper er nog geen heeft, en is null als dat mislukt. Elke vordering heeft invoice_no, invoice_amount, invoice_date, invoice_due_date en de debiteur in customer_name. debtor_consent geeft per debiteur de status van de melding, het vereiste en het ondertekende niveau (level_achieved), meets_requirement, het kanaal, de ondertekende verklaringstekst en wie heeft ondertekend.

risk.signals somt de fraudesignalen op die nog open of bevestigd zijn, elk met een stabiele code (bijvoorbeeld amount_above_history) en een severity. Een hard signaal (bijvoorbeeld een bedrag dat veranderde terwijl de factuur in een aanvraag zit, een creditnota erop of een open geschil) houdt doorsturen en financieren tegen tot het operationele team van Advanta het beoordeelt; de andere markeren alleen. risk.disputes somt elk geschil op dat tegen de aanvraag is vastgelegd.

curl -s "$BASE/v1/requests/4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87" \
  -H "Authorization: Bearer $ADVANTA_KEY"

POST/v1/requests/{id}/decision

Voorwaarden aanbieden, afwijzen, financieren of een ontvangst boeken. De aanvraag moet naar u zijn doorgestuurd, anders 409 not_routed_to_you.

De body heeft een van vier vormen, gekozen via decision:

Scope

decisions:write

Antwoord

201{ decision, request_id, offer_id, expires_at, status } (offer)

200{ decision, request_id, status } (decline)

200{ decision, request_id, status, funded_at } (fund)

200{ decision, request_id, settlement_id, status, received_total, request_total, outstanding } (settle)

Fouten

400reason_required

403not_your_request (alleen bij settle: u bent niet de financier van de aanvraag)

404not_found

409not_routed_to_you, invalid_state, credit_limit, funding_gate_failed, funding_amount_mismatch, debtor_not_eligible_for_funder, documents_missing_for_funder

422invalid_terms, invalid_amount, invalid_received_at, invalid_funding_details, step_back_message_required, invalid_decision

curl -s -X POST "$BASE/v1/requests/4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87/decision" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"decision":"offer","rate":2.4,"advance_pct":90,"days":60,"valid_days":7,"notes":"Subject to the notice being acknowledged"}'

async function offer(requestId, terms) {
  const res = await fetch(`${BASE}/v1/requests/${requestId}/decision`, {
    method: 'POST',
    headers: { ...headers, 'Content-Type': 'application/json' },
    body: JSON.stringify({ decision: 'offer', ...terms }),
  });
  const body = await res.json();
  if (res.status === 201) return body; // { decision, request_id, offer_id, expires_at, status }
  const { code, message, debtors } = body.error;
  if (code === 'debtor_not_eligible_for_funder') {
    for (const d of debtors) console.warn(d.name ?? d.debtor_key, d.reason, d.invoices);
  }
  throw new Error(`${res.status} ${code}: ${message}`);
}

await offer('4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87', { rate: 2.4, advance_pct: 90, days: 60, valid_days: 7 });

{
  "decision": "offer",
  "request_id": "4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87",
  "offer_id": "7a9e3c1b-2d4f-4e6a-8b0c-5d1e2f3a4b5c",
  "expires_at": "2026-09-30T10:30:00Z",
  "status": "terms_sent"
}

{ "decision": "decline", "reason": "concentration", "notes": "We cannot fund this buyer this quarter", "internal_note": "Group exposure above our internal limit" }

{ "decision": "fund", "value_date": "2026-10-01", "reference": "TRF-2026-1001-07" }

{ "decision": "settle", "amount": 12500.00, "received_at": "2026-10-30T10:00:00Z", "reference": "ADV-A1F51301-1000" }

POST/v1/requests/{id}/consent-level

Verhogen wat de debiteuren van één aanvraag moeten ondertekenen. Alleen omhoog, alleen voor een factoringaanvraag die naar u is doorgestuurd en loopt, en alleen voordat een van haar debiteuren heeft geantwoord.

Scope

decisions:write

Antwoord

200{ request_id, consent_level_required, changed, from }

Fouten

404not_found

409not_routed_to_you, level_lower, notice_already_decided, not_factoring, request_not_in_flight

422level_invalid, reason_required

curl -s -X POST "$BASE/v1/requests/4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87/consent-level" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"level":"acceptance","reason":"Credit committee asked for acceptance on this buyer"}'

GET/v1/requests/{id}/documents

Het documentendossier van één aanvraag. Toen de aanvraag naar u werd doorgestuurd, en opnieuw toen ze werd gefinancierd, legde Advanta vast welke versie van elk door u vereist document aan uw eisen voldeed: bestandsnaam, SHA-256, datum van uitgifte en geldigheid, en wanneer en hoe Advanta het heeft gecontroleerd. Die vastlegging verandert nooit, ook niet als de verkoper nieuwere versies uploadt; elke regel zegt ook hoe het document er vandaag voor staat, en current somt de huidige documenten van de verkoper op.

Scope

requests:read

Antwoord

200{ request_id, seller_country, today, required_now, snapshots[], current[] }

Fouten

404not_found

Elke regel met een bestand heeft een download_url die twee minuten geldig is (url_expires_in), en elke uitgegeven URL wordt gelogd. Vergelijk de SHA-256 van wat u downloadt met de vastgelegde.

curl -s "$BASE/v1/requests/4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87/documents" \
  -H "Authorization: Bearer $ADVANTA_KEY"

GET/v1/required-documents

De documenten die u van verkopers vraagt, per land van de verkoper, en de catalogus waaruit ze gekozen worden: de code van elk document, de naam in zeven talen, de uitgever, de gebruikelijke geldigheid en de gevoeligheid. De gebruikelijke geldigheid vult alleen vooraf in: de datum die op het document staat telt, en die legt de verkoper vast en controleert Advanta.

Scope

requests:read

Antwoord

200{ funder, required, catalogue[] }

Fouten

Alleen de algemene (401, 403, 500).

Een aanvraag wordt alleen naar u doorgestuurd, uw aanbod alleen vastgelegd en de aanvraag alleen gefinancierd zolang elk document op uw lijst voor het land van de verkoper door Advanta is gecontroleerd en op die datum geldig is; anders 409 documents_missing_for_funder.

curl -s "$BASE/v1/required-documents" \
  -H "Authorization: Bearer $ADVANTA_KEY"

PUT/v1/required-documents

Uw lijst voor één land van verkopers vervangen; een lege lijst wist haar. De codes komen uit de catalogus, en de wijziging wordt met note vastgelegd in de bewijsketen van Advanta. Aanvragen die al bij u liggen, blijven bij u; uw volgende aanbod of financiering op een ervan wacht tot de verkoper aan de nieuwe lijst voldoet (open_requests_not_meeting telt ze).

Scope

settings:write of decisions:write

Antwoord

200{ …required documents, changed, country, codes, open_requests_not_meeting }

Fouten

422body_required, country_invalid, codes_invalid, note_invalid, country_without_catalogue, document_code_unknown

curl -s -X PUT "$BASE/v1/required-documents" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"country":"PT","codes":["cert_hacienda","cert_seguridad_social","cirbe"],"note":"Credit committee of 23 September"}'

GET/v1/settings

Wat uw debiteuren moeten ondertekenen voordat u financiert: het niveau dat elke debiteur moet ondertekenen voordat een naar u doorgestuurde factoringaanvraag gefinancierd kan worden (receipt, dan acknowledgment, dan acceptance), of alleen door een advocaat goedgekeurde verklaringsteksten tellen, uw open aanvragen per niveau, en voor welke niveaus elk toepasselijk recht een verklaringstekst heeft, in welke talen.

Scope

requests:read

Antwoord

200{ funder, debtor_consent_level, require_counsel_approved_texts, open_requests_by_level, levels, levels_by_law, texts_counsel_approved }

Fouten

Alleen de algemene (401, 403, 500).

curl -s "$BASE/v1/settings" \
  -H "Authorization: Bearer $ADVANTA_KEY"

PUT/v1/settings

Wijzigen wat uw debiteuren moeten ondertekenen. De wijziging geldt voor aanvragen die vanaf dan naar u worden doorgestuurd; een al doorgestuurde aanvraag houdt het niveau waarmee ze werd doorgestuurd. reason wordt vastgelegd in de bewijsketen van Advanta.

Scope

settings:write of decisions:write

Antwoord

200{ …settings, changed, open_requests_keep_their_level }

Fouten

422level_invalid, invalid_flag, reason_required

curl -s -X PUT "$BASE/v1/settings" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"debtor_consent_level":"acknowledgment","reason":"Credit committee decision of 22 September"}'

GET/v1/programme

Uw programmavoorwaarden: uw standaard, de voorwaarden die u voor bepaalde bedrijven vastlegde, de bedrijven waarvoor u voorwaarden kunt vastleggen (met een aanvraag die naar u is doorgestuurd, en uw eigen klanten) en uw factoringaanvragen geteld naar hun voorwaarden. Een aanvraag krijgt de voorwaarden die gelden wanneer ze naar u wordt doorgestuurd en houdt ze.

Scope

requests:read

Antwoord

200{ funder, bank_id, default, companies[], sellers[], requests }

Fouten

Alleen de algemene (401, 403, 500).

disclosure: announced (standaard): elke debiteur krijgt de melding en bevestigt de cessie voordat u financiert. confidential: wanneer de aanvraag naar u wordt doorgestuurd, wordt de melding aan elke debiteur voorbereid, met haar vingerafdruk (SHA-256), en verzendklaar bewaard, en de financiering wacht niet op de debiteur. Vóór de financiering moeten alle blokkerende factuurcontroles geslaagd zijn, moeten de facturen uit de eigen boekhouding van de verkoper komen (ERP, e-factuur of SAF-T), moet elke debiteur een actuele voorbereide melding hebben die u noemt en een adres waar ze naartoe gaat, en moet de verificatie van de verkoper goedgekeurd zijn. De meldingen worden verstuurd wanneer u de aanvraag openbaar maakt, en automatisch bij een gefinancierde aanvraag wanneer een trigger die u aanzette zich voordoet: announce_overdue_days, announce_on_dispute, announce_on_kyc_lapse.

recourse: with (met regres) of without (zonder regres). recourse_days: dagen na de vervaldatum van een factuur voordat een gefinancierde, nog niet afgewikkelde aanvraag een vordering opent (null: geen). bank_data: off, requested (de verkoper wordt gevraagd zijn zakelijke rekening voor u te koppelen, alleen-lezen en met zijn toestemming) of required (de financiering wacht ook tot de rekening waarop u betaalt bevestigd is als die van de verkoper zelf).

curl -s "$BASE/v1/programme" \
  -H "Authorization: Bearer $ADVANTA_KEY"

{
  "funder": { "bank_id": "6d164c92-02cc-4f9a-ae8d-3f7f5ef043d3", "name": "Example Funder" },
  "default": {
    "disclosure": "announced",
    "recourse": "with",
    "recourse_days": 30,
    "announce_overdue_days": null,
    "announce_on_dispute": false,
    "announce_on_kyc_lapse": false,
    "bank_data": "requested",
    "source": "funder_default",
    "updated_at": "2026-09-28T10:00:00Z"
  },
  "companies": [
    {
      "seller_id": "2f6d8a4e-1b3c-4d5e-9f70-8a1b2c3d4e5f",
      "company_name": "Example Seller, S.L.",
      "tax_id": "B00000000",
      "terms": { "disclosure": "confidential", "recourse": "with", "recourse_days": 30, "announce_overdue_days": 15, "announce_on_dispute": true, "announce_on_kyc_lapse": true, "bank_data": "required", "source": "seller" },
      "reason": "Credit committee of 28 September"
    }
  ],
  "requests": { "announced:with:open": 4, "confidential:with:funded": 1 }
}

PUT/v1/programme

Uw standaard (zonder seller_id) of de voorwaarden van één bedrijf wijzigen. Alleen de sleutels die u stuurt veranderen; {"reset": true} met een seller_id zet dat bedrijf terug op uw standaard. De wijziging geldt voor aanvragen die vanaf dan naar u worden doorgestuurd; al doorgestuurde aanvragen houden hun voorwaarden. reason wordt vastgelegd in de bewijsketen van Advanta.

Scope

settings:write of decisions:write

Antwoord

200{ funder, bank_id, seller_id, terms, changed, open_requests_keep_their_terms }

Fouten

422body_invalid, seller_id_invalid, terms_invalid, terms_key_unknown, reason_required, seller_not_in_programme

curl -s -X PUT "$BASE/v1/programme" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"seller_id":"2f6d8a4e-1b3c-4d5e-9f70-8a1b2c3d4e5f","terms":{"disclosure":"confidential","announce_overdue_days":15,"announce_on_dispute":true,"announce_on_kyc_lapse":true,"bank_data":"required"},"reason":"Credit committee of 28 September"}'

POST/v1/requests/{id}/announce

Een stille aanvraag die naar u is doorgestuurd openbaar maken: ze wordt openbaar en de voor haar voorbereide meldingen gaan naar haar debiteuren, die ze daarna bevestigen zoals in een openbaar programma. Mogelijk zolang de aanvraag openstaat, in beoordeling is, voorwaarden heeft gekregen, goedgekeurd of gefinancierd is. Er volgt een event request.announced; zodra een melding verstuurd is, blijft de aanvraag openbaar.

Scope

decisions:write

Antwoord

200{ request_id, disclosure, trigger, notices, sending_queued }

Fouten

403not_routed_to_you

404not_found

422body_invalid, reason_required, already_announced, request_closed

curl -s -X POST "$BASE/v1/requests/4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87/announce" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Invoice 2026-118 is 20 days overdue"}'

GET/v1/requests/{id}/notices

De cessiemeldingen van de aanvraag, één per debiteur, elk met het voorbereide document als dat er is: precies het onderwerp en de HTML die de debiteur ontvangt, de taal, het toepasselijke recht en de SHA-256. Voor een aanvraag die naar u is doorgestuurd, of een waarop u al hebt gehandeld.

Scope

requests:read

Antwoord

200{ request_id, count, notices[] }

Fouten

404not_found

De HTML bevat een plaatshouder, ACK_LINK tussen dubbele accolades, waar de bevestigingslink van de debiteur komt; de link bevat een geheim en wordt nooit getoond. current zegt of het document nog overeenkomt met de facturen en het bedrag van de melding.

curl -s "$BASE/v1/requests/4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87/notices" \
  -H "Authorization: Bearer $ADVANTA_KEY"

GET/v1/requests/{id}/cash-flow

Wat de verkoper van zijn zakelijke rekening met u deelt, alleen-lezen en met zijn toestemming, via een vergunde rekeninginformatiedienst: de koppeling, zijn rekeningen (de laatste vier tekens van elke IBAN) en hun saldi, twaalf maanden transacties per maand en de controle van zijn uitbetalingsrekening. cash_flow is null zolang de verkoper geen rekening voor u heeft gekoppeld.

Scope

requests:read

Antwoord

200{ request_id, bank_data, cash_flow, bank_data_problems[], payment_alerts[] }

Fouten

404not_found

bank_data_problems zegt waar de financiering nog op wacht wanneer uw voorwaarden bankgegevens vereisen. payment_alerts zijn de betalingen die de verkoper ontving van een debiteur van deze aanvraag nadat u haar onder stille voorwaarden financierde. De toestemming van een verkoper geldt voor één financier: u ziet alleen wat hij met u deelt.

curl -s "$BASE/v1/requests/4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87/cash-flow" \
  -H "Authorization: Bearer $ADVANTA_KEY"

GET/v1/recourse

Uw gefinancierde factoringaanvragen per soort regres (with, without, en not_recorded voor aanvragen doorgestuurd vóór 28 september 2026), de vorderingen geteld per soort en status, en de vorderingen zelf, open eerst. Er opent één vordering per aanvraag wanneer een gefinancierde aanvraag recourse_days na de vervaldatum van een factuur niet is afgewikkeld: recourse, op de verkoper, voor het voorgeschoten bedrag plus uw vergoedingen, min wat u al ontving; debtor_default, zonder regres, voor uw eigen incasso en verzekering.

Scope

requests:read

Antwoord

200{ funder, bank_id, currency, as_of, by_type[], claims[], list[] }

Fouten

422status_invalid

De verkoper betaalt een regresvordering terug op pay_to_iban met pay_reference. Wanneer de betalingen die u vanaf dan boekt (een afschriftregel die u bevestigt, of de beslissing settle) claim_amount dekken, is de vordering afgewikkeld en sluit de aanvraag als afgewikkeld door regres: de facturen gaan terug naar de verkoper, nog steeds onbetaald door de debiteur.

curl -s "$BASE/v1/recourse?status=open" \
  -H "Authorization: Bearer $ADVANTA_KEY"

POST/v1/recourse/{id}/close

Een open vordering van u sluiten: een regresvordering wordt withdrawn (u ziet ervan af, of u sprak iets anders af met de verkoper), een wanbetaling van de debiteur wordt written_off (overgedragen aan uw incasso of uw verzekeraar). reason wordt vastgelegd in de bewijsketen van Advanta.

Scope

decisions:write

Antwoord

200{ claim_id, status }

Fouten

403not_your_claim

404not_found

422body_invalid, status_invalid, reason_required, close_invalid, claim_closed

curl -s -X POST "$BASE/v1/recourse/$CLAIM_ID/close" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"withdrawn","reason":"Payment plan agreed with the seller on 2 October"}'

GET/v1/bank-data

Uw eigen incassorekening, door uw beheerder in het portaal gekoppeld en op dezelfde manier gelezen: de transacties gaan door dezelfde afstemming als POST /v1/statements, zodat ontvangsten zonder bestanden te uploaden aansluiten op uw gefinancierde aanvragen. Verder: hoeveel verkopers hun rekening met u delen, de betalingswaarschuwingen op uw aanvragen (de laatste 180 dagen) en de kosten van de aanbieder die aan u worden toegerekend, per maand.

Scope

requests:read

Antwoord

200{ funder, bank_id, own_accounts[], sellers_sharing, payment_alerts[], charges[] }

Fouten

Alleen de algemene (401, 403, 500).

unit_price_eur en amount_eur zijn null tot de prijs van de aanbieder vastligt.

curl -s "$BASE/v1/bank-data" \
  -H "Authorization: Bearer $ADVANTA_KEY"

GET/v1/credit-limits

Uw boek per debiteur: uw limiet en wat uitstaat, is toegezegd, is aangeboden en nog beschikbaar is, in euro.

Scope

limits:read of requests:read

Antwoord

200{ funder, currency, count, debtors[] }

Fouten

Alleen de algemene (401, 403, 500).

Elke debiteur bevat debtor_key, debtor_name, debtor_country, limit_status, limit_amount, outstanding, committed, offered, available, overdue_count, oldest_overdue, frozen, decided_at en note.

curl -s "$BASE/v1/credit-limits" \
  -H "Authorization: Bearer $ADVANTA_KEY"

PUT/v1/credit-limits

Uw limiet op een debiteur instellen of herzien, of de debiteur weigeren. De database weigert elk later aanbod dat deze limiet niet kan dragen.

Scope

limits:write of decisions:write

Antwoord

200{ credit_limit }

Fouten

422debtor_tax_id_required, invalid_amount, invalid_limit

curl -s -X PUT "$BASE/v1/credit-limits" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"debtor_tax_id":"A00000000","debtor_country":"ES","debtor_name":"Example Buyer, S.A.","amount":250000,"status":"active"}'

POST/v1/credit-limits/import

Tot 2.000 limieten op debiteuren in één aanroep laden: uw eigen boek, of de limieten van uw kredietverzekeraar. Elke regel wordt precies zo gecontroleerd als PUT /v1/credit-limits er één controleert en krijgt een eigen antwoord: een regel die faalt, houdt de andere niet tegen, en een debiteur die twee keer in dezelfde aanroep staat, wordt de tweede keer geweigerd.

Scope

limits:write of decisions:write

Antwoord

200{ funder, source, source_ref, received, written, refused, rows[] }

Fouten

413too_many_rows

422rows_required, invalid_source, source_ref_invalid, source_ref_too_long

Elke geschreven limiet legt zijn bron en referentie vast, op de limiet en in de geschiedenis ervan. Het antwoord telt received, written en refused, en beantwoordt elke regel met row (geteld vanaf 1), debtor_tax_id en ok: een geschreven regel voegt debtor_key, status en amount toe; een geweigerde regel geeft zijn error (invalid_amount, debtor_tax_id_required, duplicate_debtor, invalid_status, amount_required, invalid_country, row_invalid of invalid_limit) en kan een detail toevoegen.

curl -s -X POST "$BASE/v1/credit-limits/import" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"insurer","source_ref":"Insurer limits 2026-09","rows":[{"debtor_tax_id":"A00000000","debtor_country":"ES","debtor_name":"Example Buyer, S.A.","amount":250000},{"debtor_tax_id":"500000000","debtor_country":"PT","status":"refused"}]}'

GET/v1/seller-limits

Uw boek per verkoper, met dezelfde cijfers als het debiteurenboek.

Scope

limits:read of requests:read

Antwoord

200{ funder, currency, count, sellers[] }

Fouten

Alleen de algemene (401, 403, 500).

Elke verkoper bevat seller_id, seller_name, seller_nif, seller_country en dezelfde limiet- en blootstellingsvelden als een debiteur.

curl -s "$BASE/v1/seller-limits" \
  -H "Authorization: Bearer $ADVANTA_KEY"

PUT/v1/seller-limits

Uw limiet op een verkoper instellen of herzien, of de verkoper weigeren.

Scope

limits:write of decisions:write

Antwoord

200{ seller_limit }

Fouten

404not_found

422seller_id_required, invalid_amount, invalid_limit

curl -s -X PUT "$BASE/v1/seller-limits" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"seller_id":"2f6d8a4e-1b3c-4d5e-9f70-8a1b2c3d4e5f","amount":100000,"status":"active","note":"Annual review"}'

GET/v1/payer-record

Hoe een afnemer zijn leveranciers betaalt, alleen geaggregeerd, uit de boekhouding van de leveranciers die met Advanta verbonden zijn. Het profiel wordt gepubliceerd wanneer minstens drie leveranciers de afnemer waarnemen; anders zegt status waarom en is elk cijfer null. U kunt het alleen lezen voor een afnemer op een aanvraag binnen uw bereik of op uw debiteurenlijst; een sandboxsleutel leest het profiel van het demonstratievlak.

Scope

limits:read of requests:read

Antwoord

200{ funder, payer_record }

Fouten

404not_found (de afnemer staat op geen aanvraag binnen uw bereik en niet op uw debiteurenlijst)

422tax_id_required

De cijfers omvatten observers, invoice_count, avg_days_to_pay, median_days_to_pay, on_time_pct, de betalingsachterstand (avg_settle_delay_days, median_settle_delay_days, p75_settle_delay_days, worst_settle_delay_days), aantallen openstaand en achterstallig, window_from en refreshed_at. payer_record is null als er geen profiel is.

curl -s "$BASE/v1/payer-record?tax_id=A00000000&country=ES" \
  -H "Authorization: Bearer $ADVANTA_KEY"

GET/v1/requests/{id}/debtors

Wat Advanta weet over elke debiteur van een factoringaanvraag die naar u is doorgestuurd, of een waarop u al hebt gehandeld: zijn level bij Advanta sinds level_since (notice: hij kent Advanta alleen van de melding; account: hij heeft zijn betalersaccount geactiveerd; books: hij heeft zijn boekhouding gekoppeld; buyer: hij voert een kopersprogramma, en buyer_programme is true), de eigen geschiedenis van de verkoper met hem, zijn officiële betaaltermijn als hij een overheidsinstantie is, en uw limiet op hem.

Scope

requests:read

Antwoord

200{ funder, request_id, count, debtors[] }

Fouten

404not_found

score is de eigen score van de debiteur (klasse, 0 tot 100, wanneer en met welke modelversie). Die wordt alleen gegeven als de debiteur zijn gegevens deelt met de financiers die door hem verschuldigde facturen financieren, op niveau books of buyer staat, en de aanvraag naar u is doorgestuurd (niet een waarop u alleen hebt gehandeld); anders is hij null. pair_history is de geschiedenis van de verkoper met deze debiteur over 36 maanden, met de regels van het betaalprofiel: alleen echte facturen, en te laat alleen ten opzichte van vervaldata die op het document of in het ERP staan. public_payment_period is de recentste officiële gemiddelde betaaltermijn van een overheidsinstantie (DGAL voor Portugese gemeenten, Hacienda voor Spaanse lokale overheden). credit_limit is uw limiet op de debiteur, waar die vandaan komt (source, source_ref) en wat ervan gebruikt is (exposure: uitstaand plus toegezegd plus aangeboden, in euro).

curl -s "$BASE/v1/requests/4c1e0d2a-8f3b-4f6e-9a55-3c2b1d0e9f87/debtors" \
  -H "Authorization: Bearer $ADVANTA_KEY"

POST/v1/statements

Het afschrift van uw incassorekening sturen voor afstemming: een CAMT.053- (XML) of CSV-bestand, hoogstens 4 MiB en 5.000 transacties. Elke bijschrijving wordt afgestemd op uw eigen gefinancierde aanvragen, eerst op de referentie die de debiteur vermeldde. Er wordt niets afgeboekt voordat u een match in het portaal bevestigt. Hetzelfde bestand wordt geen tweede keer aangenomen, herkend aan de SHA-256.

Scope

statements:write of decisions:write

Antwoord

201{ import_id, file_sha256, lines, credits, duplicates, proposed, suggested, unmatched, ignored, … }

Fouten

409statement_already_imported

413file_too_large, too_many_lines

422file_required, file_unreadable, file_empty, statement_unreadable, statement_has_no_transactions, line_invalid

curl -s -X POST "$BASE/v1/statements?file_name=statement-2026-10-30.xml&kind=camt053" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/xml" \
  --data-binary @statement-2026-10-30.xml

GET/v1/client-links

Uw eigen open link (prescriber_id null) en de huidige link van elke aanbrenger, met zijn state (active, disabled of expired) en zijn url zolang hij werkt.

Scope

requests:read, clients:write of decisions:write

Antwoord

200{ funder, count, client_links[] }

Fouten

422lang_invalid

Een bedrijf dat een link opent, geeft zijn naam, fiscaal nummer, land en e-mail, en ontvangt uw uitnodiging per e-mail. Wanneer het die aanvaardt, wordt het uw klant: zijn aanvragen gaan alleen naar u, en zijn herkomst (de link, de aanbrenger, de datum) wordt vastgelegd. Een link openen maakt nooit zelf een account aan.

Elke link draagt ook arrivals (de bedrijven die via hem voor het eerst bij u kwamen) en claims_last_day (aanmeldingen via hem in de laatste 24 uur; een link neemt er hoogstens 20 per uur en 100 per dag aan).

curl -s "$BASE/v1/client-links?lang=es" \
  -H "Authorization: Bearer $ADVANTA_KEY"

POST/v1/client-links

Uw eigen open link uitgeven, of met prescriber_id die van een aanbrenger. Er is één werkende link per eigenaar: zolang er een werkt, stuurt u replace: true om hem te vervangen (de oude werkt meteen niet meer); anders 409 link_exists. Alleen de SHA-256 van het token van de link wordt bewaard, en de uitgifte wordt vastgelegd in de bewijsketen van Advanta.

Scope

clients:write of decisions:write

Antwoord

201{ client_link }

Fouten

404not_found

409link_exists

422body_invalid, prescriber_id_invalid, expires_at_invalid, reason_invalid, replace_invalid, lang_invalid

Een link die met een sandboxsleutel is uitgegeven, maakt alleen testuitnodigingen, en de sleutel heeft decisions:write nodig: de links van de demonstratiefinancier worden door alle demonstraties gedeeld.

curl -s -X POST "$BASE/v1/client-links" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"replace":true,"reason":"The old link was forwarded too widely","lang":"es"}'

{
  "client_link": {
    "id": "8d3e1f2a-4b5c-4d6e-9f70-1a2b3c4d5e6f",
    "prescriber_id": null,
    "state": "active",
    "created_at": "2026-09-26T10:00:00Z",
    "expires_at": null,
    "disabled_at": null,
    "disabled_reason": null,
    "replaced_by": null,
    "arrivals": 0,
    "claims_last_day": 0,
    "url": "https://app.advanta.capital/join?link=…&lang=es"
  }
}

POST/v1/client-links/{id}/disable

Een link uitschakelen. Hij werkt meteen niet meer; bedrijven die al via hem kwamen, behouden hun herkomst. Een al uitgeschakelde link uitschakelen verandert niets (changed is false). Een nieuwe geeft u uit met POST /v1/client-links.

Scope

clients:write of decisions:write

Antwoord

200{ link_id, changed, state: "disabled" }

Fouten

404not_found

405method_not_allowed

422body_invalid, reason_invalid

curl -s -X POST "$BASE/v1/client-links/$LINK_ID/disable" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Campaign ended"}'

GET/v1/prescribers

Uw aanbrengers, de personen en kantoren die u klanten brengen (boekhouders, adviseurs, bemiddelaars), de actieve eerst, elk met zijn huidige link en het aantal bedrijven dat via die link kwam. Ze zijn van u, geen partners van Advanta. Dezelfde lijst als de pagina Klanten van uw portaal.

Scope

requests:read, clients:write of decisions:write

Antwoord

200{ funder, count, prescribers[] }

Fouten

422lang_invalid

Een sandboxsleutel leest de aanbrengers van de demonstratiefinancier, die alle demonstraties delen.

curl -s "$BASE/v1/prescribers?lang=es" \
  -H "Authorization: Bearer $ADVANTA_KEY"

POST/v1/prescribers

Een aanbrenger toevoegen. Zijn eigen open link wordt samen met hem uitgegeven, in prescriber.link.url. Zijn naam en e-mail blijven buiten de bewijsketen van Advanta: alleen hun hashes staan erin.

Scope

clients:write of decisions:write

Antwoord

201{ prescriber }

Fouten

409prescriber_exists

422body_required, name_required, name_invalid, email_invalid, email_not_reserved, notes_too_long, lang_invalid

Met een sandboxsleutel verandert dit gedeelde demonstratiegegevens, dus de sleutel heeft decisions:write nodig.

curl -s -X POST "$BASE/v1/prescribers" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Gestoría Norte","email":"ana@gestoria-norte.example","notes":"Accountant in Bilbao","lang":"es"}'

{
  "prescriber": {
    "id": "5f1c2a8e-3b7d-4e0a-9c61-2d4b8e7f9a10",
    "name": "Gestoría Norte",
    "email": "ana@gestoria-norte.example",
    "notes": "Accountant in Bilbao",
    "active": true,
    "created_at": "2026-09-10T09:00:00Z",
    "disabled_at": null,
    "link": {
      "id": "1e2f3a4b-5c6d-4e7f-8a9b-0c1d2e3f4a5b",
      "prescriber_id": "5f1c2a8e-3b7d-4e0a-9c61-2d4b8e7f9a10",
      "state": "active",
      "expires_at": null,
      "arrivals": 0,
      "url": "https://app.advanta.capital/join?link=…&lang=es"
    }
  }
}

POST/v1/prescribers/{id}/disable

Een aanbrenger uitschakelen. Zijn link werkt meteen niet meer; de bedrijven die hij bracht, blijven aan hem toegeschreven. Een al uitgeschakelde aanbrenger uitschakelen verandert niets (changed is false). Vastgelegd in de bewijsketen van Advanta.

Scope

clients:write of decisions:write

Antwoord

200{ prescriber, changed }

Fouten

404not_found

405method_not_allowed

422body_invalid, reason_invalid

curl -s -X POST "$BASE/v1/prescribers/$PRESCRIBER_ID/disable" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Agreement ended"}'

GET/v1/prescribers/report

Wat elke aanbrenger u heeft gebracht: één groep per aanbrenger, dan uw eigen link (own_link), uw uitnodigingen op naam (named) en uw onboardinglinks (api). Per groep en per bedrijf: wanneer het kwam, wanneer zijn account werd geopend (joined), wanneer de verificatie van het bedrijf werd goedgekeurd (onboarded), de aanvragen die naar u zijn doorgestuurd, het aangevraagde en het gefinancierde bedrag. Dezelfde cijfers als in uw portaal.

Scope

requests:read, clients:write of decisions:write

Antwoord

200{ funder, plane, generated_at, currency, totals, groups[] }

Fouten

405method_not_allowed

Een bedrijf telt één keer, voor wie het als eerste bij u bracht. Het gefinancierde bedrag is het voorschot (anders het totaal) van gefinancierde of afgewikkelde aanvragen, in euro; totals telt alle groepen op. Alleen uw eigen gegevens en alleen bedrijven op uw gegevensvlak: een sandboxsleutel ziet niet wat andere sandboxsleutels via de API hebben gedaan.

curl -s "$BASE/v1/prescribers/report" \
  -H "Authorization: Bearer $ADVANTA_KEY"

{
  "funder": {
    "bank_id": "6d164c92-02cc-4f9a-ae8d-3f7f5ef043d3",
    "name": "Compartment Demo (LU)"
  },
  "plane": "sandbox",
  "generated_at": "2026-09-26T10:00:00Z",
  "currency": "EUR",
  "totals": { "arrived": 1, "joined": 1, "onboarded": 1, "requests": 1, "amount_requested": 18450.00, "amount_funded": 16605.00 },
  "groups": [
    {
      "kind": "prescriber",
      "prescriber_id": "5f1c2a8e-3b7d-4e0a-9c61-2d4b8e7f9a10",
      "name": "Gestoría Norte",
      "active": true,
      "since": "2026-09-10T09:00:00Z",
      "arrived": 1,
      "joined": 1,
      "onboarded": 1,
      "requests": 1,
      "amount_requested": 18450.00,
      "amount_funded": 16605.00,
      "companies": [
        {
          "company_name": "Example Seller, S.L.",
          "company_tax_id": "B00000000",
          "country": "ES",
          "arrived_at": "2026-09-15T11:02:00Z",
          "joined_at": "2026-09-15T11:20:00Z",
          "onboarded_at": "2026-09-16T09:15:00Z",
          "requests": 1,
          "amount_requested": 18450.00,
          "amount_funded": 16605.00
        }
      ]
    }
  ]
}

GET/v1/client-invitations

Al uw uitnodigingen, de nieuwste eerst: via een link, op naam in het portaal of met een onboardinglink. Elke uitnodiging vermeldt hoe het bedrijf kwam (via: link, named of api), de aanbrenger die het bracht, als die er is, haar state (pending, accepted, revoked of expired), het bedrijf, de contactpersoon en de data.

Scope

requests:read, clients:write of decisions:write

Antwoord

200{ funder, count, invitations[] }

Fouten

405method_not_allowed

Alleen uw eigen gegevensvlak. Een sandboxsleutel ziet de uitnodigingen van andere sandboxsleutels niet.

curl -s "$BASE/v1/client-invitations?limit=50" \
  -H "Authorization: Bearer $ADVANTA_KEY"

GET/v1/opportunities

Het overzicht van een dag, van uw eigen klanten (de bedrijven waarvan u de vaste financier bent) die u hun facturen laten zien. Elke ochtend rond 06:30 uur Madrid-tijd, na de nachtelijke prekwalificatie, zet Advanta de facturen op een rij die sinds het vorige overzicht aan uw regels voldoen (kind new), en wat er veranderde in de facturen die u al zag: paid, disputed (de klant registreerde dat zijn debiteur de factuur betwist) of no_longer_eligible.

Scope

requests:read

Antwoord

200{ funder, date, digest, lines[] }

Fouten

404not_found

405method_not_allowed

422invalid_date

Een regel bevat de factuur, de debiteur met zijn fiscale nummer, het bedrag dat nog openstaat, de vervaldatum, en de klant met zijn sector (NACE-sectie), klasse en grootteklasse; eerst de nieuwe regels, dan de wijzigingen. no_longer_eligible heeft een reason: requested (de klant vroeg om financiering ervan), cancelled, removed (niet meer in de boeken van de klant), left_programme, not_shared (de klant deelt niet meer) of rules (voldoet niet meer aan uw regels).

digest bevat de totalen: hoeveel klanten delen en hoeveel nog niet, wat vandaag in aanmerking komt, wat nieuw is en wat veranderde. stale is true als de nachtelijke run niet afliep: die ochtend werd niets vergeleken. Een overzicht is een lijst die de database berekende, geen aanbod: een aanvraag wordt opnieuw gecontroleerd wanneer ze wordt gedaan, en u beslist zoals altijd. De webhook opportunities.daily meldt wanneer er een overzicht met inhoud klaarstaat.

curl -s "$BASE/v1/opportunities?date=2026-10-07" \
  -H "Authorization: Bearer $ADVANTA_KEY"

{
  "funder": { "bank_id": "6d164c92-02cc-4f9a-ae8d-3f7f5ef043d3", "name": "Example Funder" },
  "date": "2026-10-07",
  "digest": {
    "digest_id": "9b2d4c1e-0f3a-4e5b-8c6d-7a8b9c0d1e2f",
    "date": "2026-10-07",
    "stale": false,
    "snapshot_at": "2026-10-07T03:30:12Z",
    "clients": { "sharing": 9, "not_sharing": 1 },
    "eligible": { "count": 42, "total": 318450.00 },
    "new": { "count": 6, "total": 41200.00 },
    "changes": { "paid": 2, "disputed": 0, "no_longer_eligible": 1 },
    "currency": "EUR",
    "lines": "/v1/opportunities?date=2026-10-07"
  },
  "lines": [
    {
      "kind": "new",
      "reason": null,
      "invoice_id": "0c5e7f3a-2b4d-4c6e-9f81-3a5b7c9d1e2f",
      "number": "FV 2026/1184",
      "debtor": { "name": "Example Buyer, S.A.", "tax_id": "A00000000", "country": "ES" },
      "amount": 12400.00,
      "currency": "EUR",
      "due_date": "2026-12-15",
      "client": { "seller_id": "2f6d8a4e-1b3c-4d5e-9f70-8a1b2c3d4e5f", "name": "Example Seller, S.L.", "tax_id": "B00000000", "sector": "C", "grade": "B", "size_band": "small" }
    }
  ]
}

GET/v1/webhooks

Uw actieve endpoints, zonder hun secrets, en de eventtypes waarop u zich kunt abonneren. Een sandboxsleutel ziet alleen de endpoints die hij zelf heeft aangemaakt.

Scope

webhooks:write, decisions:write of requests:read

Antwoord

200{ count, webhooks[], event_types[] }

Fouten

Alleen de algemene (401, 403, 500).

curl -s "$BASE/v1/webhooks" \
  -H "Authorization: Bearer $ADVANTA_KEY"

POST/v1/webhooks

Een endpoint registreren. Het antwoord bevat het ondertekeningssecret, dat niet opnieuw wordt getoond.

Scope

webhooks:write of decisions:write

Antwoord

201{ webhook, secret, signature }

Fouten

409too_many_endpoints

422body_required, url_required, url_invalid, url_too_long, url_must_be_https, url_has_credentials, url_port_not_allowed, url_host_not_allowed, url_not_allowed, events_invalid, unknown_event_type, invalid_description

Hoogstens 10 actieve endpoints.

curl -s -X POST "$BASE/v1/webhooks" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://hooks.example.com/advanta","events":["request.routed","notice.acknowledged","notice.disputed","request.funded","settlement.recorded"],"description":"Credit desk"}'

const res = await fetch(`${BASE}/v1/webhooks`, {
  method: 'POST',
  headers: { ...headers, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    url: 'https://hooks.example.com/advanta',
    events: ['request.routed', 'notice.acknowledged', 'notice.disputed', 'request.funded', 'settlement.recorded'],
    description: 'Credit desk',
  }),
});
const body = await res.json();
if (res.status !== 201) throw new Error(`${res.status} ${body.error.code}: ${body.error.message}`);

// The secret is shown once: store it now, in your own secret store.
await secretStore.put(`advanta-webhook-${body.webhook.id}`, body.secret);

{
  "webhook": {
    "id": "e3b1c2d4-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
    "url": "https://hooks.example.com/advanta",
    "description": "Credit desk",
    "events": ["notice.acknowledged", "notice.disputed", "request.funded", "request.routed", "settlement.recorded"],
    "active": true,
    "secret_prefix": "whsec_1a2b3c",
    "created_via": "api"
  },
  "secret": "whsec_…",
  "signature": { "header": "Advanta-Signature", "scheme": "HMAC-SHA256 of \"<t>.<raw body>\"", "tolerance_seconds": 300 }
}

DELETE/v1/webhooks/{id}

Een endpoint stoppen. Nog openstaande afleveringen worden geannuleerd en de secrets verwijderd.

Scope

webhooks:write of decisions:write

Antwoord

200{ id, active: false, deleted: true, cancelled_deliveries }

Fouten

404not_found

curl -s -X DELETE "$BASE/v1/webhooks/$WEBHOOK_ID" \
  -H "Authorization: Bearer $ADVANTA_KEY"

POST/v1/webhooks/{id}/rotate-secret

Een nieuw ondertekeningssecret, één keer getoond. Het vorige secret blijft ondertekenen, als tweede v1 in de header, gedurende keep_previous_hours, zodat u kunt overschakelen zonder events te verliezen.

Scope

webhooks:write of decisions:write

Antwoord

200{ webhook, secret, previous_secret_valid_until }

Fouten

404not_found

422invalid_keep_previous_hours

curl -s -X POST "$BASE/v1/webhooks/$WEBHOOK_ID/rotate-secret" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"keep_previous_hours":24}'

POST/v1/webhooks/{id}/test

Een webhook.test-event voor dit endpoint in de wachtrij zetten. De volgende run van de dispatcher levert het af, binnen ongeveer een minuut.

Scope

webhooks:write of decisions:write

Antwoord

202{ endpoint_id, event_id, delivery_id, status: "pending" }

Fouten

404not_found

curl -s -X POST "$BASE/v1/webhooks/$WEBHOOK_ID/test" \
  -H "Authorization: Bearer $ADVANTA_KEY"

GET/v1/webhooks/{id}/deliveries

Het afleverlogboek van een endpoint, nieuwste eerst: status (pending, delivered, failed of cancelled), pogingen, antwoordcode, laatste fout, volgende poging en de SHA-256 van de exact verstuurde body.

Scope

webhooks:write, decisions:write of requests:read

Antwoord

200{ count, deliveries[] }

Fouten

404not_found

curl -s "$BASE/v1/webhooks/$WEBHOOK_ID/deliveries?limit=20" \
  -H "Authorization: Bearer $ADVANTA_KEY"

POST/v1/onboarding-links

Een onboardinglink voor eenmalig gebruik voor een van uw leveranciers, aan u toegeschreven. Advanta stuurt geen e-mail: u geeft de url aan uw leverancier. Wanneer de leverancier de verificatie van zijn bedrijf heeft ingediend, ontvangt u onboarding.completed, en de leverancier wordt met een ondertekende status teruggestuurd naar uw return_url.

Scope

onboarding:write of decisions:write

Antwoord

201{ onboarding_link, url, expires_at, environment, return_secret, return }

Fouten

409company_already_registered, email_has_account, invitation_pending_exists, country_not_served

422body_required, country_invalid, company_vat_invalid, contact_email_invalid, contact_name_invalid, company_name_invalid, company_name_required, return_url_invalid, return_url_not_allowed, metadata_invalid, locale_invalid, valid_days_invalid, country_not_served

Het antwoord bevat return_secret (ors_ gevolgd door 64 hexadecimale tekens), één keer getoond: bewaar het meteen. Alleen de SHA-256 van het token van de link wordt bewaard. Een link die met een sandboxsleutel is aangemaakt, legt de leverancier vast als testbedrijf op het demonstratievlak.

Wanneer de leverancier terugkomt, draagt de return_url advanta_onboarding (het id van de link), advanta_status (completed), advanta_ts (Unix-seconden) en advanta_sig: de hexadecimale HMAC-SHA256 van <advanta_onboarding>.<advanta_status>.<advanta_ts>, met uw return_secret als sleutel. Controleer die voordat uw pagina de status vertrouwt, en weiger een terugkeer die meer dan 600 seconden van uw klok afwijkt; het laatste voorbeeld hieronder doet beide.

curl -s -X POST "$BASE/v1/onboarding-links" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company_vat":"PT500000000","country":"PT","contact_email":"ana@fornecedor.example","contact_name":"Ana Sousa","company_name":"Fornecedor Exemplo, Lda.","return_url":"https://portal.example.com/onboarding/done","metadata":{"supplier_ref":"S-42"},"locale":"pt"}'

{
  "onboarding_link": {
    "id": "c2d4e6f8-1a3b-4c5d-8e7f-9a0b1c2d3e4f",
    "status": "pending",
    "company_name": "Fornecedor Exemplo, Lda.",
    "country": "PT",
    "return_url": "https://portal.example.com/onboarding/done",
    "metadata": { "supplier_ref": "S-42" },
    "expires_at": "2026-10-10T10:00:00Z",
    "completed_at": null,
    "seller_id": null
  },
  "url": "https://app.advanta.capital/accept-invite?invitation=…&lang=pt",
  "expires_at": "2026-10-10T10:00:00Z",
  "environment": "sandbox",
  "return_secret": "ors_…",
  "return": {
    "parameters": ["advanta_onboarding", "advanta_status", "advanta_ts", "advanta_sig"],
    "signature": "hex HMAC-SHA256(return_secret, \"<advanta_onboarding>.<advanta_status>.<advanta_ts>\")"
  }
}

import crypto from 'node:crypto';

// On the page behind your return_url.
// url:          the full address the supplier came back to
// returnSecret: the "ors_…" string POST /v1/onboarding-links returned, stored when you made the link
export function verifyAdvantaReturn(url, returnSecret, nowSeconds = Math.floor(Date.now() / 1000)) {
  const q = new URL(url).searchParams;
  const id = q.get('advanta_onboarding') ?? '';
  const status = q.get('advanta_status') ?? '';
  const ts = q.get('advanta_ts') ?? '';
  const sig = q.get('advanta_sig') ?? '';
  if (!id || !status || !/^[0-9]{1,12}$/.test(ts) || !/^[0-9a-f]{64}$/.test(sig)) return null;
  if (Math.abs(nowSeconds - Number(ts)) > 600) return null; // too old: ask your back end instead

  const expected = crypto.createHmac('sha256', returnSecret).update(`${id}.${status}.${ts}`).digest();
  if (!crypto.timingSafeEqual(Buffer.from(sig, 'hex'), expected)) return null;
  return { onboardingLinkId: id, status }; // status is "completed"
}

GET/v1/onboarding-links

Uw onboardinglinks, de nieuwste eerst, elk met zijn status: pending, account_created, completed, expired of revoked. Een sandboxsleutel ziet de links die hij heeft aangemaakt.

Scope

onboarding:write, decisions:write of requests:read

Antwoord

200{ count, onboarding_links[] }

Fouten

Alleen de algemene (401, 403, 500).

curl -s "$BASE/v1/onboarding-links?limit=20" \
  -H "Authorization: Bearer $ADVANTA_KEY"

GET/v1/onboarding-links/{id}

Eén onboardinglink en waar de leverancier staat. Zodra hij voltooid is, is seller_id het id dat GET /v1/seller-limits gebruikt.

Scope

onboarding:write, decisions:write of requests:read

Antwoord

200{ onboarding_link }

Fouten

404not_found

405method_not_allowed

curl -s "$BASE/v1/onboarding-links/$ONBOARDING_ID" \
  -H "Authorization: Bearer $ADVANTA_KEY"

POST/v1/exports

Start een export van alles wat uw financier kan zien: aanvragen en hun geschiedenis, aanbiedingen, facturen met hun controle, verkopers (bedrijfsgegevens, de KYC-samenvatting die u mag zien, de verificatie van de vertegenwoordiger), debiteuren, kennisgevingen met de antwoorden van de debiteuren en de gegevens van de certificaten, de vermeldingen in de bewijsketen over uw transacties met de hashes en dagroots om ze te controleren, ontvangsten en afschriften, weigeringen door de controles, uw regels en limieten, uw team, webhook-endpoints (nooit een geheim), API-sleutels (nooit een sleutel), uw audittrail en uw documenten. Hij wordt op de achtergrond aangemaakt, meestal in minder dan een minuut; export.ready meldt wanneer.

Scope

exports:write of decisions:write

Antwoord

202{ funder, export }

Fouten

403export_live_key_required

409export_in_progress

422body_invalid, lang_invalid

429export_rate_limited

Alleen een productiesleutel: een sandboxsleutel krijgt 403 export_live_key_required (de demonstratiefinancier wordt gedeeld). Eén export tegelijk, hoogstens 10 in 24 uur. Dezelfde export staat op de pagina Export van het portaal, bij de instellingen.

curl -s -X POST "$BASE/v1/exports" \
  -H "Authorization: Bearer $ADVANTA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lang":"es"}'

{
  "funder": { "bank_id": "6d164c92-02cc-4f9a-ae8d-3f7f5ef043d3", "name": "Example Funder" },
  "export": {
    "id": "5e1f0a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
    "subject": "funder",
    "status": "queued",
    "plane": "live",
    "requested_via": "api",
    "actor_role": "api:treasury",
    "lang": "es",
    "created_at": "2026-09-27T09:00:02.114000Z",
    "download_available": false,
    "manifest_sha256": null,
    "progress": { "entities_done": 0, "entities_total": 47, "rows": 0, "volumes_written": 0, "phase": "data" }
  }
}

GET/v1/exports

Uw exports, uit het portaal en de API, de nieuwste eerst, met status, grootte en manifest_sha256.

Scope

exports:write of decisions:write

Antwoord

200{ funder, count, exports[] }

Fouten

403export_live_key_required

405method_not_allowed

curl -s "$BASE/v1/exports?limit=20" \
  -H "Authorization: Bearer $ADVANTA_KEY"

GET/v1/exports/{id}

Eén export. Terwijl hij wordt aangemaakt: status queued of running, met progress. Zodra ready, en 24 uur lang: files, elk deel met een link die hoogstens een uur geldig is (nooit na die 24 uur). Vraag opnieuw voor nieuwe links; elke aanroep die links teruggeeft wordt vastgelegd. Na 24 uur worden de bestanden verwijderd en blijft het record.

Scope

exports:write of decisions:write

Antwoord

200{ funder, export, files[] }

Fouten

403export_live_key_required

404not_found

405method_not_allowed

manifest_sha256 is de SHA-256 van manifest.json geschreven zonder dat veld, met gesorteerde sleutels en zonder spaties. Advanta legde dezelfde waarde vast in de bewijsketen (vermelding export.ready); verify.py berekent hem opnieuw en controleert elk bestand en de bewijsvermeldingen.

curl -s "$BASE/v1/exports/5e1f0a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b" \
  -H "Authorization: Bearer $ADVANTA_KEY"

{
  "funder": { "bank_id": "6d164c92-02cc-4f9a-ae8d-3f7f5ef043d3", "name": "Example Funder" },
  "export": {
    "id": "5e1f0a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
    "status": "ready",
    "completed_at": "2026-09-27T09:00:41.502000Z",
    "expires_at": "2026-09-28T09:00:41.502000Z",
    "download_available": true,
    "manifest_sha256": "1c822b8797ba58903eca0689cc0c93138e7d396e01a038d133b5c1f3aeec7497",
    "size_bytes": 482113,
    "file_count": 101,
    "documents_mode": "files",
    "row_counts": { "requests": 212, "invoices": 1480, "evidence_entries": 903 }
  },
  "files": [
    {
      "name": "advanta-export-2026-09-27-5e1f0a2b-v001.zip",
      "bytes": 482113,
      "sha256": "9b0e5c1d2a7f4e6b8c3d1a0f9e8d7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a291807",
      "url": "https://…/object/sign/data-exports/…",
      "url_expires_at": "2026-09-27T10:00:41.502000Z"
    }
  ]
}

# Every volume into one folder, then the checker the export carries
curl -s "$BASE/v1/exports/$EXPORT_ID" -H "Authorization: Bearer $ADVANTA_KEY" \
  | jq -r '.files[].url' | while read -r u; do curl -s -o "v$((++n)).zip" "$u"; done
for z in v*.zip; do unzip -q -o "$z" -d export; done
python3 export/advanta-export-*/verify.py   # files, manifest digest and evidence chain

GET/v1/exports/{id}/documents

Als de documenten te groot waren om op te nemen (documents_mode links): elk document van de export met een link die 15 minuten geldig is, per pagina. De lijst wordt berekend wanneer u vraagt: een document dat u niet meer mag lezen staat er niet in.

Scope

exports:write of decisions:write

Antwoord

200{ funder, export_id, documents[], next_after }

Fouten

403export_live_key_required

404not_found

409export_not_ready, export_failed

410export_expired

curl -s "$BASE/v1/exports/5e1f0a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents?limit=100" \
  -H "Authorization: Bearer $ADVANTA_KEY"