Svea Payments

https://docs.payments.svea.com/docs
Admin
Svea Payments offers a comprehensive suite of financial solutions for businesses, including a...
Tokens:98,730
Snippets:571
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### C# Example: Get Order Information

Source: https://docs.payments.svea.com/docs/manage-order/getting_order_information

Use this C# code to make a GET request to retrieve order details. It requires setting up an HttpClient with the correct base address and adding 'Authorization' and 'Timestamp' headers. Ensure the Authentication.CreateAuthenticationToken method is implemented elsewhere.

```csharp
using Microsoft.Extensions.DependencyInjection;
  
static async Task GetOrderAsync(long checkoutOrderId)
{
  
    var services = new ServiceCollection();
    services.AddHttpClient("MyApiClient", client =>
    {
        client.BaseAddress = new Uri("http://paymentadminapistage.svea.com/api/");
    });
  
    var serviceProvider = services.BuildServiceProvider();
    var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
    var httpClient = httpClientFactory.CreateClient("MyApiClient");
  
    // Add authorization header  
    Authentication.CreateAuthenticationToken(out string token, out string timestamp);
    httpClient.DefaultRequestHeaders.Add("Authorization", token);
    httpClient.DefaultRequestHeaders.Add("Timestamp", timestamp);
  
    var apiUrl = string.Format("v1/orders/{0}", checkoutOrderId);
  
    try
    {
        HttpResponseMessage response = await httpClient.GetAsync(apiUrl);
  
        // Check if the request was successful  
        if (response.IsSuccessStatusCode)
        {
            string responseData = await response.Content.ReadAsStringAsync();
            Console.WriteLine("Response: " + responseData);
        }
        else
        {
            Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);
        }
    }
    catch (HttpRequestException ex)
    {
        Console.WriteLine("Error: " + ex.Message);
    }
}
```

--------------------------------

### Get Subscription Example in C#

Source: https://docs.payments.svea.com/docs/manage-order/callbacks/get_subscription

This C# code demonstrates how to make a GET request to retrieve a webhook subscription by its ID. It includes setting up the HTTP client, adding authorization headers, and handling the response. Ensure you have the necessary authentication methods implemented.

```csharp
using Microsoft.Extensions.DependencyInjection;
  
internal static class GetSubscription  
{
    internal static async Task GetSubscriptionAsync(string subscriptionid)
    {
        var services = new ServiceCollection();
        services.AddHttpClient("MyApiClient", client =>
        {
            client.BaseAddress = new Uri("http://paymentadminapistage.svea.com/api/");
        });

        var serviceProvider = services.BuildServiceProvider();
        var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
        var httpClient = httpClientFactory.CreateClient("MyApiClient");

        var apiUrl = string.Format("v2/callbacks/subscriptions/{0}", subscriptionid);

        // Add authorization header
        Authentication.CreateAuthenticationToken(out string token, out string timestamp);
        httpClient.DefaultRequestHeaders.Add("Authorization", token);
        httpClient.DefaultRequestHeaders.Add("Timestamp", timestamp);

        try
        {
            HttpResponseMessage response = await httpClient.GetAsync(apiUrl);

            // Check if the request was successful
            if (response.IsSuccessStatusCode)
            {
                string responseData = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Response: " + responseData);
            }
            else
            {
                Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);
            }
        }
        catch (HttpRequestException ex)
        {
            Console.WriteLine("Error: " + ex.Message);
        }
    }
}

```

--------------------------------

### C# Example for Delivering an Order

Source: https://docs.payments.svea.com/docs/manage-order/delivering_orders

This C# code demonstrates how to call the deliver order endpoint. It includes setting up the HTTP client, constructing the delivery request payload, and handling the response. Ensure you have the necessary authentication setup.

```csharp
using Microsoft.Extensions.DependencyInjection;
using System.Text.Json;
using System.Text;

internal static class DeliverOrder
{
    internal static async Task DeliverOrderAsync(long checkoutOrderId)
    {
        var services = new ServiceCollection();
        services.AddHttpClient("MyApiClient", client =>
        {
            client.BaseAddress = new Uri("http://paymentadminapistage.svea.com/api/");
        });

        var serviceProvider = services.BuildServiceProvider();
        var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
        var httpClient = httpClientFactory.CreateClient("MyApiClient");

        var apiUrl = string.Format("v1/orders/{0}/deliveries", checkoutOrderId);
        var orderRowIds = new int[] { 4 }; //Deliver Order with RowId - 4
        var rowDeliveryOptions = new List<RowDeliveryOptions>
    {
        new RowDeliveryOptions{OrderRowId = 4, Quantity = 100} //Deliver Order with RowId - 4 , Quanity - 1
    };

        var deliveryRequest = new DeliveryRequest(orderRowIds, rowDeliveryOptions, 1, false);
        var jsonString = JsonSerializer.Serialize(deliveryRequest);
        var deliveryRequestJson = new StringContent(
            jsonString,
            Encoding.UTF8,
            "application/json");

        // Add authorization header
        Authentication.CreateAuthenticationToken(out string token, out string timestamp, jsonString);
        httpClient.DefaultRequestHeaders.Add("Authorization", token);
        httpClient.DefaultRequestHeaders.Add("Timestamp", timestamp);

        try
        {
            HttpResponseMessage response = await httpClient.PostAsync(apiUrl, deliveryRequestJson);

            // Check if the request was successful
            if (response.IsSuccessStatusCode)
            {
                string responseData = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Response: " + responseData);
            }
            else
            {
                Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);
            }
        }
        catch (HttpRequestException ex)
        {
            Console.WriteLine("Error: " + ex.Message);
        }
    }
}

internal record DeliveryRequest(int[] OrderRowIds, IList<RowDeliveryOptions> RowDeliveryOptions, int InvoiceDistributionType, bool CancelRemaining);
internal class RowDeliveryOptions
{
    public int OrderRowId { get; set; }
    public int Quantity { get; set; }
}
```

