LinkCy

Direct Debit Mandate

List direct debit mandates

Fetch all direct debit mandates based on parameters.

SecurityLinkcy-Auth
Request
query Parameters
sortAttribute
string
Enum: "DEBTOR_NAME" "CREATION_DATE"
endUserId
string <uuid>

The ID of the end user. If empty, the query will return results for all end-users.

status
string
Enum: "AWAITING_ACTIVATION" "ACTIVATING" "ACTIVATED" "CANCELING" "CANCELED" … 1 more
pageSize
integer <int32> <= 100

The size of the page to be returned.

page
integer <int32> >= 0

The page number.

sortDirection
string
Enum: "ASC" "DESC"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/partner/mandates
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}
Create a new direct debit mandate
Create a direct debit mandate. Once created, the mandate must be activated in order to be effective.


SecurityLinkcy-Auth 
Request 
Request Body schema: application/json
required
endUserId
string <uuid> 
The id of the end-user, can be a consumer or corporate. Mandatory if not authenticated as end-user.


 
friendlyName
string  [ 1 .. 255 ] characters 
 
required
object (DebtorCreateRequestDto) 
The information on the debtor.


 
recurring
boolean
If true, the mandate will be used for recurring payments. By default is false.


 
expirationDate
string <date> 
The expiration date of the mandate. By default is 5 years from today.


 
Responses 
201
Created


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


post/api/partner/mandates
Request samples 
application/json
{
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "friendlyName": "string",
  • "debtor": {
    },
  • "recurring": true,
  • "expirationDate": "2019-08-24"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Cancel a direct debit mandate
Cancel a direct debit mandate. This operation is irreversible.


SecurityLinkcy-Auth 
Request 
path Parameters
mandateId
required
string <uuid> 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


post/api/partner/mandates/{mandateId}/cancel
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Activate a direct debit mandate
Activate a direct debit mandate. You must complete debtor banking details before activating the mandate.


SecurityLinkcy-Auth 
Request 
path Parameters
mandateId
required
string <uuid> 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


post/api/partner/mandates/{mandateId}/activate
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Get a direct debit mandate information
Get all information about a direct debit mandate using its ID.


SecurityLinkcy-Auth 
Request 
path Parameters
mandateId
required
string <uuid> 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


get/api/partner/mandates/{mandateId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "uniqueReference": "string",
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "status": "AWAITING_ACTIVATION",
  • "friendlyName": "string",
  • "debtor": {
    },
  • "recurring": true,
  • "expirationDate": "2019-08-24",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "creationDate": "2019-08-24T14:15:22Z"
}
Update a direct debit mandate
Update an existing direct debit mandate.


SecurityLinkcy-Auth 
Request 
path Parameters
mandateId
required
string <uuid> 
 
Request Body schema: application/json
required
friendlyName
string  [ 1 .. 255 ] characters 
 
object (DebtorUpdateRequestDto) 
The information on the debtor.


 
recurring
boolean
If true, the mandate will be used for recurring payments. By default is false.


 
expirationDate
string <date> 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


patch/api/partner/mandates/{mandateId}
Request samples 
application/json
{
  • "friendlyName": "string",
  • "debtor": {
    },
  • "recurring": true,
  • "expirationDate": "2019-08-24"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
➔ Next to Wallet