Production Date: 2021.03.31 | 
 Example Request: Code Block |
---|
{
"account_number": 20035156,
"vcc_number": "1234567890101213",
format": "regular_purchase_bypass",
"request_id": "12345678901234567890"
} |
Example Response: Code Block |
---|
{
"verification_code": 2485
} |
 Example Request - /authorization Code Block |
---|
{
"vcc_number": "1234567890123456",
"account_number": 1234567,
"reference": "orderid-12345",
"widget_session_id": "12345678901234567890", //if Online channel
"request_id": "12345678901234567890", //if in-store channel
"external_location_id" : "00-12345", //if in-store channel
"external_employee_id" :"12345-SMITH" //if in-store channel
"financing_option": {
"transaction_type": "promotional_purchase",
"plan_id": 5,
"term": 6
},
"amount": 5000.12,
"auto_capture": true,
"verification_code": 9999,
"billing_information": {
"first_name": "John",
"last_name": "Smith",
"address_1": "1234 Main Street",
"address_2": "",
"city": "Toronto",
"postal_code": "M1M1M1",
"country": "CA",
"province": "ON"
},
"shipping_information": {
"first_name": "John",
"last_name": "Smith",
"address_1": "1234 Main Street",
"address_2": "",
"city": "Toronto",
"postal_code": "M1M1M1",
"country": "CA",
"province": "ON"
},
"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
}
]
} |
 Sample Response: Code Block |
---|
{
"authorization_id": 12345768,
"reference": "orderid-12345",
"date": "2019-07-20T00:39:57Z",
"expiration_date": "2019-07-20T00:39:57Z",
"ending_date": null,
"status": "closed",
"auto_capture": true,
"amount": 123.12,
"apr": 0.1999,
"message": "lorem ipsum",
"username": "jjones",
"financing_option": {
"transaction_type": "promotional_purchase",
"plan_id": 5,
"term": 6
},
"fees": [
{
"type": "admin_total",
"description": "Admin fee:",
"amount": 49.99,
"message": "lorem ipsum"
}
],
"merchant_information": {
"corporation_id": 1234,
"corporation_name": "ACME Corporation",
"merchant_id": 10028,
"merchant_name": "ACME Jewellers",
"location_id": 1328,
"location_name": "ACME Jewellers 123"
},
"customer": {
"air": 0.3724,
"available_credit": 2000.12,
"first_name": "John",
"last_name": "Smith",
"category_type": "preferred"
},
"capture": {
"capture_id": 1234112,
"reference": "orderid-12345",
"date": "2019-07-20T00:39:57Z",
"status": "pending",
"term_amount": 123,
"amount": 123.12
},
"billing_information": {
"first_name": "John",
"last_name": "Smith",
"address_1": "1234 Main Street",
"address_2": "",
"city": "Toronto",
"postal_code": "M1M1M1",
"province": "ON"
},
"shipping_information": {
"first_name": "John",
"last_name": "Smart",
"address_1": "800 Main Ave",
"address_2": "",
"city": "Toronto",
"postal_code": "M1M1M2",
"province": "ON"
},
"account_avs": {
"shipping_information": {
"first_name": 1,
"last_name": 0.85,
"address_1": 0.54,
"address_2": 0,
"city": 1,
"postal_code": 0.92,
"province": 1
},
"billing_information": {
"first_name": 1,
"last_name": 1,
"address_1": 1,
"address_2": 0,
"city": 1,
"postal_code": 1,
"province": 1
}
"business_shipping_information": {
"first_name": 1,
"last_name": 0.85,
"address_1": 0.54,
"address_2": 0,
"city": 1,
"postal_code": 0.92,
"province": 1
},
"business_billing_information": {
"first_name": 1,
"last_name": 1,
"address_1": 1,
"address_2": 0,
"city": 1,
"postal_code": 1,
"province": 1
}
}
} |
Image Added |