--------------------------------

### Get Subscription Response Example

Source: https://docs.payments.svea.com/docs/manage-order/callbacks/get_subscriptions

This is an example of the JSON response received when successfully retrieving webhook subscriptions. It details the SubscriptionId, CallbackUri, Events, and Verified status for each subscription.

```json
[
  {
    "SubscriptionId": "fbb6c74a-cc06-4ab7-100e-08daa861c517",
    "CallbackUri": "<webhook url>",
    "Events": [
      "CheckoutOrder.CreditSucceeded",
      "CheckoutOrder.CreditFailed",
      "CheckoutOrder.Created",
      "CheckoutOrder.Delivered"
    ],
    "Verified": true
  }
]
```

--------------------------------

### Get Subscription Response Example

Source: https://docs.payments.svea.com/docs/manage-order/callbacks/get_subscription

This is an example of the JSON response received when successfully retrieving a webhook subscription. It includes the callback URI and a verification status.

```json
{
    "CallbackUri": "<webhook url>",
    "Verified": true
}

```

--------------------------------

### Get Webhook Subscriptions C# Example

Source: https://docs.payments.svea.com/docs/manage-order/callbacks/get_subscriptions

This C# code demonstrates how to make a GET request to the /api/v2/callbacks/subscriptions/ endpoint to retrieve webhook subscriptions. Ensure you have the necessary authentication headers set up.

```csharp
using Microsoft.Extensions.DependencyInjection;

internal static class GetSubscription
{
    internal static async Task GetSubscriptionsAsync()
    {
        var services = new ServiceCollection();
        services.AddHttpClient("MyApiClient", client =>
        {
            client.BaseAddress = new Uri("http://paymentadminapistage.svea.com/api/");
        });

        var serviceProvider = services.BuildServiceProvider();
        var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
        var httpClient = httpClientFactory.CreateClient("MyApiClient");

        var apiUrl = string.Format("v2/callbacks/subscriptions/");

        // Add authorization header
        Authentication.CreateAuthenticationToken(out string token, out string timestamp);
        httpClient.DefaultRequestHeaders.Add("Authorization", token);
        httpClient.DefaultRequestHeaders.Add("Timestamp", timestamp);

        try
        {
            HttpResponseMessage response = await httpClient.GetAsync(apiUrl);

            // Check if the request was successful
            if (response.IsSuccessStatusCode)
            {
                string responseData = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Response: " + responseData);
            }
            else
            {
                Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);
            }
        }
        catch (HttpRequestException ex)
        {
            Console.WriteLine("Error: " + ex.Message);
        }
    }
}
```

--------------------------------

### Add Subscription C# Example

Source: https://docs.payments.svea.com/docs/manage-order/callbacks/add_subscription

This C# code demonstrates how to add a webhook subscription by making a POST request to the Payment Admin API. It includes setting up the HTTP client, serializing the request body, and handling the response. Ensure you have the necessary authentication setup.

```csharp
using Microsoft.Extensions.DependencyInjection;
using System.Text.Json;
using System.Text;

internal static class AddSubscription
{
    internal static async Task AddSubscriptionAsync()
    {
        var services = new ServiceCollection();
        services.AddHttpClient("MyApiClient", client =>
        {
            client.BaseAddress = new Uri("http://paymentadminapistage.svea.com/api/");
        });

        var serviceProvider = services.BuildServiceProvider();
        var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
        var httpClient = httpClientFactory.CreateClient("MyApiClient");

        var apiUrl = "v2/callbacks/subscriptions";

        var subscriptionRequest = new SubscriptionRequest("webhookurl", new string[] { "CheckoutOrder.Created" });
        var jsonString = JsonSerializer.Serialize(subscriptionRequest);
        var subscriptionRequestJson = new StringContent(
            jsonString,
            Encoding.UTF8,
            "application/json");

        // Add authorization header
        Authentication.CreateAuthenticationToken(out string token, out string timestamp, jsonString);
        httpClient.DefaultRequestHeaders.Add("Authorization", token);
        httpClient.DefaultRequestHeaders.Add("Timestamp", timestamp);

        try
        {
            HttpResponseMessage response = await httpClient.PostAsync(apiUrl, subscriptionRequestJson);

            // Check if the request was successful
            if (response.IsSuccessStatusCode)
            {
                string responseData = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Response: " + responseData);
            }
            else
            {
                Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);
            }
        }
        catch (HttpRequestException ex)
        {
            Console.WriteLine("Error: " + ex.Message);
        }
    }
}

internal record SubscriptionRequest(string CallbackUri, string[] Events);
```

