API referencePay In endpointsTransaction utilities

Get transaction details

Retrieve a processed transaction's details.

Path parameters

transIdstringRequired

ReferenceId for the transaction (PaymentId).

Headers

requestTokenstringRequired

Response

Success
AchHolderTypeenum or nullDefaults to personal

The bank’s accountholder type: personal or business.

Allowed values:
AchSecCodestring or null

Standard Entry Class (SEC) code is a a three letter code that describes how an ACH payment was authorized. Supported values are:

  • PPD (Prearranged Payment and Deposit) - Used for credits or debits where an accountholder authorizes a company to initiate either a single or recurring transaction to their personal bank account. Common examples include direct deposit of payroll, mortgage payments, or utility bills. This is the default value for subscription payments.
  • WEB (Internet-Initiated/Mobile Entry) - Used for debit entries when authorization is obtained from an accountholder via the internet or a wireless network. Common examples are online bill payments, ecommerce purchases, and mobile app payments where the consumer enters their banking information online.
  • TEL (Telephone-Initiated Entry) - Used for one-time debit entries where authorization is obtained from a consumer via telephone. Common examples are phone-based purchases or bill payments where the consumer provides their banking information over the phone.
  • CCD (Corporate Credit or Debit) - Used for fund transfers between business accounts. This code is specifically for business-to-business transactions. Common examples include vendor payments and other business-to-business payments.
BatchAmountdouble or null
Batch amount.
BatchNumberstring or null
Batch number.
CfeeTransactionslist of objects or null

Service Fee or sub-charge transaction associated to the main transaction.

ConnectorNamestring or null
Connector used for transaction.
Customerobject or null
DeviceIdstring or null
Identifier of registered cloud device used in the transaction.
EntrypageIdlong or null
If applicable, the internal reference ID to the payment page capturing the payment.
ExternalProcessorInformationstring or null
Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions.
FeeAmountdouble or null

Service fee or sub-charge applied.

GatewayTransIdstring or null
Internal identifier used for processing.
InvoiceDataobject or null
Methodstring or null

Payment method used: card, ach, or wallet.

NetAmountdouble or null
Net amount paid.
Operationstring or null
The transaction's operation.
OrderIdstring or null<=250 characters
Custom identifier for the transaction.
OrgIdlong or null
ID of immediate parent organization.
ParentOrgNamestring or null
The name of the parent organization.
PaymentDataobject or null
PaymentTransIdstring or null
Unique Transaction ID.
PayorIdlong or null
Unique ID for customer linked to the transaction.
PaypointDbanamestring or null
Paypoint's DBA name.
PaypointEntrynamestring or null<=50 characters
Paypoint's entryname.
PaypointIdlong or null
InternalId for paypoint.
PaypointLegalnamestring or null
Paypoint's legal name.
PendingFeeAmountdouble or null

The difference between the configured pass-through fee and the fee amount sent in the request. When transfering funds, Payabli uses this field to deduct the fee difference and transfer the correct amount to the merchant.

When a paypoint is set up to absorb fees, and the pass-through fee sent with the request is less than the configured amount, the difference must be covered by the merchant. See Fee Configuration to learn more about pass-through fee settings.

RefundIdlong or null
Identifier of refund transaction linked to this payment.
ResponseDataobject or null
The transaction's response data.
ReturnedIdlong or null

Identifier of return/chargeback transaction linked to this payment.

ScheduleReferencelong or null
Reference to the subscription that originated the transaction.
SettlementStatusinteger or null

Settlement status for transaction. See the docs for a full reference.

Sourcestring or null<=100 characters
Custom identifier to indicate the transaction or request source.
splitFundingInstructionslist of objects or null
Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
TotalAmountdouble or null

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

TransactionEventslist of objects or null
Events associated with this transaction.
TransactionTimedatetime or null
Transaction date and time, in UTC.
TransAdditionalDataany or null
TransStatusinteger or null

Status of transaction. See the docs for a full reference.

Errors