Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Payments

Create a payment request via the redirect (Pay by Bank) flow

Create a payment request via the redirect (Pay by Bank) flow

post/api/v1/payment-requests:redirect

Request body

merchant_idstring uuid

Merchant ID. Defaults to the logged-in merchant if not provided. Required for admin tokens.

amountinteger required

Minor-unit amount (e.g. pence/cents). Decimals are rejected.

currencystring required

The currency of the payment request

payment_referencestring

Payment reference to appear on the payer’s bank statement (max 18 alphanumeric characters)

order_idstring

The unique identifier for the merchant's order

localestring required

The locale of the payment request

success_url_redirectstring

URL to redirect on successful payment

fail_url_redirectstring

URL to redirect on failed payment

test_transactionboolean

Flag for test transactions

selected_bank_idstring

Selected bank reference

Example request

{
  "merchant_id": "550e8400-e29b-41d4-a716-446655440000",
  "customer": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone_number": "+447123456789"
  },
  "billing_address": {
    "address_line1": "12 West Common Drive",
    "address_line2": "Flat 1",
    "apartment": "Apt 5B",
    "city": "London",
    "state_province": "Greater London",
    "country": "GB",
    "postal_code": "SE1 1AA",
    "company_name": "Acme Ltd"
  },
  "amount": 1999,
  "currency": "GBP",
  "payment_reference": "ORDER123",
  "order_id": "1140",
  "locale": "en_GB",
  "success_url_redirect": "https://storename.com/success",
  "fail_url_redirect": "https://storename.com/failure",
  "selected_bank_id": "38c39d03-8df3-4980-b0a8-7e283c8c62dd"
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "redirect_url": "https://example.com/redirect"
  }
}