FinLego for developers
  1. Payments
FinLego for developers
  • FinLego Core Banking
    • Services REST API
      • ClientProfile - FrontOffice
        • Client
          • /Client
          • /Client/deletion-notifications
      • ClientProfile - System
        • Clients
          • /internal/Clients
          • /internal/Clients
          • /internal/Clients/{clientId}/block
          • /internal/Clients/{clientId}/unblock
          • /internal/Clients/{clientId}
          • /internal/Clients/{clientId}
        • Documents
          • /internal/Clients/{clientId}/Documents/upload
          • /internal/Clients/{clientId}/Documents/{documentId}/download
          • /internal/Clients/{clientId}/Documents
          • /internal/Clients/{clientId}/Documents/{documentId}
      • GeneralLedger - System (1)
        • Accounts
          • /Accounts
          • /v2/internal/Accounts
          • /Accounts
          • /v2/internal/Accounts/recalculate
          • /Accounts/{id}
          • /internal/Accounts/calculateBalances
          • /Accounts/{id}
          • /v2/ledger/internal/Accounts/{accountId}
          • /Accounts/{id}
          • /v2/ledger/internal/Accounts/search
          • /Accounts/send-otp
          • /v2/ledger/internal/Accounts/getAggregatedAmounts
          • /Accounts/otp-verification
          • /Accounts/{accountNumber}
          • /Accounts/reorder-accounts
        • Transactions
          • Transactions by filter
          • /internal/Transactions/{id}
          • /internal/Transactions
          • /internal/Transactions/query
          • /internal/Transactions/report
        • BaasProvider
          • /BaasProvider/available-currencies
        • BackgroundJob
          • /internal/BackgroundJob/AccountBalanceCheckJob
        • DailyAccountBalance
          • /internal/DailyAccountBalance
          • /internal/DailyAccountBalance/recalculate
        • DailyCheck
          • /internal/DailyCheck
          • /internal/DailyCheck/details
        • Reports
          • /internal/Reports/ReconciliationReport
        • TreasuryManagement
          • /internal/TreasuryManagement/summary
        • Payments
          • Creates payment with single transaction and transfers money between accounts
            POST
          • Creates payment in Draft state without any money transfers
            POST
          • Pends payment and holds funds in case of withdrawals
            POST
          • Posts payment, withdraws held funds and deposits it to corresponding account
            POST
          • Cancels payment and performs payback in case of held
            POST
      • GeneralLedger - System (2)
        • Accounts
          • /v2/internal/Accounts
          • /v2/internal/Accounts/recalculate
          • /internal/Accounts/calculateBalances
          • /v2/ledger/internal/Accounts/{accountId}
          • /v2/ledger/internal/Accounts
          • /v2/ledger/internal/Accounts/getAggregatedAmounts
        • Payments
          • Creates payment with single transaction and transfers money between accounts
          • Creates payment in Draft state without any money transfers
          • Pends payment and holds funds in case of withdrawals
          • Posts payment, withdraws held funds and deposits it to corresponding account
          • Cancels payment and performs payback in case of held
      • TransferOrchestrator - FrontOffice
        • Confirmations
          • Generate a new confirmation code for the specified transfer.
        • Documents
          • Downloads a document by its file name.
        • Recipients
          • Fetch recipients based on the specified filters.
          • Fetch recipients based on the specified filters.
          • Add a recipient.
          • Fetch recipient details by the specified recipient identifier.
          • Fetch recipient details by the specified recipient identifier.
          • Update the visibility details of a recipient.
        • Transfers
          • Fetch transfers based on the specified filters.
          • Fetch transfers based on the specified filters.
          • Fetch transfer details by the specified transfer identifier.
          • Fetch transfer details by the specified transfer identifier.
          • Create an outgoing transfer.
          • Fetch outgoing transfer details by the specified transfer identifier.
          • Confirm an outgoing transfer.
          • Fetch incoming transfer details by the specified transfer identifier.
          • Cancel an outgoing transfer by the transfer identifier.
          • Fetch foreign exchange transfer details by the specified transfer identifier.
          • Fetch outgoing transfer details by the specified transfer identifier.
          • Fetch incoming transfer details by the specified transfer identifier.
          • Create a foreign exchange transfer.
          • Confirm an outgoing transfer.
          • Cancel an outgoing transfer by the transfer identifier.
          • Fetch foreign exchange transfer details by the specified transfer identifier.
          • Fetch a transfer type by recipient account and currency.
      • TransferOrchestrator - System (1)
        • Documents
          • Downloads a document by its file name and client identifier.
        • IncomingRequests
          • Fetch internal requests based on the specified filters.
          • process a transfer manually.
        • Recipients
          • Add a recipient.
        • Transfers
          • Fetch internal transfers based on the specified filters.
          • Fetch outgoing transfer details by the specified transfer identifier.
          • Fetch incoming transfer details by the specified transfer identifier.
          • Assign an unrecognized incoming transfer.
          • Fetch foreign exchange transfer details by the specified transfer identifier.
          • Execute a transfer manually.
          • Continue processing of an outgoing transfer.
          • Fetch outgoing transfers based on the specified filters.
          • Fetch incoming transfers based on the specified filters.
          • Fetch foreign exchange transfers based on the specified filters.
      • TransferOrchestrator - System (2)
        • Recipients
          • Add a system recipient.
        • Transfers
          • /internal/integration/Transfers/outgoing
          • /internal/integration/Transfers/outgoing/payment-request
  • Onboarding Integration
    • ClientsImport
      • Imports a new individual client from an integrated WL customer's onboarding system
      • Imports a new company client from an integrated WL customer's onboarding system
    • SumsubWebhooks
      • /integration/sumsub-webhooks/update-state
      • Simulates a verification response.
  1. Payments

