Prerequisites
- Create the payee profile by following
Create Payee. - Add at least one address for that payee via
Create Payee Addressso Paywint can route and track the delivery.
Paywint card capabilities
You can:- Issue a new Paywint card for a payee with a specified amount and currency.
- Retrieve the full Paywint card payload (numbers, expiration, status flags) using the issued
request_id. - List every Paywint card that you have issued.
- Reload an existing Paywint card to add more funds when the card still needs a top-up.
How the Paywint card flow works
1. Request a new card
Call
Issue Paywint Card For Payee with the payee identity, amount, currency, and any metadata that ties the card back to your system.2. Deliver card details
The response includes a
request_id and the encrypted card payload. Store the request_id and share the payload with the payee through your secure channels.3. Track card status
Use
List Paywint Cards to see every card for the user, or call Get Paywint Card when you need the latest metadata for a specific issuance.4. Reload when needed
If the card needs more value, call
Reload Paywint Card to top it up without issuing a new card.Available APIs
Issue Paywint Card
Generate a Paywint card for a given payee and amount.
Get Paywint Card
Retrieve the issued card payload using the
request_id.List Paywint Cards
List every Paywint card associated with a user to monitor outstanding balances.
Reload Paywint Card
Add value to an existing Paywint card when the balance needs replenishing.
Best practices
- Treat the
request_idas the canonical reference for every Paywint card issuance. - Share card details with payees securely, then delete or mask raw values on your end.
- Call
List Paywint Cardsregularly to reconcile what your system issued versus what remains outstanding. - Use the reload API only when your compliance rules allow topping up previously issued cards.