Simulate credit (sandbox only)

The credit endpoint allows to simulate an incoming payment from a third party to a chosen account.

Payment lifecycle

After successful creation, the payment will follow the same lifecycle as a payment in production.

In other words, it will appear in reports, in relevant endpoints (e.g. GET /api/v1/payments/singles) and trigger notifications if set up (e.g. IncomingPaymentBooked and IncomingPaymentProcessed)

Payment rails

You can simulate which payment rail is used to make the payment by setting the scheme parameter. The following options are currently supported.

For EUR payments:

SEPA - SEPA Credit Transfer
SEPAINST - SEPA Instant Credit Transfer
SEPA_DD - SEPA Direct Debit

For GBP payments:

FPS - Faster Payment Scheme
BACS_DD - BACS Direct Debit

Note: the currency field must match the scheme currency, otherwise the endpoint will return a validation error.

FX conversions

To simulate an FX conversion, simply select a creditorAccount that has a different currency than the scheme / amount currency set. This will result in the payment being converted on receipt.

Finding the payment after creation

To easily find a payment after creation, use the remittanceInformationLine1 field which is returned in the 200 success response.

Note: due to system limitations, we cannot immediately return a payment ID or transaction reference