GET
/
v1
/
direct-debits
/
mandates
Get mandates by filters
curl --request GET \
  --url https://api.nomba.com/v1/direct-debits/mandates \
  --header 'Authorization: Bearer <token>' \
  --header 'accountId: <accountid>'
{
  "data": {
    "items": {
      "status": "<string>",
      "customerAccountNumber": "<string>",
      "customerAccountName": "<string>",
      "bankCode": "<string>",
      "amount": 123,
      "customerName": "<string>",
      "customerAddress": "<string>",
      "customerEmail": "<string>",
      "customerPhoneNumber": "<string>",
      "merchantReference": "<string>",
      "frequency": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "mandateAdviceStatus": "<string>",
      "mandateId": "<string>"
    },
    "page": 123,
    "pageSize": 123,
    "totalItems": 123,
    "totalPages": 123,
    "hasMore": true
  },
  "message": "<string>",
  "code": "<string>",
  "description": "<string>",
  "status": true
}

Authorizations

​
Authorization
string
header
required

Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN. You need to use an "Authorization" HTTP header to provide your ACCESS_TOKEN. For example: Authorization: {ACCESS_TOKEN}.

Headers

​
accountId
string<uuid>
required

The parent accountId of the business.

Example:

"890022ce-bae0-45c1-9b9d-ee7872e6ca27"

Query Parameters

​
page
integer
required
Example:

0

​
pageSize
integer
required
Example:

20

​
from
string<date>
​
to
string<date>
​
status
string

Response

200
application/json

Page of mandates

The response is of type object.