Client Login

Client Login

Sellers

Seller

Buyers

Buyers

Paymate OnTheGo

onthego

Paymate API

The purpose of Paymate's Application Programming Interface (API) is to enable a seller’s website to interact with the Paymate service via an automated interface. Functions supported in the current release (1.0) are:

  1. Allow automated update of payments and status.
  2. Recover lost orders that were not recorded at the seller site.
  3. Allow the seller to validate that a payment was made on a specific order.

Overview

The API is HTTP request/response based.

The seller site initiates a HTTP request to Paymate's server. Paymate server will send back HTTP response to the seller. The HTTP response has an XML document as its message body instead of HTML document. The request and response are transferred via secure HTTPS protocol.


Operation

1.  Single Query

The seller can use this operation to query for a single Paymate transaction.

Request Format

The format of the request matches the format of a URL encoded HTML form.

The following properties should be provided:

  1. Method name: either “queryByTransactionId” or “queryByOrderRef
  2. The former is used in conjunction with property number 5 (txnid) while the latter is used with property number 6 (oref).
  3. Seller user nam
  4. Example: “usr=testMerchantID”
  5. Seller password (pwd
  6. Example: “pwd=testMerchantPassword”
  7. Paymate transaction ID (txnid) – see property #
  8. Example: “txnid=31607587536”
  9. Seller order ID (oref) - see property #
  10. Example: “oref=1002400”
  11. If the seller's order ID is not unique then the first transaction that matches this query will be returned
  12. 6. API version: "ver=1.

Response Format

Please refer to the following URL for the specific XML format.

  1. If the payment transaction was found
  2. XML based reply with transaction and buyer details (the details that are currently returned by express payment)
  3. If the payment is not found or a logical error occurred:
  4. Body contains XML based error response with numeric and human readable description.
  5. General error: 404 HTTP response code.

2.  Batch Query

The seller can use this operation to query multiple Paymate transactions.

Request Format

The following properties should be provided:

  1. Method name: “batchQueryByDate
  2. Seller user name.
  3. Example: “usr=testMerchantID”
  4. Seller password.
  5. Example: “pwd=testMerchantPassword”
  6. Start date.
  7. Date format: "dd/MM/yyyy HH:mm:ss".
  8. Example: “startdate=01/05/2007 13:07:39”
  9. End date.
  10. If the end date is not provided the query will assume the end date is the time that the query is done.
  11. Date format: "dd/MM/yyyy HH:mm:ss".
  12. Example: “enddate=01/05/2007 13:07:39”
  13. API version: "ver=1.0"

Response Format

Please refer to the following URL for the specific XML format.

1. If the query was successful:

XML based list of records (each containing the details that are currently returned by express payment).

An identifier that notifies that there are more records that were not returned due to limitations imposed on the size of the batch query.

  1. If a logical error occurred
  2. Body contains XML based error response with numeric and human readable description.
  3. General error: 404 HTTP response code.

3. Third Party Query

A third party may perform query on behalf of a seller, providing that the following conditions are met:

  • The seller authorizes the operation.
  • Third party is registered to the service.
  • Third party provides the email of the seller on which the query is made.

Request Format

The third party can perform single query or batch query operations. The following properties need to be added to the standard requests above:

  • Third party email – the transactions returned on the response will belong to this seller
  • (Example: “tp= This e-mail address is being protected from spambots. You need JavaScript enabled to view it ”.)

General notes

  1. There may be a limit to the number of API calls that a seller can make per day, to be determined by Paymate.
  2. A single batch transaction will be limited to 200 records. It may also be limited in other ways such as the start date may not be older than 5 days prior to today's date. These limits will be detemined by Paymate and are subject to change.
  3. Registration for the service will be necessary.  Please contact This e-mail address is being protected from spambots. You need JavaScript enabled to view it to express your interest with details.
  4. Service hours within which the seller is allowed to perform batch queries may apply.
  5. Signature of message in the HTTP request may be required in the next version of API for security enhancement.


Service urls

API requests should be directed to:

  • Sandbox environment: https://sandbox.paymate.com/PayMate/api. You will need to register a Paymate account and process payments for testing purposes.  No payments will be processed, but you can use nominated credit card numbers to receive different responses.
  • Production environment: https://www.paymate.com/PayMate/api. The seller will need to have a valid Paymate account and be approved and set up for use of the Paymate API for production usage.  Payments will be processed and fees applied under our fee structure.


Sample Code

Please download and unzip the following file: sample-code.zip


Request Parameters

Parameter ID Used in Format Description
Required request parameters:
usr all requests text/ascii Paymate account name
pwd all requests text/ascii Paymate account password
method all requests text/ascii

must be one of values

 

  1. queryByTransactionId
  2. queryByOrderRef
  3. batchQueryByDates
Inquiry method
ver all requests text/ascii

Must be "1.0"

API version

Single query request parameters:
txnid queryByTransactionId text/ascii Paymate transaction ID
oref queryByOrderRef UTF-8, URL encoded. seller's order reference

Batch query request parameters:
startdate batchQueryByDates dd/MM/yyyy HH:mm:ss start date and time for the query.
enddate batchQueryByDates

optional, dd/MM/yyyy HH:mm:ss

defaults to current date/time

end date and time for the query.
pagenumber batchQueryByDates

integer (1-99)

defaults to 1


pagesize batchQueryByDates

optional integer (1-100)

defaults to 10



Third Party query request parameters:
tp queryByOrderRef

queryByTransactionId

UTF-8, URL encoded. actual seller's email registered with Paymate

help-btn

Facebook Twitter 

contact-btn