Versions Compared

Old Version 114

changes.mady.by.user Arthur Zhao

Saved on

compared with

New Version 115

changes.mady.by.user Arthur Zhao

Saved on

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
languagejson
{
    "reference": "Order-1234",
    "vcc_number": "1234567890121256",
    "full_return": false,
    "amount": 10,
    "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
            }
        ]
    },
}

Response Parameters:

Type

Parameter

Details

BODY

return_id

  • number (16)

  • ID of the return created

BODY

reference

  • ASCII string (40)

  • Merchant Order ID saved within the capture

BODY

capture_id

  • number (9)

  • ID of the capture returned

BODY

date

  • UTC - ISO_8601 (20)

  • Auto-calculated Date-time of capture

BODY

amount

  • number (18,2)

  • Returned amount

BODY

remaining_capture_amount

  • number (18,2)

  • Remaining capture amount after the return

BODY

remaining_authorization_amount

  • number (18,2)

  • Remaining amount of the credit authorization

BODY

username

  • ASCII string (30)

  • username of the employee that performed the release

BODY

message

  • ASCII string (1000)

  • Used to convey information to notify the customer

...

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.

...