Follow

Documentation Change Log

12/04/2018

UPDATED:POST /customers/{customerId}/vaults

  • Removed WEB as a valid option for the achType parameter.

11/26/2018

UPDATED:POST /customers/{customerId}/vaults

  • Added note stating that the maximum number of vaults per customer is 50.

UPDATED:GET /customers/{customerId}/vaults

  • Adjusted wording on Pagination note at top of document to state that pagination will only be triggered on this endpoint if the limit parameter is used with a value less than 50.

UPDATED:POST /customers/{customerId}/addresses

  • Added note stating that the maximum number of addresses per customer is 50.

UPDATED:GET /customers/{customerId}/addresses

  • Adjusted wording on Pagination note at top of document to state that pagination will only be triggered on this endpoint if the limit parameter is used with a value less than 50.

9/25/2018

ADDED:GET /deposits/?offset={index}

  • Fetch a paginated array of deposit information

ADDED:GET /deposits/{depositId}

  • Fetch the details for a specific deposit

9/7/2018

The following updates were made to better clarify the difference in behavior between API version 2018-06-19 and all prior versions as well as to promote the new SMARTTERMINAL_REQUEST webhook subscription:

Updated: POST /smartterminals/{smartTerminalId}/request-payment

  • SMARTTERMINAL_REQUEST webhook example is now the default example

Updated: SMARTTERMINAL_REQUEST Webhook

  • Added versioning information to Busy Terminal section
  • Added signature capture webhook payload example
  • Added tip to point out that SMARTTERMINAL_REQUEST always references the original request id as the requestId even though payment requests return this id as the requestPaymentId

Updated: Transaction Processing Workflow

  • Added note pointing out that payment requests return requestPaymentId while other Smart Terminal requests return this as requestId
  • Updated the Webhook Workflow section to use SMARTTERMINAL_REQUEST as the default example.
  • Added example signature capture webhook payload

Updated: SMARTTERMINAL_REQUEST and SMARTTERMINAL_TRANSACTION Webhook Differences

  • Added versioning details for behavior prior to API version 2018-06-19

8/30/2018

UpdatedGET /settlements/{settlmentId}

  • Added missing REJECT status in the Breakdown Format table. 

8/29/2018

AddedGET /settlements/{settlmentId}

  • Get a breakdown of transactions for a specific settled batch.

Added: GET /settlements/?offset={index}

  • Get a list of all previously settled batches.

8/2/2018

Added: Pagination

  • Documents pagination behavior of GET endpoints which return multiple records

Updated: All GET endpoints which return multiple records

  • Added warning of pagination behavior with link back to Pagination article

7/17/2018

Added: POST /smartterminals/{smartTerminalId}/request-signature

  • Send a signature request to a selected Smart Terminal.

Added: GET /smartterminals/signatures/{signatureId}/image 

  • Get the signature image that was captured by Smart Terminal.

UpdatedGET /smartterminals/requests/{requestId} 

  • Returns the status of a Smart Terminal request returned by Smart Terminal payment requests AND Smart Terminal signature requests.

6/27/2018

Added: API version 6-19-2018 to API versions document

Updated: Testing for Busy or Offline Smart Terminal.

06/13/2018

Updated: GET /terminals documentation now conforms to 2018-06-01 API version

AddedGET /terminals *Pre-2018-06-01* added to documentation archive.

06/07/2018

Added: API Change Log

Added: Section - Documentation Changes & Previous Versions