# Get outbound transfer details GET https://api-sandbox.payabli.com/api/Query/transferDetailsOut/{entry}/{transferId} Retrieve details for a specific outbound transfer. Use filters to limit results. Reference: https://docs.payabli.com/developers/api-reference/query/get-transfer-out-details ## OpenAPI Specification ```yaml openapi: 3.1.1 info: title: Get outbound transfer details version: endpoint_query.ListTransferDetailsOut paths: /Query/transferDetailsOut/{entry}/{transferId}: get: operationId: list-transfer-details-out summary: Get outbound transfer details description: >- Retrieve details for a specific outbound transfer. Use filters to limit results. 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: 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. **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 List of field names accepted: - `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) - `adjustmentAmount` (gt, ge, lt, le, eq, ne) - `transactionId` (eq, ne, in, nin) - `category` (eq, ne, ct, nct) - `type` (eq, ne, in, nin) - `method` (eq, ne, in, nin) - `walletType` (eq, ne, in, nin) - `splitFundingAmount` (gt, ge, lt, le, eq, ne) 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__:TransferOutDetailQueryResponse '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_: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_: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_:Email: type: string format: email type_:ContactsResponse: type: object properties: ContactEmail: $ref: '#/components/schemas/type_:Email' description: Contact email address. ContactName: type: string description: Contact name. ContactPhone: type: string description: Contact phone number. ContactTitle: type: string description: Contact title. type___queryTypes__:TransferOutDetailVendorBillingData: type: object properties: id: type: - integer - 'null' description: Unique identifier for the billing data. accountId: type: - string - 'null' description: The account ID. nickname: type: - string - 'null' description: A nickname for the account. bankName: type: - string - 'null' description: The name of the bank. routingAccount: type: - string - 'null' description: The routing number. accountNumber: type: - string - 'null' description: The account number. typeAccount: type: - string - 'null' description: The type of account. bankAccountHolderName: type: - string - 'null' description: The name of the account holder. bankAccountHolderType: type: - string - 'null' description: The type of account holder. bankAccountFunction: type: - integer - 'null' description: The function of the bank account. verified: type: - boolean - 'null' description: Whether the account is verified. status: type: - integer - 'null' description: The status of the billing data. services: type: - array - 'null' items: description: Any type description: Services associated with the billing data. default: type: - boolean - 'null' description: Whether this is the default billing data. country: type: - string - 'null' description: The country of the bank account. required: - id - accountId - nickname - bankName - routingAccount - accountNumber - typeAccount - bankAccountHolderName - bankAccountHolderType - bankAccountFunction - verified - status - services - default - country type___queryTypes__:TransferOutDetailVendor: type: object properties: VendorNumber: type: - string - 'null' description: The vendor's unique number. Name1: type: - string - 'null' description: Primary name of the vendor. Name2: type: - string - 'null' description: Secondary name of the vendor. EIN: type: - string - 'null' description: Employer Identification Number. Phone: type: - string - 'null' description: Vendor's phone number. Email: type: - string - 'null' description: Vendor's email address. RemitEmail: type: - string - 'null' description: Email for remittance notifications. Address1: type: - string - 'null' description: Primary address line. Address2: type: - string - 'null' description: Secondary address line. City: type: - string - 'null' description: City of the vendor. State: type: - string - 'null' description: State of the vendor. Zip: type: - string - 'null' description: ZIP code of the vendor. Country: type: - string - 'null' description: Country of the vendor. Mcc: type: - string - 'null' description: Merchant Category Code. LocationCode: type: - string - 'null' description: Location code for the vendor. Contacts: type: - array - 'null' items: $ref: '#/components/schemas/type_:ContactsResponse' description: List of contacts for the vendor. BillingData: oneOf: - $ref: >- #/components/schemas/type___queryTypes__:TransferOutDetailVendorBillingData - type: 'null' description: Billing data for the vendor. PaymentMethod: type: - string - 'null' description: Preferred payment method. VendorStatus: type: - integer - 'null' description: Status of the vendor. VendorId: type: - integer - 'null' description: Unique identifier for the vendor. EnrollmentStatus: type: - integer - 'null' description: Enrollment status of the vendor. Summary: type: - string - 'null' description: Summary information about the vendor. PaypointLegalname: type: - string - 'null' description: Legal name of the paypoint. PaypointId: type: - integer - 'null' description: ID of the paypoint. PaypointDbaname: type: - string - 'null' description: DBA name of the paypoint. PaypointEntryname: type: - string - 'null' description: Entry name of the paypoint. ParentOrgName: type: - string - 'null' description: Name of the parent organization. ParentOrgId: type: - integer - 'null' description: ID of the parent organization. CreatedDate: type: - string - 'null' description: Date the vendor was created. LastUpdated: type: - string - 'null' description: Date the vendor was last updated. remitAddress1: type: - string - 'null' description: Primary remittance address line. remitAddress2: type: - string - 'null' description: Secondary remittance address line. remitCity: type: - string - 'null' description: Remittance city. remitState: type: - string - 'null' description: Remittance state. remitZip: type: - string - 'null' description: Remittance ZIP code. remitCountry: type: - string - 'null' description: Remittance country. payeeName1: type: - string - 'null' description: Primary payee name. payeeName2: type: - string - 'null' description: Secondary payee name. customField1: type: - string - 'null' description: Custom field 1. customField2: type: - string - 'null' description: Custom field 2. customerVendorAccount: type: - string - 'null' description: Customer vendor account number. InternalReferenceId: type: - integer - 'null' description: Internal reference ID. additionalData: type: - object - 'null' additionalProperties: description: Any type description: Additional data for the vendor. externalPaypointID: type: - string - 'null' description: External paypoint ID. StoredMethods: type: - array - 'null' items: description: Any type description: Stored payment methods for the vendor. required: - VendorNumber - Name1 - Name2 - EIN - Phone - Email - RemitEmail - Address1 - Address2 - City - State - Zip - Country - Mcc - LocationCode - Contacts - BillingData - PaymentMethod - VendorStatus - VendorId - EnrollmentStatus - Summary - PaypointLegalname - PaypointId - PaypointDbaname - PaypointEntryname - ParentOrgName - ParentOrgId - CreatedDate - LastUpdated - remitAddress1 - remitAddress2 - remitCity - remitState - remitZip - remitCountry - payeeName1 - payeeName2 - customField1 - customField2 - customerVendorAccount - InternalReferenceId - additionalData - externalPaypointID - StoredMethods type___queryTypes__:TransferOutDetailCheckData: type: object properties: CheckNumber: type: - string - 'null' description: The check number. CheckData: type: - string - 'null' description: Additional check data. required: - CheckNumber - CheckData type___queryTypes__:TransferOutDetailPaymentData: type: object properties: MaskedAccount: type: - string - 'null' description: Masked account number. AccountType: type: - string - 'null' description: Type of account. AccountExp: type: - string - 'null' description: Account expiration date. AccountZip: type: - string - 'null' description: ZIP code associated with the account. HolderName: type: - string - 'null' description: Name of the account holder. StoredId: type: - string - 'null' description: ID of the stored payment method. Initiator: type: - string - 'null' description: Initiator of the payment. StoredMethodUsageType: type: - string - 'null' description: Usage type for stored method. Sequence: type: - string - 'null' description: Sequence number. orderDescription: type: - string - 'null' description: Description of the order. cloudSignatureData: type: - string - 'null' description: Cloud signature data. cloudSignatureFormat: type: - string - 'null' description: Format of cloud signature. paymentDetails: oneOf: - description: Any type - type: 'null' description: Additional payment details. payorData: type: - string - 'null' description: Data about the payor. accountId: type: - string - 'null' description: Account ID. bankAccount: type: - string - 'null' description: Bank account information. gatewayConnector: type: - string - 'null' description: Gateway connector used. binData: oneOf: - description: Any type - type: 'null' description: BIN data for the card. required: - MaskedAccount - AccountType - AccountExp - AccountZip - HolderName - StoredId - Initiator - StoredMethodUsageType - Sequence - orderDescription - cloudSignatureData - cloudSignatureFormat - paymentDetails - payorData - accountId - bankAccount - gatewayConnector - binData type___queryTypes__:TransferOutDetailBillAttachment: type: object properties: ftype: type: - string - 'null' description: File type. filename: type: - string - 'null' description: File name. fileDescriptor: type: - string - 'null' description: File descriptor. furl: type: - string - 'null' description: File URL. fContent: type: - string - 'null' description: File content. required: - ftype - filename - fileDescriptor - furl - fContent type___queryTypes__:TransferOutDetailBill: type: object properties: billId: type: - integer - 'null' description: Unique identifier for the bill. LotNumber: type: - string - 'null' description: Lot number. AccountingField1: type: - string - 'null' description: Accounting field 1. AccountingField2: type: - string - 'null' description: Accounting field 2. Terms: type: - string - 'null' description: Payment terms. AdditionalData: type: - object - 'null' additionalProperties: description: Any type description: Additional data for the bill. attachments: type: - array - 'null' items: $ref: >- #/components/schemas/type___queryTypes__:TransferOutDetailBillAttachment description: Attachments for the bill. invoiceNumber: type: - string - 'null' description: Invoice number. netAmount: type: - string - 'null' description: Net amount of the bill. invoiceDate: type: - string - 'null' description: Date of the invoice. dueDate: type: - string - 'null' description: Due date for the bill. comments: type: - string - 'null' description: Comments on the bill. identifier: type: - string - 'null' description: Identifier for the bill. discount: type: - number - 'null' format: double description: Discount applied. totalAmount: type: - number - 'null' format: double description: Total amount of the bill. required: - billId - LotNumber - AccountingField1 - AccountingField2 - Terms - AdditionalData - attachments - invoiceNumber - netAmount - invoiceDate - dueDate - comments - identifier - discount - totalAmount type___queryTypes__:TransferOutDetailEvent: type: object properties: TransEvent: type: - string - 'null' description: Description of the transaction event. EventData: type: - string - 'null' description: Additional event data. EventTime: type: - string - 'null' description: Time the event occurred. required: - TransEvent - EventData - EventTime type___queryTypes__:TransferOutDetailRecord: type: object properties: transferDetailId: type: - integer - 'null' description: Unique identifier for the transfer detail. 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. idOut: type: - integer - 'null' description: The outbound transaction ID. IdOut: type: - integer - 'null' description: The outbound transaction ID (alternate casing). method: type: - string - 'null' description: Payment method used. type: type: - string - 'null' description: The transaction type (credit or debit). category: type: - string - 'null' description: Category of the transaction detail. grossAmount: type: - number - 'null' format: double description: The gross amount of the transaction. returnedAmount: type: - number - 'null' format: double description: Amount returned. refundAmount: type: - number - 'null' format: double description: Amount refunded. holdAmount: type: - number - 'null' format: double description: Amount being held. releasedAmount: type: - number - 'null' format: double description: Amount released. billingFeesAmount: type: - number - 'null' format: double description: Billing fees amount. adjustmentsAmount: type: - number - 'null' format: double description: Adjustments amount. netTransferAmount: type: - number - 'null' format: double description: Net transfer amount after deductions. billingFeesDetails: type: - array - 'null' items: $ref: '#/components/schemas/type_:BillingFeeDetail' description: Detailed breakdown of billing fees. CreatedAt: type: - string - 'null' description: Date and time the record was created. Comments: type: - string - 'null' description: Comments on the transfer detail. Vendor: oneOf: - $ref: '#/components/schemas/type___queryTypes__:TransferOutDetailVendor' - type: 'null' description: Vendor information. PaypointDbaname: type: - string - 'null' description: DBA name of the paypoint. PaypointLegalname: type: - string - 'null' description: Legal name of the paypoint. PaypointId: type: - integer - 'null' description: ID of the paypoint. Status: type: - integer - 'null' description: Status of the transfer detail. PaymentId: type: - string - 'null' description: Payment ID. TransId: type: - string - 'null' description: Transaction ID. TransStatus: type: - integer - 'null' description: Transaction status. TransStatusDetail: type: - string - 'null' description: Detailed transaction status. TransStatusName: type: - string - 'null' description: Name of the transaction status. TransStatusCategory: type: - string - 'null' description: Category of the transaction status. LastUpdated: type: - string - 'null' description: Date and time the record was last updated. TotalAmount: type: - number - 'null' format: double description: Total amount of the transaction. NetAmount: type: - number - 'null' format: double description: Net amount of the transaction. FeeAmount: type: - number - 'null' format: double description: Fee amount for the transaction. Source: type: - string - 'null' description: Source of the transaction. ParentOrgName: type: - string - 'null' description: Name of the parent organization. ParentOrgId: type: - integer - 'null' description: ID of the parent organization. BatchNumber: type: - string - 'null' description: Batch number for the transfer. PaymentStatus: type: - string - 'null' description: Status of the payment. PaymentMethod: type: - string - 'null' description: Payment method used. CardToken: type: - string - 'null' description: Token for the card used. CheckNumber: type: - string - 'null' description: Check number if paid by check. CheckData: oneOf: - $ref: >- #/components/schemas/type___queryTypes__:TransferOutDetailCheckData - type: 'null' description: Check data if paid by check. PaymentData: oneOf: - $ref: >- #/components/schemas/type___queryTypes__:TransferOutDetailPaymentData - type: 'null' description: Payment data for the transaction. Bills: type: - array - 'null' items: $ref: '#/components/schemas/type___queryTypes__:TransferOutDetailBill' description: Bills associated with the transfer. Events: type: - array - 'null' items: $ref: '#/components/schemas/type___queryTypes__:TransferOutDetailEvent' description: Events associated with the transfer. externalPaypointID: type: - string - 'null' description: External paypoint ID. EntryName: type: - string - 'null' description: Entry name for the paypoint. Gateway: type: - string - 'null' description: Gateway used for the transaction. BatchId: type: - integer - 'null' description: ID of the batch. HasVcardTransactions: type: - boolean - 'null' description: Whether the transfer has virtual card transactions. IsSameDayACH: type: - boolean - 'null' description: Whether this is a same-day ACH transaction. ScheduleId: type: - integer - 'null' description: ID of the schedule if applicable. SettlementStatus: type: - string - 'null' description: Settlement status. SettlementStatusName: type: - string - 'null' description: Name of the settlement status. SettlementDate: type: - string - 'null' description: Date of settlement. RiskFlagged: type: - boolean - 'null' description: Whether the transaction was flagged for risk. RiskFlaggedOn: type: - string - 'null' description: Date and time the transaction was flagged. RiskStatus: type: - string - 'null' description: Risk status of the transaction. RiskReason: type: - string - 'null' description: Reason for the risk flag. RiskAction: type: - string - 'null' description: Action taken for risk. RiskActionCode: type: - integer - 'null' description: Code for the risk action. PayoutProgram: type: - string - 'null' description: Payout program used. AchTraceNumber: type: - string - 'null' description: ACH trace number. required: - transferDetailId - transferId - transactionId - idOut - IdOut - method - type - category - grossAmount - returnedAmount - refundAmount - holdAmount - releasedAmount - billingFeesAmount - adjustmentsAmount - netTransferAmount - billingFeesDetails - CreatedAt - Comments - Vendor - PaypointDbaname - PaypointLegalname - PaypointId - Status - PaymentId - TransId - TransStatus - TransStatusDetail - TransStatusName - TransStatusCategory - LastUpdated - TotalAmount - NetAmount - FeeAmount - Source - ParentOrgName - ParentOrgId - BatchNumber - PaymentStatus - PaymentMethod - CardToken - CheckNumber - CheckData - PaymentData - Bills - Events - externalPaypointID - EntryName - Gateway - BatchId - HasVcardTransactions - IsSameDayACH - ScheduleId - SettlementStatus - SettlementStatusName - SettlementDate - RiskFlagged - RiskFlaggedOn - RiskStatus - RiskReason - RiskAction - RiskActionCode - PayoutProgram - AchTraceNumber type___queryTypes__:TransferOutDetailQueryResponse: type: object properties: Summary: $ref: '#/components/schemas/type___queryTypes__:QueryTransferSummary' description: Summary information about the transfer details. Records: type: array items: $ref: '#/components/schemas/type___queryTypes__:TransferOutDetailRecord' description: List of outbound transfer detail records. required: - Summary - Records ``` ## SDK Code Examples ```python ListTransferDetailsOutExample import requests url = "https://api-sandbox.payabli.com/api/Query/transferDetailsOut/47ace2b25/4521" querystring = {"fromRecord":"0","limitRecord":"20"} response = requests.get(url, params=querystring) print(response.json()) ``` ```javascript ListTransferDetailsOutExample const url = 'https://api-sandbox.payabli.com/api/Query/transferDetailsOut/47ace2b25/4521?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 ListTransferDetailsOutExample package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Query/transferDetailsOut/47ace2b25/4521?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 ListTransferDetailsOutExample require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Query/transferDetailsOut/47ace2b25/4521?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 ListTransferDetailsOutExample HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/transferDetailsOut/47ace2b25/4521?fromRecord=0&limitRecord=20") .asString(); ``` ```php ListTransferDetailsOutExample request('GET', 'https://api-sandbox.payabli.com/api/Query/transferDetailsOut/47ace2b25/4521?fromRecord=0&limitRecord=20'); echo $response->getBody(); ``` ```csharp ListTransferDetailsOutExample var client = new RestClient("https://api-sandbox.payabli.com/api/Query/transferDetailsOut/47ace2b25/4521?fromRecord=0&limitRecord=20"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift ListTransferDetailsOutExample import Foundation let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/transferDetailsOut/47ace2b25/4521?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() ```