Skip to main content

Values

  • SCHEDULED

    The payment has been scheduled for collection and the customer has been notified. While a payment is scheduled, it can still be deleted.

  • PENDING

    The payment has been submitted. From this point it cannot be altered.

  • CLEARED

    The payment has been approved by the merchant and added to your Kraken account.

  • FAILED

    The payment failed permanently.

  • PROMISED

    A payment promise has been created, but it has not left the customers bank account.

  • FULFILLED

    The payment has been made successfully and applied to the Kraken balance.

  • PROMISE_BROKEN

    The payment promise has been broken.

  • HISTORIC

    Payments made in a previous system and then imported into Kraken.

  • THIRD_PARTY

    Third Party payments are those recorded for financial purposes in a different system but should be added to statements.

  • REQUESTED

    The initial state of a payment in Kraken. It should be scheduled with a payment vendor in the future.

  • DELETED

    This payment was deleted. From this point it cannot be altered.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

"SCHEDULED"