Skip to main content
GET
/
v1
/
direct-debits
/
status?mandateId=
{mandateId}
Get Mandate Status
curl --request GET \
  --url 'https://api.nomba.com/v1/direct-debits/status?mandateId={mandateId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'accountId: <accountid>'
{
  "code": "00",
  "description": "SUCCESS",
  "data": {
    "customerAccountName": "Kolapo Ojo",
    "mandateId": "c93e1e1b-85f5-461e-8b9b-74ee091d4aa4",
    "customerAccountNumber": "80793414434",
    "mandateStatus": "Active",
    "rejectionComment": "Expired e-mandate",
    "mandateAdviceStatus": "Advise not sent"
  },
  "message": "SUCCESS",
  "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
required

The vendor account ID

Query Parameters

​
mandateId
string
required

Unique identifier of the mandate

Response

Mandate status fetched successfully

​
code
string
required
Example:

"00"

​
description
string
required
Example:

"SUCCESS"

​
data
object
required
​
message
string
required
Example:

"SUCCESS"

​
status
boolean
required
Example:

true