Retrieve Payment Application

Retrieves the Payment Application specified by this unique identifier, optionally including nested data sets.

A Payment Application is created by a business who receives a Payment from a customer. A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices. The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.

Roles

To call this endpoint, you must have one of these roles:

  • Group Owner
  • Group Admin
  • Member
  • Read-Only

You can view your roles with the Status API.

Data Definition

See PaymentAppliedModel for the complete data definition.

Language
Authentication
URL
Click Try It! to start a request and see the response here!