Payment Simulation

The Payment Simulation allows partners to simulate inbound payment messages across various payment rails, including Faster Payments, BACS, CHAPS, and internal payment systems.

This API enables testing and validation of payment flows without processing real transactions. By initiating simulated payments, partners can verify integration, ensure correct handling of different payment types, and troubleshoot potential issues before going live. This tool is crucial for development and quality assurance in a controlled, risk-free environment.

Please note that this API only valid for non-production environments.

The payload for the source counterparty in the Payment Simulation API must include valid details that align with the chosen simulated payment rail.

For example, when simulating a payment via Faster Payments, the source counterparty must provide an account number and sort code that pass the UK Modulus Check, ensuring they are legitimate UK bank details.

Each rail—whether it's Faster Payments, BACS, CHAPS, or internal systems—requires specific combinations of information, and the system will validate the provided data to ensure compatibility with the respective payment rail's requirements. This ensures accurate simulation and testing of different payment scenarios.

Simulate payment

POSTapi-url/v1/partner/payments/customers/{customerId}/simulate-inbound-payment

Path parameters

customerId*string

Header parameters

Body

application/json

rails*enum

FASTER_PAYMENTSCHAPSBACSINTERNAL

payload*object

Response

200400403422

Simulate payment

Request

JavaScriptCurlPythonHTTP

const response = await fetch('api-url/v1/partner/payments/customers/{customerId}/simulate-inbound-payment', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "rails": "FASTER_PAYMENTS",
      "payload": {
        "sourceCounterparty": {
          "type": "PERSONAL",
          "details": {
            "firstName": "John",
            "lastName": "Doe"
          },
          "accountCurrency": "GBP",
          "accountReferenceType": "UK_ACCOUNT",
          "accountReference": {
            "type": "UK_ACCOUNT",
            "sortCode": "010102",
            "accountNumber": "12345678"
          }
        },
        "destinationFiatAccountId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 129,
        "reference": "Sent from Algbra"
      }
    }),
});
const data = await response.json();

Response

400403422

{
  "errorType": "VALIDATION_ERROR",
  "reason": "text",
  "validationFailures": [
    {
      "message": "text",
      "path": "text"
    }
  ]
}