I/O Docs: API Documentation

OAuth 2.0 Flow: Select OAuth 2.0 Flow

Existing Client Credentials: Manual Input

API Key:

App/Key: Select Application Key Manually provide key information

Shared Secret:

Client ID:

Client Secret: Authorize

Client ID: Get Access Token

Client ID:

Client Secret:

---

Username:

Password: Get Access Token

Client ID:

Client Secret: Get Access Token

Authorization Code: Get Access Token

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

• Sample Methods

  • List Methods
  • Expand Methods

  • GET Echo /echo

    The API will respond with the input text. This acts as a ping test.

    Parameter	Value	Type	Description
    repeat		string	Ping test

• Payment Methods

  • List Methods
  • Expand Methods

  • POST Creates a Payment /payment

    Method for creating a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    Content-Type		string	Content type of the payload

    Request Body

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}
  • GET Get Payment ID /payment/id

    Method for retrieving a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of payment

  • GET Get All Payments /payment

    Method for retrieving a list of payments.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    limit		string	number of records to display per call, default is 10
    offset		string	number of records to skip before showing quantity of records set by limit

  • DELETE Delete Payment ID /payment/id

    Method for deleting a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of the payment object to be deleted.

  • POST Send receipt /payment/id/receipt

    Send the receipt of a payment

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the payment.
    contact		string	Email address of phone number where receipt will be sent.

  • GET Get receipt /payment/id/receipt

    Get URL of a created receipt

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the payment.

• Customer Methods

  • List Methods
  • Expand Methods

  • POST Create Customer /customer

    Method for creating a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    Content-Type		string	Content type of the payload

    Request Body

    { "name": "john"}

    { "name": "john"}
  • GET Get Customer by Id /customer/id

    Retrieve a specific customer record.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer

  • GET Search customers /customer

    Search for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    value		string	Id of customer
    limit		string	amount of records to display per call(defaults to 10)
    offset		string	amount of records to skip before display the amount of records set by limit

  • GET Get customer card accounts /customer/id/payment

    Get all card accounts for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    limit		string	amount of records to display per call(defaults to 10)
    offset		string	amount of records to skip before display the amount of records set by limit

  • POST Add Card account /customer/id/cardaccount

    Adds a card account for customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    Content-Type		string	Content type of the payload

    Request Body

    { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"12333" }

    { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"12333" }
  • POST Create Customer Contact /customer/id/contact

    Method for creating a customer contact.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    Content-Type		string	Content type of the payload

    Request Body

    { "name":"john", "phone":"5557778686", "address": { "address1":"123 Smith st", "city":"Birmingham", "state":"AL", "zip":"12355" }, "mobile":"5557897777"}

    { "name":"john", "phone":"5557778686", "address": { "address1":"123 Smith st", "city":"Birmingham", "state":"AL", "zip":"12355" }, "mobile":"5557897777"}
  • GET Get all Customer Contacts /customer/id/contact

    Method for retrieving all contact records for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer

  • POST Create Customer Address /customer/id/address

    Method for creating a customer address.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    Content-Type		string	Content type of the payload

    Request Body

    { "address1": "123 Smith Street", "city": "Birmingham","zip": "77777" }

    { "address1": "123 Smith Street", "city": "Birmingham","zip": "77777" }
  • GET Get all address for a customer /customer/id/address

    Method for retrieving all address records for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer

  • GET Get specific address of customer /customer/id/address/subId

    Method for creating a customer address.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    subId		string	Id of address record

