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. Please refer to Counterpary Validation section for more information.

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

post

Path parameters

customerIdstringRequired

Header parameters

authorizationstringOptional

Authorization header containing your API Token

x-alg-noncestringOptional

Nonce used to generate the payload signature

x-alg-signaturestringOptional

Payload signature

datestringOptional

Date of the request un UTC/GMT

Body

application/json

railsstring · enumRequired

The payment rail to simulate (e.g. Faster Payments)

Default: FASTER_PAYMENTSExample: FASTER_PAYMENTSPossible values:

Responses

200

Simulate payment

No content

400

Input validation error

application/json

403

Forbidden

application/json

422

Unprocessable entity

application/json

post

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

HTTPcURLJavaScriptPython

POST /v1/partner/payments/customers/{customerId}/simulate-inbound-payment HTTP/1.1
Host: api-url
Content-Type: application/json
Accept: */*
Content-Length: 386

{
  "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": "e0cab2dd-739f-43de-b131-3e423e935bf1",
    "amount": 129,
    "reference": "Sent from Algbra"
  }
}

No content