Send Faster Payment [beta]

Send a Faster Payments payment.

The Faster Payments System (FPS) is a UK service that allows near-instant electronic money transfers between banks.

This endpoint generates a FPS out payment transaction event.

In case of failure, the transaction is updated with status = CANCELLED and the status_reason field will detail why.

If the counterparty bank rejects the transaction, the transaction is still considered SETTLED and, when the provider webhook return is processed, a new FPS out return event is generated and the amount is credited back to the debtor's account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Send payment request body

string
required
length ≤ 31

Client-generated transaction identifier. Must be unique for each transaction.

creditor_account
object
required

Creditor's account information

string
enum
required

Payment scheme to be used.

  • ImmediatePayment - Single Immediate Payment (SIP)
  • StandingOrder - Standing Order Payment (SOP)
  • ForwardDatedPayment - Forward Dated Payment (FDP)
Allowed:
currency
object
required
remittance_information
object
Headers
string
required

Account token - token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message

string
required

A UUID to ensure the operation remains idempotent, allowing for operation repetition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json