LinkCy
Powered by Redocly

Card

Update a rule from cardDeprecated

Update card by creating a new card rule. When creating a card rule with a type that already exists, it will override the previous one.

Both partner and enduser can set a rule of the same type. The more restrictive one will be applied.

This operation might require SCA.

SecurityLinkcy-Auth
Request
path Parameters
cardId
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.
  • 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
type
required
string
Enum: "DAILY_MAX_SPEND" "MONTHLY_MAX_SPEND" "WEEKLY_MAX_SPEND" "DISABLE_CONTACTLESS" "DISABLE_ONLINE" … 7 more
value
required
integer <int64> [ 1 .. 999999999 ]
name
string
creatorType
string
Enum: "END_USER" "PARTNER" "LINKCY"
Responses
202

Waiting SCA

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

put/api/partner/cards/{cardId}/rules
Request samples
application/json
{
  • "type": "DAILY_MAX_SPEND",
  • "value": 1,
  • "name": "string",
  • "creatorType": "END_USER"
}
Response samples
application/json
{
  • "scaId": "b3cefad3-4f89-419b-8221-cc5050122ff3",
  • "joinCode": "0907af4a-d224-4ddb-a7ab-11c52f9fed47",
  • "ttl": {
    },
  • "scaDeviceId": "string"
}

Update a rule from card

Update card by creating a new card rule. When creating a card rule with a type that already exists, it will override the previous one.

Both partner and enduser can set a rule of the same type. The more restrictive one will be applied.

This operation might require SCA.

SecurityLinkcy-Auth
Request
path Parameters
cardId
required
string <uuid>
ruleType
required
string
Enum: "DAILY_MAX_SPEND" "MONTHLY_MAX_SPEND" "WEEKLY_MAX_SPEND" "DISABLE_CONTACTLESS" "DISABLE_ONLINE" … 7 more
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
Any of:
value
required
integer <int64> [ 1 .. 999999999 ]
name
string
endUserId
string <uuid>
creatorType
string
Enum: "END_USER" "PARTNER" "LINKCY"
Responses
202

Waiting SCA

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

put/api/partner/cards/{cardId}/rules/{ruleType}
Request samples
application/json
{
  • "value": 1,
  • "name": "string",
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "creatorType": "END_USER"
}
Response samples
application/json
{
  • "scaId": "b3cefad3-4f89-419b-8221-cc5050122ff3",
  • "joinCode": "0907af4a-d224-4ddb-a7ab-11c52f9fed47",
  • "ttl": {
    },
  • "scaDeviceId": "string"
}

Remove card rule

remove rule from card

This operation might require SCA.

SecurityLinkcy-Auth
Request
path Parameters
cardId
required
string <uuid>
ruleType
required
string
Enum: "DAILY_MAX_SPEND" "MONTHLY_MAX_SPEND" "WEEKLY_MAX_SPEND" "DISABLE_CONTACTLESS" "DISABLE_ONLINE" … 7 more
query Parameters
creatorType
string
Enum: "END_USER" "PARTNER" "LINKCY"
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.
Responses
202

Waiting SCA

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

delete/api/partner/cards/{cardId}/rules/{ruleType}
Request samples 
Response samples 
application/json
{
  • "scaId": "b3cefad3-4f89-419b-8221-cc5050122ff3",
  • "joinCode": "0907af4a-d224-4ddb-a7ab-11c52f9fed47",
  • "ttl": {
    },
  • "scaDeviceId": "string"
}
Create a default card profile ruleDeprecated
When creating a card with this profile, profile rules will by default be applied to the card.


Any modification on a rule type will ONLY apply to new created cards.


Any card created PRIOR to that modification will NOT be affected by it, and will retain all rules applied on creation.


SecurityLinkcy-Auth 
Request 
path Parameters
cardProfileId
required
string <uuid> 
 
Request Body schema: application/json
required
type
required
string
 Enum: "DAILY_MAX_SPEND" "MONTHLY_MAX_SPEND" "WEEKLY_MAX_SPEND" "DISABLE_CONTACTLESS" "DISABLE_ONLINE" … 7 more 
value
required
integer <int64>   [ 1 .. 999999999 ] 
 
name
string
 
creatorType
string
 Enum: "END_USER" "PARTNER" "LINKCY"  
