Skip to main content

API Methods

This page provides a complete list of methods for the Sales Finance Integration API. The current version is V3.

Versions V1 and V2 are scheduled for deprecation by the end of 2025.

For detailed request parameters and example responses, click on the links for each endpoint.


Order Methods

Endpoint LinkMethodDescriptionNote
/orderPOSTCreateOrder - Creates a new order and initiates the application process by sending an invitation SMS to the applicant. The application proceeds after the user accepts the invitation.The requested Amount must be supported by at least one available campaign. If no matching campaign is found, the API returns a 400 Bad Request error.
/order/{orderId}/cancelPATCHCancelOrder - Cancels the application.The status must not be CaptureRequested, Captured, Completed, or Cancelled.
/order/{orderId}/capturePATCHCaptureOrder - Confirms the delivery of goods/services to Svea, which triggers the financial capture. A Captured callback is sent on completion.If the ApprovedAmount is lower than the applied Amount, you must first call UpdateAmount before capturing.
/order/{orderId}GETGetOrder - Gets a specific order by its unique ID.
/clients/{clientId}/ordersGETGetOrders - Lists all orders for a client. The optional startDate and endDate parameters filter by a specific time period.

Order Update Methods

Endpoint LinkMethodDescriptionNote
/order/{orderId}/updatePATCHUpdateOrder - Provide values for the properties you wish to update. Null values will be ignored. Empty values will be treated as a new value. For example, an empty string for phone number will be treated as attempting to overwrite the existing phone number with an empty string.If a new phone number is submitted, a new SMS will be sent.

Allowed if status is Created.
/order/{orderId}/amountPATCHUpdateAmount - Amount can never be set to a value higher than OriginalAmount, nor higher than ApprovedAmount if set on the order.Allowed if status is Created, Approved, or ReadyForCapture.
/order/{orderId}/refnoPATCHUpdateRefNo - Updates the reference number displayed in accounting reports, which identifies the order in the merchant's system.Allowed if status is Created, Initiated, Approved, UnderReview, or ReadyForCapture.
/order/{orderId}/orderinfoPATCHUpdateOrderInfoThe status must not be Completed, Rejected, or Cancelled.
/order/{orderId}/campaignPATCHUpdateCampaign - specifies the campaign to be used for the application.Allowed if status is Approved.

Integration Methods

Endpoint LinkMethodDescriptionNote
/clients/GETGetClients - Lists all the integrator's set up clients.
/clients/{clientId}/campaignsGETGetCampaigns - Lists all campaigns available for a specific client.If the optional Amount parameter is provided, the list will be filtered to only include campaigns that are applicable for the given amount.

Accounting Methods

Endpoint LinkMethodDescriptionNote
/accounting/{clientId}/reportGETGetAccountingReport - Gets the accounting report, listing all applications completed in the given period.