Submit a GBP Faster Payments (FPS) payment

Submits an outbound GBP payment via the Faster Payments Scheme. The client must have sufficient GBP funds.

Body Params

The FPS payment details

Request body for submitting a GBP Faster Payments (FPS) payment

string
required

The Mercury-assigned reference returned from POST /api/v1/client. Must belong to an Active client under your distributor account.

int32 | null

Optional. The ID of a previous Confirmation of Payee check to link to this payment. If provided, it must match an existing CoP check on the client's record.

string
required

A unique identifier for this payment. Must never have been previously submitted.

debtor
object
required

Details of the outbound payer (the client's virtual IBAN)

creditor
object
required

Details of the payee receiving the funds. Provide either iban, or both accountNumber and sortCode.

Responses

401

Missing or invalid x-api-key, x-nonce or Authorization signature. The response has no body.

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