--------------------------------

### Create Order Request Example

Source: https://docs.payments.svea.com/docs/checkout/recurring-orders/get-recurring-order

Example JSON payload for creating an order.

```APIDOC
## POST /api/orders

### Description
Creates a new order with the specified details.

### Method
POST

### Endpoint
/api/orders

### Request Body
- **merchantSettings** (Object) - Merchant specific settings.
  - **checkoutValidationCallBackUri** (String) - Optional URI for checkout validation callback.
  - **pushUri** (String) - URI for push notifications.
- **cart** (Object) - Details of the items in the cart.
  - **items** (Array) - List of items in the cart.
    - **articleNumber** (String) - Article number of the item.
    - **name** (String) - Name of the item.
    - **quantity** (Number) - Quantity of the item.
    - **unitPrice** (Number) - Unit price of the item.
    - **discountPercent** (Number) - Discount percentage for the item.
    - **vatPercent** (Number) - VAT percentage for the item.
    - **unit** (String) - Unit of measurement (e.g., pcs, kg).
    - **temporaryReference** (String) - Temporary reference for the item.
    - **rowNumber** (Number) - Row number of the item.
    - **merchantData** (String) - Merchant-specific data for the item.
    - **rowType** (String) - Type of the row (e.g., "Row").
- **customer** (Object) - Customer information.
  - **id** (Number) - Customer ID.
  - **nationalId** (String) - Customer's national ID.
  - **countryCode** (String) - Customer's country code.
  - **isCompany** (Boolean) - Flag indicating if the customer is a company.
- **shippingAddress** (Object) - Customer's shipping address.
  - **fullName** (String) - Full name of the recipient.
  - **firstName** (String) - First name of the recipient.
  - **lastName** (String) - Last name of the recipient.
  - **streetAddress** (String) - Street address.
  - **coAddress** (String) - C/O address.
  - **postalCode** (String) - Postal code.
  - **city** (String) - City.
  - **countryCode** (String) - Country code.
  - **isGeneric** (Boolean) - Flag indicating if the address is generic.
  - **addressLines** (Array) - Additional address lines.
- **billingAddress** (Object) - Customer's billing address (same fields as shippingAddress).
- **currency** (String) - Currency of the order (ISO 4217).
- **countryCode** (String) - Country code for the order.
- **clientOrderNumber** (String) - Unique identifier for the order from the client.
- **orderId** (Number) - The ID of the order (assigned by the system).
- **emailAddress** (String) - Customer's email address.
- **phoneNumber** (String) - Customer's phone number.
- **paymentType** (String) - The payment method used.
- **payment** (Object) - Payment details.
  - **paymentMethodType** (String) - Type of payment method.
- **status** (String) - Current status of the order.
- **customerReference** (String) - Reference for B2B customers.
- **merchantData** (String) - Merchant-specific data for the order.
- **peppolId** (String) - PEPPOL ID for B2B orders.
- **recurring** (Boolean) - Indicates if the order is recurring.
- **recurringToken** (String) - Token for recurring orders.

### Request Example
```json
{
  "merchantSettings": {
    "checkoutValidationCallBackUri": "https://your.domain/validation-callback/your-identifier",
    "pushUri": "https://your.domain/push-callback/{checkout.order.uri}"
  },
  "cart": {
    "items": [
      {
        "articleNumber": "ABC80",
        "name": "Computer",
        "quantity": 300,
        "unitPrice": 500000,
        "discountPercent": 1000,
        "vatPercent": 2500,
        "unit": null,
        "temporaryReference": null,
        "rowNumber": 1,
        "merchantData": null,
        "rowType": "Row"
      },
      {
        "articleNumber": "ABC81",
        "name": "Another Computer",
        "quantity": 200,
        "unitPrice": 400000,
        "discountAmount": 10000,
        "vatPercent": 2500,
        "unit": null,
        "temporaryReference": null,
        "rowNumber": 2,
        "merchantData": null,
        "rowType": "Row"
      }
    ]
  },
  "customer": {
    "id": 1,
    "nationalId": "121314-1234",
    "countryCode": "SE",
    "isCompany": false
  },
  "shippingAddress": {
    "fullName": "John Doe",
    "firstName": "John",
    "lastName": "Doe",
    "streetAddress": "My Street 1",
    "coAddress": "",
    "postalCode": "99999",
    "city": "My Town",
    "countryCode": "SE",
    "isGeneric": false,
    "addressLines": []
  },
  "billingAddress": {
    "fullName": "John Doe",
    "firstName": "John",
    "lastName": "Doe",
    "streetAddress": "My Street 1",
    "coAddress": "",
    "postalCode": "99999",
    "city": "My Town",
    "countryCode": "SE",
    "isGeneric": false,
    "addressLines": []
  },
  "currency": "SEK",
  "countryCode": "SE",
  "clientOrderNumber": "ABCDEFGHIJKLMNOP0123456789",
  "orderId": 569569,
  "emailAddress": "john.doe@svea.com",
  "phoneNumber": "0712345678",
  "paymentType": "SVEACARDPAY_PF",
  "payment": {
    "paymentMethodType": "Card"
  },
  "status": "Final",
  "customerReference": null,
  "merchantData": null,
  "peppolId": null,
  "recurring": true,
  "recurringToken": "4b10836f-f9e4-4b2d-32e8-08dad38a1eda"
}
```
```