• Order Methods

  • List Methods
  • Expand Methods

  • POST Creates a Order /order

    Method for creating a order.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    Content-Type		string	Content type of the payload

    Request Body

    { "merchantId":"-1","totalAmount":"10.00"}

    { "merchantId":"-1","totalAmount":"10.00"}
  • GET Get Order ID /order/id

    Method for retrieving an order.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of order

  • GET Get All Orders /order

    Method for retrieving a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    searchValue		string	The value being searched for inside the searchType
    searchType		string	This can be based on Account, Email, Receipt, Customer, Invoices, Recent, InvoiceNumber, PhoneNumber, PurchaseOrderNumber,CustomerId
    limit		string	number of records to display per call, default is 10
    offset		string	number of records to skip before showing quantity of records set by limit

  • DELETE Delete Order ID /order/id

    Method for deleting an order.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of the order object to be deleted.

  • GET Get All Discounts /order/id/discount

    Gets all the discounts on an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • POST Create Order Discount /order/id/discount

    Method for creating a customer address.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of order resource
    Content-Type		string	Content type of the payload

    Request Body

    { }

    { }
  • GET Retrieve Order History /order/id/history

    Retrieve the history(creation date of order and its payments) of an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • GET Retrieve Order Payment /order/id/payment

    Retrieve all payments made to an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • POST Create Payment on Order /order/id/payment

    Create a payment on an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.
    Content-Type		string	Content type of the payload

    Request Body

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}
  • POST Create Purchase on Order /order/id/purchase

    Create a purchase on an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.
    Content-Type		string	Content type of the payload

    Request Body

    { "quantity":"1","price":"4.99"}

    { "quantity":"1","price":"4.99"}
  • GET Retrieve Order Purchases /order/id/purchase

    Retrieve all purchases made to an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • POST Send order receipt /order/id/receipt

    Send a receipt via email/SMS

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.
    contact		string	Email address of phone number where receipt will be sent.

  • GET Get order receipt /order/id/receipt

    Get URL of created receipt for order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the payment.

• Sample Methods

  • List Methods
  • Expand Methods

  • GET Echo /echo

    The API will respond with the input text. This acts as a ping test.

    Parameter	Value	Type	Description
    repeat		string	Ping test

• Payment Methods

  • List Methods
  • Expand Methods

  • POST Creates a Payment /payment

    Method for creating a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    Content-Type		string	Content type of the payload

    Request Body

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}
  • GET Get Payment ID /payment/id

    Method for retrieving a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of payment

  • GET Get All Payments /payment

    Method for retrieving a list of payments.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    limit		string	number of records to display per call, default is 10
    offset		string	number of records to skip before showing quantity of records set by limit

  • DELETE Delete Payment ID /payment/id

    Method for deleting a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of the payment object to be deleted.

  • POST Send receipt /payment/id/receipt

    Send the receipt of a payment

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the payment.
    contact		string	Email address of phone number where receipt will be sent.

  • GET Get receipt /payment/id/receipt

    Get URL of a created receipt

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the payment.

• Customer Methods

  • List Methods
  • Expand Methods

  • POST Create Customer /customer

    Method for creating a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    Content-Type		string	Content type of the payload

    Request Body

    { "name": "john"}

    { "name": "john"}
  • GET Get Customer by Id /customer/id

    Retrieve a specific customer record.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer

  • GET Search customers /customer

    Search for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    value		string	Id of customer
    limit		string	amount of records to display per call(defaults to 10)
    offset		string	amount of records to skip before display the amount of records set by limit

  • GET Get customer card accounts /customer/id/payment

    Get all card accounts for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    limit		string	amount of records to display per call(defaults to 10)
    offset		string	amount of records to skip before display the amount of records set by limit

  • POST Add Card account /customer/id/cardaccount

    Adds a card account for customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    Content-Type		string	Content type of the payload

    Request Body

    { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"12333" }

    { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"12333" }
  • POST Create Customer Contact /customer/id/contact

    Method for creating a customer contact.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    Content-Type		string	Content type of the payload

    Request Body

    { "name":"john", "phone":"5557778686", "address": { "address1":"123 Smith st", "city":"Birmingham", "state":"AL", "zip":"12355" }, "mobile":"5557897777"}

    { "name":"john", "phone":"5557778686", "address": { "address1":"123 Smith st", "city":"Birmingham", "state":"AL", "zip":"12355" }, "mobile":"5557897777"}
  • GET Get all Customer Contacts /customer/id/contact

    Method for retrieving all contact records for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer

  • POST Create Customer Address /customer/id/address

    Method for creating a customer address.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    Content-Type		string	Content type of the payload

    Request Body

    { "address1": "123 Smith Street", "city": "Birmingham","zip": "77777" }

    { "address1": "123 Smith Street", "city": "Birmingham","zip": "77777" }
  • GET Get all address for a customer /customer/id/address

    Method for retrieving all address records for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer

  • GET Get specific address of customer /customer/id/address/subId

    Method for creating a customer address.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    subId		string	Id of address record

