Get Details for Payout Transaction

Intro

API Basics

Pay In Endpoints

MoneyIn
Subscription
TokenStorage
Invoice
LineItem
PaymentLink
PaymentMethodDomain
HostedPaymentPages
Cloud
Wallet: Apple Pay

Pay Out Endpoints

Pay Ops Endpoints

Templates
Boarding
Chargebacks and ACH Returns
Entities
Notification
Query
Statistic
Export
Import

Object Models

Object Model References

GET

MoneyOut

details

{transId}

{
  "IdOut": 350,
  "CreatedAt": "2023-04-24T09:17:49.063",
  "Comments": "testing",
  "Vendor": {
    "VendorNumber": "54321",
    "Name1": "Paul's",
    "Name2": "Supplies",
    "EIN": "123456789",
    "Phone": 9706188888,
    "Email": "paul@payabli.com",
    "Address1": "5724 Walnut Street",
    "Address2": "",
    "City": "Lakeland",
    "State": "FL",
    "Zip": "33809",
    "Country": "US",
    "Mcc": "",
    "LocationCode": null,
    "Contacts": null,
    "BillingData": {
      "id": null,
      "bankName": "Chase",
      "routingAccount": "02100XXX",
      "accountNumber": "3XXXXXX8888",
      "typeAccount": "Checking",
      "bankAccountHolderName": null,
      "bankAccountHolderType": null,
      "bankAccountFunction": 0
    },
    "PaymentMethod": "",
    "VendorStatus": 1,
    "VendorId": 89,
    "EnrollmentStatus": null,
    "Summary": null,
    "PaypointLegalname": null,
    "PaypointDbaname": null,
    "PaypointEntryname": null,
    "ParentOrgName": null,
    "CreatedDate": "2023-03-13T16:36:20",
    "LastUpdated": "2023-03-29T21:51:49",
    "remitAddress1": "",
    "remitAddress2": "",
    "remitCity": "",
    "remitState": "",
    "remitZip": "",
    "remitCountry": "",
    "payeeName1": null,
    "payeeName2": null,
    "customField1": "",
    "customField2": "",
    "customerVendorAccount": "",
    "InternalReferenceId": 3,
    "additionalData": null,
    "externalPaypointID": null
  },
  "PaypointDbaname": "The Board Haus",
  "PaypointLegalname": "Board Haus LLC.",
  "Status": 11,
  "Gateway": "TSYS",
  "StatusText": "Captured",
  "LastUpdated": "2023-04-23T17:00:00",
  "TotalAmount": 8800,
  "NetAmount": 8800,
  "FeeAmount": 0,
  "Source": "api",
  "ParentOrgName": "PayabliDemoAccount(PB)",
  "BatchNumber": null,
  "PaymentStatus": "Authorized",
  "PaymentMethod": "managed",
  "CardToken": null,
  "CheckNumber": null,
  "CheckData": null,
  "PaymentId": "187-350",
  "PaymentData": {
    "MaskedAccount": "",
    "AccountType": "",
    "AccountExp": null,
    "AccountZip": null,
    "HolderName": "",
    "StoredId": null,
    "orderDescription": null,
    "cloudSignatureData": null,
    "cloudSignatureFormat": null,
    "paymentDetails": null,
    "payorData": null,
    "accountId": null,
    "bankAccount": null,
    "gatewayConnector": {
      "configuration": null,
      "Name": "repay",
      "Descriptor": null,
      "Mode": 2,
      "gatewayID": 391,
      "Enabled": true
    }
  },
  "Bills": [
    {
      "billId": null,
      "LotNumber": null,
      "AccountingField1": null,
      "AccountingField2": null,
      "Terms": null,
      "AdditionalData": null,
      "invoiceNumber": null,
      "netAmount": "8800.00",
      "invoiceDate": null,
      "dueDate": null,
      "comments": null
    }
  ],
  "Events": [
    {
      "TransEvent": "Authorized",
      "EventData": null,
      "EventTime": "2023-04-24T09:17:49.073"
    }
  ],
  "externalPaypointID": ""
}

