Checkout APIs
Embedly Checkout service enable you to create temporary wallets that let customers securely transfer funds into your ecosystem. These wallets are ideal for scenarios like order payments, ticketing, donations, or any situation where you need to collect funds without provisioning a permanent wallet. Each checkout wallet is:- Time-bound – Expires after a set period
- Event-driven – Created in response to a specific action or event
Checkout Base URL
The base URL for all checkout API requests on the staging environment is:Staging
For testing on the staging environment, use the general credentials below.-
OrganizationId:
02600494-1a3c-11f0-a818-6045bd97b81d
-
API Key:
BSK-sqg0f3hCF3sC2KGtNBVsfxbOFFaiOgCEraaCYmg6G0EsqUQ9ihAbeIE2FkAvFlBtIv4kecDVsy4H
-
Organization Prefix Mapping Id:
8b4432bc-f3c7-4055-b5e5-e232707e79af
How Does It Work?
- Creating a Checkout Wallet: This generates a temporary wallet tied to a specific transaction or purpose.
- Retrieving Wallets by Organization: With your organization’s ID, you are able to view all generated checkout wallets. This helps in tracking active, expired, or used wallets and managing customer payments.
Each checkout wallet is designed to receive a single payment and can be
monitored. This simplifies reconciliation and improves user experience.
Common Questions
- How Long Does a Checkout Wallet Last? The lifespan of a checkout wallet is 30 minutes.
- Is a Customer Required to Create an Account? No, checkout wallets are designed to collect payments from customers without requiring full wallet onboarding.
- How do I verify that a payment has been made? We send notifications once credit is received into a checkout wallet within the 30 minutes from the time of generation. Click here to see sample payloads for the notifications sent for different checkout payment events.
Tips for Using the Service
- Initiate Just-in-Time: Only create checkout wallets when the customer is ready to make a payment, since each wallet expires 30 minutes after creation.
- Track with Metadata on Your Side: Maintain a mapping between your internal references (like order ID or customer ID) and the wallet in your system for reconciliation.
- Monitor for Expiry: If the customer hasn’t paid within the 30-minute window, you’ll need to generate a new checkout wallet. Consider setting up automated reminders or fallback actions.
- Regularly Sync Wallet Status: Use the Get All Checkout Wallets endpoint to check for payments, expired wallets, or unused entries to keep your records up to date.