...
For more information on entries please review the entries event field in our API Documentation here: https://portal.payrix.com/docs/api#entriesResponse
Different Type of Events
Entries overall represent money movement in the Payrix system and are always associated with an event that indicates what triggered the entry or money movement. This is true for Disbursements AND Transaction Entries.
...
Transactional Events (associated with Disbursements)
Fees (that are not associated with a transactional event)
Other (chargebacks, rollovers, etc.)
Transactional Events
A Transactional Event is any instance where funds are credited or debited from the merchant balance as part of standard transaction processing.
...
| Info |
|---|
NOTE: A record ID that begins with p1 = Production and one that begins with t1 = Sandbox. |
Other Fees
This will be a list of all fees that were not included in the Transactional Events section.
...
Entry ID | Event Type | Event ID | Amount | Event Net |
|---|---|---|---|---|
p1_etr_1 | Boarding | p1_mer_1 | $5 | -$5 |
p1_etr_2 | Auth | p1_txn_4 | $1 | -$1 |
Other
Any event that is not a Transactional Event or Other Fee event is covered in this section:
...
Event Type | Event Value Example |
|---|---|
Adjustments (Event | $50 |
Fee Refunds (Event | $5 |
Reserve (Event | -$10 |
Rollover/Remainder (Event | -$0.005 |
Reconciling a Disbursement
This section breaks down the disbursement data and how you can retrieve the necessary events to break-down what made up the disbursement total and what was funded. This section will discuss how to loop through the data and organize it into “buckets” that can be used to reconcile the disbursement amount.
Step 1 - Disbursement Data
To get data around how much was disbursed and when it was disbursed query the disbursements endpoint. This endpoint provides a summary of what was funded to the entity account.
...
created: The timestamp when the disbursement was requested.processed: The timestamp when the disbursement was sent for funding.amount: The amount to be disbursed.
Step 2 - Disbursement Entry Data
To get data on the activity that made up the disbursement total, query the disbursementEntries endpoint.
...
Once all the disbursementEntries associated with the disbursement has been pulled, loop through all the data to place each entry in the proper bucket based on the type of events outlined at the beginning of this guide.
Step 3 - Disbursement Entry Looping/Bucketing
1. Create Entry and Output Buckets
We will start by splitting our disbursemnetEntries into two “buckets”:
...
OutputTxnEvents
OutputOtherFees
OutputOther
Examples to be provided
2. Loop through EventEntries
We will loop through the EventEntries obtained in step 1 and add them to their proper “bucket” based on the EventType. An entry is created and is a record of the movement of funds. In order to get details on the event itself such as the transaction that triggered the capture or refund fee we will want to reference the disbursementEntries.entry
...
In this example, we provide an example of how to get detailed event data.
EventType = 7 (Capture) or 21 (ECSale)
You can get the full transaction data by expanding the eventId within the entry or by querying the txns endpoint with the transaction associated with the disbursement.entry.txn.
...
| Note |
|---|
A fee on a txn resource is only populated if the fee was submitted on the initial transaction. This field |
EventType = 8 (Refund) or 22 (ECRefund)
Similar to above to get data for refunds you will get the transaction details associated with the entry by expanding the eventId or querying the txn endpoint using the transaction associated with the disbursementEntries.entry.txn. Additionally, we will expand the related transaction forTxn, which is the original transaction that is being refunded.
...
Entry | Description | Fields |
|---|---|---|
Event ID | The event that triggered the movement of funds and is associated with the disbursementEntry. |
|
Event Type | The type of event that triggered the event (i.e - Capture, ECSale, etc.) |
|
Txn ID | The transaction associated with the |
|
Txn Amount | The total amount of the disbursementEntry, this is displayed to the cent in the API. (e.g - 500 = $5.00) |
|
Txn Cardholder | The cardholder name that initiated with the original transaction and is associated with the refund transaction. This is only populated if supplied on the transaction or associated with a customer such as if a transaction. |
|
Fee Amount | This is a placeholder for fees associated with the transaction, which will be retrieved in Step 3: Loop through FeeEntries. | 0 |
Event Net | The net amount of the event that moved funds and created a disubursementEntry. |
|
EventType = 11 (Chargeback) or 20 (Arbitration)
Similar to a transaction in order to get all the information related to a chargeback, and not just the details of the entry, we will expand the eventId or query the chargebacks endpoint using the chargeback associated with the disbursement.entry.chargeback.
...
Event | Description | Fields |
|---|---|---|
Event ID | The event that triggered the movement of funds and is associated with the disbursementEntry. |
|
Event Type | The type of event that triggered the event (i.e - Chargeback.) |
|
Event Amount | The total amount of the disbursementEntry, this is displayed to the cent in the API. (e.g - 500 = $5.00) |
|
Txn ID | The transaction associated with the |
|
Txn Amount | The transaction approved amount for the original transaction issued the chargeback. |
|
Txn Cardholder | The cardholder name that initiated with the original transaction and is associated with the transaction that was issued the chargeback. |
|
Fee Amount | This is a placeholder for fees associated with the chargeback, which will be retrieved in Step 3: Loop through FeeEntries. | 0 |
Event Net | The net amount of the event that moved funds and created a disubursementEntry. |
|
Other EventType
For any EventType that is not listed within EventEntries above, we will push to an OutputOther “bucket”. These can be grouped by event type.
Event Type:
disbursemnetEntry.eventEvent Net:
disbursemnetEntry.amount
3: Loop through FeeEntries
Now we will loop through the disbursementEntries collected from Step 2 FeeEntries and add them to the proper “bucket” based on the disbursemnetEntry.event. In order to get information such as the txn that triggered the interchange or associated with the chargeback we will want to reference the disbursementEntry.entry.originalEventId.
...
| Info |
|---|
In the future adding |
EventType = 13 (Interchange)
In order to get data on assessments and find the original transaction, you will reference the disbursement.entry.originalEventId. You can also expand the eventId to get information on the assessment.
...
Entry | Description | Fields |
|---|---|---|
Entry ID | The event that triggered the movement of funds and is associated with the disbursementEntry. |
|
Event Type | The type of event that triggered the event (i.e - Fee.) |
|
Event ID | The ID of the event that triggered the assessment event. |
|
Amount | The negative amount that made up the assessment total that was incurred |
|
Event Net | The net amount of the event that moved funds and created a disubursementEntry. |
|
EventType = 6 (Auth), 7 (Capture), 8 (Refund), 11 (Chargeback), 20 (Arbitration), 21 (ECSale), 22 (ECRefund), 23 (ECReturn), 24 (Settlement)
Similar to the above if any of the fees associated to these events match a transaction ID obtained when creating the OutputTxnEvents bucket, then increment If disbursemnetEntry.eventId matches the EventId of an element in the OutputTxnEvents bucket, then you should increment the FeeAmount and EventNet for the record created by the disbursementEntry.amount.
...
Event | Description | Fields |
|---|---|---|
Entry ID | he event that triggered the movement of funds and is associated with the disbursementEntry. |
|
Event Type | The type of event that triggered the event (i.e - Transaction, Chargeback, etc.) |
|
Event ID | The ID of the event that triggered the fee event. |
|
Amount | The negative amount that made up the fee total that was incurred. |
|
Event Net | The net amount of the event that moved funds and created a disubursementEntry. |
|
Other EventType
Any other fee not associated to the EventTypes listed above should be pushed to the OutputOtherFees bucket:
...