v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Get a Batch's transactions

List all transactions within a batch

get/v3/batchpayment?id={batchId}

Path parameters

batchIdinteger required

Batch Id

Response

200

recordCountinteger

Example response

{
  "records": [
    {
      "created": "2018-08-13T16:32:49.1Z",
      "paymentToken": "PuxC40yq10wgVglWcyhqlCM",
      "id": 8983246,
      "creatorName": "APi Key",
      "merchantId": 282059433,
      "batch": "0001",
      "batchId": 10000000550618,
      "tenderType": "Card",
      "currency": "USD",
      "amount": "85.26",
      "cardAccount": {
        "cardType": "Visa",
        "entryMode": "Keyed",
        "last4": "4242",
        "cardId": "ESkW1RwQPH4wdBllGQMsf",
        "token": "PuxC40yq10YztVgVWlWcyhqlCM",
        "expiryMonth": "12",
        "expiryYear": "25"
      },
      "authCode": "PPS6L1",
      "status": "Settled",
      "risk": {
        "avsResponseCode": "Z",
        "avsZipMatch": true
      },
      "settledAmount": "0",
      "settledCurrency": "USD",
      "settledDate": "2018-08-13T17:10:00.85",
      "authMessage": "AUTH/TKT PPS6L1",
      "availableAuthAmount": "0",
      "reference": "PV6HS00MFIGG",
      "tax": "5.58",
      "invoice": "S00MFIGG",
      "customerCode": "eFiling 31524",
      "customerName": "MAGGIE NEWTON",
      "clientReference": "PV6HS00MFIGG",
      "type": "SaleCompletion",
      "source": "API"
    }
  ],
  "recordCount": 2
}