Responses 
204
No Content


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


put/api/partner/card-profiles/{cardProfileId}/rules
Request samples 
application/json
{
  • "type": "DAILY_MAX_SPEND",
  • "value": 1,
  • "name": "string",
  • "creatorType": "END_USER"
}
Response samples 
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}
Create a default card profile rule
When creating a card with this profile, profile rules will by default be applied to the card.


Any modification on a rule type will ONLY apply to new created cards.


Any card created PRIOR to that modification will NOT be affected by it, and will retain all rules applied on creation.


SecurityLinkcy-Auth 
Request 
path Parameters
cardProfileId
required
string <uuid> 
 
ruleType
required
string
 Enum: "DAILY_MAX_SPEND" "MONTHLY_MAX_SPEND" "WEEKLY_MAX_SPEND" "DISABLE_CONTACTLESS" "DISABLE_ONLINE" … 7 more 
Request Body schema: application/json
required
Any of:
value
required
integer <int64>   [ 1 .. 999999999 ] 
 
name
string
 
endUserId
string <uuid> 
 
creatorType
string
 Enum: "END_USER" "PARTNER" "LINKCY"  
Responses 
204
No Content


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


put/api/partner/card-profiles/{cardProfileId}/rules/{ruleType}
Request samples 
application/json
{
  • "value": 1,
  • "name": "string",
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "creatorType": "END_USER"
}
Response samples 
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}
Remove default card profile rule
Remove a default card rule from card profile.


This only applies to cards created AFTER default rule deletion.


Any card created PRIOR to that modification will NOT be affected by it, and will retain all rules applied on creation.


SecurityLinkcy-Auth 
Request 
path Parameters
cardProfileId
required
string <uuid> 
 
ruleType
required
string
 Enum: "DAILY_MAX_SPEND" "MONTHLY_MAX_SPEND" "WEEKLY_MAX_SPEND" "DISABLE_CONTACTLESS" "DISABLE_ONLINE" … 7 more 
Responses 
204
No Content


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


delete/api/partner/card-profiles/{cardProfileId}/rules/{ruleType}
Request samples 
Response samples 
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}
List cards
Fetch all cards based on parameters. More options will be added in the near future.


SecurityLinkcy-Auth 
Request 
query Parameters
sortAttribute
string
 Value: "CREATION_DATE"  
endUserId
string <uuid> 
The ID of the end-user. If empty, the query will return results for all end-users.


 
ledgerId
string <uuid> 
The ID of the card ledger. If empty, the query will return cards for all ledgers.


 
profileId
string <uuid> 
The ID of the card profile. If empty, the query will return cards for all profiles.


 
status
Array of strings
Items Enum: "CREATING" "AWAITING_ACTIVATION" "ACTIVATING" "REACTIVATING" "ACTIVE" … 6 more 
types
Array of strings
Items Enum: "PHYSICAL" "VIRTUAL"  
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


get/api/partner/cards
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}
Create a card
Create a card for a specific ledger.


Please note: when creating the first card of a ledger, if the specified ledger is not empty, we will have to empty it briefly in order to configure the card.The money will be back in the ledger within a few seconds.


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
Any of:
deliveryMethod
required
string
 Enum: "FRENCH_MAIL" "FRENCH_MAIL_TRACKING" "INTERNATIONAL_MAIL"  
ledgerId
required
string <uuid> 
 
profileId
required
string <uuid> 
The card profile id. Must be an active card profile.


 
nameOnCard
string^[A-Z\s]{1,21}$
 Default:  "\"FIRSTNAME LASTNAME\" or \"CORPORATE NAME\""
The name that will be printed on the card : Consumer name for consumer cards or corporate name for Corporate cards.


Can only contain ISO basic Latin alphabet and can be up to 21 characters long including spaces.


 
cardholderNameOnCard
string^[A-Z0-9\s]{1,21}$
 Default:  "CORPORATE NAME"
Cardholder Name printed on card for corporate card. Can only contain ISO basic Latin alphabet, numbers and can be up to 21 characters long including spaces.


This name is only available when the card profile has a corporate card program.


 
friendlyName
string  [ 1 .. 255 ] characters 
 