--------------------------------

### Get Reconciliation Report C# Example

Source: https://docs.payments.svea.com/docs/manage-order/reports

This C# code demonstrates how to call the reconciliation report endpoint. Ensure you have the necessary setup for HTTP client and authentication.

```csharp
using Microsoft.Extensions.DependencyInjection;
  
internal static class GetReport  
{
    internal static async Task GetReportAsync(string reportDate, bool includeWithholding)  
    {
        var services = new ServiceCollection();
        services.AddHttpClient("MyApiClient", client =>  
        {
            client.BaseAddress = new Uri("http://paymentadminapistage.svea.com/api/");
        });

        var serviceProvider = services.BuildServiceProvider();
        var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
        var httpClient = httpClientFactory.CreateClient("MyApiClient");

        // Add authorization header  
        Authentication.CreateAuthenticationToken(out string token, out string timestamp);
        httpClient.DefaultRequestHeaders.Add("Authorization", token);
        httpClient.DefaultRequestHeaders.Add("Timestamp", timestamp);

        var apiUrl = string.Format("v2/reports?date={0}&includeWithholding={1}", reportDate, includeWithholding);

        try  
        {
            HttpResponseMessage response = await httpClient.GetAsync(apiUrl);

            // Check if the request was successful  
            if (response.IsSuccessStatusCode)  
            {
                string responseData = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Response: " + responseData);
            }
            else  
            {
                Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);
            }
        }
        catch (HttpRequestException ex)  
        {
            Console.WriteLine("Error: " + ex.Message);
        }
    }
}
```

--------------------------------

### C# Shipping Onboarding Get Credentials

Source: https://docs.payments.svea.com/docs/checkout/shipping/shipping-onboarding

Use this C# code to make a GET request to the /api/shipping/onboarding endpoint. Ensure you have configured the HttpClient with the correct base address and added the Authorization and Timestamp headers.

```csharp
using Microsoft.Extensions.DependencyInjection;  
  
namespace APIPortal_CodeSamples.Checkout  
{
    public class ShippingOnboardingGetSample  
    {

        public static async Task ShippingOnboardingGet()  
        {
            var services = new ServiceCollection();  
            services.AddHttpClient("MyApiClient", client =>  
            {
                client.BaseAddress = new Uri("https://checkoutapistage.svea.com");  
            });

            var serviceProvider = services.BuildServiceProvider();  
            var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();  
            var httpClient = httpClientFactory.CreateClient("MyApiClient");  

            Authentication.CreateAuthenticationToken(out string token, out string timestamp);  
            httpClient.DefaultRequestHeaders.Add("Authorization", token);  
            httpClient.DefaultRequestHeaders.Add("Timestamp", timestamp);  

            var apiUrl = $"/api/shipping/onboarding";  

            try  
            {
                HttpResponseMessage response = await httpClient.GetAsync(apiUrl);  

                // Check if the request was successful  
                if (response.IsSuccessStatusCode)  
                {
                    string responseData = await response.Content.ReadAsStringAsync();  
                    Console.WriteLine("Response: " + responseData);  
                }
                else  
                {
                    Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);  
                }
            }
            catch (HttpRequestException ex)  
            {
                Console.WriteLine("Error: " + ex.Message);  
            }
        }
    }
}

```

--------------------------------

### C# Instore Order Creation Example

Source: https://docs.payments.svea.com/docs/instore/create-a-order

This C# code demonstrates how to create an instore order using HttpClient. Ensure you have the necessary API keys and base address configured.

```csharp
namespace Instore
{
    using APIPortal_CodeSamples;
    using Microsoft.Extensions.DependencyInjection;
    using System.Net.Http.Headers;
    using System.Text;
    using System.Text.Json;

    public class CreateOrderSample
    {
        public static async Task CreateInstoreOrder()
        {
            var services = new ServiceCollection();
            services.AddHttpClient("MyApiClient", client =>
            {
                client.BaseAddress = new Uri("https://webpayinstoreapistage.svea.com");
            });

            var serviceProvider = services.BuildServiceProvider();
            var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
            var httpClient = httpClientFactory.CreateClient("MyApiClient");

            InstoreCreateOrderRequestModel createOrdeRequest = InstoreOrderMockRequest.CreateBaseMockRequest();
            var jsonString = JsonSerializer.Serialize(createOrdeRequest);

            var createOrderRequestJson = new StringContent(
                jsonString,
                Encoding.UTF8,
                "application/json");
            // Add authorization header
            Authentication.BasicAuthenticationToken(out byte[] token);
            httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(token));

            var apiUrl = "/api/v1/orders";

            try
            {
                HttpResponseMessage response = await httpClient.PostAsync(apiUrl, createOrderRequestJson);

                // Check if the request was successful
                if (response.IsSuccessStatusCode)
                {
                    string responseData = await response.Content.ReadAsStringAsync();
                    Console.WriteLine("Response: " + responseData);
                }
                else
                {
                    Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);

```

