Retrieve the amount and status of a payment

Learn how to retrieve the amount and status of a payment.

Prerequisites

To successfully complete this tutorial, you must have:

• Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
• 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. Find the specific financial event group of the payment

Call the listFinancialEventGroups operation to retrieve the latest 100 financial event groups. This returns the groups and a page token for retrieving additional groups.

Step 2. Filter for closed financial event groups

To select financial event groups that have successfully sent payments, select the financial event groups where ProcessingStatus is equal to Closed.

Step 3. Retrieve the payment amount

The OriginalTotal property provides the total amount of disbursement or charge. The CurrencyAmount provides the monetary value, and the CurrencyCode contains the three-digit currency code in ISO 4217 format.