API reference

Mandates

Knox answers these operations with the same requests and responses as Stripe's API. Authenticate with your secret key, Authorization: Bearer sk_test_..., from your server, and send form-encoded bodies. Test mode only: live processing is currently disabled.

Base URL
https://api.knoxapi.com

Retrieve a Mandate

GET/v1/mandates/{mandate}

Retrieves a Mandate object.

Path parameters

  • mandatestringRequired

Query parameters

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The mandate object.

GET /v1/mandates/{mandate}
curl https://api.knoxapi.com/v1/mandates/mandate_1Pgc78B7WZ01zgkW9EfgTVki \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "customer_acceptance": {
    "accepted_at": 123456789,
    "online": {
      "ip_address": "127.0.0.0",
      "user_agent": "device"
    },
    "type": "online"
  },
  "id": "mandate_1Pgc78B7WZ01zgkW9EfgTVki",
  "livemode": false,
  "multi_use": {},
  "object": "mandate",
  "payment_method": "pm_123456789",
  "payment_method_details": {
    "sepa_debit": {
      "reference": "123456789",
      "url": ""
    },
    "type": "sepa_debit"
  },
  "status": "active",
  "type": "multi_use"
}

Operations and schemas come from the pinned Stripe OpenAPI specification (MIT); response examples from its fixtures. Nested object definitions and enums are in the complete specification.