Core Feature

Digital Mandates

Create and manage digital mandates for recurring authorizations, direct debits, and standing instructions.

Create Mandate

POST

/v1/service/mandates

Create a new digital mandate

Request Body

Parameter	Type	Required	Description
recipient	string	Yes	Recipient's phone number or email
type	string	Yes	Mandate type: direct_debit, standing_order, authorization
amount	number	No	Maximum authorized amount
currency	string	No	ISO 4217 currency code (default: USD)
frequency	string	No	Payment frequency: daily, weekly, monthly, yearly
description	string	Yes	Human-readable mandate description

Create mandate

curl -X POST 'https://api.mobid.io/v1/service/mandates' \
  -H 'Content-Type: application/json' \
  -H 'X-Mobid-Key: qk_your_api_key' \
  -d '{
    "recipient": "+1234567890",
    "type": "direct_debit",
    "amount": 500.00,
    "currency": "USD",
    "frequency": "monthly",
    "description": "Monthly subscription fee"
  }'

Response

{
  "code": 200,
  "message": "Mandate created",
  "data": {
    "id": "mdt_abc123",
    "status": "pending_authorization",
    "recipient": "+1234567890",
    "type": "direct_debit",
    "amount": 500.00,
    "currency": "USD",
    "frequency": "monthly",
    "createdAt": "2025-01-15T12:00:00Z"
  }
}

Get Mandate

GET

/v1/service/mandates/:id

Retrieve mandate details

Update Mandate

PUT

/v1/service/mandates/:id

Update an existing mandate

⚠

Re-authorization Required

Updating the amount or frequency of an active mandate requires re-authorization from the recipient through the MID app.

Delete Mandate

DELETE

/v1/service/mandates/:id

Cancel and delete a mandate

List Mandates

GET

/v1/service/mandates

List all mandates with pagination and filtering

Query Parameters

Parameter	Type	Description
status	string	Filter by status: active, pending, cancelled, expired
type	string	Filter by type: direct_debit, standing_order, authorization
page	number	Page number (default: 1)
limit	number	Results per page (default: 20, max: 100)