> ## Documentation Index > Fetch the complete documentation index at: https://developers.novatrade24.com/llms.txt > Use this file to discover all available pages before exploring further. # Update one shipment's payment. > Replaces the payment of the named shipment under `If-Match`. The tag it compares is the one `GET` of this same resource issues, not the order's. ## OpenAPI ````yaml /openapi-integration-v1.yaml patch /partners/{sellerId}/orders/{uuid}/shipments/{shipmentId}/payment openapi: 3.1.0 info: title: Novatrade24 Integration API version: 1.5.0-draft summary: Customer-facing integration API for the Novatrade24 compliance platform. description: > The Novatrade24 Integration API lets marketplaces, dealers, and financial partners embed EU VAT-compliant cross-border vehicle transactions into their own systems. The API is organized around the end-to-end compliance workflow: 1. **Buyer (KYC)**: create or sync a buyer, run VIES, upload KYC documents, optionally trigger NT24-led verification. 2. **Order**: register a VIN-based transaction linked to a buyer. 3. **Invoice**: submit VAT security deposit invoice (`PRELIMINARY`) and final invoice data and documents. 4. **Payment**: submit proof-of-payment; pickup readiness is derived from it. 5. **Transport**: confirm pickup and delivery with CMR / declarations. 6. **Compliance rollup**: poll the composed state of the five modules above, or subscribe to webhooks. The rollup is also where you see what is still missing: `blockers[]` names the artifact and the module waiting for it. There is no seventh step. Novatrade24 staff close an order once the artifacts are on file; the rollup reports that as `complianceStatus: VALID`. The final invoice is submitted through the invoice operation with `type: FINAL`, like the VAT security deposit invoice (`PRELIMINARY`). **Status:** Draft specification. The production endpoint `https://api.novatrade24.com/v1` is live, with access restricted to pilot customers: every request needs a bearer token obtained through the OAuth2 client credentials grant. A hosted mock is available at `https://mock.api.novatrade24.com` for integration design. termsOfService: https://novatrade24.com/terms-and-conditions contact: name: Novatrade24 Integration Support email: integration-support@novatrade24.com url: https://developers.novatrade24.com license: name: Proprietary url: https://novatrade24.com/terms-and-conditions servers: - url: https://api.novatrade24.com/v1 description: Production (pilot, restricted access) - url: https://api.stage.novatrade24.com/v1 description: Staging environment - url: https://mock.api.novatrade24.com description: Hosted mock server (Prism), spec-driven stub responses security: - oauth2ClientCredentials: [] tags: - name: Discovery description: Organization + capability discovery. - name: Buyers description: | Manage buyer (trade partner) records and KYC lifecycle. `COMPANY` buyers are upserted by `(sellerId, vatNumber)`. Natural-person (`CONSUMER`) buyers are onboarded through the prospect / Click2Comply flow rather than through this API, but they are read here on the same operations and carry the same `BuyerResponse`. - name: KYC description: KYC documents, VIES checks, Mode B verification, profile. - name: Self-service invitations description: | Orchestrate buyer-facing self-service links for KYC submission and prospect onboarding. - name: Orders description: | Register vehicle transactions. Orders may contain one or more VINs; single-VIN is the default. - name: Invoice description: >- Buyer's VAT security deposit invoice (PRELIMINARY) or final invoice (FINAL). - name: Payment description: Proof-of-payment data and documents; pickup readiness trigger. - name: Transport description: Pickup + delivery milestones and documents (CMR, declarations). - name: Compliance description: End-to-end compliance rollup per order. - name: Prospects description: | The seller's Click2Comply campaign links (prospect invitations), and the seller's prospects from every entry channel: the company link, a contact's personal link or a campaign link. - name: Documents description: Typed document download. - name: Webhooks description: Webhook endpoint registration, delivery history, test-fire. paths: /partners/{sellerId}/orders/{uuid}/shipments/{shipmentId}/payment: parameters: - $ref: '#/components/parameters/SellerIdPath' - $ref: '#/components/parameters/OrderUuidPath' - $ref: '#/components/parameters/ShipmentIdPath' patch: tags: - Payment summary: Update one shipment's payment. description: | Replaces the payment of the named shipment under `If-Match`. The tag it compares is the one `GET` of this same resource issues, not the order's. operationId: updateShipmentPayment parameters: - $ref: '#/components/parameters/IdempotencyKeyHeader' - $ref: '#/components/parameters/IfMatchHeader' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PaymentRequest' responses: '200': description: Updated content: application/json: schema: $ref: '#/components/schemas/PaymentResponse' 4XX: $ref: '#/components/responses/Problem' 5XX: $ref: '#/components/responses/Problem' components: parameters: SellerIdPath: name: sellerId in: path required: true description: UUID of the seller trade partner (must be in caller's authorized list). schema: type: string format: uuid OrderUuidPath: name: uuid in: path required: true schema: type: string format: uuid ShipmentIdPath: name: shipmentId in: path required: true description: | UUID of one live shipment of the order in the path, as the order's `shipmentIds` list them. A shipment that is not this order's live shipment is `404`, whether it belongs to another order or no longer exists. schema: type: string format: uuid IdempotencyKeyHeader: name: Idempotency-Key in: header required: true description: | Client-generated unique key (UUID recommended) for this write operation. Identical key + identical body within 24h returns the cached response. Identical key + different body returns `422`. schema: type: string minLength: 1 maxLength: 255 IfMatchHeader: name: If-Match in: header description: | ETag value from a previous response, used for optimistic concurrency. Mismatch returns `409` with the current resource. schema: type: string schemas: PaymentRequest: type: object required: - paymentDate - bankAmount - cashAmount properties: paymentDate: type: string format: date bankAmount: $ref: '#/components/schemas/Money' cashAmount: $ref: '#/components/schemas/Money' sourceIban: type: string example: DE89370400440532013000 sourceAccountComment: type: string description: | Why the payment came from a bank account that is not registered with Novatrade24. The payment is stored without it, but an order whose payment is not from a registered account (`ibanConsistent: false`) cannot be completed until a comment is on file — the same rule the platform applies to its own users. Absent or blank leaves any comment already on the payment untouched. On a response it is the comment on file, whether sent here or entered by NT24 staff. example: >- Paid from the managing director's private account; the company account was frozen. PaymentResponse: allOf: - $ref: '#/components/schemas/PaymentRequest' - type: object properties: status: $ref: '#/components/schemas/PaymentStatus' amountMatchesInvoice: type: boolean ibanConsistent: type: boolean readyForPickup: type: boolean description: | Payment recorded and evidenced: `paymentDate` is set and an active proof of payment — a `PAYMENT_BANK_TRANSFER_SCREENSHOT` or a `PAYMENT_CONFIRMATION`, either one — is filed against the order, plus a source-of-funds declaration once cash reaches €10,000. Derived on every read, and it can turn back to false — raising the cash amount past the threshold makes the order wait for the declaration. On an order split across several shipments, every shipment answers. version: type: integer updatedAt: type: string format: date-time Money: type: object required: - value - currency properties: value: type: integer format: int64 minimum: 0 description: Amount in minor units (e.g. 7900 = €79.00). example: 7900 currency: type: string description: ISO 4217 currency code. example: EUR PaymentStatus: type: string enum: - DRAFT - SUBMITTED - VALID - INVALID Problem: type: object required: - type - title - status properties: type: type: string format: uri title: type: string status: type: integer detail: type: string instance: type: string traceId: type: string responses: Problem: description: | RFC 9457 problem detail. Default fallback for any status not explicitly enumerated on the operation. Concrete status is in `status` field. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' securitySchemes: oauth2ClientCredentials: type: oauth2 description: | OAuth 2.0 client_credentials grant via Keycloak service account. Clients are provisioned per `IntegrationOrganization` in the `nt24-idp` realm. flows: clientCredentials: tokenUrl: >- https://auth.novatrade24.com/realms/nt24-idp/protocol/openid-connect/token scopes: {} ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.