Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

These are all of the necessary endpoints required for Transactions (purchases, authorizations, captures, releases, returns).

...

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5.1/client-id/{client_id}/authorization

NOTE: the /authorization endpoint has been updated to version 2.5.1, reflected in the URI.

...

Code Block
{
    "reference": "orderid-12345",
    "amount": 1000.12
    "external_location_id" : "00-12345",  //if in-store channel
    "external_employee_id" :"12345-SMITH" //if in-store channel
    "vcc_number": "1234567890123423",
    "capture_id": 346123,
    "sku_data": {
        "purchase_order": "100001234",
        "register_id": "1A45",
        "transaction_discount_total": -125.08,
        "transaction_subtotal": -821.17,
        "transaction_total": -1026.47,
        "gst_hst": -133.45,
        "pst": -71.85,
        "products": [
            {
                "sku_id": "100xx4567",
                "category": "electronics",
                "description": "Apple Macbook 16-inch",
                "quantity": 1,
                "unit_price": 1000,
                "extended_price": 984.35
            },
            {
                "sku_id": "20bb3457",
                "category": "office supplies",
                "description": "24lb Multiuse Paper, White",
                "quantity": 1,
                "unit_price": 33.99,
                "extended_price": 42.12
            }
        ]
    },
}

Example Request: No SKU

Code Block
{
    "reference": "orderid-12345",
    "amount": 1000.12
    "external_location_id" : "00-12345",  //if in-store channel
    "external_employee_id" :"12345-SMITH" //if in-store channel
    "vcc_number": "1234567890123423",
    "capture_id": 346123
}

Success Response:

Code Block
{
}

...

Code Block
breakoutModewide
https://{posapi_url}/flexiti/pos-api/v2.5.1/client-id/{client_id}/authorizations?lang=en&account_number=12341234&transaction_type=promotional_purchase&authorization_status=opened&creation_date_from=2018-11-11&creation_date_to=2018-12-11&page_number=1&page_size=10

NOTE: the /authorizations endpoint has been updated to version 2.5.1, reflected in the URI.

...

Code Block
breakoutModewide
https://{posapi_url}/flexiti/pos-api/v2.5.1/client-id/{client_id}/authorization/12343&lang=en

NOTE: the /authorization/{authorizationId} endpoint has been updated to version 2.5.1, reflected in the URI.

...

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5.1/client-id/{client_id}/captures&lang=en&account_number=12341234
&transaction_type=promotional_purchase&capture_status=opened&creation_date_from=2018-11-11&creation_date_to=2018-12-11&capture_id=1234&authorization_corporation_id=1234&authorization_merchant_id=1234&authorization_location_id=1122&authorization_employee_username=billm&capture_employee_username=johnm&page_number=1&page_size=10

NOTE: the /captures endpoint has been updated to version 2.5.1, reflected in the URI.

...