Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Input your API key (e.g. your public key) as a Bearer token to access this API.

Body

bankId
string
required

The unique identifier of the bank selected by the customer, as returned by the bank list endpoint (e.g., lloyds)

transactionReference
string
required

The unique reference for the transaction

amount
number<double>
required

The amount to be paid (e.g., 10.00)

currency
string
required

The currency of the payment (Must be GBP)

checkoutCustomerData
object
required
metaData
string | null

Additional data to attach to the transaction, passed as a JSON string (e.g., "{"name":"test"}")

checkoutCustomizationData
object | null

Response

200 - application/json

OK

status
boolean

Indicates whether the request was successful

message
string | null

A message describing the result of the request

data
object | null
Example: