Skip to content

Getting Recurrent Payment Consent

Endpoint: GET /api/recurrent/clients/{client_id}

Endpoint: GET /api/recurrent/leads/{lead_id}

When using the API_GATEWAY domain, use the endpoint https://{customer_key}-api.brainysoft.ru/lanister/recurrent/{clients,leads}/{id}

Response:

json
{
  "status": "ok",
  "timestamp": "1646914328000",
  "data": {
    "recurrentAvailable": true // Passed value of recurrent payment consent
  }
}
  • If the service has no value set for either the lead or the client, true will be returned
  • If the service has a value of false set for the client and no value for the lead, false will be returned (the client's value)
  • If the client has false and the lead has true, the response will be true