PIpismo
Faster payments

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.

Notes:

  • Before calling this endpoint, you must call Confirmation of Payee to verify the payee.

  • In case of failure, the transaction is updated with status = CANCELLED, and the status_reason field explains 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.

  • This endpoint generates a FPS out payment transaction event.

post/v1/payments/fps/out

Request

  • Base URL
    https://sandbox.pismolabs.io/fps
  • URL
    https://sandbox.pismolabs.io/fps/v1/payments/fps/out
  • Auth
    none declared. Required headers: Authorization, Idempotency-key

Headers

Authorizationstring required

Account token—token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Idempotency-keystring 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.

Request body

end_to_end_idstring required

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

scheme_payment_type'ImmediatePayment' | 'StandingOrder' | 'ForwardDatedPayment' required

Payment scheme to be used.<br>

  • ImmediatePayment — Single Immediate Payment (SIP)<br>
  • StandingOrder — Standing Order Payment (SOP)<br>
  • ForwardDatedPayment— Forward Dated Payment (FDP)<br>

Example request

{
  "end_to_end_id": "1374f841568e4ff4b3a63b023c170ec",
  "creditor_account": {
    "name": "Len Lease",
    "scheme_name": "iban",
    "identification": "AA00AAA000000000000000"
  },
  "scheme_payment_type": "ImmediatePayment",
  "currency": {
    "amount": 853.09,
    "code": "GBP"
  },
  "remittance_information": {
    "reference": "Reference information"
  }
}

Response

Response Body

end_to_end_idstring

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

status'CREATED' | 'PROCESSING' | 'SETTLED' | 'CANCELLED' | 'HOLD'
  • CREATED - Payment has been created and is pending processing
  • PROCESSING - P2P balance was impacted and waiting for provider confirmation
  • SETTLED - Transaction completed processing and is settled
  • CANCELLED - Something went wrong and the transaction is cancelled. Refer to reason for more details
  • HOLD - The payment is on hold, pending further review

Example response

{
  "end_to_end_id": "1374f841568e4ff4b3a63b023c170ec",
  "status": "PROCESSING"
}

Changes

No recorded changes to this operation across all 1 revision of this API.