A Payment Object represents a incoming or going payment from one of your wallets. Payment objects can have one of three types:
TRANSFER: This is a payment between two wallets, e.g. SPLIT to VENDOR.
PAY_IN: This is a payment from an external source to one of your Virtual IBANs e.g. your acquirer making a payment to your split wallet.
WITHDRAWAL: This is a payment from one of your wallets to an external IBAN. e.g. Vendor payout to their bank account.
One of the three above-mentioned types will automatically be added to all payment objects created. When creating a new Payment Object the sending account (the payer) and receiving account (the payee) should be specified.
A detailed overview of the payment flow can be seen in How ZTLment works.
For regulatory compliance reasons all Payment Objects where the payee is configured to allow payouts (e.g. Vendor wallets) a signature via the ZTLment Authentication App is required. Newly created Payment Objects will immediately appear on the payer’s dashboard, there you can see if further conditions must be completed e.g. dashboard approval or signing via the ZTLment Authentication App.
If you are making a payment and want to provide supporting documentation please use the following endpoint Create Payment Objects with Supporting Docs.
Payment Object States
Below is an overview of the different states a payment object can have. You can set up webhooks to receive notifications in your application whenever a PaymentObject changes state, or when new ones are created as described in the Webhooks page.
PENDING - Payment awaiting conditions to be met for the payment can be sent for execution .e.g signing.
INITIATED_PAYMENT - The ZTLment backend has registered the payment in our internal system.
PROCESSING_PAYMENT - Payment has been sent for processing via bank partner.
PROCESSED - Payment is confirmed processed from our banking partner.
REJECTED_COMPLIANCE - Rejected via our compliance provider.
REJECTED_APPROVAL - Payment was rejected via the dashboard.
REJECTED_SIGNING - Payment has been rejected via the ZTLment authenticator native app.
FAILED - Payment has failed.
REVERSED - In very rare scenarios payments that have been PROCESSED can be reversed. In this case the funds will be returned to your account.
