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.
Waiting SCA
No Content
Bad Request
Unauthorized
Forbidden
Not Found
{- "type": "DAILY_MAX_COUNT",
- "value": 1,
- "name": "string"
}
{- "scaId": "b3cefad3-4f89-419b-8221-cc5050122ff3",
- "joinCode": "0907af4a-d224-4ddb-a7ab-11c52f9fed47",
- "ttl": {
- "seconds": 0,
- "nano": 0,
- "negative": true,
- "zero": true,
- "units": [
- {
- "dateBased": true,
- "timeBased": true,
- "durationEstimated": true
}
]
}, - "scaDeviceId": "string"
}
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.
No Content
Bad Request
Unauthorized
Forbidden
Not Found
{- "type": "DAILY_MAX_COUNT",
- "value": 1,
- "name": "string"
}
{- "status": 400,
- "details": [
- {
- "field": "name",
- "rejectedValue": "John Doe 56",
- "message": "Name must contains only letters"
}
], - "error": "linkcy.bad.request",
- "timestamp": "2019-08-24T14:15:22Z"
}
Fetch all cards based on parameters. More options will be added in the near future.
OK
Bad Request
Unauthorized
Forbidden
{- "content": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
- "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
- "friendlyName": "string",
- "profile": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "expiryDate": "string",
- "nameOnCard": "string",
- "type": "PHYSICAL",
- "status": "CREATED",
- "creationDate": "2019-08-24T14:15:22Z"
}
], - "totalElements": 1,
- "page": 0,
- "pageSize": 0
}
Create a card for a specific ledger.
This operation might require SCA.
Created
Waiting SCA
Bad Request
Unauthorized
Forbidden
Conflict
{- "deliveryMethod": "UK_MAIL",
- "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
- "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
- "nameOnCard": "FIRSTNAME LASTNAME",
- "friendlyName": "string",
- "rules": [
- {
- "type": "DAILY_MAX_COUNT",
- "value": 1,
- "name": "string"
}
]
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Suspend a card, all transactions on it will be blocked until it is reactivated.
Card is being suspended
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
{- "operator": "END_USER",
- "reason": "STOLEN",
- "otherReason": "string"
}
{- "status": 400,
- "details": [
- {
- "field": "name",
- "rejectedValue": "John Doe 56",
- "message": "Name must contains only letters"
}
], - "error": "linkcy.bad.request",
- "timestamp": "2019-08-24T14:15:22Z"
}
Reset the number of PIN attempts for a physical card.
This operation might require SCA.
Waiting SCA
Card PIN attempts are being reset
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
{- "scaId": "b3cefad3-4f89-419b-8221-cc5050122ff3",
- "joinCode": "0907af4a-d224-4ddb-a7ab-11c52f9fed47",
- "ttl": {
- "seconds": 0,
- "nano": 0,
- "negative": true,
- "zero": true,
- "units": [
- {
- "dateBased": true,
- "timeBased": true,
- "durationEstimated": true
}
]
}, - "scaDeviceId": "string"
}
Permanently close a card.
Card is being closed
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
{- "operator": "END_USER",
- "reason": "STOLEN",
- "otherReason": "string"
}
{- "status": 400,
- "details": [
- {
- "field": "name",
- "rejectedValue": "John Doe 56",
- "message": "Name must contains only letters"
}
], - "error": "linkcy.bad.request",
- "timestamp": "2019-08-24T14:15:22Z"
}
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.
Card is being activated
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
{- "truncatedPan": "1111"
}
{- "errorCode": "INVALID_PAN",
- "status": 400,
- "details": [
- {
- "field": "name",
- "rejectedValue": "John Doe 56",
- "message": "Name must contains only letters"
}
], - "error": "linkcy.bad.request",
- "timestamp": "2019-08-24T14:15:22Z"
}
Fetch all card profiles based on parameters.
OK
Bad Request
Unauthorized
Forbidden
{- "content": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "scheme": "MASTERCARD",
- "ledgerType": "EUR_ESTONIA",
- "cardType": "PHYSICAL",
- "userType": "CORPORATE",
- "active": true,
- "program": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "design": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "rules": [
- {
- "type": "DAILY_MAX_COUNT",
- "name": "string",
- "value": 0
}
]
}
], - "totalElements": 1,
- "page": 0,
- "pageSize": 0
}
Create a card profile based on a card design.
Created
Bad Request
Unauthorized
Forbidden
{- "name": "string",
- "cardDesignId": "21f1b6eb-5662-41f7-952d-3d240b7c3aed",
- "active": true
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Get all information about a card using its ID.
OK
Bad Request
Unauthorized
Forbidden
Not Found
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
- "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
- "profile": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "expiryDate": "string",
- "nameOnCard": "string",
- "friendlyName": "string",
- "deliveryAddress": {
- "isoCountryCode": "ABW",
- "city": "string",
- "postalCode": "string",
- "street": "string",
- "number": "string",
- "refinement": "string",
- "stateOrProvince": "string",
- "status": "INVALID"
}, - "deliveryMethod": "UK_MAIL",
- "truncatedPan": "string",
- "type": "PHYSICAL",
- "scheme": "MASTERCARD",
- "currency": "EUR",
- "status": {
- "value": "CREATED",
- "reason": "STOLEN",
- "otherReason": "string",
- "operator": "END_USER"
}, - "creationDate": "2019-08-24T14:15:22Z",
- "updateDate": "2019-08-24T14:15:22Z",
- "pinStatus": "LOCKED",
- "rules": [
- {
- "type": "DAILY_MAX_COUNT",
- "name": "string",
- "value": 0,
- "creator": "END_USER",
- "counter": 0
}
]
}
You can patch a card to update some information.
OK
Bad Request
Unauthorized
Forbidden
Not Found
{- "friendlyName": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Patch a cardProfile.
OK
Bad Request
Unauthorized
Forbidden
Not Found
{- "active": true
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Get the PIN code of a card.
This operation might require SCA.
OK
Waiting SCA
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
{- "pin": "string"
}
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.
OK
Waiting SCA
Bad Request
Unauthorized
Forbidden
Not Found
{- "token": "237733595",
- "secret": "066#28055031",
- "ttl": "PT8H6M12.345S"
}
Fetch all card designs based on parameters.
OK
Bad Request
Unauthorized
Forbidden
{- "content": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "friendlyName": "string",
- "scheme": "MASTERCARD",
- "ledgerType": "EUR_ESTONIA",
- "cardType": "PHYSICAL",
- "userType": "CORPORATE",
- "availableCountries": [
- "ABW"
]
}
], - "totalElements": 1,
- "page": 0,
- "pageSize": 0
}
remove rule from card
This operation might require SCA.
Waiting SCA
No Content
Bad Request
Unauthorized
Forbidden
Not Found
{- "scaId": "b3cefad3-4f89-419b-8221-cc5050122ff3",
- "joinCode": "0907af4a-d224-4ddb-a7ab-11c52f9fed47",
- "ttl": {
- "seconds": 0,
- "nano": 0,
- "negative": true,
- "zero": true,
- "units": [
- {
- "dateBased": true,
- "timeBased": true,
- "durationEstimated": true
}
]
}, - "scaDeviceId": "string"
}
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.
No Content
Bad Request
Unauthorized
Forbidden
Not Found
{- "status": 400,
- "details": [
- {
- "field": "name",
- "rejectedValue": "John Doe 56",
- "message": "Name must contains only letters"
}
], - "error": "linkcy.bad.request",
- "timestamp": "2019-08-24T14:15:22Z"
}