Skip to main content
The Klyme API reports back three status variables when a payment is authorised and executed: status, statusCode and description.

​
Description

Description illustrates the payment authorisation status with a given bank.
  • PENDING when the initiation request is still being processed.
  • COMPLETED when the initiation request has passed validation checks and been accepted by the bank. Settlement is expected to happen in due course (unless fraud checks fail).
  • FAILED when the bank has rejected the initiation request and the payment will not be processed further.

​
Status Code

The Status Code provides a more detailed and extensive view on the payment status. It’s primary use is after a payment has been successfully initiated. The Status Code can be used to track the payment through its execution lifecycle, all the way up to the final settlement into the payee’s account.
Please note that the provision and accuracy of Status Code values are determined by the banks themselves. In some cases, reporting may be limited or stop prematurely. Klyme simply transmits the data we receive from the banks and cannot influence or validate its completeness.

​
Status Codes Flow Diagram

status-codes-chart

​
Detailed Overview of Status Codes

Name: AcceptedCreditSettlementCompletedDescription: COMPLETEDExtended Description: Payment successfully processed. Settlement on the creditor’s account has been completed.Status: 1
Name: AcceptedWithoutPostingDescription: COMPLETEDExtended Description: Payment instruction included in the credit transfer is accepted without being settled to the creditor customer’s account.Status: 1
Name: AcceptedSettlementCompletedDescription: COMPLETEDExtended Description: Payment successfully processed. Settlement on the debtor’s account has been completed but not on the creditor’s account.Status: 1
Name: AcceptedSettlementInProcessDescription: PENDINGExtended Description: All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.Status: 2
Name: AcceptedFundsCheckedDescription: PENDINGExtended Description: Pre-ceeding check of technical validation and customer profile was successful and an automatic funds check was positive.Status: 2
Name: AcceptedCustomerProfileDescription: PENDINGExtended Description: Preceding checks of technical validation was successful. Customer profile check was also successful.Status: 2
Name: AcceptedWithChangeDescription: PENDINGExtended Description: Instruction is accepted but a change will be made, such as date or remittance not sent.Status: 2
Name: AcceptedTechnicalValidationDescription: PENDINGExtended Description: Authentication and syntactical and semantical validation are successful.Status: 2
Name: PartiallyAcceptedTechnicalCorrectDescription: PENDINGExtended Description: The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful.Status: 2
Name: PartiallyAcceptedDescription: PENDINGExtended Description: A number of transactions have been accepted, whereas another number of transactions have not yet achieved ‘accepted’ status. This code may be used only in case of bulk payments, where reporting is performed against the entire file.Status: 2
Name: PendingDescription: PENDINGExtended Description: Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.Status: 2
Name: ReceivedDescription: PENDINGExtended Description: Payment initiation has been received by the Institution.Status: 2
Name: RejectedDescription: FAILEDExtended Description: Payment initiation or individual transaction included in the payment initiation has been rejected.Status: 0
Name: CancelledDescription: FAILEDExtended Description: Payment initiation has been cancelled before execution.Status: 0

​
Status

The Status is computed based upon the combined logic of both Description and Status Code.
We recommend clients to focus on Status above all else when integrating Klyme.
  • Status of 1 implies the payment flow has been successful and the funds have left the users bank account.
  • Status of 0 implies the payment was rejected or failed due to technical issues on the banks side.
  • Status of 2 implies the payment is in a pending state and the customers bank has further checks to complete before the payment is authorised.
Please note that while status codes ACSC and ACWP are marked as 1, their settlement success rate is approximately 99%, compared to ACCC which settles at 100%. In most cases, payments with a status code of ACSC or ACWP will settle successfully, though in rare cases, reversals may occur. It is the client’s responsibility to determine how these two status codes are handled within their integration.
⌘I