--------------------------------

### Sample GET Order Response

Source: https://docs.payments.svea.com/docs/manage-order/getting_order_information

This is a sample JSON response for a successful GET order request, detailing order information such as ID, currency, status, amounts, addresses, and order rows.

```json
{
    "Id": 9118224,
    "Currency": "SEK",
    "MerchantOrderId": "585c1942b0104c7c9dd280e8da4a5331",
    "OrderStatus": "Delivered",
    "SystemStatus": "SUCCESS",
    "SystemStatusMessage": "SUCCESS",
    "PaymentCreditStatus": null,
    "EmailAddress": "myemail@me.com",
    "BillingEmailAddress": null,
    "PhoneNumber": "1234567890",
    "CustomerReference": null,
    "PeppolId": null,
    "PaymentType": "Swish",
    "CreationDate": "2024-04-03T13:56:08",
    "NationalId": "123407192384",
    "IsCompany": false,
    "CancelledAmount": 0,
    "OrderAmount": 52800,
    "BillingAddress": {
        "FullName": "FirstName LastName",
        "StreetAddress": "Address 1",
        "CoAddress": null,
        "PostalCode": "12345",
        "City": null,
        "CountryCode": "SE",
        "Source": 0
    },
    "ShippingAddress": {
        "FullName": "FirstName LastName",
        "StreetAddress": "Address 1",
        "CoAddress": null,
        "PostalCode": "12345",
        "City": "Cityname",
        "CountryCode": "SE",
        "Source": 1
    },
    "Deliveries": [
        {
            "Id": 86521923793,
            "CreationDate": "2024-04-03T13:56:08",
            "InvoiceId": null,
            "DeliveryAmount": 49900,
            "CreditedAmount": 0,
            "Credits": null,
            "OrderRows": [
                {
                    "OrderRowId": 1,
                    "ArticleNumber": "ArticleNo1",
                    "Name": "Artcle 1",
                    "Quantity": 100,
                    "UnitPrice": 49900,
                    "DiscountPercent": 0,
                    "DiscountAmount": 0,
                    "VatPercent": 2500,
                    "Unit": null,
                    "IsCancelled": false,
                    "Actions": []
                }
            ],
            "Actions": [
                "CanCreditAmount"
            ],
            "Status": null,
            "DueDate": null
        }
    ],
    "OrderRows": [
        {
            "OrderRowId": 2,
            "ArticleNumber": "ArticleNo2",
            "Name": "Article 2",
            "Quantity": 100,
            "UnitPrice": 2900,
            "DiscountPercent": 0,
            "DiscountAmount": 0,
            "VatPercent": 2500,
            "Unit": null,
            "IsCancelled": false,
            "Actions": []
        }
    ],
    "Actions": [],
    "SveaWillBuy": null,
    "ExpirationDate": null,
    "BillingReferences": []
}
```

--------------------------------

### Create Onboarding Response Body

Source: https://docs.payments.svea.com/docs/checkout/shipping/shipping-onboarding

Example response upon successful creation or update of onboarding credentials. Includes merchant ID, masked access token, and delivery checkout ID.

```json
{
  "id": 100003,
  "accessToken": "aWQ=",
  "deliveryCheckoutId": "id1",
  "isAddonDisabled": false
}
```

--------------------------------

### Get Order C# Sample

Source: https://docs.payments.svea.com/docs/checkout/get-a-order

This C# code retrieves an existing Checkout order by its ID. Ensure you have the necessary authentication setup.

```csharp
public class GetOrderSample  
{  
  
    public static async Task GetOrder(long orderId)  
    {  
        var services = new ServiceCollection();  
        services.AddHttpClient("MyApiClient", client =>  
        {  
            client.BaseAddress = new Uri("https://checkoutapistage.svea.com");  
        });  
  
        var serviceProvider = services.BuildServiceProvider();  
        var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();  
        var httpClient = httpClientFactory.CreateClient("MyApiClient");  
  
        // Add authorization header  
        Authentication.CreateAuthenticationToken(out string token, out string timestamp);  
        httpClient.DefaultRequestHeaders.Add("Authorization", token);  
        httpClient.DefaultRequestHeaders.Add("Timestamp", timestamp);  
  
        var apiUrl = $"/api/orders/{orderId}";  
  
        try  
        {  
            HttpResponseMessage response = await httpClient.GetAsync(apiUrl);  
  
            // Check if the request was successful  
            if (response.IsSuccessStatusCode)  
            {  
                string responseData = await response.Content.ReadAsStringAsync();  
                Console.WriteLine("Response: " + responseData);  
            }  
            else  
            {  
                Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);  
            }  
        }  
        catch (HttpRequestException ex)  
        {  
            Console.WriteLine("Error: " + ex.Message);  
        }  
    }  
}  
  

```

