Retrieve 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.


This endpoint does not return a customer's EBT Card balance.

If you’re looking for a customer's EBT Card balance, then send a GET to /api/payment_methods/{payment_method_ref}, and inspect the balance response field.

A GET request to /balance_sessions/ retrieves the properties of a Custom Balance Check Session.

Use this endpoint to inspect a Session's success_redirect_url and cancel_redirect_url values.


References and guides

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