About Recipients

Aggregator Workflow

To create/manage a recipient to be used across 1-n payers, use the aggregator's payer_id as the URL parameter value.

Verification Information

If the Payer configuration requires Recipient Identity Verification (TIN and Name verification), the Recipient response payload may contain additional fields relevant to the Recipient's Verification. If a Recipient has been verified, PUT and PATCH methods will not overwrite the verified name.

Recipient Name values

The API will only accept Standard and Printable ASCII characters for name values. ASCII extended values will be rejected with a BAD REQUEST response.