Create a Custom Balance Check Session

This endpoint is only relevant to Custom integrations.

If you’re building with an SDK or using the Fully Hosted Forage Checkout UI, then consult the Payments API introduction for a list of resources by integration type.

A POST request to /balance_sessions/ initiates a Session of the Custom Balance Check Forage UI.

Pass the Forage PaymentMethod ref, the hashed reference ID that represents the EBT Card, as the payment_method param in the request body.

The response payload represents the Custom Balance Check Session. The redirect_url value is the URL that launches the front-end, customer-facing Forage UI. Point a customer to this URL to enter their PIN to perform a secure balance inquiry.

If PIN entry is successful, then Forage points the customer to the success_redirect_url specified in the request body. Forage directs them to the cancel_redirect_url if they cancel the balance inquiry via the Forage UI.

How to retrieve a customer's EBT Card balance

After a customer completes the Forage UI and is pointed to your success_redirect_url, send a GET to /api/payment_methods/{payment_method_ref}/ and inspect the balance field of the response to retrieve their EBT Card balance.



Click Try It! to start a request and see the response here!