Create a payment

post

https://api-sandbox.modulrfinance.com/api-sandbox-token/payments

Supports both Payments to external bank accounts via Faster Payments and transfers to other Modulr accounts. Requests to Payments are asynchronous.

Body Params

sourceAccountId

string

required

Identifier for the sending Account.

destination

object

Destination of the Payment

currency

string

enum

Currency of the account in ISO 4217 format. Default is GBP

amount

number

0.01 to 2147483647

Amount of the payment in Major Current Units - '1' = 1.00 GBP

reference

string

Reference to be used for the Payment. This will appear on the Account statement/the recipient's bank account. Min 6 to max 18 characters that are not all the same (up to 140 characters for currencies other than GBP). Can contain alphanumeric, '-', '.', '&', '/' and space.

externalReference

string

length between 0 and 50

Your reference for this payment

endToEndReference

string

Optional end to end reference. For international payments, Modulr payment ID will be used as end-to-end reference.

regulatoryReporting

object

Regulatory reporting

paymentDate

string

The future date on which to make the payment. Date format 'yyyy-MM-dd'.

Not applicable for international payments which will be submitted on date of submission or next working day, in line with cut-offs.

overseasPaymentDetail

object

Details relating to payment originated overseas.

Not applicable for international payments - all international transactions must originate from the Modulr account creating the payment request.

fxQuoteId

string

deprecated

FX quote ID related to this payment. If supplied, neither 'amount' nor 'currency' should be supplied.

purposeOfPayment

string

enum

A code from the UK Recommended Purpose Code list that indicates the type of Payment. This is optional for most payment types but recommended to be completed where possible; where it is required for certain purposes of CHAPS payment if not supplied a default value will be used

categoryOfPayment

string

enum

A category code from the UK Recommended Purpose Code list that indicates the general category of the Payment. This is optional for all types of payment, and defaults to 'OTHR' on schemes that accept category

permittedScheme

string

enum

Attempt to process the payment using only the specified scheme

Allowed:

nameCheck

object

Reference to name check result for the destination account.

destinationId

string

destinationType

string

enum

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201PaymentReference

400Validation errors