• Order Methods

  • List Methods
  • Expand Methods

  • POST Creates a Order /order

    Method for creating a order.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    Content-Type		string	Content type of the payload

    Request Body

    { "merchantId":"-1","totalAmount":"10.00"}

    { "merchantId":"-1","totalAmount":"10.00"}
  • GET Get Order ID /order/id

    Method for retrieving an order.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of order

  • GET Get All Orders /order

    Method for retrieving a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    searchValue		string	The value being searched for inside the searchType
    searchType		string	This can be based on Account, Email, Receipt, Customer, Invoices, Recent, InvoiceNumber, PhoneNumber, PurchaseOrderNumber,CustomerId
    limit		string	number of records to display per call, default is 10
    offset		string	number of records to skip before showing quantity of records set by limit

  • DELETE Delete Order ID /order/id

    Method for deleting an order.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of the order object to be deleted.

  • GET Get All Discounts /order/id/discount

    Gets all the discounts on an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • POST Create Order Discount /order/id/discount

    Method for creating a customer address.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of order resource
    Content-Type		string	Content type of the payload

    Request Body

    { }

    { }
  • GET Retrieve Order History /order/id/history

    Retrieve the history(creation date of order and its payments) of an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • GET Retrieve Order Payment /order/id/payment

    Retrieve all payments made to an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • POST Create Payment on Order /order/id/payment

    Create a payment on an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.
    Content-Type		string	Content type of the payload

    Request Body

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}
  • POST Create Purchase on Order /order/id/purchase

    Create a purchase on an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.
    Content-Type		string	Content type of the payload

    Request Body

    { "quantity":"1","price":"4.99"}

    { "quantity":"1","price":"4.99"}
  • GET Retrieve Order Purchases /order/id/purchase

    Retrieve all purchases made to an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • POST Send order receipt /order/id/receipt

    Send a receipt via email/SMS

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.
    contact		string	Email address of phone number where receipt will be sent.

  • GET Get order receipt /order/id/receipt

    Get URL of created receipt for order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the payment.

• Sample Methods

  • List Methods
  • Expand Methods

  • GET Echo /echo

    The API will respond with the input text. This acts as a ping test.

    Parameter	Value	Type	Description
    repeat		string	Ping test

• Payment Methods

  • List Methods
  • Expand Methods

  • POST Creates a Payment /payment

    Method for creating a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    Content-Type		string	Content type of the payload

    Request Body

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}
  • GET Get Payment ID /payment/id

    Method for retrieving a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of payment

  • GET Get All Payments /payment

    Method for retrieving a list of payments.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    limit		string	number of records to display per call, default is 10
    offset		string	number of records to skip before showing quantity of records set by limit

  • DELETE Delete Payment ID /payment/id

    Method for deleting a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of the payment object to be deleted.

  • POST Send receipt /payment/id/receipt

    Send the receipt of a payment

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the payment.
    contact		string	Email address of phone number where receipt will be sent.

  • GET Get receipt /payment/id/receipt

    Get URL of a created receipt

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the payment.