Authorizations

requestToken

string

header

required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

transId

string

required

ReferenceId for the transaction (PaymentId).

Response

200 - application/json

Bills

object[] | null

Events associated to this transaction.

Bills.AccountingField1

string | null

Optional custom field.

Bills.AccountingField2

string | null

Optional custom field.

Bills.AdditionalData

string | null

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

Bills.attachments

object[] | null

Bill image attachment. Send the bill image as Base64-encoded string, or as a publicly-accessible link. For full details on using this field with a payout authorization, see the documentation.

Bills.billId

integer | null

Bill ID in Payabli.

Bills.comments

string | null

Any comments about bill. For managed payouts, this field has a limit of 100 characters.

Maximum length: 250

Bills.dueDate

string | null

Bill due date in format YYYY-MM-DD or MM/DD/YYYY.

Bills.invoiceDate

string | null

Bill date in format YYYY-MM-DD or MM/DD/YYYY.

Bills.invoiceNumber

string | null

Custom number identifying the bill. Must be unique in paypoint. Required for new bill and when billId is not provided.

Maximum length: 250

Bills.netAmount

string | null

Net Amount owed in bill. Required when adding a bill.

Bills.Terms

string | null

Description of payment terms.

CheckData

object | null

Object referencing to paper check image.

CheckNumber

string | null

Paper check number related to payout transaction.

Comments

string | null

Any comment or description for payout transaction.

Maximum length: 250

CreatedDate

string

Timestamp when the payment was created, in UTC.

Events

object[] | null

Events associated to this transaction.

FeeAmount

number

Service fee or sub-charge applied.

Gateway

string | null

Gateway used to process the transaction.

IdOut

integer

Identifier of payout transaction.

LastUpdated

string | null

Timestamp when payment record was updated, in UTC.

NetAmount

number | null

Net amount.

parentOrgName

string | null

The name of the parent organization.

PaymentData

object

PaymentData.AccountExp

string | null

Expiration date of card used in transaction.

PaymentData.accountId

string | null

Custom identifier for payment connector.

Maximum length: 250

PaymentData.AccountType

string | null

Bank account type or card brand.

PaymentData.AccountZip

string | null

ZIP code for card used in transaction.

PaymentData.binData

object

Object containing information related to the card. This object is null unless the payment method is card. If the payment method is Apple Pay, the binData will be related to the DPAN (device primary account number), not the card connected to Apple Pay.

PaymentData.HolderName

string | null

Account holder name for the method.

PaymentData.Initiator

string | null

default:

merchant

Strongly recommended The cardholder-initiated transaction (CIT) or merchant-initiated transaction (MIT) indicator for the transaction. If you don't specify a value, Payabli defaults to merchant.

Available values:

payor: For cardholder-initiated transactions
merchant: For merchant-initiated transactions

See Understanding CIT and MIT Indicators for more information.

PaymentData.MaskedAccount

string | null

Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).

PaymentData.orderDescription

string | null

Text description of the transaction.

Maximum length: 250

PaymentData.paymentDetails

object

Details about the payment.

PaymentData.paymentDetails.totalAmount

number

required

Total amount to be charged. If a service fee is sent, then this amount should include the service fee."

PaymentData.paymentDetails.categories

object[] | null

Array of payment categories/line items describing the amount to be paid Note: These categories are for information only and are not validated against the total amount provided.

PaymentData.paymentDetails.checkImage

object | null

Object containing image of paper check.

PaymentData.paymentDetails.checkNumber

string | null

A check number to be used in the ach transaction. Required for payment method = 'check'.

PaymentData.paymentDetails.currency

string | null

Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.

PaymentData.paymentDetails.serviceFee

number | null

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.

PaymentData.paymentDetails.splitFunding

object[] | null

Split funding instructions for the transaction. See Split a Transaction for more.

PaymentData.Sequence

string | null

The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected and populated by Payabli.

