LinkCy
Powered by Redocly

Beneficiary

List Beneficiaries

Fetch all your beneficiaries.

SecurityLinkcy-Auth
Request
query Parameters
endUserId
string <uuid>

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

name
string

The name of the beneficiary. If empty, the query will return results for all beneficiaries.

iban
string

The IBAN of the beneficiary. If empty, the query will return results for all beneficiaries.

status
Array of strings
Items Enum: "DECLINED" "PENDING_REVIEW" "VALID" "PENDING"
sortAttribute
string
Enum: "NAME" "CREATION_DATE"
display
boolean

Show only display or non display beneficiaries. Both statuses are shown by default.

active
boolean

Show results with only active status or non active status. Both statuses are shown by default.

pageSize
integer <int32> <= 100

The size of the page to be returned.

page
integer <int32> [ 0 .. 500 ]

The page number.

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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

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.


This operation might require SCA.


SecurityLinkcy-Auth 
Request 
header Parameters
Linkcy-SCA-Strategy
string
 Default:  PUSH_NOTIFICATION
The strategy to use when a SCA is required:



More information:


    

  • PUSH_NOTIFICATION: will send a notification if the SCA is required.
    • 

  • DATA_SIGNING: Linkcy-SCA-Signature header must contain signature provided by PowerAuth Mobile SDK on registered device.
    • 

  • BY_PASS: Sandbox only - will ignore any SCA if used.



 Enum: "PUSH_NOTIFICATION" "DATA_SIGNING" "BY_PASS"  
Linkcy-SCA-Signature
string
The signature that needs to be validated, it is generated from data signing.



More information:


    

  • Signature will be verified against wultra.
    • 

  • Operation will be denied if signature is not valide.
    • 

  • Avoid creating multiple signature at same time for the same registration.
    • 

  • Signature TTL is 30 sec.



 
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.


 
type
required
string
Describe if the beneficiary is a person or a company.


 Enum: "PERSON" "COMPANY"  
fullName
string
 Deprecated 
Use name instead


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


 
friendlyName
string  [ 1 .. 255 ] characters 
Friendly name given to the beneficiary.


 
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).


 
active
boolean
Activate (or not) the beneficiary. Default value is true.


 
Responses 
201
Created


202
Waiting SCA


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


post/api/partner/beneficiaries
Request samples 
application/json
{
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "type": "PERSON",
  • "fullName": "string",
  • "name": "John Michael Doe",
  • "friendlyName": "string",
  • "bankingDetails": {
    },
  • "display": true,
  • "active": 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


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


This operation might require SCA.


SecurityLinkcy-Auth 
Request 
path Parameters
beneficiaryId
required
string <uuid> 
 
header Parameters
Linkcy-SCA-Strategy
string
 Default:  PUSH_NOTIFICATION
The strategy to use when a SCA is required:



More information:


    

  • PUSH_NOTIFICATION: will send a notification if the SCA is required.
    • 

  • DATA_SIGNING: Linkcy-SCA-Signature header must contain signature provided by PowerAuth Mobile SDK on registered device.
    • 

  • BY_PASS: Sandbox only - will ignore any SCA if used.



 Enum: "PUSH_NOTIFICATION" "DATA_SIGNING" "BY_PASS"  
Linkcy-SCA-Signature
string
The signature that needs to be validated, it is generated from data signing.



More information:


    

  • Signature will be verified against wultra.
    • 

  • Operation will be denied if signature is not valide.
    • 

  • Avoid creating multiple signature at same time for the same registration.
    • 

  • Signature TTL is 30 sec.



 
Request Body schema: application/json
required
active
boolean
Activate (or not) the beneficiary. Default value is true.


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


 
friendlyName
string  [ 1 .. 255 ] characters 
Friendly name given to the beneficiary.


 
Responses 
200
OK


202
Waiting SCA


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


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