Return FPS payment [beta]

Manually trigger a return for a previously credited FPS inbound transaction.

This endpoint allows clients to initiate a return of funds for an inbound FPS payment that has already been credited to the beneficiary's account. The return is submitted to the payment provider (Form3) for processing.

Returns initiated through this endpoint are marked with return_origin = CLIENT to distinguish them from provider-initiated returns.

The return_reason must be one of the 14 standardized Form3 reason codes (00000001 through 00000014).

This endpoint generates an FPS inbound payment return processed event with return_origin = CLIENT.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 31

FPS transaction's end to end ID.

Body Params

Return payment request body

string
enum
required

Form3 return reason code. Must be one of the following 14 codes:

  • 00000001—Beneficiary sort code/account number unknown
  • 00000002—Beneficiary account closed
  • 00000003—Beneficiary account stopped
  • 00000004—Beneficiary deceased
  • 00000005—Account cannot be identified without data in reference field
  • 00000006—Beneficiary account name does not match beneficiary account number
  • 00000007—Return requested by sender of original payment
  • 00000008—Account is not in currency quoted
  • 00000009—Beneficiary not expecting funds/instructed return
  • 00000010—Terms and conditions of account do not permit crediting of these funds
  • 00000011—Sending institution action required
  • 00000012—Account transferred
  • 00000013—Payment cannot be applied because of beneficiary sensitivities
  • 00000014—Reason not given
string
required
length ≤ 20

Amount to return. Must match the original transaction amount, since the Pismo platform does not support partial returns.

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

Organization ID

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.

string

Request tracking identifier. If not provided, a random UUID will be generated.

Responses

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