Recipients
- Paymish
- Recipients
Recipients
Manage payout recipients that can be reused across transfer flows.
Endpoints
4 endpoints in this collection.
Authentication
Review each endpoint for its auth requirement before implementation.
What this section covers
- Create or retrieve reusable transfer recipients.
- Blacklist recipients that should no longer receive funds.
- Power recipient management screens in back office tools.
Method mix
Capture and validate recipient details from a trusted internal workflow.
Create or look up the recipient before initiating a payout.
Update or blacklist recipients when compliance or support rules require it.
Prerequisites
- Confirm the business process in your application that should trigger recipients operations.
- Identify the required IDs, credentials, and payload fields before wiring this collection into production flows.
- Decide where you will store returned references so later lookups and support actions can be linked correctly.
Implementation Checklist
- Validate required inputs on your backend before the API call is sent.
- Persist important references returned by the API for future lookups and reconciliation.
- Add clear error handling, logging, and retry rules around production requests.
Success Signals
- The core workflow completes without operators needing to inspect raw API traffic manually.
- Returned references are available in your internal tools for support and reconciliation.
- Failures can be investigated quickly because request context is logged consistently.
Common Pitfalls
- Sending production calls before validating inputs and required identifiers in your own application.
- Not storing returned references, which makes later lookups and support actions harder.
- Treating API success as the only state that matters instead of designing for failures and retries too.
Operational Notes
- Keep sensitive API calls in backend-only services where credentials and audit rules are easier to control.
- Document who in your team owns failed requests, retries, and customer-facing follow-up actions.
- Use request and response metadata to improve support tooling instead of relying on raw logs alone.
Each endpoint below links to a fuller implementation guide with request structure, code examples, and response notes.
Python
Use shared client helpers so auth, retries, and response parsing remain consistent across backend jobs and services.
Node.js
Keep sensitive operations in server-side modules and expose a higher-level integration service to the rest of the app.
PHP
Wrap request formatting and error handling in one reusable Paymish client so controllers stay thin.
cURL
Use cURL as a debugging aid to understand request and response shape before translating the flow into production service code.