Determine payment transactions

Learn how to determine which released transactions make up a payment based on matching identifiers.

Prerequisites

To complete this tutorial, you must have:

• Authorization from the selling partner for whom you are making calls. Refer to the Authorizing Selling Partner API applications for more information.
• Approval for the Finance and Accounting role in your developer profile.
• The Finance and Accounting role selected in the App registration page for your application.

Step 1. Retrieve a list of financial event groups

Call the listFinancialEventGroups operation of the Finances API v0 to retrieve up to 100 financial event groups at a time. If there are more groups available, you can retrieve them with the provided nextToken.

Step 2. Find the financial event group ID of the payment

Examine the response to listFinancialEventGroups to find the FinancialEventGroupId of the payment you're interested in.

Step 3. Retrieve a list of released transactions

Call the listTransactions operation. If there are more transactions available, you can retrieve them with the provided nextToken.

Select the result transactions where the transactionStatus value is RELEASED.

Step 4. Review the transactions that have matching identifiers

The response to listTransactions contains the transactions array. For each transaction in this array, examine the elements of the relatedIdentifiers array. For each relatedIdentifier, if the relatedIdentifierName is EVENT_GROUP_ID, check if the relatedIdentifierValue matches the FinancialEventGroupId obtained in Step 2. Find the financial event group ID of the payment. If it does, then this transaction is part of the payment.