Payers represent the external bank accounts used to fund Payments to Platform. The endpoints below cover the Payer lifecycle: creating a funding source, verifying its bank account, retrieving its details, and removing it when it's no longer needed.
| Endpoint | What It Does | When to Use It |
|---|---|---|
| Create a Partner Payer | Creates a Payer from an external bank account and returns a payerId for that funding source. | The starting point for funding your platform account. Create a Payer for each external bank account you want available as a funding source. |
| Verify a Payer | Verifies the bank account associated with a Payer using microdeposit amounts. | After creating a Payer when its bank account requires verification before it can be used as a funding source. |
| Get a List of Payers | Returns the Payers you've created and any identifying information for each funding source. | Viewing the funding sources available to you or finding the payerId needed for another Payer or payment action. |
| Get Single Payer Details | Returns the account details for a specific Payer. | Looking up a known Payer when you need information about that funding source without retrieving the full list. |
| Delete a Payer | Removes a Payer from active use while preserving its reference in transaction history. | Retiring a funding source that should no longer be available for future payments. |
📘 A Payer is the source of funds for a Payment to Platform. Create and, when required, verify the Payer first, then use its payerId when making a Payment to Platform.