Incoming payments

An incoming payment represents a credit to your account. These payments can come from various sources, such as customer payments, transfers from other accounts, direct debit collections (where you collect money from third parties via direct debit), or returns initiated by the recipient's financial institution due to issues like invalid account details.

Payment Status

Incoming payments will appear in your account with a status of processed once they have been successfully received and credited to your account.

Webhook Notifications

To help you track incoming payments in real-time, we provide webhook notifications for key events:

  • IncomingPaymentProcessed: Triggered when an incoming payment has been successfully processed and credited to your account
  • IncomingPaymentBooked: Triggered when the incoming payment has been booked in our ledger

To learn more about setting up and using webhooks, please refer to our Webhooks documentation.

Returning an Incoming Payment

While incoming payments can be returned, this process must be initiated through our support team. If you need to return an incoming payment, please contact us with:

  • The payment reference
  • The reason for the return
  • Any additional relevant information

We will assist you with processing the return according to the applicable scheme rules and timeframes.

Testing with the Payment Simulator

When working in the sandbox environment, you can use our payment simulator to test some incoming payment scenarios. This allows you to:

  • Simulate incoming payments with different amounts and reference information
  • Test your webhook handling for incoming payment events
  • Validate your reconciliation processes