LinkCy

Partner

List user accounts

List all user accounts of the specified partner.

SecurityLinkcy-Auth
Request
query Parameters
sortAttribute
string
Value: "EMAIL"
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/accounts
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}
Create user account
Create a partner user account.


SecurityLinkcy-Auth 
Request 
Request Body schema: application/json
required
Any of:
email
required
string
 
roles
required
Array of strings (LinkcyRole)   unique 
List of roles to give to the created user. Connected user can only give roles present in its JWT.


Items Enum: "ACCOUNT_CREATE" "BANKING_DETAILS_DOCUMENT_EXPORT" "BENEFICIARY_CREATE" "BENEFICIARY_INFO" "BENEFICIARY_LIST" … 95 more 
Responses 
201
Created


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


post/api/partner/accounts
Request samples 
application/json
{
  • "email": "string",
  • "roles": [
    ]
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "otp": "string"
}
Get your information
Get your configuration information as partner.


SecurityLinkcy-Auth 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


get/api/partner
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "displayName": "string",
  • "logoUrl": "string",
  • "address": {
    },
  • "consumerOtpMessage": "string",
  • "corporateOtpMessage": "string",
  • "emailProperties": {
    },
  • "contactInformation": {
    },
  • "limits": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z"
}
Update your information
Update your configuration information as Partner.


SecurityLinkcy-Auth 
Request 
Request Body schema: application/json
required
object (EuropeanAddressRequest) 
Address that will be used on the bank statements of your users.


 
consumerOtpMessage
string
Message that will be displayed when requesting a OTP message. You must include the following place holder: "$otp" where you want to display the OTP secret.


If not set, the default message is: "Your {partnerName} secret to change your password is: {secret} If you are not at the origin of this message, you can ignore it."


 
corporateOtpMessage
string
Message that will be displayed when requesting a OTP message. You must include the following place holder: "$otp" where you want to display the OTP secret.


If not set, the default message is: "Your {partnerName} secret to change your password is: {secret} If you are not at the origin of this message, you can ignore it."


 
displayName
string
Name display on documents.


 
logoUrl
string
Url that provides the logo.


 
object (ContactInformation_Partner) 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


patch/api/partner
Request samples 
application/json
{
  • "address": {
    },
  • "consumerOtpMessage": "string",
  • "corporateOtpMessage": "string",
  • "displayName": "string",
  • "logoUrl": "string",
  • "contactInformation": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updateDate": "2019-08-24T14:15:22Z"
}
Update user account
Update a partner user account.


SecurityLinkcy-Auth 
Request 
path Parameters
accountId
required
string <uuid> 
 
Request Body schema: application/json
required
Any of:
roles
required
Array of strings (LinkcyRole)   unique 
List of roles to give to the created user. Connected user can only give roles present in its JWT.


Items Enum: "ACCOUNT_CREATE" "BANKING_DETAILS_DOCUMENT_EXPORT" "BENEFICIARY_CREATE" "BENEFICIARY_INFO" "BENEFICIARY_LIST" … 95 more 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


patch/api/partner/accounts/{accountId}
Request samples 
application/json
{
  • "roles": [
    ]
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updateDate": "2019-08-24T14:15:22Z"
}
Get your acquiring configuration
Get your acquiring configuration information.


SecurityLinkcy-Auth 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


get/api/partner/acquiring-configuration
Request samples 
Response samples 
application/json
{
  • "saleMerchantId": "string",
  • "recurringSaleMerchantId": "string",
  • "loadMerchantId": "string",
  • "recurringLoadMerchantId": "string",
  • "saleLedgerId": "7c9baf3d-1dd4-4bcc-8ea2-e16acc7b3405",
  • "loadLedgerId": "c6604c79-9922-41d2-b00b-5fa26e6d7c23",
  • "loadRateFee": 0,
  • "loadFlatFee": 0,
  • "minLoad": 0,
  • "maxLoad": 0
}
➔ Next to Webhook