Skip to main content
PUT
/
v1
/
direct-debits
/
update-status
Update mandate status
curl --request PUT \
  --url https://api.nomba.com/v1/direct-debits/update-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'accountId: <accountid>' \
  --data '
{
  "mandateId": "c93e1e1b-85f5-461e-8b9b-74ee091d4aa4",
  "status": "SUSPEND"
}
'
{
  "code": "00",
  "description": "SUCCESS",
  "data": {
    "mandateId": "c93e1e1b-85f5-461e-8b9b-74ee091d4aa4",
    "mandateStatus": "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

Body

application/json
​
mandateId
string
required

Unique identifier of the mandate

​
status
enum<string>
required

New status of the mandate

Available options:
SUSPEND,
ACTIVE,
DELETE

Response

Mandate status updated successfully

​
code
string
required
Example:

"00"

​
description
string
required
Example:

"SUCCESS"

​
data
object
required
​
message
string
required
Example:

"SUCCESS"

​
status
boolean
required
Example:

true