# Get payout details GET https://api-sandbox.payabli.com/api/MoneyOut/details/{transId} Returns details for a processed money out transaction. Reference: https://docs.payabli.com/developers/api-reference/moneyout/get-details-for-a-processed-payout-transaction ## OpenAPI Specification ```yaml openapi: 3.1.1 info: title: Get details for a processed payout transaction version: endpoint_moneyOut.PayoutDetails paths: /MoneyOut/details/{transId}: get: operationId: payout-details summary: Get details for a processed payout transaction description: Returns details for a processed money out transaction. tags: - - subpackage_moneyOut parameters: - name: transId in: path description: ReferenceId for the transaction (PaymentId). required: true schema: type: string - name: requestToken in: header required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/type_:BillDetailResponse' '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_:BillId: type: integer format: int64 type_:InvoiceNumber: type: string type_:NetAmountstring: type: string type_:Datenullable: type: string format: date type_:Comments: type: string type_:BillDetailsResponse: type: object properties: billId: $ref: '#/components/schemas/type_:BillId' lotNumber: type: string description: Lot number of the bill. invoiceNumber: $ref: '#/components/schemas/type_:InvoiceNumber' description: Custom number identifying the bill. netAmount: $ref: '#/components/schemas/type_:NetAmountstring' description: Net Amount owed in bill. Required when adding a bill. discount: type: string description: Bill discount amount. dueDate: $ref: '#/components/schemas/type_:Datenullable' description: Bill due date in format YYYY-MM-DD or MM/DD/YYYY. invoiceDate: $ref: '#/components/schemas/type_:Datenullable' description: Bill date in format YYYY-MM-DD or MM/DD/YYYY. comments: $ref: '#/components/schemas/type_:Comments' description: >- Any comments about bill. **For managed payouts, this field has a limit of 100 characters**. 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_:CreatedAt: type: string format: date-time 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_:FeeAmount: type: number format: double type_:Gatewayfield: type: string type_:LastModified: type: string format: date-time type_:Netamountnullable: type: number format: double type_:OrgParentName: type: string type_:OrgParentId: 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_:PaymentIdString: type: string type_:Dbaname: type: string type_:Legalname: type: string type_:Source: type: string type_:AdditionalData: type: object additionalProperties: type: object additionalProperties: description: Any type type_:AddressNullable: type: string type_:AddressAddtlNullable: type: string type_:BankName: type: string type_:RoutingAccount: type: string type_:AccountNumber: type: string type_:TypeAccount: type: string enum: - value: Checking - value: Savings type_:BankAccountHolderName: type: string type_:BankAccountHolderType: type: string enum: - value: Personal - value: Business type_:BillingDataResponse: type: object properties: id: type: integer description: The bank's ID in Payabli. accountId: description: Any type nickname: type: string bankName: $ref: '#/components/schemas/type_:BankName' routingAccount: $ref: '#/components/schemas/type_:RoutingAccount' accountNumber: $ref: '#/components/schemas/type_:AccountNumber' typeAccount: $ref: '#/components/schemas/type_:TypeAccount' bankAccountHolderName: $ref: '#/components/schemas/type_:BankAccountHolderName' bankAccountHolderType: $ref: '#/components/schemas/type_:BankAccountHolderType' bankAccountFunction: type: integer description: >- Describes whether the bank account is used for deposits or withdrawals in Payabli: - `0`: Deposit - `1`: Withdrawal - `2`: Deposit and withdrawal verified: type: boolean status: type: integer services: type: array items: description: Any type default: type: boolean required: - id - nickname - bankName - routingAccount - accountNumber - typeAccount - bankAccountHolderName - bankAccountHolderType - bankAccountFunction - verified - status - services - default type_:CityNullable: 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_:Ein: type: string type_:EnrollmentStatus: type: string type_:ExternalPaypointId: type: string type_:InternalReferenceId: type: integer format: int64 type_:Mcc: type: string type_:PayeeName: type: string type_:VendorPaymentMethodString: type: string type_:Entrypointfield: type: string type_:Remitaddress1: type: string type_:Remitaddress2: type: string type_:Remitcity: type: string type_:Remitcountry: type: string type_:RemitEmail: type: string format: email type_:Remitstate: type: string type_:Remitzip: type: string type_:StateNullable: type: string type_:VendorResponseStoredMethod: type: object properties: IdPmethod: type: - string - 'null' Method: type: - string - 'null' Descriptor: type: - string - 'null' MaskedAccount: type: - string - 'null' ExpDate: type: - string - 'null' HolderName: type: - string - 'null' AchSecCode: type: - string - 'null' AchHolderType: type: - string - 'null' IsValidatedACH: type: - boolean - 'null' BIN: type: - string - 'null' binData: type: - string - 'null' ABA: type: - string - 'null' PostalCode: type: - string - 'null' MethodType: type: - string - 'null' LastUpdated: type: - string - 'null' format: date-time CardUpdatedOn: type: - string - 'null' format: date-time required: - IdPmethod - Method - Descriptor - MaskedAccount - ExpDate - HolderName - AchSecCode - AchHolderType - IsValidatedACH - BIN - binData - ABA - PostalCode - MethodType - LastUpdated - CardUpdatedOn type_:VendorSummary: type: object properties: ActiveBills: type: integer PendingBills: type: integer InTransitBills: type: integer PaidBills: type: integer OverdueBills: type: integer ApprovedBills: type: integer DisapprovedBills: type: integer TotalBills: type: integer ActiveBillsAmount: type: number format: double PendingBillsAmount: type: number format: double InTransitBillsAmount: type: number format: double PaidBillsAmount: type: number format: double OverdueBillsAmount: type: number format: double ApprovedBillsAmount: type: number format: double DisapprovedBillsAmount: type: number format: double TotalBillsAmount: type: number format: double type_:Vendorid: type: integer type_:VendorNumber: type: string type_:Vendorstatus: type: integer type_:Zip: type: string type_:VendorQueryRecord: type: object properties: additionalData: $ref: '#/components/schemas/type_:AdditionalData' Address1: $ref: '#/components/schemas/type_:AddressNullable' Address2: $ref: '#/components/schemas/type_:AddressAddtlNullable' BillingData: $ref: '#/components/schemas/type_:BillingDataResponse' City: $ref: '#/components/schemas/type_:CityNullable' Contacts: $ref: '#/components/schemas/type_:ContactsResponse' Country: type: string CreatedDate: $ref: '#/components/schemas/type_:CreatedAt' customerVendorAccount: type: string customField1: type: string customField2: type: string EIN: $ref: '#/components/schemas/type_:Ein' Email: $ref: '#/components/schemas/type_:Email' EnrollmentStatus: $ref: '#/components/schemas/type_:EnrollmentStatus' externalPaypointID: $ref: '#/components/schemas/type_:ExternalPaypointId' InternalReferenceId: $ref: '#/components/schemas/type_:InternalReferenceId' LastUpdated: $ref: '#/components/schemas/type_:LastModified' LocationCode: type: string Mcc: $ref: '#/components/schemas/type_:Mcc' Name1: type: string Name2: type: string ParentOrgName: $ref: '#/components/schemas/type_:OrgParentName' ParentOrgId: $ref: '#/components/schemas/type_:OrgParentId' payeeName1: $ref: '#/components/schemas/type_:PayeeName' payeeName2: $ref: '#/components/schemas/type_:PayeeName' PaymentMethod: $ref: '#/components/schemas/type_:VendorPaymentMethodString' PaypointDbaname: $ref: '#/components/schemas/type_:Dbaname' PaypointEntryname: $ref: '#/components/schemas/type_:Entrypointfield' PaypointLegalname: $ref: '#/components/schemas/type_:Legalname' Phone: type: string remitAddress1: $ref: '#/components/schemas/type_:Remitaddress1' remitAddress2: $ref: '#/components/schemas/type_:Remitaddress2' remitCity: $ref: '#/components/schemas/type_:Remitcity' remitCountry: $ref: '#/components/schemas/type_:Remitcountry' RemitEmail: $ref: '#/components/schemas/type_:RemitEmail' remitState: $ref: '#/components/schemas/type_:Remitstate' remitZip: $ref: '#/components/schemas/type_:Remitzip' State: $ref: '#/components/schemas/type_:StateNullable' StoredMethods: type: array items: $ref: '#/components/schemas/type_:VendorResponseStoredMethod' Summary: $ref: '#/components/schemas/type_:VendorSummary' VendorId: $ref: '#/components/schemas/type_:Vendorid' VendorNumber: $ref: '#/components/schemas/type_:VendorNumber' VendorStatus: $ref: '#/components/schemas/type_:Vendorstatus' Zip: $ref: '#/components/schemas/type_:Zip' type_:Entry: type: string type_:HasVcardTransactions: type: boolean type_:IsSameDayACH: type: boolean type_:ScheduleId: type: integer format: int64 type_:SettlementStatus: type: integer 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_:BillDetailResponse: type: object properties: Bills: type: array items: $ref: '#/components/schemas/type_:BillDetailsResponse' description: Events associated to this transaction. CheckData: $ref: '#/components/schemas/type_:FileContent' description: Object referencing to paper check image. CheckNumber: type: string description: Paper check number related to payout transaction. Comments: $ref: '#/components/schemas/type_:Comments' description: Any comment or description for payout transaction. CreatedDate: $ref: '#/components/schemas/type_:CreatedAt' description: Timestamp when the payment was created, in UTC. CreatedAt: $ref: '#/components/schemas/type_:CreatedAt' Events: type: array items: $ref: '#/components/schemas/type_:QueryTransactionEvents' description: Events associated to this transaction. FeeAmount: $ref: '#/components/schemas/type_:FeeAmount' Gateway: $ref: '#/components/schemas/type_:Gatewayfield' IdOut: type: integer format: int64 description: Identifier of payout transaction. LastUpdated: $ref: '#/components/schemas/type_:LastModified' description: Timestamp when payment record was updated, in UTC. NetAmount: $ref: '#/components/schemas/type_:Netamountnullable' ParentOrgName: $ref: '#/components/schemas/type_:OrgParentName' ParentOrgId: $ref: '#/components/schemas/type_:OrgParentId' PaymentData: $ref: '#/components/schemas/type_:QueryPaymentData' PaymentGroup: type: string description: Unique identifier for group or batch containing the transaction. PaymentId: $ref: '#/components/schemas/type_:PaymentIdString' PaymentMethod: type: string description: Method of payment applied to the transaction. PaymentStatus: type: string description: Status of payout transaction. PaypointDbaname: $ref: '#/components/schemas/type_:Dbaname' PaypointLegalname: $ref: '#/components/schemas/type_:Legalname' description: Paypoint legal name. Source: $ref: '#/components/schemas/type_:Source' Status: type: integer description: >- Internal status of transaction. Payout statuses, also known as money out transaction statuses, appear in PartnerHub and PayHub, and the API, and describe where a payout transaction is in its lifecycle. | Status | Key | Description | Events | |--------|-----|-------------|---------| | **Authorized** | 11 | A payout is authorized. These are queued payouts, and nothing happens with them until they're captured. | Authorized | | **Captured** | 1 | A payout is captured and is now part of the batch for payout. | Captured | | **Canceled** | 0 | An authorized payout has been canceled. A captured payout can be canceled before batch close at 5 PM ET. | Cancelled | | **Processing** | 2 | A payout is being processed. | Waiting funds, Funded, Pending (payment type is pending), Generating check | | **Processed** | 3 | A payment method is defined for the vendor, and the payout has been sent to the recipient. | Open (vCard issued, ACH sent, check generated but not yet cashed), Processed (Payment Type is no longer pending), Reissued, Returned, Errored | | **OnHold** | 4 | A payout has been placed on hold and requires review before proceeding. | OnHold | | **Paid** | 5 | A payout has been paid and the recipient has redeemed the funds. | Paid (check cleared, vCard used, ACH settled) | StatusText: type: string description: Status of payout transaction. TotalAmount: type: number format: double description: Transaction total amount (including service fee or sub-charge). Vendor: $ref: '#/components/schemas/type_:VendorQueryRecord' description: Vendor related to the payout transaction. externalPaypointID: $ref: '#/components/schemas/type_:ExternalPaypointId' EntryName: $ref: '#/components/schemas/type_:Entry' BatchId: type: string description: >- Identifier for the batch in which this transaction was processed. Used to track and reconcile batch-level operations. HasVcardTransactions: $ref: '#/components/schemas/type_:HasVcardTransactions' IsSameDayACH: $ref: '#/components/schemas/type_:IsSameDayACH' ScheduleId: $ref: '#/components/schemas/type_:ScheduleId' SettlementStatus: $ref: '#/components/schemas/type_:SettlementStatus' RiskFlagged: $ref: '#/components/schemas/type_:RiskFlagged' RiskFlaggedOn: $ref: '#/components/schemas/type_:RiskFlaggedOn' RiskStatus: $ref: '#/components/schemas/type_:RiskStatus' RiskReason: $ref: '#/components/schemas/type_:RiskReason' RiskAction: $ref: '#/components/schemas/type_:RiskAction' RiskActionCode: $ref: '#/components/schemas/type_:RiskActionCode' ``` ## SDK Code Examples ```python AuthorizedTransaction from payabli import payabli client = payabli( api_key="YOUR_API_KEY", ) client.money_out.payout_details( trans_id="45-as456777hhhhhhhhhh77777777-324", ) ``` ```typescript AuthorizedTransaction import { PayabliClient } from "@payabli/sdk-node"; const client = new PayabliClient({ apiKey: "YOUR_API_KEY" }); await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324"); ``` ```go AuthorizedTransaction import ( context "context" option "github.com/payabli/sdk-go/option" sdkgoclient "github.com/payabli/sdk-go/client" ) client := sdkgoclient.NewClient( option.WithApiKey( "", ), ) response, err := client.MoneyOut.PayoutDetails( context.TODO(), "45-as456777hhhhhhhhhh77777777-324", ) ``` ```csharp AuthorizedTransaction using PayabliApi; var client = new PayabliApiClient("API_KEY"); await client.MoneyOut.PayoutDetailsAsync("45-as456777hhhhhhhhhh77777777-324"); ``` ```ruby AuthorizedTransaction require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/MoneyOut/details/45-as456777hhhhhhhhhh77777777-324") 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 AuthorizedTransaction HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/MoneyOut/details/45-as456777hhhhhhhhhh77777777-324") .header("requestToken", "") .asString(); ``` ```php AuthorizedTransaction request('GET', 'https://api-sandbox.payabli.com/api/MoneyOut/details/45-as456777hhhhhhhhhh77777777-324', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```swift AuthorizedTransaction import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/MoneyOut/details/45-as456777hhhhhhhhhh77777777-324")! 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() ``` ```python AuthorizeAndCapturedTransaction from payabli import payabli client = payabli( api_key="YOUR_API_KEY", ) client.money_out.payout_details( trans_id="45-as456777hhhhhhhhhh77777777-324", ) ``` ```typescript AuthorizeAndCapturedTransaction import { PayabliClient } from "@payabli/sdk-node"; const client = new PayabliClient({ apiKey: "YOUR_API_KEY" }); await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324"); ``` ```go AuthorizeAndCapturedTransaction import ( context "context" option "github.com/payabli/sdk-go/option" sdkgoclient "github.com/payabli/sdk-go/client" ) client := sdkgoclient.NewClient( option.WithApiKey( "", ), ) response, err := client.MoneyOut.PayoutDetails( context.TODO(), "45-as456777hhhhhhhhhh77777777-324", ) ``` ```csharp AuthorizeAndCapturedTransaction using PayabliApi; var client = new PayabliApiClient("API_KEY"); await client.MoneyOut.PayoutDetailsAsync("45-as456777hhhhhhhhhh77777777-324"); ``` ```ruby AuthorizeAndCapturedTransaction require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/MoneyOut/details/45-as456777hhhhhhhhhh77777777-324") 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 AuthorizeAndCapturedTransaction HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/MoneyOut/details/45-as456777hhhhhhhhhh77777777-324") .header("requestToken", "") .asString(); ``` ```php AuthorizeAndCapturedTransaction request('GET', 'https://api-sandbox.payabli.com/api/MoneyOut/details/45-as456777hhhhhhhhhh77777777-324', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```swift AuthorizeAndCapturedTransaction import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/MoneyOut/details/45-as456777hhhhhhhhhh77777777-324")! 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() ```