List mandates for an account
Returns a paginated list of mandates owned by the given (branch, accountNumber). Optionally filter by status. Results are sorted by createdAt descending.
Query Parameters
- Type: stringbranchrequired
Branch (4 digits) of the sender account
- Type: stringaccount
Number requiredAccount number of the sender
- Type: string enumstatus
Filter by mandate status
values- P
E N D I N G _ U S E R _ A P P R O V A L - P
E N D I N G _ C O U N T E R P A R T Y _ A P P R O V A L - A
P P R O V A L _ S E N T - A
C T I V E - R
E J E C T E D - C
A N C E L L E D - E
X P I R E D - F
A I L E D
- Type: integer Format: int32page
Page index (0-based)
- Type: integer Format: int32size
Page size
Responses
- application/json
- 400
Invalid query parameters
Request Example for get/api/v1/mandates
curl 'http://localhost:8080/api/v1/mandates?branch=0001&accountNumber=12345' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"content": [
{
"mandateId": "SC87654321202604211500abc",
"mandateRequestId": "string",
"receiver": {
"key": "string",
"name": "string",
"document": {
"type": "CPF",
"value": "string"
},
"account": {
"ispb": "string",
"type": "CACC",
"branch": "string",
"number": "string"
}
},
"sender": {
"name": "string",
"document": {
"type": "CPF",
"value": "string"
},
"account": {
"ispb": "string",
"type": "CACC",
"branch": "string",
"number": "string"
}
},
"frequency": "MNTH",
"firstCollectionDate": "2026-07-29",
"finalCollectionDate": "2026-07-29",
"amount": 30,
"status": "PENDING_USER_APPROVAL",
"receivedAt": "2026-07-29T19:28:46.556Z",
"approvedAt": "2026-07-29T19:28:46.556Z",
"rejectedAt": "2026-07-29T19:28:46.556Z",
"rejectReason": "string",
"activatedAt": "2026-07-29T19:28:46.556Z",
"cancelledAt": "2026-07-29T19:28:46.556Z",
"cancelledBy": "SELF",
"cancellationReason": "string",
"createdAt": "2026-07-29T19:28:46.556Z",
"updatedAt": "2026-07-29T19:28:46.556Z"
}
],
"page": 0,
"size": 20,
"totalElements": 42,
"totalPages": 3
}