Skip to main content

Create Order

warning

This API method is deprecated. Consumers must not rely on any response data from this endpoint.

CreateOrder

This method creates an invoice or payment plan order in the system.


Input

CreateOrderRequest

FieldRTypeDescription
ClientId-LongID that identifies a client in Svea Payments system. Required if the account has several clients of this order type.
OrderInformation*CreateOrderInformationInformation needed to create the order.

Output

CreateOrderResponse

FieldRTypeDescription
CreateOrderResult-CreateOrderResultThe result of the operation.
OrderRows-Collection of NumberedOrderRowThe order rows in the request, decorated with an order row number.

Structures

CreateOrderInformation

FieldRTypeDescription
ClientOrderNumber-String(32)Order number from the client’s ordersystem.
OrderRows*Collection of OrderRowsThe order rows connected to the order.
CustomerIdentity*CustomerIdentityThe ID details of the customer.
OrderDate*DateTimeDate of the order.
AddressSelector-StringUsed to select a specific address returned from GetAddress.
CustomerReference-String(32)(Optional) Customer reference.
OrderType*OrderTypeInvoice or PaymentPlan.
OrderDeliveryAddress-AddressOrder delivery address, if different from the address provided in CustomerIdentity.
CreatePaymentPlanDetails-CreatePaymentPlanDetailsRequired if order type is PaymentPlan.

Address

FieldRTypeDescription
FullName*StringFull name of the customer (either first name + family name or company name).
Street*StringCustomer’s street address.
CoAddress-StringCustomer co-address.
ZipCode*StringThe complete zip code of the customer.
HouseNumber-StringHouse number (only applicable in certain countries).
Locality*StringCustomer’s town of residence.
CountryCode*String (2)A country code which defines where the customer is residing.

CreatePaymentPlanDetails

FieldRTypeDescription
CampaignCode-LongWhat campaign code to use. Either a campaign code or a fixed monthly amount must be entered.
CoCustomerIdentity-CustomerIdentityAdditional customer details if applicable.
SendAutomaticGiroPaymentForm-BoolIndicates if the AutoGiro payment form should be sent to the customer.
FixedMonthlyAmount-Decimal(18,2)The desired amount to pay each month, including the notification fee.

CreateOrderResult

FieldRTypeDescription
SveaOrderId-LongThe order ID.
OrderType-StringInvoice or PaymentPlan.
SveaWillBuyOrder-BoolTrue if Svea agrees to buy this order/invoice.
Amount-Decimal(18,2)The total order amount.
CustomerIdentity-CustomerIdentityIdentity of the customer.
ExpirationDate-DateTimeThe order’s expiration date.
PendingReasons-List<string>Contains identifiers if the order is pending.