Table of Contents | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
In this guide, we first break down the different types of events that can make up a disbursement and then how to group the Disbursement Entries (disbursementEntries
) that make up the disbursement total to reconcile what was funded.
For more information on entries please review the entries event
field in our API Documentation here: https://portal.payrix.com/docs/api#entriesResponse
Note |
---|
Warning: Certain Interchange Fees that amount to less than a full cent ($0.01) will be displayed under Not Disbursed on a Disbursement Summary, as an undisbursed amount rollover. |
Reconciling a Disbursement
...
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
Step 3 - Disbursement Entry Looping/Bucketing1. Create Entry and Output BucketsWe will start by splitting our
We will also initialize three output “buckets” based on the different type of events:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2Step 3.1 Loop through EventEntriesWe will loop through the EventEntries obtained in step 1 and add them to their proper “bucket” based on the EventTypeEvent Type. 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 The EventType Event Type will be based on the In this example, we provide an example of how to get detailed event data. EventType Event Type = 7 (Capture) or 21 (ECSale)You can get the full transaction data by expanding the Expanding the
Querying
Using the data collected from
EventType Event Type = 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 Expanding the
Querying
Using the data collected from disbursementEntries in ‘1 EventEntries’ and the transaction data pulled above this will need to be pushed to the OutputTxnEvents bucket:
EventType Event Type = 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 Expanding the EventId:
Querying Txn Endpoint:
Using the data collected from disbursementEntries in ''1 EventEntries and the chargeback data pulled above this will also need to be pushed to the OutputTxnEvents bucket:
Other EventTypeEvent TypeFor any EventType Event Type that is not listed within EventEntries above, we will push to an OutputOther “bucket”. These can be grouped by event type.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Step 3.2: Loop through FeeEntriesNow we will loop through the disbursementEntries collected from Step 2 FeeEntries and add them to the proper “bucket” based on the The These will be events 13 (assessments), 26 (profit share), & 47 (entry refund). In this example, we provide an example on how to get detailed event data.
EventType Event Type = 13 (Interchange)In order to get data on assessments and find the original transaction, you will reference the Getting Data on the Assessment: Expanding the
Querying Assessments Endpoint:
Finding Original Transaction:
In the assessments endpoint if the If the assessments.eventId does not equal a transactional event retrieved in Step 2 then this should be pushed to the OutputOtherFees “bucket”.
EventType Event Type = 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 If not the fees do not equal a transactional event retrieved in Step 2 then this should be pushed to the OutputOtherFees bucket.
Other EventTypeEvent TypeAny other fee not associated to the EventTypes Event Types listed above should be pushed to the OutputOtherFees bucket:
|
...