Finalize purchase

On this page you will find information about How to charge for Delivered goods, How to handle Returns and Refunds.

Delivery – Send information about delivered items to Avarda

On delivery Merchant sends delivered items to Avarda via PurchaseOrder.

Charge for delivered goods – Send PurchaseOrder request to Avarda

• ExternalID/PurchaseID from checkout needs to be included.
• Merchant order reference needs to be included.
• Part delivery possible – several delivery messages can be sent for one order.
• Different order references possible.
• Rebate items (negative amount) possible as long as whole message is positive.
• Tolerance exists for Invoice / Account – amount can be higher than authorized.
• For prepaid orders (Card, Direct bank, Swish) over charging is not allowed – authorized amount is maximum for related purchase order(s).
• Zero amount items accepted.
• Submitted items will be displayed on invoice as invoice lines.
  
• Submitted items will be paid for by Avarda.
• Same message regardless of payment method.

PurchaseOrder

POST /CheckOut2Api/Commerce/PurchaseOrder

The method allows partners to invoice a customer. A call to this method should be performed on delivery of the purchased items. The items submitted in the call will be enlisted on the invoice as individual invoice lines. Items with both positive and negative (rebates) value are supported as long the total amount is positive. The Reseller order ID passed in a request will be used to identify the transaction.

Example request

{
  "ExternalId": "2b152405a841ee7828e2c317712f5d8d",
  "TranId": "DD9ACDB9DE28424083BA",
  "OrderReference": "4000124352",
  "TrackingCode": "",
  "Items": [
    {
      "Description": "Carrey-hybriditakki, naisten, punai",
      "Notes": "HH854765",
      "Amount": 20.97,
      "TaxCode": "24.0000",
      "TaxAmount": 4.06
    },
    {
      "Description": "Lester-matkakassi, sininen",
      "Notes": "HH1001863",
      "Amount": 29.97,
      "TaxCode": "24.0000",
      "TaxAmount": 5.8
    },
 {
      "Description": "Discount",
      "Notes": "HH1001863",
      "Amount": -2.97,
      "TaxCode": "24.0000",
      "TaxAmount": -0.41
    }
  ]
}

Return Value

If successful, the method returns a HTTP status code 200 (OK) with no additional content.

Returns – Send information about returned items to Avarda  

Merchant receives returns for purchased goods. On delivery Merchant ends delivered items to Avarda via PurchaseOrder

Credit end customer – Send ReturnOrder request to Avarda

• ExternalID/PurchaseID from checkout needs to be included
• Merchant order reference needs to be included
• Part returns possible – several return messages can be sent for one order.
• Different order references possible
• For returns to be accepted merchant needs to have charged for the original order (purchase order).
• Purchase balance needs to cover return amount
• For prepaid orders (Card, Direct bank, Swish) returns will automatically generate a refund to end customer.
• Submitted items will be displayed on invoice as credited invoice lines.
• Submitted items will be withdrawn from next put payment by Avarda
• Same message regardless of payment method.

ReturnOrder

POST /CheckOut2Api/Commerce/ReturnOrder

The method allows to submit a return or to make a price adjustment of goods purchased by a customer. The call is performed when the returned goods are received to the reseller or if some amount needs to be credited. All items submitted in the return call will be printed as negative invoice rows at the invoice.

Input Parameters

Example request

{
 "ExternalId": "19ac0d1ee909c302d212b4324d9194b5",
 "Items": [
 {
 "Description": "Description",
 "Notes": "Notes",
 "Amount": 1
 }
 ],
 "OrderReference": "ue12345",
 "TranId": "123456",
 "TrackingCode": "123456",
 "PosId": "Id123456"
} 

Return Value

If successful, the method returns a HTTP status code 200 (OK) with no additional content.

Refunds – Prepaid orders which cant be deliver should be refunded to end customer

Merchant is unable to deliver all goods for one order.

Send refund to pay back the money to customer for undelivered orders

• ExternalID/PurchaseID from checkout needs to be included
• Partly refunds possible – several refund messages can be sent for one order.
• For returns to be accepted merchant needs to have uncharged authorized amount for the end customer
• Authorized uncharged balance cover refund amount
• For prepaid orders (Card, Direct bank, Swish) refund will automatically generate a refund to end customer.
• Same message regardless of payment method – but only applicable for prepaid orders (Card, Direct bank and Swish).

RefundOrder

POST /CheckOut2Api/Commerce/Refund

The method allows to merchant refund money.

Input Parameters

Example request

{
 "ExternalId": "19ac0d1ee909c302d212b4324d9194b5",
 "Amount": 10.0,
 "TranId": "123456",
 "OrderReference": "ue12345"
} 

Return Value

If successful, the method returns a HTTP status code 200 (OK) with no additional content.