Array of SpendLimitRuleDto (object) or PaymentDisableRuleDto (object) or MerchantsMultipleTargetsRuleDto (object) or MccMultipleTargetsRuleDto (object) or DaysMultipleTargetsRuleDto (object)
You can add rules when creating a card. You can only send one rule by type in the list.


As a partner, this rules take priority over the rules set in the profile


 
Responses 
201
Created


202
Waiting SCA


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


post/api/partner/cards
Request samples 
application/json
{
  • "deliveryMethod": "FRENCH_MAIL",
  • "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "nameOnCard": "\"FIRSTNAME LASTNAME\" or \"CORPORATE NAME\"",
  • "cardholderNameOnCard": "CORPORATE NAME",
  • "friendlyName": "string",
  • "rules": [
    ]
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Suspend a card
Suspend a card, all transactions on it will be blocked until it is reactivated.


SecurityLinkcy-Auth 
Request 
path Parameters
cardId
required
string
The card id


 
Request Body schema: application/json
required
operator
required
string (Operator) 
 Default:  "END_USER"
The entity initiating this operation.


 Enum: "END_USER" "PARTNER" "LINKCY"  
reason
string
Optional reason of the card suspension.


 Enum: "STOLEN" "LOST" "DAMAGED" "OTHER"  
otherReason
string  [ 0 .. 511 ] characters 
Description of reason if 'OTHER' was chosen.


 
Responses 
204
Card is being suspended


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


post/api/partner/cards/{cardId}/suspend
Request samples 
application/json
{
  • "operator": "END_USER",
  • "reason": "STOLEN",
  • "otherReason": "string"
}
Response samples 
application/json
{
  • "details": [
    ],
  • "errorCode": "OTHER_STATUS_REASON_MUST_HAVE_A_DESCRIPTION",
  • "error": "linkcy.bad.request",
  • "status": 400,
  • "timestamp": "2025-03-31T08:12:09.273547223Z"
}
Reset physical card's PIN attempts
Reset the number of PIN attempts for a physical card.


This operation might require SCA.


SecurityLinkcy-Auth 
Request 
path Parameters
cardId
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.
    • 

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





 
Responses 
202
Waiting SCA


204
Card PIN attempts are being reset


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


post/api/partner/cards/{cardId}/pin/reset
Request samples 
Response samples 
application/json
{
  • "scaId": "b3cefad3-4f89-419b-8221-cc5050122ff3",
  • "joinCode": "0907af4a-d224-4ddb-a7ab-11c52f9fed47",
  • "ttl": {
    },
  • "scaDeviceId": "string"
}
Close a card
Permanently close a card.


SecurityLinkcy-Auth 
Request 
path Parameters
cardId
required
string
The card id


 
Request Body schema: application/json
required
operator
required
string (Operator) 
 Default:  "END_USER"
The entity initiating this operation.


 Enum: "END_USER" "PARTNER" "LINKCY"  
reason
required
string
 Enum: "STOLEN" "LOST" "DAMAGED" "OTHER"  
otherReason
string  [ 0 .. 511 ] characters 
Description of reason if 'OTHER' was chosen.


 
Responses 
204
Card is being closed


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


post/api/partner/cards/{cardId}/close
Request samples 
application/json
{
  • "operator": "END_USER",
  • "reason": "STOLEN",
  • "otherReason": "string"
}
Response samples 
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}
Activate a card
When activating a card for the first time, you must retrieve its truncated PAN from the end-user. In Sandbox, you can retrieve the PAN here.


SecurityLinkcy-Auth 
Request 
path Parameters
cardId
required
string
The card id


 
Request Body schema: application/json
required
truncatedPan
string^[0-9]{4}$
Last 4 digits of the card. This value is only available when the card has been received by the end-user.


 
Responses 
204
Card is being activated


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


post/api/partner/cards/{cardId}/activate
Request samples 
application/json
{
  • "truncatedPan": "1111"
}
Response samples 
application/json
{
  • "details": [
    ],
  • "errorCode": "INVALID_PAN",
  • "error": "linkcy.bad.request",
  • "status": 400,
  • "timestamp": "2025-03-31T08:12:09.320318894Z"
}
List card profiles
Fetch all card profiles based on parameters.


SecurityLinkcy-Auth 
Request 
query Parameters
sortAttribute
string
 Value: "NAME"  
