# Export batch details for paypoint

GET https://api-sandbox.payabli.com/api/Export/batchDetails/{format}/{entry}

This endpoint is deprecated. Export batch details for a paypoint. Use filters to limit results.

Reference: https://docs.payabli.com/developers/api-reference/export/export-batch-details-for-entrypoint

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Export batch details for a paypoint
  version: endpoint_export.ExportBatchDetails
paths:
  /Export/batchDetails/{format}/{entry}:
    get:
      operationId: export-batch-details
      summary: Export batch details for a paypoint
      description: >-
        This endpoint is deprecated. Export batch details for a paypoint. Use
        filters to limit results.
      tags:
        - - subpackage_export
      parameters:
        - name: format
          in: path
          description: 'Format for the export, either XLSX or CSV. '
          required: true
          schema:
            $ref: '#/components/schemas/type_export:ExportFormat1'
        - name: entry
          in: path
          description: >-
            The paypoint's entrypoint identifier. [Learn
            more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
        - name: fromRecord
          in: query
          description: >-
            The number of records to skip before starting to collect the result
            set.
          required: false
          schema:
            type: integer
            default: 0
        - name: limitRecord
          in: query
          description: >-
            The number of records to return for the query. The maximum is 30,000
            records. When this parameter isn't sent, the API returns up to
            25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
        - name: parameters
          in: query
          description: >-
            Collection of field names, conditions, and values used to filter the
            query


            <Info>
              **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**

              Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.

              For example:

              --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20

              should become:

              --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
            </Info>


            See [Filters and Conditions
            Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
            for help.


            **List of field names accepted:**

              - `settlementDate` (gt, ge, lt, le, eq, ne)
              - `depositDate` (gt, ge, lt, le, eq, ne)
              - `transId`  (ne, eq, ct, nct)
              - `gatewayTransId`  (ne, eq, ct, nct)
              - `method`   (in, nin, eq, ne)
              - `settledAmount`  (gt, ge, lt, le, eq, ne)
              - `operation`    (in, nin, eq, ne)
              - `source`   (in, nin, eq, ne)
              - `batchNumber`  (ct, nct, eq, ne)
              - `payaccountLastfour`   (nct, ct)
              - `payaccountType`   (ne, eq, in, nin)
              - `customerFirstname`   (ct, nct, eq, ne)
              - `customerLastname`    (ct, nct, eq, ne)
              - `customerName`   (ct, nct)
              - `customerId`  (eq, ne)
              - `customerNumber`  (ct, nct, eq, ne)
              - `customerCompanyname`    (ct, nct, eq, ne)
              - `customerAddress` (ct, nct, eq, ne)
              - `customerCity`    (ct, nct, eq, ne)
              - `customerZip` (ct, nct, eq, ne)
              - `customerState` (ct, nct, eq, ne)
              - `customerCountry` (ct, nct, eq, ne)
              - `customerPhone` (ct, nct, eq, ne)
              - `customerEmail` (ct, nct, eq, ne)
              - `customerShippingAddress` (ct, nct, eq, ne)
              - `customerShippingCity`    (ct, nct, eq, ne)
              - `customerShippingZip` (ct, nct, eq, ne)
              - `customerShippingState` (ct, nct, eq, ne)
              - `customerShippingCountry` (ct, nct, eq, ne)
              - `orgId`  (eq) *mandatory when entry=org*
              - `isHold` (eq, ne)
              - `paypointId`  (ne, eq)
              - `paypointLegal`  (ne, eq, ct, nct)
              - `paypointDba`  (ne, eq, ct, nct)
              - `orgName`  (ne, eq, ct, nct)
              - `batchId` (ct, nct, eq, neq)
              - `additional-xxx`  (ne, eq, ct, nct) where xxx is the additional field name

            List of parameters accepted:

            - limitRecord: max number of records for query (default="20", "0" or
            negative value for all)

            - fromRecord: initial record in query


            Example: `amount(gt)=20` return all records with amount greater than
            20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_:File'
        '400':
          description: Bad request/ invalid data
          content: {}
        '401':
          description: Unauthorized request.
          content: {}
        '500':
          description: Internal API Error
          content: {}
        '503':
          description: Database connection error
          content: {}
components:
  schemas:
    type_export:ExportFormat1:
      type: string
      enum:
        - value: csv
        - value: xlsx
    type_:File:
      type: object
      additionalProperties:
        description: Any type

```

## SDK Code Examples

```typescript
import { PayabliClient, PayabliEnvironment } from "@payabli/sdk-node";

async function main() {
    const client = new PayabliClient({
        environment: PayabliEnvironment.Sandbox,
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.export.exportBatchDetails("8cfec329267", "csv", {
        columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
        fromRecord: 251,
        limitRecord: 1000,
    });
}
main();

```

```python
from payabli import payabli
from payabli.environment import payabliEnvironment

client = payabli(
    environment=payabliEnvironment.SANDBOX,
    api_key="YOUR_API_KEY_HERE"
)

client.export.export_batch_details(
    entry="8cfec329267",
    format="csv",
    columns_export="BatchDate:Batch_Date,PaypointName:Legal_name",
    from_record=251,
    limit_record=1000
)

```

```csharp
using PayabliApi;
using System.Threading.Tasks;

namespace Usage;

public class Example
{
    public async Task Do() {
        var client = new PayabliApiClient(
            apiKey: "YOUR_API_KEY_HERE",
            clientOptions: new ClientOptions {
                BaseUrl = PayabliApiEnvironment.Sandbox
            }
        );

        await client.Export.ExportBatchDetailsAsync(
            ExportFormat1.Csv,
            "8cfec329267",
            new ExportBatchDetailsRequest {
                ColumnsExport = "BatchDate:Batch_Date,PaypointName:Legal_name",
                FromRecord = 251,
                LimitRecord = 1000
            }
        );
    }

}

```

```go
package example

import (
    client "github.com/payabli/sdk-go/v/client"
    option "github.com/payabli/sdk-go/v/option"
    payabli "github.com/payabli/sdk-go/v"
    context "context"
)

func do() {
    client := client.NewClient(
        option.WithBaseURL(
            payabli.Environments.Sandbox,
        ),
        option.WithApiKey(
            "YOUR_API_KEY_HERE",
        ),
    )
    request := &payabli.ExportBatchDetailsRequest{
        ColumnsExport: payabli.String(
            "BatchDate:Batch_Date,PaypointName:Legal_name",
        ),
        FromRecord: payabli.Int(
            251,
        ),
        LimitRecord: payabli.Int(
            1000,
        ),
    }
    client.Export.ExportBatchDetails(
        context.TODO(),
        "8cfec329267",
        payabli.ExportFormat1Csv.Ptr(),
        request,
    )
}

```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Export/batchDetails/csv/8cfec329267?columnsExport=BatchDate%3ABatch_Date%2CPaypointName%3ALegal_name&fromRecord=251&limitRecord=1000")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Export/batchDetails/csv/8cfec329267?columnsExport=BatchDate%3ABatch_Date%2CPaypointName%3ALegal_name&fromRecord=251&limitRecord=1000")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Export/batchDetails/csv/8cfec329267?columnsExport=BatchDate%3ABatch_Date%2CPaypointName%3ALegal_name&fromRecord=251&limitRecord=1000', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```swift
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Export/batchDetails/csv/8cfec329267?columnsExport=BatchDate%3ABatch_Date%2CPaypointName%3ALegal_name&fromRecord=251&limitRecord=1000")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```