Payments / RailsFPE
FPE
UK's Faster Payments scheme. Used for pay-out in the United Kingdom.
Rail overview
Use FPE for GBP payouts through the UK Faster Payments network.
The payment leaves the internal Conomy account and settles through the local UK rail after provider confirmation.
Use sort code and account number validation before capture to reduce payout failures.
Required fields
Section titled “Required fields”| Field | Type | Description |
|---|---|---|
type | string | Must be "FPE" |
currency | string | Must be "GBP" |
fpe.accountNumber | string | UK bank account number (8 digits) |
fpe.sortCode | string | Sort code (6 digits, e.g., "200415") |
fpe.customer.firstName | string | Recipient’s first name |
fpe.customer.lastName | string | Recipient’s last name |
fpe.customer.email | string | Recipient’s email |
Example
Section titled “Example”{ "type": "FPE", "currency": "GBP", "fpe": { "accountNumber": "12345678", "sortCode": "200415", "customer": { "firstName": "Emma", "lastName": "Thompson", "email": "emma@example.com" } }}Object
Section titled “Object”UK bank account number (8 digits).
Sort code (6 digits, e.g., "200415").
Information on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer's name
emailstringPayer's email
lastNamestringPayer's last name
phoneNumberstringPayer's phone number without prefix
phoneNumberPrefixstringPhone number prefix (e.g., +57)
documentTypestringDocumeny type of the entity (e.g., RUT, CURP, CURL). Go to the Supported Identity document types page for the complete list of supported values.
documentNumberstringThe document number associated with the documentType
addressobjectThe entity’s address information.
administrativeAreaLevel1stringThe first-level administrative division.
administrativeAreaLevel2stringThe second-level administrative division.
administrativeAreaLevel3stringThe third-level administrative division.
streetstringThe name of the street.
streetNumberstringThe street number.
optionalAddressstringAdditional address details.
countrystringCountry of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., CHL, USA, MEX). Go to the countries page for the complete list of supported values.
zipcodestringZipcode f the address