Make a batch payment

post https://api-sandbox.modulrfinance.com/api-sandbox-token/batchpayments

As well as supporting individual payment requests, the Modulr payment platform can also handle multiple payment objects in the same request. This endpoint allows you to make a new batch payment.

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

externalReference

string

length between 0 and 50

Your reference for this Batch of payments

strictProcessing

boolean

Flag to control if the entire batch fails for any individual payment validation failure

submissionType

string

BATCH restricts operations to batch level. BULK (default) allows payment level operations such as approval

payments

array of objects

required

length between 1 and 2147483647

List of payments. Need at least 1 and maximum of 10000

payments*

sourceAccountId

string

required

Identifier for the sending Account.

destination

object

Destination of the Payment

currency

string

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.

destinationId

string

destinationType

string

Responses

Response body

object

string

Unique id for the Batch Payment. 10 characters long

externalReference

string

External reference, if provided

status

string

Current status of batch.

ACCEPTED REJECTED SUBMITTED CANCELLED

totalPayments

int32

Total count of payments in this batch

currentUserCanApprove

boolean

Whether the user is allowed to approve this batch, based on their approval limits, and applicable configuration

paymentDetails

object

Summary of payments and approvals, per currency (as a 3-alpha currency code)

approvals

array of objects

List of batch-level approvals

approvals

object

approvedBy

string

ID of user who approved this batch payment request

approvedOn

date

Date this approval was applied

currentUserCanCancel

boolean

Whether the user is allowed and currently able to cancel at least one of the payments in this batch

createdDate

date-time

Datetime when the batch payment was created. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

processingDateFrom

date

Earliest processing date in the batch file or the batch creation date if the file does not have any dates. Date format 'yyyy-MM-dd'

processingDateTo

date

Last processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000'

earliestScheduledPaymentDate

date

Earliest processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000'

requiredApprovalCount

int32

The number of required approvals for the batch. Applicable to batch payments of submissionType BATCH

summary

object

Summary of the state of payment requests in this batch

total

int32

Total count of payment requests in this batch

invalid

int32

Count of invalid payment requests

inprogress

int32

Count of payment requests in progress

completed

int32

Count of completed payments

errors

int32

Count of failed payment requests

info

string

Additional information or error message regarding this batch payment request

strict

boolean

Language

Credentials

Header


xxxxxxxxxx
43
1
curl --request POST \
2
     --url https://api-sandbox.modulrfinance.com/api-sandbox-token/batchpayments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "payments": [
8
    {
9
      "destination": {
10
        "type": "BENEFICIARY",
11
        "address": {
12
          "country": "AT"
13
        },
14
        "countrySpecificDetails": {
15
          "business": true,
16
          "bankCodeType": "ABA",
17
          "bankCountry": "AT"
18
        }
19
      },
20
      "currency": "GBP",
21
      "regulatoryReporting": {
22
        "type": "CRED",
23
        "regulatoryAuthority": {
24
          "authorityCountry": "AT"
25
        },
26
        "structuredRegulatoryReporting": {
27
          "currencyCode": "GBP"
28
        }
29
      },

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

201BatchPaymentReference

400Validation errors