--------------------------------

### Get Onboarding Credentials

Source: https://docs.payments.svea.com/docs/checkout/shipping/shipping-onboarding

This endpoint is used to retrieve the currently stored nShift credentials.

```APIDOC
## GET /api/shipping/onboarding

### Description
Retrieves the nShift credentials that have been previously configured.

### Method
GET

### Endpoint
/api/shipping/onboarding

### Response
#### Success Response (200)
- **id** (Int64) - Checkout Merchant Id
- **accessToken** (String) - Masked NshiftCombinedId
- **deliveryCheckoutId** (String) - Delivery checkout ID from nShift
- **isAddonDisabled** (Boolean) - 

#### Response Example
```json
{
  "id": 100003,
  "accessToken": "aWQ=",
  "deliveryCheckoutId": "id1",
  "isAddonDisabled": false
}
```
```

--------------------------------

### Currency, Quantity & Percentage Format Example

Source: https://docs.payments.svea.com/docs/getting-started/before-you-start

Demonstrates how to format currency, quantity, and percentage values in minor units for order rows. Ensure all values are provided in their smallest unit (e.g., cents for currency).

```javascript
var Cart = {
  Items: [
    {
      // In this example we create
      Quantity: 100, // one(1.00) item
      Name: "Computer", // called “Computer”
      UnitPrice: 500000, // with a price of 5000.00 SEK,
      DiscountPercent: 1000, // a discount of 10.00%
      VatPercent: 2500, // and 25.00% VAT
    },
  ],
};
```

--------------------------------

### C# Example for Delivering Order Amount

Source: https://docs.payments.svea.com/docs/manage-order/delivering_orders

This C# code demonstrates how to call the DeliverAndLowerAmount endpoint. Ensure you have the 'MyApiClient' HttpClient configured and the necessary authentication headers.

```csharp
using Microsoft.Extensions.DependencyInjection;
using System.Text.Json;
using System.Text;

internal static class DeliverOrderAmount
{
    internal static async Task DeliverOrderAmountAsync(long checkoutOrderId)
    {
        var services = new ServiceCollection();
        services.AddHttpClient("MyApiClient", client =>
        {
            client.BaseAddress = new Uri("http://paymentadminapistage.svea.com/api/");
        });

        var serviceProvider = services.BuildServiceProvider();
        var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
        var httpClient = httpClientFactory.CreateClient("MyApiClient");

        var apiUrl = string.Format("v1/orders/{0}/deliveries/DeliverAndLowerAmount", checkoutOrderId);


        var deliveryRequest = new DeliveryAmountRequest(100);
        var jsonString = JsonSerializer.Serialize(deliveryRequest);
        var deliveryRequestJson = new StringContent(
            jsonString,
            Encoding.UTF8,
            "application/json");

        // Add authorization header
        Authentication.CreateAuthenticationToken(out string token, out string timestamp, jsonString);
        httpClient.DefaultRequestHeaders.Add("Authorization", token);
        httpClient.DefaultRequestHeaders.Add("Timestamp", timestamp);

        try
        {
            HttpResponseMessage response = await httpClient.PostAsync(apiUrl, deliveryRequestJson);

            // Check if the request was successful
            if (response.IsSuccessStatusCode)
            {
                string responseData = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Response: " + responseData);
            }
            else
            {
                Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);
            }
        }
        catch (HttpRequestException ex)
        {
            Console.WriteLine("Error: " + ex.Message);
        }
    }
}

internal record DeliveryAmountRequest(long DeliveredAmount);
```

--------------------------------

### Credit Order by Amount - C# Example

Source: https://docs.payments.svea.com/docs/manage-order/crediting_orders

Use this C# code to create a credit for a specific amount on an order. Ensure the 'CanCreditAmount' action is available for the delivery. The API client is configured with a base address for staging.

```csharp
using Microsoft.Extensions.DependencyInjection;
using System.Text.Json;
using System.Text;

internal static class CreditOrderAmount
{
    internal static async Task CreditOrderAmountAsync(long checkoutOrderId, long deliveryId)
    {
        var services = new ServiceCollection();
        services.AddHttpClient("MyApiClient", client =>
        {
            client.BaseAddress = new Uri("http://paymentadminapistage.svea.com/api/");
        });

        var serviceProvider = services.BuildServiceProvider();
        var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
        var httpClient = httpClientFactory.CreateClient("MyApiClient");

        var apiUrl = string.Format("v1/orders/{0}/deliveries/{1}", checkoutOrderId, deliveryId);


        var creditRequest = new CreditAmountRequest(100);
        var jsonString = JsonSerializer.Serialize(creditRequest);
        var creditRequestJson = new StringContent(
            jsonString,
            Encoding.UTF8,
            "application/json");

        // Add authorization header
        Authentication.CreateAuthenticationToken(out string token, out string timestamp, jsonString);
        httpClient.DefaultRequestHeaders.Add("Authorization", token);
        httpClient.DefaultRequestHeaders.Add("Timestamp", timestamp);

        try
        {
            HttpResponseMessage response = await httpClient.PatchAsync(apiUrl, creditRequestJson);

            // Check if the request was successful
            if (response.IsSuccessStatusCode)
            {
                string responseData = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Response: " + responseData);
            }
            else
            {
                Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);
            }
        }
        catch (HttpRequestException ex)
        {
            Console.WriteLine("Error: " + ex.Message);
        }
    }
}

internal record CreditAmountRequest(long CreditedAmount);
```

