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 Details for Payout Transaction
Returns details for a processed money out transaction.
{
"IdOut": 350,
"CreatedAt": "2023-04-24T09:17:49.063",
"Comments": "testing",
"Vendor": {
"VendorNumber": "54321",
"Name1": "Paul's",
"Name2": "Supplies",
"EIN": "XXXX6789",
"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
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
ReferenceId for the transaction (PaymentId).
Response
Identifier of payout transaction.
Vendor related to the payout transaction.
Custom number identifying the vendor. Must be unique in paypoint.
Primary name for vendor.
Secondary name for vendor.
Business EIN or tax ID. This value is masked in API responses, for example XXXX6789
.
Vendor's phone number.
Vendor's email address.
Vendor's address.
Additional line for vendor's address.
Vendor's city.
Vendor's state.
Vendor's zip code.
Vendor's country.
Business Merchant Category Code (MCC). This resource lists MCC codes.
Additional location code used to identify the vendor.
The bank's ID in Payabli.
Name of bank for account.
Routing number of bank account.
Masked account number for bank account.
Type of bank account: Checking or Savings.
Checking
, Savings
The accountholder's name.
Describes whether the bank is a personal or business account.
Personal
, Business
Describes whether the bank account is used for deposits or withdrawals in Payabli:
0
: Deposit1
: Withdrawal2
: Deposit and withdrawal
Object containing details about the payment method to use for the payout.
Payment method to use for payout. Leave empty for managed payables.
managed
, vcard
, ach
, check
Vendor's status. Allowed status:
-
0 Inactive
-
1 Active
Payabli identifier for vendor record.
Enrollment status of vendor in payables program.
Business legal name.
The alternate or common name that this business is doing business under usually referred to as a DBA name.
The entrypoint identifier.
50
The name of the parent organization.
Timestamp of when record was created, in UTC.
Timestamp of when record was last updated, in UTC.
Remittance address. Used for mailing paper checks.
Remittance address additional line. Used for mailing paper checks.
Remittance address city. Used for mailing paper checks.
Remittance address state. Used for mailing paper checks.
Remittance address ZIP code. Used for mailing paper checks.
Remittance address country. Used for mailing paper checks.
Alternative name used to receive paper check.
Alternative name used to receive paper check.
Account number of paypoint in the vendor system.
Internal identifier for global vendor account.
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"
}
}
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.
Any comment or description for payout transaction.
250
The name of the parent organization.
The alternate or common name that this business is doing business under usually referred to as a DBA name.
Paypoint legal name.
Transaction total amount (including service fee or sub-charge).
Net amount.
Service fee or sub-charge applied.
Custom identifier to indicate the transaction or request source.
100
Unique transaction ID.
Unique identifier for group or batch containing the transaction.
Internal status of transaction.
Gateway used to process the transaction.
Status of payout transaction.
Status of payout transaction.
Paper check number related to payout transaction.
Object referencing to paper check image.
The MIME type of the file (if content is provided)
pdf
, doc
, docx
, jpg
, jpeg
, png
, gif
, txt
The name of the attached file.
Optional url provided to show or download the file remotely
Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB.
Method of payment applied to the transaction.
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
Bank account type or card brand.
Expiration date of card used in transaction.
ZIP code for card used in transaction.
Account holder name for the method.
Text description of the transaction.
250
Identifier of stored payment method used in transaction.
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 transactionsmerchant
: For merchant-initiated transactions
See Understanding CIT and MIT Indicators for more information.
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.
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.
Custom identifier for payment connector.
250
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.
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.
The card brand. For example, Visa, MasterCard, American Express, Discover.
The type of card: Credit or Debit.
The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked PREPAID
.
The name of the financial institution that issued the card.
The issuing financial institution's country name.
The issuing financial institution's two-character ISO country code. See this resource for a list of codes.
The issuing financial institution's ISO standard numeric country code. See this resource for a list of codes.
Details about the payment.
Total amount to be charged. If a service fee is sent, then this amount should include the service fee."
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.
Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.
A check number to be used in the ach transaction. Required for payment method = 'check'.
Object containing image of paper check.
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.
Name of item or category.
Price/cost per unit of item or category.
Description of item or category
Quatity of item or category
Split funding instructions for the transaction. See Split a Transaction for more.
The entrypoint the split should be sent to.
The accountId for the account the split should be sent to.
A description for the split.
Amount from the transaction to sent to this recipient.
Events associated to this transaction.
Custom number identifying the bill. Must be unique in paypoint. Required for new bill and when billId
is not provided.
250
Net Amount owed in bill. Required when adding a bill.
Bill date in format YYYY-MM-DD or MM/DD/YYYY.
Bill due date in format YYYY-MM-DD or MM/DD/YYYY.
Any comments about bill. For managed payouts, this field has a limit of 100 characters.
250
Optional custom field.
Optional custom field.
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"
}
}
Description of payment terms.
Bill ID in Payabli.
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.
The MIME type of the file (if content is provided)
pdf
, doc
, docx
, jpg
, jpeg
, png
, gif
, txt
The name of the attached file.
Optional url provided to show or download the file remotely
Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB.
Events associated to this transaction.
Event descriptor. See TransEvent Reference for more details.
Any data associated to the event received from processor. Contents vary by event type.
Date and time of event.
Timestamp when the payment was created, in UTC.
Timestamp when payment record was updated, in UTC.
Was this page helpful?
{
"IdOut": 350,
"CreatedAt": "2023-04-24T09:17:49.063",
"Comments": "testing",
"Vendor": {
"VendorNumber": "54321",
"Name1": "Paul's",
"Name2": "Supplies",
"EIN": "XXXX6789",
"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": ""
}