Available values:

first: The first use of the payment method. This is almost always a cardholder-initiated transaction.
subsequent: For merchant-initiated transactions after the first use of the payment method.

See Understanding CIT and MIT Indicators for more information.

PaymentData.SignatureData

string | null

PaymentData.StoredId

string | null

Identifier of stored payment method used in transaction.

PaymentData.StoredMethodUsageType

string | null

default:

unscheduled

Strongly recommended The usage type for the stored method, used for merchant-initiated transactions (MIT). If you don't specify a value, Payabli defaults to unscheduled.

Available values:

unscheduled: This type is used for transactions that are one-time or otherwise not pre-scheduled.
subscription: This type is used for subscription payments. For example, monthly rental fees or ongoing service subscriptions.
recurring: This type is used for recurring payments that occur per a set plan. For example, splitting an HOA special assessment over 6 monthly payments.

See Understanding CIT and MIT Indicators for more information.

PaymentGroup

string | null

Unique identifier for group or batch containing the transaction.

PaymentId

string | null

Unique transaction ID.

PaymentMethod

string | null

Method of payment applied to the transaction.

PaymentStatus

string | null

Status of payout transaction.

paypointDbaname

string | null

The alternate or common name that this business is doing business under usually referred to as a DBA name.

paypointLegalname

string | null

Paypoint legal name.

Source

string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100

Status

integer

Internal status of transaction.

StatusText

string | null

Status of payout transaction.

TotalAmount

number

Transaction total amount (including service fee or sub-charge).

Vendor

object

Vendor related to the payout transaction.

Vendor.additionalData

object

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

Vendor.address1

string | null

Vendor's address.

Vendor.address2

string | null

Additional line for vendor's address.

Vendor.billingData

object

Vendor.city

string | null

Vendor's city.

Vendor.contacts

object[] | null

List of contacts.

Vendor.country

string | null

Vendor's country.

Vendor.createdDate

string

Timestamp of when record was created, in UTC.

Vendor.customerVendorAccount

string | null

Account number of paypoint in the vendor system.

Vendor.ein

string | null

Business EIN or tax ID.

Vendor.email

string | null

Vendor's email address.

Vendor.enrollmentStatus

string | null

Enrollment status of vendor in payables program.

Vendor.externalPaypointId

string | null

A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.

Vendor.internalReferenceId

integer | null

Internal identifier for global vendor account.

Vendor.lastUpdated

string | null

Timestamp of when record was last updated, in UTC.

Vendor.locationCode

string | null

Additional location code used to identify the vendor.

Vendor.mcc

string | null

Business Merchant Category Code (MCC). This resource lists MCC codes.

Vendor.name1

string | null

Primary name for vendor.

Vendor.name2

string | null

Secondary name for vendor.

Vendor.parentOrgName

string | null

The name of the parent organization.

Vendor.payeeName1

string | null

Alternative name used to receive paper check.

Vendor.payeeName2

string | null

Alternative name used to receive paper check.

Vendor.paymentMethod

object

Object containing details about the payment method to use for the payout.

Vendor.paypointDbaname

string | null

The alternate or common name that this business is doing business under usually referred to as a DBA name.

Vendor.paypointEntryname

string | null

The entrypoint identifier.

Maximum length: 50

Vendor.paypointLegalname

string | null

Business legal name.

Vendor.phone

string | null

Vendor's phone number.

Vendor.remitAddress1

string | null

Remittance address. Used for mailing paper checks.

Vendor.remitAddress2

string | null

Remittance address additional line. Used for mailing paper checks.

Vendor.remitCity

string | null

Remittance address city. Used for mailing paper checks.

Vendor.remitCountry

string | null

Remittance address country. Used for mailing paper checks.

Vendor.remitState

string | null

Remittance address state. Used for mailing paper checks.

Vendor.remitZip

string | null

Remittance address ZIP code. Used for mailing paper checks.

Vendor.state

string | null

Vendor's state.

Vendor.summary

