We're sorry but

Your browser is not supported.

To enjoy our website, try using
a newer browser like Google Chrome,
Mozilla Firefox, or Microsoft Edge.

product features
User experience

Your users can initiate payments without leaving your app or website, improving their experience and increasing conversions

Verify payment status

Reduce the possibility of misdirected payments by verifying the recipient account and confirming payment status

Reduce costs

Payment Initiation uses Faster Payments rails for low-cost payments

Create payment response

 
  http code 200
  {
    "payment_id": "payment-id-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3",
    "status": "PAYMENT_STATUS_INPUT_NEEDED",
    "request_id": "4ciYVmesrySiUAB"
  }
  

Retrieve payment request data

The /payment/create endpoint allows you to create a payment initiation request

payment_id

The backend identifier of the payment request and can be used to retrieve metadata for the payment request

status

Describes whether the payment has been initiated, needs user input, or has been verified

View API docs

Retrieve payment request data

The /payment/create endpoint allows you to create a payment initiation request

Create payment response

 
  http code 200
  {
    "payment_id": "payment-id-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3",
    "status": "PAYMENT_STATUS_INPUT_NEEDED",
    "request_id": "4ciYVmesrySiUAB"
  }
  

payment_id

The backend identifier of the payment request and can be used to retrieve metadata for the payment request

status

Describes whether the payment has been initiated, needs user input, or has been verified

Retrieve payment status data

The /payment/get endpoint allows you to retrieve the status of a payment and returns details such as the amount and recipient_id

amount

Settled value in specified currency

last_status_update

The last time that the payment status was updated

recipient_id

The unique identifier of the payment recipient, returned by the /payment_initiation/recipient/create endpoint

status

Describes whether the payment has been initiated, needs user input, or has been verified

View API docs

Get payment response

 
  http code 200
  {
    "payment_id": "payment-id-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3",
    "payment_token": "payment-token-sandbox-c6a26505-42b4-46fe-8ecf-bf9edcafbebb",
    "reference": "Account Funding 99744",
    "amount": {
      "currency": "GBP",
      "value": 100.00
    },
    "status": "PAYMENT_STATUS_INPUT_NEEDED",
    "last_status_update": "2019-11-06T21:10:52Z",
    "payment_expiration_time": "2019-11-06T21:25:52Z",
    "recipient_id": "recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6",
    "request_id": "aEAQmewMzlVa1k6"
  }
  

Retrieve payment status data

The /payment/get endpoint allows you to retrieve the status of a payment and returns details such as the amount and recipient_id

Get payment response

 
  http code 200
  {
    "payment_id": "payment-id-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3",
    "payment_token": "payment-token-sandbox-c6a26505-42b4-46fe-8ecf-bf9edcafbebb",
    "reference": "Account Funding 99744",
    "amount": {
      "currency": "GBP",
      "value": 100.00
    },
    "status": "PAYMENT_STATUS_INPUT_NEEDED",
    "last_status_update": "2019-11-06T21:10:52Z",
    "payment_expiration_time": "2019-11-06T21:25:52Z",
    "recipient_id": "recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6",
    "request_id": "aEAQmewMzlVa1k6"
  }
  

amount

Settled value in specified currency

last_status_update

The last time that the payment status was updated

recipient_id

The unique identifier of the payment recipient, returned by the /payment_initiation/recipient/create endpoint

status

Describes whether the payment has been initiated, needs user input, or has been verified


Account funding

An easy way for your customers to fund their accounts within your application’s flow

Bill payments

A streamlined way for your customers to make bill and invoice payments

Online payments

A safe, fast, and cost-effective payment method