API Reference

Credit Transfers

Credit transfers represent regular payments that can be made from LYNKS. They follow the workflow that has been configured in your tenant, so you'll be able to retrieve the current status of the credit transfer and the completed and missing authorizations that have been done and that are still missing.

Status

The following credit transfer statuses are available:

  • DRAFT - the credit transfer has been created by not yet sent for authorization
  • WAITING_FOR_SIGNATURES - the credit transfer was sent for authorization, but not all authorizations have been received
  • PENDING_DELIVERY_TO_BANK - the credit transfer is authorized by all signatories, and is going to be sent to the bank at the next opportunity
  • REJECTED_BY_SIGNATORY - the credit transfer was rejected by a signatory during the signing process
  • WAITING_MANUAL_TRANSFER_TO_BANK - the credit transfer is waiting to be manually sent to the bank
  • CANCELLED - the credit transfer was cancelled by the user at any stage before sending to the bank, or by the system if the ordering account or counterparty was deactivated or rejected.
  • PENDING_EXECUTION_BY_BANK - the credit transfer has been sent and acknowledged by the bank and is currently being executed
  • FAILED - the credit has been manually transferred to the REJECTED_BY_BANK status after confirmation from the bank, or if LYNKS has detected a refund of a credit transfer
  • NOT_EXECUTED_BY_BANK - the credit transfer was not acknowledge by the bank
  • EXECUTED - the credit transfer execution was confirmed by the bank

State chart

A credit transfer can transition from one status to another according to the state chart below.

Charge details

  • CRED - All transaction charges are to be borne by the Creditor.
  • DEBT - All transaction charges are to be borne by the Debtor.
  • SHAR - Charges applied by Debtor and Creditor Bank are charged respectively to Debtor and Creditor. Non SEPA transactions only.
  • SLEV - For SEPA transactions it is the only value allowed. Charges applied by Debtor and Creditor Bank are charged respectively to Debtor and Creditor.

Urgency

  • URGENT - Transaction to be processed with urgency (might incur in extra fees)
  • NORMAL - Transaction to be treated normally without urgency