LinkCy
Powered by Redocly

Crypto Transaction

List crypto transactions

Fetch all crypto transactions.

SecurityLinkcy-Auth
Request
query Parameters
sortAttribute
string
Value: "CREATION_DATE"
endUserId
string <uuid>

The id of the end-user who is transaction actor (sender / receiver)

walletId
string <uuid>

Get transactions made from or to this wallet (walletFrom / walletTo)

blockchainTypes
Array of strings
Items Enum: "BITCOIN" "ETHEREUM" "BNB_SMART_CHAIN"
paymentTypes
Array of strings
Items Enum: "TOKEN_SEND" "TOKEN_RECEIVE"
showDeclinedTransaction
boolean

Get transactions in DECLINED status, by default is true

startDate
string <date-time>

Get transactions from this date, example: 2022-05-16T10:30

endDate
string <date-time>

Get transactions until this date, example: 2022-05-16T10:30

status
Array of strings
Items Enum: "APPROVED" "PENDING" "DECLINED"
pageSize
integer <int32> <= 100

The size of the page to be returned.

page
integer <int32> >= 0

The page number.

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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

get/api/partner/crypto/transactions
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}
Send tokens to a crypto beneficiary
Send tokens to a crypto beneficiary.


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

  • JOIN_CODE: will return a join code if SCA is required.
    • 

  • FAIL: will fail if SCA is required.
    • 

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




ErrorCode


    

  • 409 Conflict
      

    • SCA_REQUIRED: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.
      • 

    • SCA_DEVICE_NOT_SET: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. 





 Enum: "PUSH_NOTIFICATION" "JOIN_CODE" "FAIL" "BY_PASS"  
Linkcy-SCA-Factor
string
 Default:  BIOMETRY
The factor type required for the operation :



More information:


    

  • BIOMETRY: will require fingerprint or face recognition depending on device.
    • 

  • PIN: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.




ErrorCode


    

  • 400 Bad Request
      

    • SCA_FACTOR_NOT_SET: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.





 Enum: "BIOMETRY" "PIN"  
Linkcy-SCA-Id
string <uuid> 
The id of the completed SCA operation.



ErrorCode


    

  • 404 Not Found
      

    • SCA_INTERACTION_NOT_FOUND: The specified id could not be found.
      • 

    

    • 

  • 409 Conflict
      

    • SCA_INTERACTION_NOT_COMPLETED: The SCA interaction is not completed (pending).
      • 

    • SCA_INTERACTION_DECLINED: The SCA interaction was declined by user or expired. 
      • 

    • SCA_INTERACTION_ALREADY_CONSUMED: The SCA interaction has already been used, you need to create a new one.
      • 

    • SCA_INTERACTION_DOES_NOT_MATCH: The SCA interaction does not match the one you are trying to make. Body or url is different.





 
Request Body schema: application/json
required
beneficiaryId
required
string <uuid> 
 
walletFromId
required
string <uuid> 
 
reference
string  [ 0 .. 60 ] characters ^[.'a-zA-ZÀ-ÿ0-9,? ]*$
 
asset
required
string
The symbol of the asset to be sent. For example, 'SepoliaETH' for Sepolia Ethereum.


 
contract
string
 
amount
required
number
Amount in the smallest fraction. (example: for 1 ETH, amount should be 1000000000000000000)


 
Responses 
201
Created


202
Waiting SCA


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


post/api/partner/crypto/transactions
Request samples 
application/json
{
  • "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
  • "walletFromId": "053f8d4b-9949-4ce1-a1b8-5890d9b26f9a",
  • "reference": "string",
  • "asset": "ETH",
  • "contract": "string",
  • "amount": 0
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Get crypto transaction's information
Get all information about a crypto transaction using its ID.


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


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


get/api/partner/crypto/transactions/{cryptoTransactionId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "paymentType": "TOKEN_SEND",
  • "type": "DIGITAL_ASSETS",
  • "status": "APPROVED",
  • "amount": 0,
  • "asset": "string",
  • "decimals": 0,
  • "information": {
    },
  • "fees": {
    },
  • "sender": {
    },
  • "receiver": {
    },
  • "reference": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "confirmationDate": "2019-08-24T14:15:22Z"
}
➔ Next to Additional