GET /v1/mandates Bearer

Check recurring status

Step 2 of the direct debit flow: POST /v1/mandates, then GET /v1/mandates until succeeded, then POST /v1/mandates/{mandate_id}/debits. Look up by your mandate merchant_reference (not the MD_ id). While processing, Omni refreshes from the processor (throttled). Debit only after status is succeeded.

Query parameters

merchant_reference required string

GET https://omni.mojo-pay.com/v1/mandates

curl -X GET "https://omni.mojo-pay.com/v1/mandates?merchant_reference={merchant_reference}" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Accept: application/json"

Response

{
    "object": "mandate",
    "mandate_id": "20189719",
    "status": "succeeded",
    "merchant_reference": "mandateTest010912026003",
    "frequency": "DAILY",
    "description": "daily subscription payment",
    "mobile": "233597225334",
    "provider": "MTN"
}