Mandates
List Mandates
Retrieve a paginated list of all UPI mandates.
GET
/
v1
/
mandates
List mandates
curl --request GET \
--url https://billing.example.com/v1/mandates \
--header 'Authorization: Bearer <token>'import requests
url = "https://billing.example.com/v1/mandates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://billing.example.com/v1/mandates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://billing.example.com/v1/mandates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://billing.example.com/v1/mandates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://billing.example.com/v1/mandates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.example.com/v1/mandates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mandate_type": "<string>",
"payment_method": "<string>",
"vpa": "<string>",
"razorpay_token_id": "<string>",
"razorpay_subscription_id": "<string>",
"razorpay_customer_id": "<string>",
"max_amount": 123,
"frequency": "weekly",
"status": "created",
"authorized_at": "2023-11-07T05:31:56Z",
"activated_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"last_debit_at": "2023-11-07T05:31:56Z",
"next_debit_at": "2023-11-07T05:31:56Z",
"pre_debit_notified": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
}
}Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
customer_id | string (UUID) | No | Filter mandates by customer ID. |
status | string | No | Filter by status: created, authorized, paused, revoked, or expired. |
frequency | string | No | Filter by frequency: weekly, monthly, quarterly, or yearly. |
limit | integer | No | Number of records to return (default 10, max 100). |
offset | integer | No | Number of records to skip (default 0). |
Example Request
curl -G https://api.recurso.dev/v1/mandates \
-H "Authorization: Bearer rsk_live_xxx" \
-d customer_id="cust_a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
-d limit=10
Response
Returns a list of mandate objects.{
"object": "list",
"data": [
{
"id": "mdt_7a6b5c4d3e2f1098",
"object": "mandate",
"customer_id": "cust_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"subscription_id": "sub_9f8e7d6c5b4a3210",
"vpa": "rajesh.kumar@okicici",
"max_amount": 99900,
"frequency": "monthly",
"status": "authorized",
"umn": "UMN-202606231015-ABCDEF",
"valid_from": "2026-06-23T00:00:00Z",
"valid_until": "2031-06-23T00:00:00Z",
"created_at": "2026-06-23T10:15:30Z",
"updated_at": "2026-06-24T08:00:00Z"
},
{
"id": "mdt_1b2c3d4e5f6a7890",
"object": "mandate",
"customer_id": "cust_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"subscription_id": null,
"vpa": "rajesh.kumar@okicici",
"max_amount": 50000,
"frequency": "quarterly",
"status": "created",
"umn": "UMN-202606221400-GHIJKL",
"valid_from": "2026-06-22T00:00:00Z",
"valid_until": "2031-06-22T00:00:00Z",
"created_at": "2026-06-22T14:00:00Z",
"updated_at": "2026-06-22T14:00:00Z"
}
],
"has_more": false,
"total_count": 2
}
Authorizations
Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.
Query Parameters
Max rows returned (clamped to 1000).
Required range:
x <= 1000Rows to skip, for paging past the clamp.
Required range:
x >= 0Response
Mandates for the tenant.
Show child attributes
Show child attributes
⌘I
List mandates
curl --request GET \
--url https://billing.example.com/v1/mandates \
--header 'Authorization: Bearer <token>'import requests
url = "https://billing.example.com/v1/mandates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://billing.example.com/v1/mandates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://billing.example.com/v1/mandates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://billing.example.com/v1/mandates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://billing.example.com/v1/mandates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.example.com/v1/mandates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mandate_type": "<string>",
"payment_method": "<string>",
"vpa": "<string>",
"razorpay_token_id": "<string>",
"razorpay_subscription_id": "<string>",
"razorpay_customer_id": "<string>",
"max_amount": 123,
"frequency": "weekly",
"status": "created",
"authorized_at": "2023-11-07T05:31:56Z",
"activated_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"last_debit_at": "2023-11-07T05:31:56Z",
"next_debit_at": "2023-11-07T05:31:56Z",
"pre_debit_notified": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
}
}