LinkCy
Powered by Redocly

Crypto Beneficiary

List Crypto Beneficiaries

Fetch all your crypto beneficiaries.

SecurityLinkcy-Auth
Request
query Parameters
active
boolean

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

display
boolean

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

sortAttribute
string
Enum: "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: "DECLINED" "PENDING_REVIEW" "VALID" "PENDING"
blockchainType
string
Enum: "BITCOIN" "ETHEREUM" "BNB_SMART_CHAIN"
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/crypto/beneficiaries
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}
Add a new crypto-beneficiary
Create a crypto beneficiary in order to send digital assets.


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"  
name
required
string  [ 3 .. 511 ] characters 
Complete name of the person (firstName middleName lastName) or name of the company.


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


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


 
required
object (WalletDetails) 
 
Responses 
201
Created


202
Waiting SCA


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


post/api/partner/crypto/beneficiaries
Request samples 
application/json
{
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "type": "PERSON",
  • "name": "string",
  • "friendlyName": "string",
  • "display": true,
  • "walletDetails": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Get Information on a Crypto Beneficiary
Get information on a crypto beneficiary.


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


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


get/api/partner/crypto/beneficiaries/{cryptoBeneficiaryId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "friendlyName": "string",
  • "type": "PERSON",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "display": true,
  • "status": "DECLINED",
  • "walletDetails": {
    }
}
Update information of a Crypto Beneficiary
Update information on a crypto beneficiary.


SecurityLinkcy-Auth 
Request 
path Parameters
cryptoBeneficiaryId
required
string <uuid> 
 
Request Body schema: application/json
required
active
boolean
 
display
boolean
 
friendlyName
string
 
name
string
 
status
string
 Enum: "DECLINED" "PENDING_REVIEW" "VALID" "PENDING"  
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


patch/api/partner/crypto/beneficiaries/{cryptoBeneficiaryId}
Request samples 
application/json
{
  • "active": true,
  • "display": true,
  • "friendlyName": "string",
  • "name": "string",
  • "status": "DECLINED"
}
Response samples 
application/json
{
  • "cryptoBeneficiaryId": "348139d3-780c-4a44-9242-2411d3b41501"
}
➔ Next to Crypto Transaction