Transaction

List transactions

Fetch all transactions.

SecurityLinkcy-Auth
Request
query Parameters
sortAttribute
string
Value: "CREATION_DATE"
endUserId
string <uuid>
ledgerId
string <uuid>
cardId
string <uuid>
transactionTypes
Array of strings (TransactionType)
Items Enum: "CARD_AUTHORIZATION" "CARD_CLEARING" "INTER_LEDGER" "DEBIT_PAYMENT_SEND" "DEBIT_SEND" "FX" "MANUAL_CREDIT" "MANUAL_DEBIT" "OUTSTANDING_BALANCE_REPAYMENT" "RECEIVE" "SEND" "VIRTUAL_DEBIT_CARD_DEBIT" "UNKNOWN"
showReleasedTransaction
boolean
showDeclinedTransaction
boolean
startDate
string <date-time>
endDate
string <date-time>
pageSize
integer <int32> [ 0 .. 100 ]
Default: 20

The size of the page to be returned.

page
integer <int32> >= 0
Default: 0

The page number.

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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

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.

SecurityLinkcy-Auth
Request
Request Body schema: application/json
amount
required
number
beneficiaryId
required
string <uuid>
ledgerFromId
required
string <uuid>
reference
string [ 0 .. 18 ] characters ^[.'a-zA-ZÀ-ÿ0-9,? ]*$
allowFastPayment
required
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
required
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

400

Bad Request

401

Unauthorized

403

Forbidden

409
500

Internal Server Error

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.

SecurityLinkcy-Auth
Request
Request Body schema: application/json
ledgerFromId
required
string <uuid>
ledgerToId
required
string <uuid>
amount
required
number
reference
string [ 0 .. 18 ] characters ^[.'a-zA-ZÀ-ÿ0-9,? ]*$
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409
500

Internal Server Error

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"
}

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

500

Internal Server Error

get/api/partner/transactions/{transactionId}
Request samples
Response samples
application/json
{
  • "id": "40662b88-d158-48b9-bf7c-eb4b59975ac6",
  • "type": "DEBIT_PAYMENT_SEND",
  • "paymentType": "AU_NPP",
  • "status": "APPROVED",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "currency": "EUR",
  • "information": {
    },
  • "sender": {
    },
  • "receiver": {
    }
}