# List transfers

GET https://api-sandbox.payabli.com/api/Query/transfers/{entry}

Retrieve a list of transfers for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.

Reference: https://docs.payabli.com/developers/api-reference/query/get-list-of-transfers

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get list of transfers for a paypoint
  version: endpoint_query.ListTransfers
paths:
  /Query/transfers/{entry}:
    get:
      operationId: list-transfers
      summary: Get list of transfers for a paypoint
      description: >-
        Retrieve a list of transfers for a paypoint. Use filters to limit
        results. Include the `exportFormat` query parameter to return the
        results as a file instead of a JSON response.
      tags:
        - - subpackage_query
      parameters:
        - name: entry
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/type_:Entry'
        - name: exportFormat
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/type_:ExportFormat'
        - 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: >-
            Max number of records to return for the query. Use `0` or negative
            value to return all records.
          required: false
          schema:
            type: integer
            default: 20
        - name: parameters
          in: query
          description: >-
            Collection of field names, conditions, and values used to filter the
            query. See [Filters and Conditions
            Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
            for more information.

            <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>

            List of field names accepted:

              - `transferDate` (gt, ge, lt, le, eq, ne)
              - `grossAmount` (gt, ge, lt, le, eq, ne)
              - `chargeBackAmount` (gt, ge, lt, le, eq, ne)
              - `returnedAmount` (gt, ge, lt, le, eq, ne)
              - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
              - `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)
              - `netFundedAmount` (gt, ge, lt, le, eq, ne)
              - `adjustmentAmount` (gt, ge, lt, le, eq, ne)
              - `processor` (ne, eq, ct, nct)
              - `transferStatus` (ne, eq, in, nin)
              - `batchNumber` (ne, eq, ct, nct)
              - `batchId` (ne, eq, in, nin)
              - `transferId` (in, nin, eq, ne)
              - `bankAccountNumber` (ct, nct, ne, eq)
              - `bankRoutingNumber` (ct, nct, ne, eq)
              - `batchCurrency` (in, nin, ne, eq)
              - `parentOrgName` (ct, nct, ne, eq)
              - `parentOrgId` (ct, nct, ne, eq)
              - `externalPaypointID` (ct, nct)
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
        - name: sortBy
          in: query
          description: >-
            The field name to use for sorting results. Use `desc(field_name)` to
            sort descending by `field_name`, and use `asc(field_name)` to sort
            ascending by `field_name`.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_:TransferQueryResponse'
        '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_:Entry:
      type: string
    type_:ExportFormat:
      type: string
      enum:
        - description: Comma-separated values file
          value: csv
        - description: Excel spreadsheet file
          value: xlsx
    type_:PaypointId:
      type: integer
      format: int64
    type_:BatchNumber:
      type: string
    type_:TransferIdentifier:
      type: string
    type_:Legalname:
      type: string
    type_:Dbaname:
      type: string
    type_:AccountNumber:
      type: string
    type_:RoutingAccount:
      type: string
    type_:BankName:
      type: string
    type_:TransferBankAccount:
      type: object
      properties:
        accountNumber:
          $ref: '#/components/schemas/type_:AccountNumber'
        routingNumber:
          $ref: '#/components/schemas/type_:RoutingAccount'
        bankName:
          $ref: '#/components/schemas/type_:BankName'
      required:
        - accountNumber
        - routingNumber
        - bankName
    type_:Source:
      type: string
    type_:GeneralEvents:
      type: object
      properties:
        description:
          type: string
          description: Event description.
        eventTime:
          type: string
          format: date-time
          description: Event timestamp, in UTC.
        extraData:
          type: object
          additionalProperties:
            description: Any type
          description: Extra data.
        refData:
          type: string
          description: Reference data.
        source:
          $ref: '#/components/schemas/type_:Source'
          description: The event source.
    type_:TransferMessageProperties:
      type: object
      properties:
        originalTransferStatus:
          type:
            - string
            - 'null'
        currentTransferStatus:
          type:
            - string
            - 'null'
      required:
        - originalTransferStatus
        - currentTransferStatus
    type_:TransferMessage:
      type: object
      properties:
        Id:
          type:
            - integer
            - 'null'
        RoomId:
          type:
            - integer
            - 'null'
        UserId:
          type:
            - integer
            - 'null'
        UserName:
          type:
            - string
            - 'null'
        Content:
          type:
            - string
            - 'null'
        CreatedAt:
          type:
            - string
            - 'null'
        MessageType:
          type:
            - integer
            - 'null'
        MessageProperties:
          oneOf:
            - $ref: '#/components/schemas/type_:TransferMessageProperties'
            - type: 'null'
      required:
        - Id
        - RoomId
        - UserId
        - UserName
        - Content
        - CreatedAt
        - MessageType
        - MessageProperties
    type_:Transfer:
      type: object
      properties:
        transferId:
          type: integer
          description: The transfer ID.
        paypointId:
          $ref: '#/components/schemas/type_:PaypointId'
        batchNumber:
          $ref: '#/components/schemas/type_:BatchNumber'
        batchCurrency:
          type:
            - string
            - 'null'
          description: The currency of the batch, either USD or CAD.
        batchRecords:
          type:
            - integer
            - 'null'
          description: Number of records in the batch.
        transferIdentifier:
          $ref: '#/components/schemas/type_:TransferIdentifier'
        batchId:
          type: integer
          description: The ID of the batch the transfer belongs to.
        paypointEntryName:
          type:
            - string
            - 'null'
          description: The paypoint entryname.
        paypointLegalName:
          oneOf:
            - $ref: '#/components/schemas/type_:Legalname'
            - type: 'null'
          description: The paypoint legal name.
        paypointDbaName:
          oneOf:
            - $ref: '#/components/schemas/type_:Dbaname'
            - type: 'null'
          description: The paypoint DBA name.
        paypointLogo:
          type:
            - string
            - 'null'
          description: The paypoint logo URL.
        parentOrgName:
          type:
            - string
            - 'null'
          description: The parent organization name.
        parentOrgId:
          type:
            - integer
            - 'null'
          description: The parent organization ID.
        parentOrgEntryName:
          type:
            - string
            - 'null'
          description: The parent organization entryname.
        parentOrgLogo:
          type:
            - string
            - 'null'
          description: The parent organization logo URL.
        externalPaypointID:
          type:
            - string
            - 'null'
          description: The external paypoint ID.
        bankAccount:
          oneOf:
            - $ref: '#/components/schemas/type_:TransferBankAccount'
            - type: 'null'
          description: Bank account information for the transfer.
        transferDate:
          type: string
          description: Date when the transfer occurred.
        processor:
          type: string
          description: The payment processor used for the transfer.
        transferStatus:
          type: integer
          description: The current status of the transfer.
        grossAmount:
          type: number
          format: double
          description: >-
            Gross batch is the total amount of the payments grouped in the
            batch. This amount includes service fees.
        chargeBackAmount:
          type: number
          format: double
          description: Amount of chargebacks to be deducted from batch.
        returnedAmount:
          type: number
          format: double
          description: Amount of ACH returns to be deducted from batch.
        holdAmount:
          type: number
          format: double
          description: Amount being held for fraud or risk concerns.
        releasedAmount:
          type: number
          format: double
          description: >-
            Amount of previously held funds that have been released after a risk
            review.
        billingFeesAmount:
          type: number
          format: double
          description: Amount of charges and fees applied for services and transactions.
        thirdPartyPaidAmount:
          type: number
          format: double
          description: >-
            Amount of payments captured in the batch cycle that are deposited
            separately. For example, checks or cash payments recorded in the
            batch but not deposited via Payabli, or card brands making a direct
            transfer in certain situations.
        adjustmentsAmount:
          type: number
          format: double
          description: Amount of corrections applied to Billing & Fees charges.
        netTransferAmount:
          type: number
          format: double
          description: The net transfer amount after all deductions and additions.
        splitAmount:
          type:
            - number
            - 'null'
          format: double
          description: The sum of each splitFundingAmount of each record in the transfer.
        eventsData:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/type_:GeneralEvents'
          description: List of events associated with the transfer.
        messages:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/type_:TransferMessage'
          description: List of messages related to the transfer.
      required:
        - transferId
        - paypointId
        - batchNumber
        - batchCurrency
        - batchRecords
        - transferIdentifier
        - batchId
        - paypointEntryName
        - paypointLegalName
        - paypointDbaName
        - paypointLogo
        - parentOrgName
        - parentOrgId
        - parentOrgEntryName
        - parentOrgLogo
        - externalPaypointID
        - bankAccount
        - transferDate
        - processor
        - transferStatus
        - grossAmount
        - chargeBackAmount
        - returnedAmount
        - holdAmount
        - releasedAmount
        - billingFeesAmount
        - thirdPartyPaidAmount
        - adjustmentsAmount
        - netTransferAmount
        - splitAmount
        - eventsData
        - messages
    type_:Totalpages:
      type: integer
    type_:Totalrecords:
      type: integer
    type_:Pagesize:
      type: integer
    type_:TransferSummary:
      type: object
      properties:
        totalPages:
          $ref: '#/components/schemas/type_:Totalpages'
        totalRecords:
          $ref: '#/components/schemas/type_:Totalrecords'
        pageSize:
          $ref: '#/components/schemas/type_:Pagesize'
      required:
        - totalPages
        - totalRecords
        - pageSize
    type_:TransferQueryResponse:
      type: object
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/type_:Transfer'
        Summary:
          $ref: '#/components/schemas/type_:TransferSummary'
      required:
        - Records
        - Summary

```

## SDK Code Examples

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

async function main() {
    const client = new PayabliClient({
        environment: PayabliEnvironment.Sandbox,
    });
    await client.query.listTransfers("47862acd", {
        fromRecord: 0,
        limitRecord: 20,
    });
}
main();

```

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

client = payabli(
    environment=payabliEnvironment.SANDBOX
)

client.query.list_transfers(
    entry="47862acd",
    from_record=0,
    limit_record=20
)

```

```csharp ListTransfer
using PayabliPayabliApi;
using System.Threading.Tasks;

namespace Usage;

public class Example
{
    public async Task Do() {
        var client = new PayabliPayabliApiClient(
            clientOptions: new ClientOptions {
                BaseUrl = PayabliPayabliApiEnvironment.Sandbox
            }
        );

        await client.Query.ListTransfersAsync(
            "47862acd",
            new ListTransfersRequest {
                FromRecord = 0,
                LimitRecord = 20
            }
        );
    }

}

```

```go ListTransfer
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/Query/transfers/47862acd?fromRecord=0&limitRecord=20"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

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

url = URI("https://api-sandbox.payabli.com/api/Query/transfers/47862acd?fromRecord=0&limitRecord=20")

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

request = Net::HTTP::Get.new(url)

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

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

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Query/transfers/47862acd?fromRecord=0&limitRecord=20")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Query/transfers/47862acd?fromRecord=0&limitRecord=20');

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

```swift ListTransfer
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/transfers/47862acd?fromRecord=0&limitRecord=20")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```