object

Vendor.vendorId

integer | null

Payabli identifier for vendor record.

Vendor.vendorNumber

string | null

Custom number identifying the vendor. Must be unique in paypoint.

Vendor.vendorStatus

integer | null

Vendor's status. Allowed status:

0 Inactive
1 Active

Vendor.zip

string | null

Vendor's zip code.

Was this page helpful?

Cancel Payout Get vCard Details

{
  "IdOut": 350,
  "CreatedAt": "2023-04-24T09:17:49.063",
  "Comments": "testing",
  "Vendor": {
    "VendorNumber": "54321",
    "Name1": "Paul's",
    "Name2": "Supplies",
    "EIN": "123456789",
    "Phone": 9706188888,
    "Email": "paul@payabli.com",
    "Address1": "5724 Walnut Street",
    "Address2": "",
    "City": "Lakeland",
    "State": "FL",
    "Zip": "33809",
    "Country": "US",
    "Mcc": "",
    "LocationCode": null,
    "Contacts": null,
    "BillingData": {
      "id": null,
      "bankName": "Chase",
      "routingAccount": "02100XXX",
      "accountNumber": "3XXXXXX8888",
      "typeAccount": "Checking",
      "bankAccountHolderName": null,
      "bankAccountHolderType": null,
      "bankAccountFunction": 0
    },
    "PaymentMethod": "",
    "VendorStatus": 1,
    "VendorId": 89,
    "EnrollmentStatus": null,
    "Summary": null,
    "PaypointLegalname": null,
    "PaypointDbaname": null,
    "PaypointEntryname": null,
    "ParentOrgName": null,
    "CreatedDate": "2023-03-13T16:36:20",
    "LastUpdated": "2023-03-29T21:51:49",
    "remitAddress1": "",
    "remitAddress2": "",
    "remitCity": "",
    "remitState": "",
    "remitZip": "",
    "remitCountry": "",
    "payeeName1": null,
    "payeeName2": null,
    "customField1": "",
    "customField2": "",
    "customerVendorAccount": "",
    "InternalReferenceId": 3,
    "additionalData": null,
    "externalPaypointID": null
  },
  "PaypointDbaname": "The Board Haus",
  "PaypointLegalname": "Board Haus LLC.",
  "Status": 11,
  "Gateway": "TSYS",
  "StatusText": "Captured",
  "LastUpdated": "2023-04-23T17:00:00",
  "TotalAmount": 8800,
  "NetAmount": 8800,
  "FeeAmount": 0,
  "Source": "api",
  "ParentOrgName": "PayabliDemoAccount(PB)",
  "BatchNumber": null,
  "PaymentStatus": "Authorized",
  "PaymentMethod": "managed",
  "CardToken": null,
  "CheckNumber": null,
  "CheckData": null,
  "PaymentId": "187-350",
  "PaymentData": {
    "MaskedAccount": "",
    "AccountType": "",
    "AccountExp": null,
    "AccountZip": null,
    "HolderName": "",
    "StoredId": null,
    "orderDescription": null,
    "cloudSignatureData": null,
    "cloudSignatureFormat": null,
    "paymentDetails": null,
    "payorData": null,
    "accountId": null,
    "bankAccount": null,
    "gatewayConnector": {
      "configuration": null,
      "Name": "repay",
      "Descriptor": null,
      "Mode": 2,
      "gatewayID": 391,
      "Enabled": true
    }
  },
  "Bills": [
    {
      "billId": null,
      "LotNumber": null,
      "AccountingField1": null,
      "AccountingField2": null,
      "Terms": null,
      "AdditionalData": null,
      "invoiceNumber": null,
      "netAmount": "8800.00",
      "invoiceDate": null,
      "dueDate": null,
      "comments": null
    }
  ],
  "Events": [
    {
      "TransEvent": "Authorized",
      "EventData": null,
      "EventTime": "2023-04-24T09:17:49.073"
    }
  ],
  "externalPaypointID": ""
}