userTypes
Array of strings
Items Enum: "CORPORATE" "CONSUMER"  
ledgerTypes
Array of strings
Items Enum: "EUR_BELGIUM" "EUR_FRANCE" "EUR_ESTONIA" "EUR_LITHUANIA" "USD_USA" … 1 more 
cardTypes
Array of strings
Items Enum: "PHYSICAL" "VIRTUAL"  
active
boolean
 
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


get/api/partner/card-profiles
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}
Create a card profile
Create a card profile based on a card design.


SecurityLinkcy-Auth 
Request 
Request Body schema: application/json
required
name
required
string
 
cardDesignId
required
string <uuid> 
The card design identifier on which the new card profile will be based.


 
active
boolean
When active, end-users are able to see this profile and create card with it.


When disabled, it can not be used to create new cards anymore.


 
Responses 
201
Created


400
Bad Request


401
Unauthorized


403
Forbidden


post/api/partner/card-profiles
Request samples 
application/json
{
  • "name": "string",
  • "cardDesignId": "21f1b6eb-5662-41f7-952d-3d240b7c3aed",
  • "active": true
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Get card's information
Get all information about a card using its ID.


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


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


get/api/partner/cards/{cardId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
  • "profile": {
    },
  • "expiryDate": "string",
  • "nameOnCard": "string",
  • "cardholderNameOnCard": "string",
  • "friendlyName": "string",
  • "deliveryAddress": {
    },
  • "deliveryMethod": "UK_MAIL",
  • "deliveryShipmentDate": "2019-08-24",
  • "deliveryTrackingNumber": "string",
  • "truncatedPan": "string",
  • "type": "PHYSICAL",
  • "scheme": "MASTERCARD",
  • "currency": "EUR",
  • "status": {
    },
  • "suspensionsInformation": [
    ],
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "pinStatus": "LOCKED",
  • "rules": [
    ]
}
Update a card
You can patch a card to update some information.


SecurityLinkcy-Auth 
Request 
path Parameters
cardId
required
string <uuid> 
 
Request Body schema: application/json
required
friendlyName
string  [ 1 .. 255 ] characters 
 
object (PhoneRequestDto) 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


patch/api/partner/cards/{cardId}
Request samples 
application/json
{
  • "friendlyName": "string",
  • "phone": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Update a card profile
Patch a cardProfile.


SecurityLinkcy-Auth 
Request 
path Parameters
cardProfileId
required
string <uuid> 
 
Request Body schema: application/json
required
active
boolean
When active, end-users are able to see this profile and create card with it.


When disabled, it can not be used to create new cards anymore.


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


patch/api/partner/card-profiles/{cardProfileId}
Request samples 
application/json
{
  • "active": true
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Get a physical card's PIN
Get the PIN code of a card.


This operation might require SCA.


SecurityLinkcy-Auth 
Request 
path Parameters
cardId
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.
    • 

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





 
Responses 
200
OK


202
Waiting SCA


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


get/api/partner/cards/{cardId}/pin
Request samples 
Response samples 
application/json
{
  • "pin": "string"
}
Get PAN credentials
Get temporary PAN credentials for this card.


Credentials are valid for 60 seconds, after which you will need to request new credentials again.


This operation might require SCA.


SecurityLinkcy-Auth 
Request 
path Parameters
cardId
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.
    • 

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





 
Responses 
200
OK


202
Waiting SCA


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


get/api/partner/cards/{cardId}/pan/credentials
Request samples 
Response samples 
application/json
{
  • "token": "237733595",
  • "secret": "066#28055031",
  • "ttl": "PT8H6M12.345S"
}
List card designs
Fetch all card designs based on parameters.


SecurityLinkcy-Auth 
Request 
query Parameters
sortAttribute
string
 Value: "FRIENDLY_NAME"  
scheme
string
 Enum: "MASTERCARD" "VISA"  
ledgerType
string
 Enum: "EUR_BELGIUM" "EUR_FRANCE" "EUR_ESTONIA" "EUR_LITHUANIA" "USD_USA" … 1 more 
cardType
string
 Enum: "PHYSICAL" "VIRTUAL"  
userType
string
 Enum: "CORPORATE" "CONSUMER"  
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


get/api/partner/card-designs
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}
➔ Next to Acquiring