/ Guides / Payments / Tutorial / List payment batches

Step 2: list payment batches

Now that we know you have at least one payment batch, let's try getting a list of all the payment batches on your account.

Sample requestRequest structure
Copy
Copied
curl -i -X GET \
  'https://api.equalsmoney.com/v2/payment-batches?accountId=F50091&sort=asc&offset=100&limit=200&ids=string&include=string&includeHidden=true&statuses=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'requestid: string' \
Copy
Copied
  'https://api.equalsmoney.com/v2/payment-batches?accountId=F50091&sort=asc&offset=100&limit=200&ids=string&include=string&includeHidden=true&statuses=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'requestid: string' \

If your request is successful, you'll receive a 200 response containing a list of payment batches.

Sample responseResponse structure
Copy
Copied
{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "accountId": "string",
      "name": "string",
      "createdBy": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "person"
      },
      "product": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "status": "draft",
      "visible": true,
      "visibleAt": "2019-08-24T14:15:22Z",
      "confirmedBy": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "person"
      },
      "confirmedAt": "2019-08-24T14:15:22Z",
      "passedMfaCheckAt": "2019-08-24T14:15:22Z",
      "riskCheckedAt": "2019-08-24T14:15:22Z",
      "ordersSentAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "alerts": [
        {
          "timestamp": "2019-08-24T14:15:22Z",
          "type": "Error",
          "code": "string",
          "message": "string"
        }
      ],
      "ordersSummary": {
        "numberOfOrders": 0,
        "uniqueCurrencyCodes": [
          "USD"
        ]
      },
      "input": {
        "format": "csv",
        "status": "accepted",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    }
  ]
}
Copy
Copied
{
  "limit": number,
  "offset": number,
  "count": number,
  "rows": [
    {
      "id": "string",
      "accountId": "string",
      "name": "string",
      "createdBy": {
        "id": "string",
        "type": "string"
      },
      "product": {
        "id": "string",
        "name": "string"
      },
      "status": "string",
      "visible": boolean,
      "visibleAt": "string",
      "confirmedBy": {
        "id": "string",
        "type": "string"
      },
      "confirmedAt": "string",
      "passedMfaCheckAt": "string",
      "riskCheckedAt": "string",
      "ordersSentAt": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "alerts": [
        {
          "timestamp": "string",
          "type": "string",
          "code": "string",
          "message": "string"
        }
      ],
      "ordersSummary": {
        "numberOfOrders": number,
        "uniqueCurrencyCodes": [
          "string"
        ]
      },
      "input": {
        "format": "string",
        "status": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    }
  ]
}

Next