Cancels payment and performs payback in case of held

POST
/internal/Payments/{paymentId}/cancel
Payments

Request

Path Params
paymentId
string <uuid>
required
Payment identifier

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/internal/Payments//cancel'

Responses

🟢200OK
application/json
Body
paymentId
string <uuid>
required
parentId
string <uuid>
required
parentType
enum<string> 
required
Allowed values:
transferpaymentRequestadjustingPayment
transactions
array[object (Bank.GeneralLedger.Dto.Transaction.TransactionDto) {15}] 
required
id
string <uuid>
optional
paymentId
string <uuid>
optional
parentId
string <uuid> | null 
optional
parentType
enum<string> 
optional
Allowed values:
transferpaymentRequestadjustingPayment
debtorAccountId
string <uuid>
optional
debtorAccountNumber
string 
optional
creditorAccountId
string <uuid>
optional
creditorAccountNumber
string 
optional
currency
enum<string> 
optional
Allowed values:
cadcnydkknoksekchfgbpusdeurpln
amount
number <double>
optional
state
enum<string> 
optional
Allowed values:
draftpendingpostedcancelederror
stateReason
string  | null 
optional
createdDate
string <date-time>
optional
postedDate
string <date-time> | null 
optional
stateChanges
array[object (Bank.GeneralLedger.Dto.Transaction.StateChangesDto) {4}] 
optional
Example
{
    "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
    "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
    "parentType": "transfer",
    "transactions": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
            "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
            "parentType": "transfer",
            "debtorAccountId": "d9695c4c-f4a8-4c4e-b1b1-0b2201504693",
            "debtorAccountNumber": "string",
            "creditorAccountId": "0411bd28-c6c2-4498-8a47-b18d967449d7",
            "creditorAccountNumber": "string",
            "currency": "cad",
            "amount": 0,
            "state": "draft",
            "stateReason": "string",
            "createdDate": "2019-08-24T14:15:22Z",
            "postedDate": "2019-08-24T14:15:22Z",
            "stateChanges": [
                {
                    "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
                    "from": "draft",
                    "to": "draft",
                    "timestamp": "2019-08-24T14:15:22Z"
                }
            ]
        }
    ]
}
🟠400Bad Request
🟠404Not Found
🟠422Unprocessable Content
🔴500Internal Server Error
Previous
Posts payment, withdraws held funds and deposits it to corresponding account
Next
/v2/internal/Accounts
Built with