--------------------------------

### Shipping Onboarding Get Credentials

Source: https://docs.payments.svea.com/docs/checkout/shipping/shipping-onboarding

This endpoint retrieves the necessary credentials for shipping onboarding with Svea Payments.

```APIDOC
## GET /api/shipping/onboarding

### Description
Retrieves credentials required for shipping onboarding.

### Method
GET

### Endpoint
/api/shipping/onboarding

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (Int64) - Checkout Merchant Id
- **accessToken** (String) - Access Token created by Svea from NshiftCombinedId
- **deliveryCheckoutId** (String) - Delivery checkout ID from nShift
- **isAddonDisabled** (Boolean) - 

#### Response Example
```json
{
  "id": 100001,
  "accessToken": "VE0********************1k=",
  "deliveryCheckoutId": "00000000-0000-0000-0000-000000000000",
  "isAddonDisabled": false
}
```
```

--------------------------------

### Shipping Created Callback Example

Source: https://docs.payments.svea.com/docs/checkout/shipping/shipping-events

This JSON structure represents a successful shipping creation callback. It includes details about the shipment session and order.

```json
{
    "type": "shipping.created",
    "description": "{\r\n  \"tmsReference\": \"9184632\",\r\n  \"selectedShippingOption\": {\r\n    \"id\": \"BUDBEESTD\",\r\n    \"carrier\": \"Budbee\"\r\n  },\r\n  \"shipmentSession\": {\r\n    \"id\": \"3b78a322-ae63-499f-b0e8-b7c4de229c0b\",\r\n    \"name\": \"Budbee\",\r\n    \"description\": \"\",\r\n    \"carrier\": \"budbee-home\",\r\n    \"shippingFee\": 1000,\r\n    \"totalShippingFee\": 1000,\r\n    \"location\": null,\r\n    \"fields\": [\r\n      {\r\n        \"id\": \"FCRECEIVERPHONE\",\r\n        \"value\": \"123\\u2022\\u2022\\u2022\\u2022\\u202290\"\r\n      }\r\n    ],\r\n    \"addons\": [],\r\n    \"timeslot\": \"\",\r\n    \"postalCode\": \"11251\"\r\n  }\r\n}",
    "orderId": 9184632
}
```

--------------------------------

### Update Order Sample (C#)

Source: https://docs.payments.svea.com/docs/checkout/update-a-order

A C# sample demonstrating how to set up an HttpClient to call the Update Order API. It includes configuring the base address and creating an instance of the UpdateOrderRequestModel.

```csharp
public class UpdateOrderSample
{

    public static async Task UpdateOrder(long orderId)
    {
        var services = new ServiceCollection();
        services.AddHttpClient("MyApiClient", client =>
        {
            client.BaseAddress = new Uri("https://checkoutapistage.svea.com");
        });

        var serviceProvider = services.BuildServiceProvider();
        var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
        var httpClient = httpClientFactory.CreateClient("MyApiClient");

        var updateOrderRequest = UpdateOrderMockRequest.CreateBaseMockRequestSE();

```

--------------------------------

### Create Order Sample Handler

Source: https://docs.payments.svea.com/docs/checkout/create-a-order

Handles the creation of a checkout order using a mock request. Sets up HTTP client and serializes the request model to JSON.

```csharp
public class CreateOrderSample  
{

    public static async Task<dynamic> Handle()  
    {
        return await CreateOrder(CreateOrderMockRequest.CreateBaseMockRequestSE());
    }
    /// <summary>
    /// Refer to CreateOrderMockRequest for example of minimal request needed to create a checkout order.
    /// </summary>
    public static async Task<dynamic> CreateOrder(CreateOrderRequestModel createOrdeRequest)  
    {
        var services = new ServiceCollection();
        services.AddHttpClient("MyApiClient", client =>
        {
            client.BaseAddress = new Uri("https://checkoutapistage.svea.com");
        });

        var serviceProvider = services.BuildServiceProvider();
        var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
        var httpClient = httpClientFactory.CreateClient("MyApiClient");

        var jsonString = JsonSerializer.Serialize(createOrdeRequest);

        var createOrderRequestJson = new StringContent(
            jsonString,
            Encoding.UTF8,
            "application/json");
        // Add authorization header
        Authentication.CreateAuthenticationToken(out string token, out string timestamp, jsonString);

```

--------------------------------

### Get Order Status Example in C#

