ListProfileDirectDebits

GEThttps://test.api.neotek.sa/single-api-aggregator/v1/profile/direct-debits/{account_id}

Sandbox URL · in Production call https://api.neotek.sa

Returns the direct debit mandates on one account — the standing authorisations that let a biller or merchant collect from it.

Path parameters:

Parameter	Required	Description
`account_id`	Required	the account to look up, an `AccountId` from ListProfileAccounts

Query parameters:

Parameter	Required	Description
`psu_id`	Optional	the Payment Service User id: the identifier you assign to the customer in your own system. Use the same id you sent when creating the accounts link, since that is how Neotek resolves which consented accounts to return

Headers:

Parameter	Required	Description
`authorization`	Required	`Bearer <ACCESS_TOKEN>`, with scope `single_api`
`x-request-id`	Optional	an RFC 4122 UUID you generate; quote it when raising a support ticket

cURL

curl 'https://test.api.neotek.sa/single-api-aggregator/v1/profile/direct-debits/{account_id}' \  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response (schema — DirectDebit is a list of mandate references, and Meta carries only TotalPages)

JSON

{    "Data": {        "AccountId": "string",        "DirectDebit": [            "string"        ]    },    "Links": {        "Self": "string",        "First": "string",        "Last": "string"    },    "Meta": {        "TotalPages": 0    }}

Errors

Scenario	Status	Code	Message
Missing required param	`400`	`NTSP.ERROR.400.090`	One or more required API parameters are missing in the API request.
Invalid enum value	`400`	`NTSP.ERROR.400.901`	Backend Invalid Request Body
Invalid/expired token	`401`	`NTSP.ERROR.401.001`	Cannot pass the security checks that are required by the target API or operation…
No Authorization header	`401`	`NTSP.ERROR.401.001`	Invalid client id or secret.
Wrong method	`405`	`null`	The method is not allowed for the requested URL

PreviousListProfileBeneficiaries NextListProfileParties