# Get list of outbound transfers for a paypoint

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

Retrieve a list of outbound transfers for a paypoint. Use filters to limit results.

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

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get list of outbound transfers for a paypoint
  version: endpoint_query.ListTransfersOutPaypoint
paths:
  /Query/transfersOut/{entry}:
    get:
      operationId: list-transfers-out-paypoint
      summary: Get list of outbound transfers for a paypoint
      description: >-
        Retrieve a list of outbound transfers for a paypoint. Use filters to
        limit results.
      tags:
        - - subpackage_query
      parameters:
        - name: entry
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/type_:Entry'
        - 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)
              - `returnedAmount` (gt, ge, lt, le, eq, ne)
              - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
              - `netFundedAmount` (gt, ge, lt, le, eq, ne)
              - `processor` (ne, eq, ct, nct)
              - `transferStatus` (ne, eq, in, nin)
              - `transferId` (ne, eq, in, nin)
              - `paypointLegalName` (ne, eq, ct, nct)
              - `paypointDbaName` (ne, eq, ct, nct)
              - `batchNumber` (ne, eq, ct, nct)
              - `batchId` (ne, eq, in, nin)
          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___queryTypes__:TransferOutQueryResponse
        '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___queryTypes__:TransferOutSummary:
      type: object
      properties:
        totalPages:
          type:
            - integer
            - 'null'
          description: Number of pages in the response.
        totalRecords:
          type:
            - integer
            - 'null'
          description: Number of records in the response.
        pageSize:
          type:
            - integer
            - 'null'
          description: Number of records per page.
      required:
        - totalPages
        - totalRecords
        - pageSize
    type___queryTypes__:TransferOutBankAccount:
      type: object
      properties:
        accountNumber:
          type:
            - string
            - 'null'
          description: The masked bank account number.
        routingNumber:
          type:
            - string
            - 'null'
          description: The bank routing number.
        bankName:
          type:
            - string
            - 'null'
          description: The bank name.
      required:
        - accountNumber
        - routingNumber
        - bankName
    type___queryTypes__:TransferOutEventData:
      type: object
      properties:
        description:
          type:
            - string
            - 'null'
          description: Description of the event.
        eventTime:
          type:
            - string
            - 'null'
          description: The time the event occurred.
        refData:
          type:
            - string
            - 'null'
          description: Reference data for the event.
        extraData:
          oneOf:
            - description: Any type
            - type: 'null'
          description: >-
            Additional event data, which may contain detailed transaction
            information.
        source:
          type:
            - string
            - 'null'
          description: The source of the event.
      required:
        - description
        - eventTime
        - refData
        - extraData
        - source
    type___queryTypes__:TransferOutMessageProperties:
      type: object
      properties:
        originalTransferStatus:
          type:
            - string
            - 'null'
          description: The original status of the transfer before the message.
        currentTransferStatus:
          type:
            - string
            - 'null'
          description: The current status of the transfer after the message.
      required:
        - originalTransferStatus
        - currentTransferStatus
    type___queryTypes__:TransferOutMessage:
      type: object
      properties:
        Id:
          type:
            - integer
            - 'null'
          description: Unique identifier for the message.
        RoomId:
          type:
            - integer
            - 'null'
          description: The ID of the room where the message was sent.
        UserId:
          type:
            - integer
            - 'null'
          description: The ID of the user who sent the message.
        UserName:
          type:
            - string
            - 'null'
          description: The name of the user who sent the message.
        Content:
          type:
            - string
            - 'null'
          description: The content of the message.
        CreatedAt:
          type:
            - string
            - 'null'
          description: The time the message was created.
        MessageType:
          type:
            - integer
            - 'null'
          description: The type of message.
        MessageProperties:
          oneOf:
            - $ref: >-
                #/components/schemas/type___queryTypes__:TransferOutMessageProperties
            - type: 'null'
          description: Additional properties for the message.
      required:
        - Id
        - RoomId
        - UserId
        - UserName
        - Content
        - CreatedAt
        - MessageType
        - MessageProperties
    type___queryTypes__:TransferOutRecord:
      type: object
      properties:
        transferId:
          type:
            - integer
            - 'null'
          description: Unique identifier for the transfer.
        paypointId:
          type:
            - integer
            - 'null'
          description: The ID of the paypoint associated with the transfer.
        batchNumber:
          type:
            - string
            - 'null'
          description: The batch number for the transfer.
        batchCurrency:
          type:
            - string
            - 'null'
          description: The currency of the batch.
        batchRecords:
          type:
            - integer
            - 'null'
          description: The number of records in the batch.
        transferIdentifier:
          type:
            - string
            - 'null'
          description: An identifier for the transfer.
        batchId:
          type:
            - integer
            - 'null'
          description: The ID of the batch.
        batchNetAmount:
          type:
            - number
            - 'null'
          format: double
          description: The net amount of the batch.
        batchStatus:
          type:
            - integer
            - 'null'
          description: The status of the batch.
        paypointEntryName:
          type:
            - string
            - 'null'
          description: The entry name for the paypoint.
        paypointLegalName:
          type:
            - string
            - 'null'
          description: The legal name of the paypoint.
        paypointDbaName:
          type:
            - string
            - 'null'
          description: The DBA name of the paypoint.
        paypointLogo:
          type:
            - string
            - 'null'
          description: URL to the paypoint's logo.
        parentOrgName:
          type:
            - string
            - 'null'
          description: The name of the parent organization.
        parentOrgId:
          type:
            - integer
            - 'null'
          description: The ID of the parent organization.
        parentOrgLogo:
          type:
            - string
            - 'null'
          description: URL to the parent organization's logo.
        parentOrgEntryName:
          type:
            - string
            - 'null'
          description: The entry name for the parent organization.
        externalPaypointID:
          type:
            - string
            - 'null'
          description: External identifier for the paypoint.
        bankAccount:
          oneOf:
            - $ref: '#/components/schemas/type___queryTypes__:TransferOutBankAccount'
            - type: 'null'
          description: Bank account information for the transfer.
        transferDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The date of the transfer.
        processor:
          type:
            - string
            - 'null'
          description: The processor used for the transfer.
        transferStatus:
          type:
            - integer
            - 'null'
          description: The status of the transfer.
        grossAmount:
          type:
            - number
            - 'null'
          format: double
          description: The gross amount of the transfer.
        chargeBackAmount:
          type:
            - number
            - 'null'
          format: double
          description: The chargeback amount deducted from the transfer.
        returnedAmount:
          type:
            - number
            - 'null'
          format: double
          description: The returned amount deducted from the transfer.
        holdAmount:
          type:
            - number
            - 'null'
          format: double
          description: The amount being held.
        releasedAmount:
          type:
            - number
            - 'null'
          format: double
          description: The amount that has been released.
        billingFeesAmount:
          type:
            - number
            - 'null'
          format: double
          description: The billing fees amount.
        thirdPartyPaidAmount:
          type:
            - number
            - 'null'
          format: double
          description: The third party paid amount.
        adjustmentsAmount:
          type:
            - number
            - 'null'
          format: double
          description: The adjustments amount.
        netTransferAmount:
          type:
            - number
            - 'null'
          format: double
          description: The net transfer amount after all deductions.
        splitAmount:
          type:
            - number
            - 'null'
          format: double
          description: The split funding amount.
        eventsData:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/type___queryTypes__:TransferOutEventData'
          description: List of events associated with the transfer.
        messages:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/type___queryTypes__:TransferOutMessage'
          description: List of messages associated with the transfer.
      required:
        - transferId
        - paypointId
        - batchNumber
        - batchCurrency
        - batchRecords
        - transferIdentifier
        - batchId
        - batchNetAmount
        - batchStatus
        - paypointEntryName
        - paypointLegalName
        - paypointDbaName
        - paypointLogo
        - parentOrgName
        - parentOrgId
        - parentOrgLogo
        - parentOrgEntryName
        - externalPaypointID
        - bankAccount
        - transferDate
        - processor
        - transferStatus
        - grossAmount
        - chargeBackAmount
        - returnedAmount
        - holdAmount
        - releasedAmount
        - billingFeesAmount
        - thirdPartyPaidAmount
        - adjustmentsAmount
        - netTransferAmount
        - splitAmount
        - eventsData
        - messages
    type___queryTypes__:TransferOutQueryResponse:
      type: object
      properties:
        Summary:
          $ref: '#/components/schemas/type___queryTypes__:TransferOutSummary'
          description: Summary information about the transfers.
        Records:
          type: array
          items:
            $ref: '#/components/schemas/type___queryTypes__:TransferOutRecord'
          description: List of outbound transfer records.
      required:
        - Summary
        - Records

```

## SDK Code Examples

```python ListTransfersOutPaypointExample
import requests

url = "https://api-sandbox.payabli.com/api/Query/transfersOut/47cade237"

querystring = {"fromRecord":"0","limitRecord":"20"}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript ListTransfersOutPaypointExample
const url = 'https://api-sandbox.payabli.com/api/Query/transfersOut/47cade237?fromRecord=0&limitRecord=20';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go ListTransfersOutPaypointExample
package main

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

func main() {

	url := "https://api-sandbox.payabli.com/api/Query/transfersOut/47cade237?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 ListTransfersOutPaypointExample
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Query/transfersOut/47cade237?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 ListTransfersOutPaypointExample
HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Query/transfersOut/47cade237?fromRecord=0&limitRecord=20")
  .asString();
```

```php ListTransfersOutPaypointExample
<?php

$client = new \GuzzleHttp\Client();

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

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

```csharp ListTransfersOutPaypointExample
var client = new RestClient("https://api-sandbox.payabli.com/api/Query/transfersOut/47cade237?fromRecord=0&limitRecord=20");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift ListTransfersOutPaypointExample
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/transfersOut/47cade237?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()
```