v1

latestOpenAPI 3.1.02026-07-24260142.2 KB

/payments/{merchantId}/json

Sandbox (Testing): https://gateway.sand.us.zip.co/payments/{merchantId}/json

An abbreviated list of payments in JSON format.

get/payments/{merchantId}/json

Path parameters

merchantIdstring required

The unique Zip Merchant ID

Query parameters

MinimumCreateDateTimestring date required

The begin created date of the query search

MaximumCreateDateTimestring date required

The end created date of the query search

OrderBystring

The order sort of the result set

X-QP-Signaturestring required

The signature for merchant validation

MerchantIdstring required

The unique Zip Merchant ID

Headers

QP-Territorystring required

Territory of the request (US)

X-QP-Signaturestring required

The signature for merchant validation

Response

200

totalinteger

Example response

{
  "value": [
    {
      "transferId": "tr_1IobRYD4siJYPQuYs9O2QEZ6",
      "date": "2021-05-07T21:42:44Z",
      "amount": 843.1
    }
  ],
  "total": 6
}