Beneficiary

List Beneficiaries

Fetch all your beneficiaries.

SecurityLinkcy-Auth
Request
query Parameters
active
boolean
display
boolean
sortAttribute
string
Enum: "NAME" "CREATION_DATE"
endUserId
string <uuid>
pageSize
integer <int32> [ 0 .. 100 ]
Default: 20

The size of the page to be returned.

page
integer <int32> >= 0
Default: 0

The page number.

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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

get/api/partner/beneficiaries
Request samples
Response samples
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}

Add a new beneficiary

Beneficiaries are the one who will receive funds. When you add a beneficiary, the consumer must use the exact full name. If he adds as a beneficiary one of his own accounts, we must be able to detect it. It will simplify Strong Customer Authentication (SCA) during a transfer.

You must fill one of the beneficiary types. BIC / SWIFT code is only required for IBAN. If you want to simplify transfers later, we suggest you add a SWIFT code for US and UK beneficiaries.

SecurityLinkcy-Auth
Request
Request Body schema: application/json
type
required
string

Describe if the beneficiary is a person or a company.

Enum: "PERSON" "COMPANY"
fullName
required
string [ 0 .. 511 ] characters

Complete name of the person (firstName middleName lastName) or name of the company.

endUserId
string <uuid>

The id of the endUser, can be a consumer or corporate.
Mandatory if not authenticated as end-user.

required
SepaBankingDetails (object) or GbpBankingDetails (object) or UsdBankingDetails (object) (BankingDetails)
display
boolean

Display (or not) the beneficiary to the end-user (unusable by end-user).

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409
500

Internal Server Error

post/api/partner/beneficiaries
Request samples
application/json
{
  • "type": "PERSON",
  • "fullName": "John Michael Doe",
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "bankingDetails": {
    },
  • "display": true
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get beneficiary's information

Get all information about a beneficiary using its ID.

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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

get/api/partner/beneficiaries/{beneficiaryId}
Request samples
Response samples
application/json
{
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "PERSON",
  • "currency": "EUR",
  • "active": true,
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "display": true,
  • "accountType": "IBAN",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "linkcyLedgerId": "a46808dc-b040-4d05-b916-a3302b04dc12",
  • "accountNumber": "string",
  • "sortCode": "string"
}

Patch a beneficiary

Patch a beneficiary.

SecurityLinkcy-Auth
Request
path Parameters
beneficiaryId
required
string <uuid>
Request Body schema: application/json
active
boolean

Activate (or not) the beneficiary.

display
boolean

Display (or not) the beneficiary to the end-user (unusable by end-user).

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

patch/api/partner/beneficiaries/{beneficiaryId}
Request samples
application/json
{
  • "active": true,
  • "display": true
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}