Model¶

PaymentInstruction¶

A PaymentInstruction is the first object that you need to create. It contains information such as the total amount, the payment method, the currency, and any data that is necessary for the payment method, for example credit card information.

Below you find the different states that a PaymentInstruction can go through:

digraph PaymentInstruction_State_Flow { "New" -> "Valid"; "New" -> "Invalid"; "Valid" -> "Closed"; }

Payment¶

Each PaymentInstruction may be split up into several payments. A Payment always holds an amount, and the current state of the workflow, such as initiated, approved, deposited, etc.

This allows, for example, to request a fraction of the total amount to be deposited before an order ships, and the rest afterwards.

Below, you find the different states that a Payment can go through:

digraph Payment_State_Flow { "New" -> "Canceled" "New" -> "Approving" "Approving" -> "Approved" "Approving" -> "Failed" "Approved" -> "Depositing" "Depositing" -> "Deposited" "Depositing" -> "Expired" "Depositing" -> "Failed" }

FinancialTransaction¶

Each Payment may have several transactions. Each FinancialTransaction represents a specific interaction with the payment backend. In the case of a credit card payment, this could for example be an authorization transaction.

Below, you find the different states that a FinancialTransaction can go through:

digraph Financial_Transaction_State_Flow { "New" -> "Pending" "New" -> "Failed" "New" -> "Success" "New" -> "Canceled" "Pending" -> "Failed" "Pending" -> "Success" }