Get remittance data by payment reference

Retrieve invoices and line items associated with a payment reference for remittance portal access

post/api/v1/remittance_portal/remittance

Request body

payment_refstring required

Payment reference to search for

provider_emailstring required

Provider email address

plan_manager_idstring required

Plan manager ID

Example request

{
  "provider_email": "provider@example.com",
  "plan_manager_id": "pm_123"
}

Response

Successful Response

successboolean required

Whether the request was successful

messagestring required

Response message

dataobject nullable

Response data containing invoices and line items

Changes