Source: https://docs.payments.svea.com/docs/instore/get-order-status

Use this C# code to retrieve the status of an order by its merchant order number. Ensure the HttpClient is configured with the correct base address and authorization header.

```csharp
namespace Instore
{
    using APIPortal_CodeSamples;
    using Microsoft.Extensions.DependencyInjection;
    using System.Net.Http.Headers;

    public class GetOrderStatus
    {
        public static async Task GetOrderStatusAsync(string merchantOrderNumber)
        {
            var services = new ServiceCollection();
            services.AddHttpClient("MyApiClient", client =>
            {
                client.BaseAddress = new Uri("https://webpayinstoreapistage.svea.com");
            });

            var serviceProvider = services.BuildServiceProvider();
            var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
            var httpClient = httpClientFactory.CreateClient("MyApiClient");

            // Add authorization header
            Authentication.BasicAuthenticationToken(out byte[] token);
            httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(token));

            var apiUrl = string.Format("/api/v1/orders/{0}/status", merchantOrderNumber);

            try
            {
                HttpResponseMessage response = await httpClient.GetAsync(apiUrl);

                // Check if the request was successful
                if (response.IsSuccessStatusCode)
                {
                    string responseData = await response.Content.ReadAsStringAsync();
                    Console.WriteLine("Response: " + responseData);
                }
                else
                {
                    Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);
                }
            }
            catch (HttpRequestException ex)
            {
                Console.WriteLine("Error: " + ex.Message);
            }
        }
    }
}
```

--------------------------------

### Get Token Endpoint

Source: https://docs.payments.svea.com/docs/checkout/recurring-orders/get-recurring-token

Use this GET request to retrieve an existing token by its ID. A 200 HTTP status code indicates success.

```http
GET /api/tokens/{token}
```

--------------------------------

### Credit Order Row with Fee C# Example

Source: https://docs.payments.svea.com/docs/manage-order/crediting_orders

This C# code demonstrates how to make a POST request to credit an order row with an optional fee. It includes setting up the HttpClient, constructing the request body, and handling the response. Ensure you have the necessary authentication details.

```csharp
using Microsoft.Extensions.DependencyInjection;
using System.Text.Json;
using System.Text.Json.Serialization;
using System.Text;

internal static class CreditOrderNewRowFee
{
    internal static async Task CreditOrderNewRowFeeAsync(long checkoutOrderId, long deliveryId)
    {
        var services = new ServiceCollection();
        services.AddHttpClient("MyApiClient", client =>
        {
            client.BaseAddress = new Uri("http://paymentadminapistage.svea.com/api/");
        });

        var serviceProvider = services.BuildServiceProvider();
        var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
        var httpClient = httpClientFactory.CreateClient("MyApiClient");

        var apiUrl = string.Format("v1/orders/{0}/deliveries/{1}/credits/CreditWithFee", checkoutOrderId, deliveryId);
        var orderRowIds = new int[] { 2 }; //Credit Order with RowId - 1
        var rowCreditingOptions = new List<RowCreditingOptions>
        {
            new RowCreditingOptions{OrderRowId = 2, Quantity = 100} //Credit Order with RowId - 2 , Quanity - 1
        };

        var fee = new CreditFee("art-1", "Article-1", 100, 0);

        var creditRequest = new CreditNewRowFeeRequest(orderRowIds, fee, rowCreditingOptions);

        var jsonString = JsonSerializer.Serialize(creditRequest);
        var creditRowRequestJson = new StringContent(
            jsonString,
            Encoding.UTF8,
            "application/json");

        // Add authorization header
        Authentication.CreateAuthenticationToken(out string token, out string timestamp, jsonString);
        httpClient.DefaultRequestHeaders.Add("Authorization", token);
        httpClient.DefaultRequestHeaders.Add("Timestamp", timestamp);

        try
        {
            HttpResponseMessage response = await httpClient.PostAsync(apiUrl, creditRowRequestJson);

            // Check if the request was successful
            if (response.IsSuccessStatusCode)
            {
                string responseData = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Response: " + responseData);
            }
            else
            {
                Console.WriteLine("Failed to retrieve data. Status code: " + response.StatusCode);
            }
        }
        catch (HttpRequestException ex)
        {
            Console.WriteLine("Error: " + ex.Message);
        }
    }
}

internal record CreditFee(string ArticleNumber, string Name, long UnitPrice, long VatPercent);
internal record CreditNewRowFeeRequest(int[] OrderRowIds, CreditFee Fee, IList<RowCreditingOptions> RowCreditingOptions);
internal class RowCreditingOptions
{
    public int OrderRowId { get; set; }
    public int Quantity { get; set; }
}

```

--------------------------------

### Get Available Part Payment Campaigns

Source: https://docs.payments.svea.com/docs/checkout/get-available-campaign

Use this GET request to retrieve a list of available B2C/B2B part payment campaigns. The `amount` parameter filters campaigns based on requirements and is used to calculate a monthly amount.

```http
GET /api/util/GetAvailablePartPaymentCampaigns?isCompany={isCompany}&amount={amount}
```
Tokens:
Raw