ListProfileBeneficiaries

GEThttps://test.api.neotek.sa/single-api-aggregator/v1/profiles/beneficiaries

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

Returns every saved payee across all the customer's linked accounts and banks in one call — payee name, destination IBAN, and the receiving bank.

Query parameters:

Parameter	Required	Description
`PSUId`	Required	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

PSUId is the only required parameter. Everything else is optional:

Parameter	Filters by
`ProfileId`	profile
`FinancialInstitutionId`	one bank (BIC)
`FinancialInstitutionName`	bank name
`AccountsLinkId`	one consent/link
`AccountId`	one account
`BeneficiaryType`	beneficiary type
`BeneficiaryName`	payee name
`BeneficiaryShortName`	payee short name
`BeneficiaryBankName`	receiving bank
`Page`	page number

An optional x-request-id header is also supported.

cURL

curl -G 'https://test.api.neotek.sa/single-api-aggregator/v1/profiles/beneficiaries' \  -H 'Authorization: Bearer <ACCESS_TOKEN>' \  -d 'PSUId=PTP100'

Response (trimmed to one beneficiary)

JSON

{    "Data": {        "Beneficiaries": [            {                "ProfileId": "MohammadHath",                "AccountsLinkId": "2618",                "FinancialInstitution": {                    "FinancialInstitutionId": "SAIBCSARI",                    "NameEn": "The Saudi Investment Bank"                },                "AccountId": "ACC-5C9F1F19",                "BeneficiaryId": "BEN-ED54C7FE",                "BeneficiaryType": "KSAOB.Activated",                "AccountHolderName": "Ahmed Al-Rashid",                "AccountHolderShortName": "Ahmed A.",                "CreditorAgent": {                    "IdentificationType": "KSAOB.BIC",                    "Identification": "SARJHI",                    "Name": "Al Rajhi Bank"                },                "CreditorAccount": [                    {                        "IdentificationType": "KSAOB.IBAN",                        "Identification": "SA1080000012345678901006"                    }                ]            }        ]    },    "Meta": {        "PageNumber": 1,        "TotalPages": 1    }}

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

PreviousListProfileTransactions NextListProfileDirectDebits