Push Integration

Push Integration is used when your ERP can proactively create and update the records Jodo needs for payment, Flex, Pay, and Cred workflows.

In this pattern, your system sends student, fee, payment, and user context to Jodo before the user reaches the Jodo-hosted flow. Jodo then uses that stored context to power checkout, subscriptions, and webhook updates.

When to Use Push

• Your ERP can send updates to Jodo whenever student or fee data changes.
• You want Jodo to already have the required context before the payer starts checkout.
• You need explicit API control over student creation, fee updates, existing payments, and user access.
• Your integration prefers deterministic API writes over on-demand fetches.

Data Flow

1. Create or update the student using Student APIs.
2. Sync fee structure and existing payments where applicable.
3. Register the user or fetch an access token when the payer needs to enter a Jodo-hosted flow.
4. Open the relevant redirect URL from your web or mobile app.
5. Listen to product webhooks for payment, subscription, loan, or order status updates.

API Reference

User API

Register User

Create a Jodo user profile for experiences that require user-level access.

Open reference → User API

Get Access Token

Generate an access token used to construct a secure redirect into a Jodo-hosted flow.

Open reference → Student API

Register Student

Create a student record with fee and contact context for student-linked products.

Open reference → Student API

Update Fee

Keep fee structure and payable amounts synchronized after the student has been created.

Open reference →

Notes

• Use webhooks as the source for asynchronous status changes.
• Treat redirects and callbacks as user navigation events, not as final settlement confirmation.
• Keep API writes idempotent on your side so retries do not create duplicate downstream records.