• Customer Methods

  • List Methods
  • Expand Methods

  • POST Create Customer /customer

    Method for creating a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    Content-Type		string	Content type of the payload

    Request Body

    { "name": "john"}

    { "name": "john"}
  • GET Get Customer by Id /customer/id

    Retrieve a specific customer record.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer

  • GET Search customers /customer

    Search for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    value		string	Id of customer
    limit		string	amount of records to display per call(defaults to 10)
    offset		string	amount of records to skip before display the amount of records set by limit

  • GET Get customer card accounts /customer/id/payment

    Get all card accounts for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    limit		string	amount of records to display per call(defaults to 10)
    offset		string	amount of records to skip before display the amount of records set by limit

  • POST Add Card account /customer/id/cardaccount

    Adds a card account for customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    Content-Type		string	Content type of the payload

    Request Body

    { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"12333" }

    { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"12333" }
  • POST Create Customer Contact /customer/id/contact

    Method for creating a customer contact.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    Content-Type		string	Content type of the payload

    Request Body

    { "name":"john", "phone":"5557778686", "address": { "address1":"123 Smith st", "city":"Birmingham", "state":"AL", "zip":"12355" }, "mobile":"5557897777"}

    { "name":"john", "phone":"5557778686", "address": { "address1":"123 Smith st", "city":"Birmingham", "state":"AL", "zip":"12355" }, "mobile":"5557897777"}
  • GET Get all Customer Contacts /customer/id/contact

    Method for retrieving all contact records for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer

  • POST Create Customer Address /customer/id/address

    Method for creating a customer address.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    Content-Type		string	Content type of the payload

    Request Body

    { "address1": "123 Smith Street", "city": "Birmingham","zip": "77777" }

    { "address1": "123 Smith Street", "city": "Birmingham","zip": "77777" }
  • GET Get all address for a customer /customer/id/address

    Method for retrieving all address records for a customer.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer

  • GET Get specific address of customer /customer/id/address/subId

    Method for creating a customer address.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of customer
    subId		string	Id of address record

• Order Methods

  • List Methods
  • Expand Methods

  • POST Creates a Order /order

    Method for creating a order.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    Content-Type		string	Content type of the payload

    Request Body

    { "merchantId":"-1","totalAmount":"10.00"}

    { "merchantId":"-1","totalAmount":"10.00"}
  • GET Get Order ID /order/id

    Method for retrieving an order.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of order

  • GET Get All Orders /order

    Method for retrieving a payment.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    searchValue		string	The value being searched for inside the searchType
    searchType		string	This can be based on Account, Email, Receipt, Customer, Invoices, Recent, InvoiceNumber, PhoneNumber, PurchaseOrderNumber,CustomerId
    limit		string	number of records to display per call, default is 10
    offset		string	number of records to skip before showing quantity of records set by limit

  • DELETE Delete Order ID /order/id

    Method for deleting an order.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of the order object to be deleted.

  • GET Get All Discounts /order/id/discount

    Gets all the discounts on an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • POST Create Order Discount /order/id/discount

    Method for creating a customer address.

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Id of order resource
    Content-Type		string	Content type of the payload

    Request Body

    { }

    { }
  • GET Retrieve Order History /order/id/history

    Retrieve the history(creation date of order and its payments) of an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • GET Retrieve Order Payment /order/id/payment

    Retrieve all payments made to an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • POST Create Payment on Order /order/id/payment

    Create a payment on an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.
    Content-Type		string	Content type of the payload

    Request Body

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}

    { "merchantId":"-1","tenderType":"Card", "cardAccount": { "number":"4744452112344444", "expiryMonth":"07", "expiryYear":"2018", "cvv":"123", "avsZip":"123" },"amount":"2"}
  • POST Create Purchase on Order /order/id/purchase

    Create a purchase on an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.
    Content-Type		string	Content type of the payload

    Request Body

    { "quantity":"1","price":"4.99"}

    { "quantity":"1","price":"4.99"}
  • GET Retrieve Order Purchases /order/id/purchase

    Retrieve all purchases made to an order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.

  • POST Send order receipt /order/id/receipt

    Send a receipt via email/SMS

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the order.
    contact		string	Email address of phone number where receipt will be sent.

  • GET Get order receipt /order/id/receipt

    Get URL of created receipt for order

    Parameter	Value	Type	Description
    Authorization		string	OAuth 2.0
    id		string	Identification number of the payment.