POST /CheckOut2Api/v2/AuthorizeDirectInvoiceEID

The method authorize an invoices based on provided parameters and returns purchaseid. If Electronic ID validation is required the function will respond only with purchaseid and a flag that electronicID validation is required.

1. Call AuthorizeDirectInvoiceEID
2. Check response – if no electronic ID validation is required then response message contains everything to complete the order.
3. IF ELECTRONIC ID VALIDATION IS REQUIRED:
4. Check response – if electronic ID validation is required then response contains only purchaseid and IsElectronicValidationNeeded = true. Merchant now needs to redirect the user to a predefined URL where Avarda offer ElectronicID validation. URL: /CheckOut2ElectronicId/?externalId={PURCHASEID}&returnUrl={yourreturnurl.com}
5. After electronicID validation is performed then Avarda redirect back to defined returnURL. Example: https://yourreturnurl.com/?externalId=d736dd5fea853b18a30fd2413ebfcab5&status=OK
6. Merchant checks status on the purchase via GetPaymentStatus. If ok then fulfill the order

To send the invoice and debit the end customer an extra call to PurchaseOrder is required when goods are delivered.

Input Parameters

Items

The class represents a single row that appears on an invoice. Typically a purchased commodity but it can also be a more abstract think such as a discount with a negative value.

Example request

{
  "IdentificationNumber": "191704109279",
  "Description": null,
  "ReferenceName": "Test",
  "ReferenceId": "Test",
  "UserLanguageCode": null,
  "Phone": "041234567",
  "Mail": "Testperson@avarda.comm",
  "IsPhoneAndMailEditable": null,
  "Price": 82.72,
  "InvoicingFirstName": "Testname",
  "InvoicingLastName": "Testlastname",
  "InvoicingAddressLine1": "Address X11",
  "InvoicingZip": "11136 ",
  "InvoicingCity": "Jyväskylä",
  "DeliveryFirstName": "Testname",
  "DeliveryLastName": "Testlastname",
  "DeliveryAddressLine1": "Address X11",
  "DeliveryZip": "11136 ",
  "DeliveryCity": "JYVÄSKYLÄ",
  "IsDeliveryEditable": false,
  "UseDifferentDeliveryAddress": true,
  "Items": [
    {
      "Description": "HD7462/21 Daily Collection kahvinke",
      "Notes": "HH1018333",
      "Amount": 39.9,
      "TaxCode": "24",
      "TaxAmount": 7.72
    },
    {
      "Description": "Ultra Kevät -pussilakanasetti, jade",
      "Notes": "HH1010279",
      "Amount": 35.92,
      "TaxCode": "24",
      "TaxAmount": 6.95
    },
    {
      "Description": "Toimitus- ja kasittelykulut",
      "Notes": "Toimituskulut",
      "Amount": 6.9,
      "TaxCode": "24",
      "TaxAmount": 1.34
    }
  ],
  "ProductGroup": null,
  "LoyaltyNumber": null,
  "OrderReference": "2000099999",
  "DefaultPaymentMethod": 0,
  "HidePersonalDetails": "0",
  "CustomerToken": "",
  "OfferRecPmt": true,
  "PreSelectRecPmt": true,
  "CompanyName": "string",
  "Emailinvoice": 0,
  "OfferNewsLetter": true
}

Output parameters

Return Value – If no extra electronicID validation is required. Process is Done.

Output parameters Example

{
  "ExternalId": "d736dd5fea853b18a30fd2413ebfcab5",
  "AccountNumber": "198631249625058",
  "FirstName": "Testname",
  "LastName": "Testlastname",
  "RequireDeliveryAuthorization": false,
  "CreditLimit": 4000,
  "ErrorType": 0,
  "ErrorMessage": null
}

Return Value – When extra electroniID validation is required.

Output parameters Example

{
  "ExternalId": "d736dd5fea853b18a30fd2413ebfcab5",
  "IsElectronicValidationNeeded": true,
  "ErrorType": 0,
  "ErrorMessage": null
}

Redirect user to ID validation

Redirect user to following URL where ElectronicID validation is performed.

PROD:

https://online.avarda.org/CheckOut2/CheckOut2ElectronicId/?externalId={PURCHASEID}&returnUrl={yourreturnurl.com}

TEST

https://stage.avarda.org/CheckOut2/CheckOut2ElectronicId/?externalId={PURCHASEID}&returnUrl={yourreturnurl.com}

Callback Success

https://yourreturnurl.com/?externalId=d736dd5fea853b18a30fd2413ebfcab5&status=OK

Merchant: calls GetPurchaseStatus and if Completed then fulfill the order.

Callback Failed

https://yourreturnurl.com/?externalId=d736dd5fea853b18a30fd2413ebfcab5&status=Cancel

Merchant: offer other payment method or try electronic id validation again.

Error messages

{
  "ErrorCode": "30154",
  "ErrorDetail": null,
  "UserErrorMessage": "CreditNotApproved",
  "DetailedErrorMessage": "(30154) Application denied. Choose a different payment option",
  "LocalizedErrorMessage": "Luottoa lasku- tai tilimaksuun ei voitu myöntää. Ole hyvä ja valitse toinen maksutapa kassalla."
}