v1

latestOpenAPI 3.0.02026-07-244352379.2 KB

Custom Sessions

Retrieve a Custom Balance Check Session

⚠️ Check EBT Card Balance

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.

See these guides for additional information:

get/api/balance_sessions/{session_ref}/

Response

OK - Success

payment_methodstring required

The unique, hashed reference ID to the Forage PaymentMethod instance that represents the EBT Card. The type of the PaymentMethod must be ebt, otherwise the API returns an error.

Send a POST to /payment_methods/ to create a PaymentMethod.

success_redirect_urlstring required

The URL that Forage redirects your customer to if the balance inquiry is successful.

cancel_redirect_urlstring required

The URL that Forage redirects your customer to if the balance inquiry is canceled.

refstring

A unique identifier for the Custom Balance Check Session. Pass this ref in a GET to /balance_sessions/{session_ref}/ to inspect the Session properties.

redirect_urlstring url

The URL that launches the Forage Session UI. Point a customer to this URL when they are ready to enter their EBT Card PIN to perform a secure balance inquiry.

Example response

{
  "ref": "93410bcaff",
  "payment_method": "b16673fe21",
  "success_redirect_url": "https://www.your-app.com/status=SUCCEEDED",
  "cancel_redirect_url": "https://www.your-app.com/status=CANCELED",
  "redirect_url": "https://checkout.joinforage.app/balance?session=93410bcaff&merchant=1234567",
  "previous_errors": []
}