# Get transfer details
GET https://api-sandbox.payabli.com/api/Query/transferDetails/{entry}/{transferId}
Retrieve a list of transfer details records 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-transfer-details
## OpenAPI Specification
```yaml
openapi: 3.1.1
info:
title: Get transfer details for a paypoint
version: endpoint_query.ListTransferDetails
paths:
/Query/transferDetails/{entry}/{transferId}:
get:
operationId: list-transfer-details
summary: Get transfer details for a paypoint
description: >-
Retrieve a list of transfer details records 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: transferId
in: path
description: The numeric identifier for the transfer, assigned by Payabli.
required: true
schema:
type: integer
- 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
required: false
schema:
$ref: '#/components/schemas/type___queryTypes__:limitRecord'
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter
the query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**List of field names accepted:**
- `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)
- `splitFundingAmount` (gt, ge, lt, le, eq, ne)
- `operation` (in, nin, eq, ne)
- `transactionId` (eq, ne, in, nin)
- `category` (eq, ne, ct, nct)
- `type` (eq, ne, in, nin)
- `method` (eq, ne, 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
- name: requestToken
in: header
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/type___queryTypes__:QueryTransferDetailResponse
'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___queryTypes__:limitRecord:
type: integer
type_:BillingFeeDetail:
type: object
properties:
billableEvent:
type: string
service:
type: string
eventId:
type: string
description:
type: string
description: Description of the billing fee
category:
type: string
description: Category of the billing fee
fixPrice:
type: number
format: double
description: Fixed price component of the fee
floatPrice:
type: number
format: double
description: Percentage component of the fee
billableAmount:
type: number
format: double
description: Amount eligible for the fee
billAmount:
type: number
format: double
description: Total fee amount charged
frequency:
type: string
serviceGroup:
type: string
type_:OrgParentName:
type: string
type_:Dbaname:
type: string
type_:Legalname:
type: string
type_:ExternalProcessorInformation:
type: string
type_:OrderId:
type: string
type_:BatchNumber:
type: string
type_:PayorId:
type: integer
format: int64
type_:Accountexp:
type: string
type_:Accountid:
type: string
type_:Accounttype:
type: string
type_:Accountzip:
type: string
type_:BinData:
type: object
properties:
binMatchedLength:
type: string
description: |-
The number of characters from the beginning of the card number that
were matched against a Bank Identification Number (BIN) or the Card
Range table.
binCardBrand:
type: string
description: |-
The card brand. For example, Visa, Mastercard, American Express,
Discover.
binCardType:
type: string
description: 'The type of card: Credit or Debit.'
binCardCategory:
type: string
description: >-
The category of the card, which indicates the card product. For
example: Standard, Gold, Platinum, etc. The binCardCategory for
prepaid cards is marked `PREPAID`.
binCardIssuer:
type: string
description: The name of the financial institution that issued the card.
binCardIssuerCountry:
type: string
description: The issuing financial institution's country name.
binCardIssuerCountryCodeA2:
type: string
description: >-
The issuing financial institution's two-character ISO country code.
See [this resource](https://www.iso.org/obp/ui/#search) for a list
of codes.
binCardIssuerCountryNumber:
type: string
description: >-
The issuing financial institution's ISO standard numeric country
code. See [this resource](https://www.iso.org/obp/ui/#search) for a
list of codes.
binCardIsRegulated:
type: string
description: Indicates whether the card is regulated.
binCardUseCategory:
type: string
description: The use category classification for the card.
binCardIssuerCountryCodeA3:
type: string
description: >-
The issuing financial institution's three-character ISO country
code.
See [this resource](https://www.iso.org/obp/ui/#search) for a list
of
codes.
type_:Holdername:
type: string
type_:Initiator:
type: string
type_:Maskedaccount:
type: string
type_:Orderdescription:
type: string
type_:PaymentCategories:
type: object
properties:
amount:
type: number
format: double
description: Price/cost per unit of item or category.
description:
type: string
description: Description of item or category
label:
type: string
description: Name of item or category.
qty:
type: integer
default: 1
description: Quantity of item or category
required:
- amount
- label
type_:SplitFundingContent:
type: object
properties:
accountId:
type: string
description: The accountId for the account the split should be sent to.
amount:
type: number
format: double
description: Amount from the transaction to sent to this recipient.
description:
type: string
description: A description for the split.
recipientEntryPoint:
type: string
description: The entrypoint the split should be sent to.
type_:SplitFunding:
type: array
items:
$ref: '#/components/schemas/type_:SplitFundingContent'
type_:PaymentDetail:
type: object
properties:
categories:
type: array
items:
$ref: '#/components/schemas/type_:PaymentCategories'
description: >-
Array of payment categories/line items describing the amount to be
paid.
**Note**: These categories are for information only and aren't
validated against the total amount provided.
checkImage:
type: object
additionalProperties:
description: Any type
description: Object containing image of paper check.
checkNumber:
type: string
description: >-
A check number to be used in the ach transaction. **Required** for
payment method = 'check'.
currency:
type: string
description: >-
The currency for the transaction, `USD` or `CAD`. If your paypoint
is configured for CAD, you must send the `CAD` value in this field,
otherwise it defaults to USD, which will cause the transaction to
fail.
serviceFee:
type: number
format: double
description: >-
Service fee to be deducted from the total amount. This amount must
be a number, percentages aren't accepted. If you are using a
percentage-based fee schedule, you must calculate the value
manually.
splitFunding:
$ref: '#/components/schemas/type_:SplitFunding'
description: >-
Split funding instructions for the transaction. See [Split a
Transaction](/developers/developer-guides/money-in-split-funding)
for more.
totalAmount:
type: number
format: double
description: >-
Total amount to be charged. If a service fee is sent, then this
amount should include the service fee."
required:
- totalAmount
type_:Sequence:
type: string
type_:Signaturedata:
type: string
type_:Storedmethodid:
type: string
type_:StoredMethodUsageType:
type: string
type_:QueryPaymentData:
type: object
properties:
AccountExp:
$ref: '#/components/schemas/type_:Accountexp'
accountId:
$ref: '#/components/schemas/type_:Accountid'
AccountType:
$ref: '#/components/schemas/type_:Accounttype'
AccountZip:
$ref: '#/components/schemas/type_:Accountzip'
binData:
$ref: '#/components/schemas/type_:BinData'
HolderName:
$ref: '#/components/schemas/type_:Holdername'
Initiator:
$ref: '#/components/schemas/type_:Initiator'
MaskedAccount:
$ref: '#/components/schemas/type_:Maskedaccount'
orderDescription:
$ref: '#/components/schemas/type_:Orderdescription'
paymentDetails:
$ref: '#/components/schemas/type_:PaymentDetail'
Sequence:
$ref: '#/components/schemas/type_:Sequence'
SignatureData:
$ref: '#/components/schemas/type_:Signaturedata'
StoredId:
$ref: '#/components/schemas/type_:Storedmethodid'
description: Identifier of stored payment method used in transaction.
StoredMethodUsageType:
$ref: '#/components/schemas/type_:StoredMethodUsageType'
type_:PaypointId:
type: integer
format: int64
type_:Netamountnullable:
type: number
format: double
type_:FeeAmount:
type: number
format: double
type_:Operation:
type: string
type_:Authcode:
type: string
type_:AvsResponse:
type: string
type_:AvsResponseText:
type: string
type_:CvvResponse:
type: string
type_:CvvResponseText:
type: string
type_:EmvAuthResponseData:
type: string
type_:ResultCodev2:
type: string
type_:ResultCodeText:
type: string
type_:QueryResponseData:
type: object
properties:
authcode:
$ref: '#/components/schemas/type_:Authcode'
avsresponse:
$ref: '#/components/schemas/type_:AvsResponse'
avsresponse_text:
$ref: '#/components/schemas/type_:AvsResponseText'
cvvresponse:
$ref: '#/components/schemas/type_:CvvResponse'
cvvresponse_text:
$ref: '#/components/schemas/type_:CvvResponseText'
emv_auth_response_data:
$ref: '#/components/schemas/type_:EmvAuthResponseData'
orderid:
$ref: '#/components/schemas/type_:OrderId'
response:
type: string
description: 'Response text for operation: ''Success'' or ''Declined''.'
response_code:
type: string
description: >-
Internal result code processing the transaction. Value 1 indicates
successful operation, values 2 and 3 indicate errors.
response_code_text:
type: string
description: >-
Text describing the result. If resultCode = 1, will return
'Approved' or a general success message. If resultCode = 2 or 3,
will contain the cause of the decline.
responsetext:
type: string
description: >-
Text describing the result. If resultCode = 1, will return
'Approved' or a general success message. If resultCode = 2 or 3,
will contain the cause of the decline.
resultCode:
$ref: '#/components/schemas/type_:ResultCodev2'
resultCodeText:
$ref: '#/components/schemas/type_:ResultCodeText'
transactionid:
type: string
description: The transaction identifier in Payabli.
type:
type: string
description: Type of transaction or operation.
type_:Source:
type: string
type_:Orgid:
type: integer
format: int64
type_:RefundId:
type: integer
format: int64
type_:ReturnedId:
type: integer
format: int64
type_:ChargebackId:
type: integer
format: int64
type_:RetrievalId:
type: integer
format: int64
type_:AdditionalDataMap:
type: object
additionalProperties:
type: string
type_:FileContentFtype:
type: string
enum:
- value: pdf
- value: doc
- value: docx
- value: jpg
- value: jpeg
- value: png
- value: gif
- value: txt
type_:FileContent:
type: object
properties:
fContent:
type: string
description: >-
Content of file, Base64-encoded. Ignored if furl is specified. Max
upload size is 30 MB.
filename:
type: string
description: The name of the attached file.
ftype:
$ref: '#/components/schemas/type_:FileContentFtype'
description: The MIME type of the file (if content is provided)
furl:
type: string
description: Optional URL provided to show or download the file remotely
type_:Attachments:
type: array
items:
$ref: '#/components/schemas/type_:FileContent'
type_:Discount:
type: number
format: double
type_:DutyAmount:
type: number
format: double
type_:FreightAmount:
type: number
format: double
type_:Frequency:
type: string
enum:
- value: onetime
- value: weekly
- value: every2weeks
- value: every6months
- value: monthly
- value: every3months
- value: annually
type_:InvoiceAmount:
type: number
format: double
type_:Datenullable:
type: string
format: date
type_:InvoiceNumber:
type: string
type_:Invoicestatus:
type: integer
type_:InvoiceType:
type: integer
type_:ItemCommodityCode:
type: string
type_:ItemDescription:
type: string
type_:ItemProductCode:
type: string
type_:ItemProductName:
type: string
type_:ItemUnitofMeasure:
type: string
type_:BillItem:
type: object
properties:
itemCategories:
type: array
items:
type: string
description: Array of tags classifying item or product.
itemCommodityCode:
$ref: '#/components/schemas/type_:ItemCommodityCode'
itemCost:
type: number
format: double
description: Item or product price per unit.
itemDescription:
$ref: '#/components/schemas/type_:ItemDescription'
itemMode:
type: integer
description: >-
Internal class of item or product: value '0' is only for invoices ,
'1' for bills and, '2' common for both.
itemProductCode:
$ref: '#/components/schemas/type_:ItemProductCode'
itemProductName:
$ref: '#/components/schemas/type_:ItemProductName'
itemQty:
type: integer
description: Quantity of item or product.
itemTaxAmount:
type: number
format: double
description: Tax amount applied to item or product.
itemTaxRate:
type: number
format: double
description: Tax rate applied to item or product.
itemTotalAmount:
type: number
format: double
description: Total amount in item or product.
itemUnitOfMeasure:
$ref: '#/components/schemas/type_:ItemUnitofMeasure'
required:
- itemCost
type_:BillDataPaymentTerms:
type: string
enum:
- value: PIA
- value: CIA
- value: UR
- value: NET10
- value: NET20
- value: NET30
- value: NET45
- value: NET60
- value: NET90
- value: EOM
- value: MFI
- value: 5MFI
- value: 10MFI
- value: 15MFI
- value: 20MFI
- value: 2/10NET30
- value: UF
- value: 10UF
- value: 20UF
- value: 25UF
- value: 50UF
type_:PurchaseOrder:
type: string
type_:Shippingaddress:
type: string
type_:Shippingaddressadditional:
type: string
type_:Shippingcity:
type: string
type_:Shippingcountry:
type: string
type_:Email:
type: string
format: email
type_:ShippingFromZip:
type: string
type_:Shippingstate:
type: string
type_:Shippingzip:
type: string
type_:SummaryCommodityCode:
type: string
type_:Tax:
type: number
format: double
type_:TermsConditions:
type: string
type_:BillData:
type: object
properties:
AdditionalData:
$ref: '#/components/schemas/type_:AdditionalDataMap'
attachments:
$ref: '#/components/schemas/type_:Attachments'
company:
type: string
description: Company name of the recipient of the invoice.
discount:
$ref: '#/components/schemas/type_:Discount'
dutyAmount:
$ref: '#/components/schemas/type_:DutyAmount'
firstName:
type: string
description: First name of the recipient of the invoice.
freightAmount:
$ref: '#/components/schemas/type_:FreightAmount'
frequency:
$ref: '#/components/schemas/type_:Frequency'
description: Frequency of scheduled invoice.
invoiceAmount:
$ref: '#/components/schemas/type_:InvoiceAmount'
invoiceDate:
$ref: '#/components/schemas/type_:Datenullable'
description: 'Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
invoiceDueDate:
$ref: '#/components/schemas/type_:Datenullable'
description: >-
Invoice due date in one of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY.
invoiceEndDate:
$ref: '#/components/schemas/type_:Datenullable'
description: >-
Indicate the date to finish a scheduled invoice cycle
(`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY.
invoiceNumber:
$ref: '#/components/schemas/type_:InvoiceNumber'
description: Invoice number. Identifies the invoice under a paypoint.
invoiceStatus:
$ref: '#/components/schemas/type_:Invoicestatus'
invoiceType:
$ref: '#/components/schemas/type_:InvoiceType'
items:
type: array
items:
$ref: '#/components/schemas/type_:BillItem'
description: Array of line items included in the invoice.
lastName:
type: string
description: Last name of the recipient of the invoice.
notes:
type: string
description: Notes included in the invoice.
paymentTerms:
$ref: '#/components/schemas/type_:BillDataPaymentTerms'
purchaseOrder:
$ref: '#/components/schemas/type_:PurchaseOrder'
shippingAddress1:
$ref: '#/components/schemas/type_:Shippingaddress'
shippingAddress2:
$ref: '#/components/schemas/type_:Shippingaddressadditional'
shippingCity:
$ref: '#/components/schemas/type_:Shippingcity'
shippingCountry:
$ref: '#/components/schemas/type_:Shippingcountry'
shippingEmail:
$ref: '#/components/schemas/type_:Email'
description: Shipping recipient's contact email address.
shippingFromZip:
$ref: '#/components/schemas/type_:ShippingFromZip'
shippingPhone:
type: string
description: Recipient phone number.
shippingState:
$ref: '#/components/schemas/type_:Shippingstate'
shippingZip:
$ref: '#/components/schemas/type_:Shippingzip'
summaryCommodityCode:
$ref: '#/components/schemas/type_:SummaryCommodityCode'
tax:
$ref: '#/components/schemas/type_:Tax'
termsConditions:
$ref: '#/components/schemas/type_:TermsConditions'
type_:EntrypageId:
type: integer
format: int64
type_:ExternalPaypointId:
type: string
type_:DatetimeNullable:
type: string
format: date-time
type_:BillingZip:
type: string
type_:CustomerNumberNullable:
type: string
type_:CustomerId:
type: integer
format: int64
type_:CustomerStatus:
type: integer
type_:QueryTransactionPayorData:
type: object
properties:
Identifiers:
type: array
items:
description: Any type
description: Array of field names to be used as identifiers.
FirstName:
type: string
description: Customer/Payor first name.
LastName:
type: string
description: Customer/Payor last name.
CompanyName:
type: string
description: Customer's company name.
BillingAddress1:
type: string
description: Customer's billing address.
BillingAddress2:
type: string
description: Additional line for Customer's billing address.
BillingCity:
type: string
description: Customer's billing city.
BillingState:
type: string
description: >-
Customer's billing state. Must be 2-letter state code for address in
US.
BillingZip:
$ref: '#/components/schemas/type_:BillingZip'
description: Customer's billing ZIP code.
BillingCountry:
type: string
description: Customer's billing country.
BillingPhone:
type: string
description: Customer's phone number.
BillingEmail:
$ref: '#/components/schemas/type_:Email'
description: Customer's email address.
CustomerNumber:
$ref: '#/components/schemas/type_:CustomerNumberNullable'
ShippingAddress1:
$ref: '#/components/schemas/type_:Shippingaddress'
ShippingAddress2:
$ref: '#/components/schemas/type_:Shippingaddressadditional'
ShippingCity:
$ref: '#/components/schemas/type_:Shippingcity'
ShippingState:
$ref: '#/components/schemas/type_:Shippingstate'
ShippingZip:
$ref: '#/components/schemas/type_:Shippingzip'
ShippingCountry:
$ref: '#/components/schemas/type_:Shippingcountry'
customerId:
$ref: '#/components/schemas/type_:CustomerId'
customerStatus:
$ref: '#/components/schemas/type_:CustomerStatus'
AdditionalData:
$ref: '#/components/schemas/type_:AdditionalDataMap'
type_:TransactionTime:
type: string
format: date-time
type_:QueryCFeeTransaction:
type: object
properties:
cFeeTransid:
type: string
feeAmount:
type: number
format: double
operation:
type: string
refundId:
type: integer
format: int64
responseData:
type: object
additionalProperties:
description: Any type
settlementStatus:
type: integer
transactionTime:
$ref: '#/components/schemas/type_:TransactionTime'
transStatus:
type: integer
type_:QueryTransactionEventsEventData:
oneOf:
- type: object
additionalProperties:
description: Any type
- type: string
type_:QueryTransactionEvents:
type: object
properties:
EventData:
$ref: '#/components/schemas/type_:QueryTransactionEventsEventData'
description: >-
Any data associated to the event received from processor. Contents
vary by event type.
EventTime:
type: string
format: date-time
description: Date and time of event.
TransEvent:
type: string
description: >-
Event descriptor. See [TransEvent
Reference](/guides/pay-in-transevents-reference) for more details.
type_:PendingFeeAmount:
type: number
format: double
type_:RiskFlagged:
type: boolean
type_:RiskFlaggedOn:
type: string
format: date-time
type_:RiskStatus:
type: string
type_:RiskReason:
type: string
type_:RiskAction:
type: string
type_:RiskActionCode:
type: integer
type_:Device:
type: string
type_:DeviceId:
$ref: '#/components/schemas/type_:Device'
type_:AchSecCode:
type: string
type_:AchHolderType:
type: string
enum:
- value: personal
- value: business
default: personal
type_:IpAddress:
type: string
type___queryTypes__:TransferDetailRecord:
type: object
properties:
transferDetailId:
type:
- integer
- 'null'
description: Unique identifier for the transfer detail record
transferId:
type:
- integer
- 'null'
description: The ID of the transfer this detail belongs to
transactionId:
type:
- string
- 'null'
description: The transaction ID in Payabli's system
transactionNumber:
type:
- string
- 'null'
description: External transaction reference number
type:
type:
- string
- 'null'
description: The transaction type (credit or debit)
category:
type:
- string
- 'null'
description: >-
A field used to categorize the transaction details. Values include:
auth, decline, refund, adj, cb, split
grossAmount:
type:
- number
- 'null'
format: double
description: The gross amount of the transaction
chargeBackAmount:
type:
- number
- 'null'
format: double
description: Chargeback amount deducted from transaction
returnedAmount:
type:
- number
- 'null'
format: double
description: ACH return amount deducted from transaction
refundAmount:
type:
- number
- 'null'
format: double
description: Refund amount deducted from transaction
holdAmount:
type:
- number
- 'null'
format: double
description: Amount being held for fraud or risk concerns
releasedAmount:
type:
- number
- 'null'
format: double
description: Previously held funds that have been released after a risk review
billingFeesAmount:
type:
- number
- 'null'
format: double
description: Charges applied for transactions and services
thirdPartyPaidAmount:
type:
- number
- 'null'
format: double
description: >-
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
- 'null'
format: double
description: Corrections applied to Billing & Fees charges
netTransferAmount:
type:
- number
- 'null'
format: double
description: The net amount after all deductions
splitFundingAmount:
type:
- number
- 'null'
format: double
description: Total amount directed to split funding destinations
billingFeesDetails:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/type_:BillingFeeDetail'
ParentOrgName:
oneOf:
- $ref: '#/components/schemas/type_:OrgParentName'
- type: 'null'
PaypointDbaname:
oneOf:
- $ref: '#/components/schemas/type_:Dbaname'
- type: 'null'
PaypointLegalname:
oneOf:
- $ref: '#/components/schemas/type_:Legalname'
- type: 'null'
PaypointEntryname:
type:
- string
- 'null'
description: The paypoint's entryname
PaymentTransId:
type:
- string
- 'null'
description: The transaction ID for the payment
ConnectorName:
type:
- string
- 'null'
description: The payment connector used to process the transaction
ExternalProcessorInformation:
oneOf:
- $ref: '#/components/schemas/type_:ExternalProcessorInformation'
- type: 'null'
GatewayTransId:
type:
- string
- 'null'
description: Internal identifier used for processing
OrderId:
oneOf:
- $ref: '#/components/schemas/type_:OrderId'
- type: 'null'
Method:
type:
- string
- 'null'
description: 'Payment method used: card, ach, or wallet'
BatchNumber:
oneOf:
- $ref: '#/components/schemas/type_:BatchNumber'
- type: 'null'
BatchAmount:
type:
- number
- 'null'
format: double
description: The amount of the batch
PayorId:
oneOf:
- $ref: '#/components/schemas/type_:PayorId'
- type: 'null'
description: Unique ID for customer linked to the transaction
PaymentData:
oneOf:
- $ref: '#/components/schemas/type_:QueryPaymentData'
- type: 'null'
TransStatus:
type:
- integer
- 'null'
description: >-
Status of transaction. See [the
docs](/developers/references/money-in-statuses#money-in-transaction-status)
for a
full reference.
PaypointId:
oneOf:
- $ref: '#/components/schemas/type_:PaypointId'
- type: 'null'
TotalAmount:
type:
- number
- 'null'
format: double
description: Transaction total amount (including service fee or sub-charge)
NetAmount:
oneOf:
- $ref: '#/components/schemas/type_:Netamountnullable'
- type: 'null'
description: Net amount paid
FeeAmount:
oneOf:
- $ref: '#/components/schemas/type_:FeeAmount'
- type: 'null'
SettlementStatus:
type:
- integer
- 'null'
description: >-
Settlement status for transaction. See [the
docs](/developers/references/money-in-statuses#payment-funding-status)
for a full reference.
Operation:
oneOf:
- $ref: '#/components/schemas/type_:Operation'
- type: 'null'
ResponseData:
oneOf:
- $ref: '#/components/schemas/type_:QueryResponseData'
- type: 'null'
Source:
oneOf:
- $ref: '#/components/schemas/type_:Source'
- type: 'null'
ScheduleReference:
type:
- integer
- 'null'
description: >-
Reference to the subscription or schedule that originated the
transaction
OrgId:
oneOf:
- $ref: '#/components/schemas/type_:Orgid'
- type: 'null'
RefundId:
oneOf:
- $ref: '#/components/schemas/type_:RefundId'
- type: 'null'
ReturnedId:
oneOf:
- $ref: '#/components/schemas/type_:ReturnedId'
- type: 'null'
ChargebackId:
oneOf:
- $ref: '#/components/schemas/type_:ChargebackId'
- type: 'null'
RetrievalId:
oneOf:
- $ref: '#/components/schemas/type_:RetrievalId'
- type: 'null'
TransAdditionalData:
oneOf:
- description: Any type
- type: 'null'
description: Additional transaction data
invoiceData:
oneOf:
- $ref: '#/components/schemas/type_:BillData'
- type: 'null'
description: Associated invoice data
EntrypageId:
oneOf:
- $ref: '#/components/schemas/type_:EntrypageId'
- type: 'null'
externalPaypointID:
oneOf:
- $ref: '#/components/schemas/type_:ExternalPaypointId'
- type: 'null'
IsValidatedACH:
type:
- boolean
- 'null'
description: Indicates whether the ACH account has been validated
TransactionTime:
oneOf:
- $ref: '#/components/schemas/type_:DatetimeNullable'
- type: 'null'
description: Transaction date and time, in UTC
Customer:
oneOf:
- $ref: '#/components/schemas/type_:QueryTransactionPayorData'
- type: 'null'
splitFundingInstructions:
oneOf:
- $ref: '#/components/schemas/type_:SplitFunding'
- type: 'null'
CfeeTransactions:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/type_:QueryCFeeTransaction'
TransactionEvents:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/type_:QueryTransactionEvents'
PendingFeeAmount:
oneOf:
- $ref: '#/components/schemas/type_:PendingFeeAmount'
- type: 'null'
RiskFlagged:
oneOf:
- $ref: '#/components/schemas/type_:RiskFlagged'
- type: 'null'
RiskFlaggedOn:
oneOf:
- $ref: '#/components/schemas/type_:RiskFlaggedOn'
- type: 'null'
RiskStatus:
oneOf:
- $ref: '#/components/schemas/type_:RiskStatus'
- type: 'null'
RiskReason:
oneOf:
- $ref: '#/components/schemas/type_:RiskReason'
- type: 'null'
RiskAction:
oneOf:
- $ref: '#/components/schemas/type_:RiskAction'
- type: 'null'
RiskActionCode:
oneOf:
- $ref: '#/components/schemas/type_:RiskActionCode'
- type: 'null'
DeviceId:
oneOf:
- $ref: '#/components/schemas/type_:DeviceId'
- type: 'null'
AchSecCode:
oneOf:
- $ref: '#/components/schemas/type_:AchSecCode'
- type: 'null'
AchHolderType:
oneOf:
- $ref: '#/components/schemas/type_:AchHolderType'
- type: 'null'
IpAddress:
oneOf:
- $ref: '#/components/schemas/type_:IpAddress'
- type: 'null'
IsSameDayACH:
type:
- boolean
- 'null'
description: Indicates if this was a same-day ACH transaction.
WalletType:
type:
- string
- 'null'
description: Type of wallet used for the transaction (if applicable)
required:
- transferDetailId
- transferId
- transactionId
- transactionNumber
- type
- category
- grossAmount
- chargeBackAmount
- returnedAmount
- refundAmount
- holdAmount
- releasedAmount
- billingFeesAmount
- thirdPartyPaidAmount
- adjustmentsAmount
- netTransferAmount
- splitFundingAmount
- billingFeesDetails
- ParentOrgName
- PaypointDbaname
- PaypointLegalname
- PaypointEntryname
- PaymentTransId
- ConnectorName
- ExternalProcessorInformation
- GatewayTransId
- OrderId
- Method
- BatchNumber
- BatchAmount
- PayorId
- PaymentData
- TransStatus
- PaypointId
- TotalAmount
- NetAmount
- FeeAmount
- SettlementStatus
- Operation
- ResponseData
- Source
- ScheduleReference
- OrgId
- RefundId
- ReturnedId
- ChargebackId
- RetrievalId
- TransAdditionalData
- invoiceData
- EntrypageId
- externalPaypointID
- IsValidatedACH
- TransactionTime
- Customer
- splitFundingInstructions
- CfeeTransactions
- TransactionEvents
- PendingFeeAmount
- RiskFlagged
- RiskFlaggedOn
- RiskStatus
- RiskReason
- RiskAction
- RiskActionCode
- DeviceId
- AchSecCode
- AchHolderType
- IpAddress
- IsSameDayACH
- WalletType
type_:Totalrecords:
type: integer
type_:Totalpages:
type: integer
type_:Pagesize:
type: integer
type_:PageIdentifier:
type: string
type___queryTypes__:QueryTransferSummary:
type: object
properties:
achReturns:
type:
- number
- 'null'
format: double
description: ACH returns deducted from the batch.
adjustments:
type:
- number
- 'null'
format: double
description: Corrections applied to Billing & Fees charges.
billingFees:
type:
- number
- 'null'
format: double
description: Charges applied for transactions and services.
chargebacks:
type:
- number
- 'null'
format: double
description: Chargebacks deducted from batch.
grossTransferAmount:
type:
- number
- 'null'
format: double
description: The gross batch amount before deductions.
releaseAmount:
type:
- number
- 'null'
format: double
description: Previously held funds that have been released after a risk review.
thirdPartyPaid:
type:
- number
- 'null'
format: double
description: >-
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.
totalNetAmountTransfer:
type:
- number
- 'null'
format: double
description: The gross batch amount minus service fees.
splitAmount:
type:
- number
- 'null'
format: double
description: The sum of each splitFundingAmount of each record in the transfer.
serviceFees:
type:
- number
- 'null'
format: double
description: >-
Service fees are any pass-through fees charged to the customer at
the time of payment. These aren't transferred to the merchant when
the batch is transferred and funded.
netBatchAmount:
type:
- number
- 'null'
format: double
description: >-
The net batch amount is the gross batch amount minus any returns,
refunds,
billing and fees items, chargebacks, adjustments, and third party
payments.
transferAmount:
type:
- number
- 'null'
format: double
description: >-
The transfer amount is the net batch amount plus or minus any
returns, refunds, billing and fees items, chargebacks, adjustments,
and third party payments. This is the amount from the batch that is
transferred to the merchant bank account.
refunds:
type:
- number
- 'null'
format: double
description: Refunds deducted from batch.
heldAmount:
type:
- number
- 'null'
format: double
description: Funds being held for fraud or risk concerns.
totalRecords:
oneOf:
- $ref: '#/components/schemas/type_:Totalrecords'
- type: 'null'
description: Number of records in the response.
totalAmount:
type:
- number
- 'null'
format: double
description: The total sum of the transfers in the response.
totalNetAmount:
type:
- number
- 'null'
format: double
description: The total sum of the transfers in the response.
totalPages:
oneOf:
- $ref: '#/components/schemas/type_:Totalpages'
- type: 'null'
description: Number of pages in the response.
pageSize:
oneOf:
- $ref: '#/components/schemas/type_:Pagesize'
- type: 'null'
description: Number of records per page.
pageidentifier:
oneOf:
- $ref: '#/components/schemas/type_:PageIdentifier'
- type: 'null'
description: >-
Auxiliary validation used internally by payment pages and
components.
required:
- achReturns
- adjustments
- billingFees
- chargebacks
- grossTransferAmount
- releaseAmount
- thirdPartyPaid
- totalNetAmountTransfer
- splitAmount
- serviceFees
- netBatchAmount
- transferAmount
- refunds
- heldAmount
- totalRecords
- totalAmount
- totalNetAmount
- totalPages
- pageSize
- pageidentifier
type___queryTypes__:QueryTransferDetailResponse:
type: object
properties:
Records:
type: array
items:
$ref: '#/components/schemas/type___queryTypes__:TransferDetailRecord'
description: List of transfer detail records
Summary:
$ref: '#/components/schemas/type___queryTypes__:QueryTransferSummary'
description: Summary of the transfer details query
required:
- Records
- Summary
```
## SDK Code Examples
```python ListTransferDetailsPaypoint
from payabli import payabli
client = payabli(
api_key="YOUR_API_KEY",
)
client.query.list_transfer_details(
entry="47862acd",
transfer_id=123456,
)
```
```typescript ListTransferDetailsPaypoint
import { PayabliClient } from "@payabli/sdk-node";
const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.query.listTransferDetails("47862acd", 123456);
```
```go ListTransferDetailsPaypoint
import (
context "context"
option "github.com/payabli/sdk-go/option"
sdkgo "github.com/payabli/sdk-go"
sdkgoclient "github.com/payabli/sdk-go/client"
)
client := sdkgoclient.NewClient(
option.WithApiKey(
"",
),
)
response, err := client.Query.ListTransferDetails(
context.TODO(),
"47862acd",
123456,
&sdkgo.ListTransfersPaypointRequest{},
)
```
```csharp ListTransferDetailsPaypoint
using PayabliApi;
var client = new PayabliApiClient("API_KEY");
await client.Query.ListTransferDetailsAsync("47862acd", 123456, new ListTransfersPaypointRequest());
```
```ruby ListTransferDetailsPaypoint
require 'uri'
require 'net/http'
url = URI("https://api-sandbox.payabli.com/api/Query/transferDetails/47862acd/123456")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["requestToken"] = ''
response = http.request(request)
puts response.read_body
```
```java ListTransferDetailsPaypoint
HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/transferDetails/47862acd/123456")
.header("requestToken", "")
.asString();
```
```php ListTransferDetailsPaypoint
request('GET', 'https://api-sandbox.payabli.com/api/Query/transferDetails/47862acd/123456', [
'headers' => [
'requestToken' => '',
],
]);
echo $response->getBody();
```
```swift ListTransferDetailsPaypoint
import Foundation
let headers = ["requestToken": ""]
let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/transferDetails/47862acd/123456")! 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()
```