LinkCy

Acquiring

Start an acquiring for a payment

Initiate an acquiring transaction for a payment. For testing purposes, use the following fake cards: Testing cards

SecurityLinkcy-Auth
Request
Request Body schema: application/json
required
amount
required
number
endUserId
string <uuid>
redirectUrl
string

Browser will load this URL once payment is completed and can be used to continue the payment journey.

The redirectUrl must be fully qualified for HTTP POST requests.

reference
string
storeCard
boolean

Needs to be set to true in order to register external card. Mandatory if amount is zero

externalCardId
string <uuid>

Id of the external card (required to start a direct payment/top-up).

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

post/api/partner/acquiring/payment
Request samples
application/json
{
  • "amount": 0,
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "redirectUrl": "string",
  • "reference": "string",
  • "storeCard": true,
  • "externalCardId": "fcafdf75-98d6-4bb8-9493-4b96e1b8a14c"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "webPage": {
    }
}

Start an acquiring for a top-up

Initiate an acquiring transaction for an account load. For testing purposes, use the following fake cards: Testing cards

SecurityLinkcy-Auth
Request
Request Body schema: application/json
required
amount
required
number
targetLedgerId
required
string <uuid>

Identifies the ledger that will be topped up

redirectUrl
string

Browser will load this URL once payment is completed and can be used to continue the payment journey.

The redirectUrl must be fully qualified for HTTP POST requests.

reference
string
storeCard
boolean

Needs to be set to true in order to register external card. Mandatory if amount is zero

endUserId
string <uuid>
externalCardId
string <uuid>

Id of the external card (required to start a direct payment/top-up).

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

post/api/partner/acquiring/account-load
Request samples
application/json
{
  • "amount": 0,
  • "targetLedgerId": "c08a7469-a75d-455d-a40f-2578815cd03c",
  • "redirectUrl": "string",
  • "reference": "string",
  • "storeCard": true,
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "externalCardId": "fcafdf75-98d6-4bb8-9493-4b96e1b8a14c"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "webPage": {
    }
}

List external cards

Fetch all external cards based on parameters

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.

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/external-cards
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}
Get acquiring transaction information
Get all information about an acquiring transaction using its ID.


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


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


get/api/partner/acquiring/transactions/{transactionId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "INTER_LEDGER",
  • "paymentType": "MONEY_TRANSFER",
  • "status": "APPROVED",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "currency": "EUR",
  • "information": {
    },
  • "sender": {
    },
  • "receiver": {
    }
}
➔ Next to Beneficiary