Transaction

List transactions

Fetch all 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)

ledgerId
string <uuid>

Get transactions made from or to this ledger (ledgerFrom / ledgerTo)

cardId
string <uuid>

Get transactions made from this card

transactionTypes
Array of strings (TransactionType)
Items Enum: "CARD_AUTHORIZATION" "CARD_CLEARING" "SEPA_DIRECT_DEBIT" "INTER_LEDGER" "ACQUIRING" … 4 more
paymentTypes
Array of strings
Items Enum: "MONEY_TRANSFER" "TECH_MVC_CREATION" "TECH_TRANSACTION" "TECH_VIRTUAL_TRANSFER" "ACCOUNT_LOAD" … 35 more
showReleasedTransaction
boolean

Get transactions in RELEASED status (card authorization), by default is true

showDeclinedTransaction
boolean

Get transactions in DECLINED and ABORTED 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" "DECLINED" "RELEASED" "REVERSED" "PENDING" … 3 more
pageSize
integer <int32> <= 100

The size of the page to be returned.

page
integer <int32> [ 0 .. 500 ]

The page number.

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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

get/api/partner/transactions
Request samples
Response samples
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}

Create a transaction to a beneficiary

Create a transaction between a ledger and a 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.
  • DATA_SIGNING: Linkcy-SCA-Signature header must contain signature provided by PowerAuth Mobile SDK on registered device.
  • BY_PASS: Sandbox only - will ignore any SCA if used.
Enum: "PUSH_NOTIFICATION" "DATA_SIGNING" "BY_PASS"
Linkcy-SCA-Signature
string

The signature that needs to be validated, it is generated from data signing.

More information:
  • Signature will be verified against wultra.
  • Operation will be denied if signature is not valide.
  • Avoid creating multiple signature at same time for the same registration.
  • Signature TTL is 30 sec.
Request Body schema: application/json
required
amount
required
number
beneficiaryId
required
string <uuid>
ledgerFromId
required
string <uuid>
reference
string [ 0 .. 60 ] characters ^[.'a-zA-ZÀ-ÿ0-9,_? /-]*$

Reference of the transaction. If null, default reference will be 'Transfer'.

allowFastPayment
boolean
Default: true

If for any reason you do not want want to allow fast payment, (ie: want to use EU_SEPA_STEP2 over EU_SEPA_INSTANT), you can set this field to false. In sandbox, GBP transactions are always in fast payment and EUR transactions are always in normal payment.

allowInterLedger
boolean
Default: true

If Linkcy detect a possible inter-ledger operation, Linkcy automatically perform this inter-ledger operation. However, if you do not want to, you can set this field to false

Responses
201

Created

202

Waiting SCA

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/api/partner/transactions
Request samples
application/json
{
  • "amount": 0,
  • "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
  • "ledgerFromId": "b595c981-8a0f-4604-a66c-209d65193394",
  • "reference": "string",
  • "allowFastPayment": true,
  • "allowInterLedger": true
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Create an inter-ledger transaction

Create a transaction between ledgers of two of your end-users.

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.
  • DATA_SIGNING: Linkcy-SCA-Signature header must contain signature provided by PowerAuth Mobile SDK on registered device.
  • BY_PASS: Sandbox only - will ignore any SCA if used.
Enum: "PUSH_NOTIFICATION" "DATA_SIGNING" "BY_PASS"
Linkcy-SCA-Signature
string

The signature that needs to be validated, it is generated from data signing.

More information:
  • Signature will be verified against wultra.
  • Operation will be denied if signature is not valide.
  • Avoid creating multiple signature at same time for the same registration.
  • Signature TTL is 30 sec.
Request Body schema: application/json
required
ledgerFromId
required
string <uuid>
ledgerToId
required
string <uuid>
amount
required
number
reference
string [ 0 .. 60 ] characters ^[.'a-zA-ZÀ-ÿ0-9,_? /-]*$

Reference of the transaction. If null, default reference will be 'Transfer'.

Responses
201

Created

202

Waiting SCA

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/api/partner/transactions/inter-ledger
Request samples
application/json
{
  • "ledgerFromId": "b595c981-8a0f-4604-a66c-209d65193394",
  • "ledgerToId": "7280fced-5334-43dd-8913-9f06bb46b488",
  • "amount": 0,
  • "reference": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Create a direct debit transaction

Create a SEPA Direct Debit transaction. The ledger and the mandate must be activated.

If the mandate is not recurring, only one transaction will be allowed.

SecurityLinkcy-Auth
Request
Request Body schema: application/json
required
mandateId
required
string <uuid>
ledgerToId
required
string <uuid>
date
required
string <date>

The date on which the direct debit must be executed. Cannot be earlier than D+2 and must be a working day (neither weekend nor public holiday).

amount
required
number
reference
required
string [ 0 .. 60 ] characters ^[.'a-zA-ZÀ-ÿ0-9,_? /-]*$

Reference of the transaction. If null, default reference will be 'Transfer'.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/api/partner/transactions/direct-debit
Request samples
application/json
{
  • "mandateId": "d4dbf0da-b5aa-43ae-b9db-c2aff331d3ad",
  • "ledgerToId": "7280fced-5334-43dd-8913-9f06bb46b488",
  • "date": "2019-08-24",
  • "amount": 0,
  • "reference": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get transaction's information

Get all information about a 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

409

Conflict

get/api/partner/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": {
    }
}

Get a transaction receipt

Create a receipt for a transaction using its ID. File generated is in pdf format.

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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

get/api/partner/documents/transaction-receipt/{transactionId}
Request samples
Response samples
application/json
{
  • "url": "string",
  • "ttl": "PT8H6M12.345S"
}