Modulr API

Accounts
Beneficiaries
Cards
Confirmation of Payee
Customers
Direct Debits
Payments
Rules
Transactions
- Get transactions for a specific Accountget
Document
- Uploads and stores documentpost
Access Group
Card Simulator
File Upload
Notification
Variable Recurring Payments
Payment Initiations
Channel Manager Card

Modulr API

Accounts
Beneficiaries
Cards
Confirmation of Payee
Customers
Direct Debits
Payments
Rules
Transactions
- Get transactions for a specific Accountget
Document
- Uploads and stores documentpost
Access Group
Card Simulator
File Upload
Notification
Variable Recurring Payments
Payment Initiations
Channel Manager Card

Initiate a Variable Recurring Payment.

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

Initiates a new Variable Recurring Payment using an existing authorised consent.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Body Params

consentId

string

required

The unique identifier of the VRP consent initiation request at Modulr.

payment

object

required

Payment details for the VRP payment initiation request.

Responses

Response body

object

string

The unique identifier of the VRP payment initiation request at Modulr

status

string

required

The current status of vrp payment. Must be one of “SUBMITTED”,“ACCEPTEDCREDITSETTLEMENTCOMPLETED”,“ACCEPTEDWITHOUTPOSTING”,“ACCEPTEDSETTLEMENTCOMPLETED”,“ACCEPTEDSETTLEMENTINPROCESS”,“PENDING”,“REJECTED”,“ER_GENERAL”,“ER_EXTSYS”

SUBMITTED ACCEPTEDCREDITSETTLEMENTCOMPLETED ACCEPTEDWITHOUTPOSTING ACCEPTEDSETTLEMENTCOMPLETED ACCEPTEDSETTLEMENTINPROCESS PENDING REJECTED ER_GENERAL ER_EXTSYS

Response body

array of objects

object

field

string

code

string

GENERAL BUSINESSRULE MFASTATUS MFAERROR MFATIMEOUT MFADEVICEMM MFAMESSAGEINVALID NOTFOUND DUPLICATE INVALID CONNECTION RETRY RATELIMIT PERMISSION NOTACCEPTABLE MFAVERIFICATION TOKENEXPIRED

errorCode

string

message

string

sourceService

string

Updated 4 months ago

Check if a particular webhook has failed

Create a VRP consent

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.modulrfinance.com/api-sandbox-token/vrp \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

*/*

Updated 4 months ago

Check if a particular webhook has failed

Create a VRP consent

Did this page help you?

Modulr API
Accounts
Get accounts using filterget
Block a specific accountpost
Close an accountpost
Unblock a specific accountpost
Create account by customerpost
Get accounts by customerget
Set the secured funding limit for an accountput
Edit an accountput
Get an accountget
Beneficiaries
Retrieve locked beneficiary entitiesget
Retrieve beneficiariesget
Delete beneficiaries for a specified customerdelete
Create a new beneficiary for a specified customerpost
Cards
Get card token OTP detailsget
Retrieve secure card details (PAN + CVV + PIN)get
Get card tokensget
View the details of existing cardsget
Create a new virtual cardpost
View the details of existing cards by accountget
Create a new physical cardpost
Deactivate card tokenpost
Suspend card tokenpost
Unsuspend card tokenpost
Card enquirypost
Reset card PINpost
Activate a physical cardpost
Block an existing cardpost
Cancel an existing cardpost
Get in-app provisioning data for Apple Paypost
Unblock PINpost
Reset card PINpost
Retrieve PINget
Replace a cardpost
Create secure card details tokenpost
Restricted
[Restricted] Expire an existing authorisationpost
[Restricted] Suspend an existing cardpost
[Restricted] Unsuspend a cardpost
Unblock an existing cardpost
Update cardpatch
Update a cardpost
View the details of an existing cardget
Custom Fields
Delete card custom fielddelete
Delete customer custom field keydelete
Delete partner custom field keydelete
View existing customer card custom field keysget
View existing partner card custom field keysget
Update a card's custom fieldspost
Bulk create customer custom field keyspost
Bulk create partner custom field keyspost
Activities, Reports & Reports Notifications
View activities for specific cards or over a date rangeget
Download a specific card reportget
Retrieve card reportsget
Toggled notifications for customer and card report typepost
Delete card report notification configuration for customer and report typedelete
Update report type notification configuration for customerpost
Retrieve card report type notification configuration for customerget
Toggle card report notification for partner and report typepost
Delete card report notification configuration for partner and report typedelete
Update report type notification configuration for partnerpost
Retrieve card report type notification configuration for partnerget
Async
Get physical card create tasks by accountget
Get a card taskget
Get tasksget
Update card authenticationput
Confirmation of Payee
Get SRD Accountsget
Create an account name check for Direct Debit Payerpost
Create an account name checkpost
Customers
Create a new customerpost
Retrieve customers using filtersget
Edit a customerpatch
Edit a specific customer using a unique customer referenceput
Retrieve a specific customer using a unique customer referenceget
Direct Debits
Direct Debit Outbound Mandate Operations
Retrieve all Mandates for an accountget
Cancel a specific Mandatepost
Reject Collectionpost
Get all collection activities of an accountget
Get all collectionschedules for a mandateget
Get Mandates based on search criteria.get
Get Reconciliations based on search criteria.get
Create a Direct Debit mandate for the given account-id.post
Represent collection for given collection idpost
Cancel a Direct Debit collection for the given collection-id.post
Cancel a Direct Debit collection schedule for the given collection-id.post
Bulk mandate cancellation request for the given account-id.post
Bulk request of Direct Debit mandates for the given account-id.post
Cancel Mandate for given mandate-id.post
Create the collection schedule for the given mandate-id.post
Reinstate Mandate for given mandate-id.post
Suspend Mandate for given mandate-id.post
Payments
Inbound Payments
Endpoint to mock the credit of an accountpost
Cancel the batch paymentpost
Make a batch paymentpost
Get batch payments by a given set of parametersget
Create a paymentpost
Retrieve paymentsget
Rules
Retrieve a Rule by rule type on a specific accountget
Get all Rules for a specific Accountget
Delete a Ruledelete
Create a Rulepost
Edit a specific Ruleput
Transactions
Get transactions for a specific Accountget
Document
Uploads and stores documentpost
Access Group
Get access groupget
Create access grouppost
Get a list of access groupsget
Update access groupput
Card Simulator
Reverse the card authorisationpost
Settle the card authorisationpost
Create a card authorisationpost
File Upload
Get an upload file latest statusget
Create payments from an uploaded filepost
Upload payment file and store valid paymentspost
Notification
Check if a particular webhook has failedget
Set up a Notification for a Customerpost
Get all Notifications for a Customerget
Set up a Notification for a Partnerpost
Get all Notifications linked directly to a Partnerget
Update a specific notification by unique reference for a specific customerput
Retrieve a specific notification by unique reference for a specific customerget
Update a specific notification by unique reference for a specific partnerput
Retrieve a specific notification by unique reference for a specific partnerget
Variable Recurring Payments
Revoke a VRP consent.delete
Get VRP consent.get
Get Variable Recurring Paymentget
Confirm the availability of funds in an account.post
Create a VRP consentpost
Initiate a Variable Recurring Payment.post
Payment Initiations
Get supported ASPSPsget
Get payment initiation request detailsget
Get standing order initiation request detailsget
Initiate payment from ASPSPpost
Initiate standing order from ASPSPpost
Channel Manager Card
Channel Manager download a specific card reportget
Retrieve channel manager's card reportsget
Retrieve channel manager's card activitiesget
Retrieve channel manager's cardsget
Channel Manager Create cardpost
Channel Manager Card enquirypost
Channel Manager Update Card Custom Fieldspost
Channel Manager Update cardpatch
Channel Manager Update cardpost

Modulr API
Accounts
Get accounts using filterget
Block a specific accountpost
Close an accountpost
Unblock a specific accountpost
Create account by customerpost
Get accounts by customerget
Set the secured funding limit for an accountput
Edit an accountput
Get an accountget
Beneficiaries
Retrieve locked beneficiary entitiesget
Retrieve beneficiariesget
Delete beneficiaries for a specified customerdelete
Create a new beneficiary for a specified customerpost
Cards
Get card token OTP detailsget
Retrieve secure card details (PAN + CVV + PIN)get
Get card tokensget
View the details of existing cardsget
Create a new virtual cardpost
View the details of existing cards by accountget
Create a new physical cardpost
Deactivate card tokenpost
Suspend card tokenpost
Unsuspend card tokenpost
Card enquirypost
Reset card PINpost
Activate a physical cardpost
Block an existing cardpost
Cancel an existing cardpost
Get in-app provisioning data for Apple Paypost
Unblock PINpost
Reset card PINpost
Retrieve PINget
Replace a cardpost
Create secure card details tokenpost
Restricted
[Restricted] Expire an existing authorisationpost
[Restricted] Suspend an existing cardpost
[Restricted] Unsuspend a cardpost
Unblock an existing cardpost
Update cardpatch
Update a cardpost
View the details of an existing cardget
Custom Fields
Delete card custom fielddelete
Delete customer custom field keydelete
Delete partner custom field keydelete
View existing customer card custom field keysget
View existing partner card custom field keysget
Update a card's custom fieldspost
Bulk create customer custom field keyspost
Bulk create partner custom field keyspost
Activities, Reports & Reports Notifications
View activities for specific cards or over a date rangeget
Download a specific card reportget
Retrieve card reportsget
Toggled notifications for customer and card report typepost
Delete card report notification configuration for customer and report typedelete
Update report type notification configuration for customerpost
Retrieve card report type notification configuration for customerget
Toggle card report notification for partner and report typepost
Delete card report notification configuration for partner and report typedelete
Update report type notification configuration for partnerpost
Retrieve card report type notification configuration for partnerget
Async
Get physical card create tasks by accountget
Get a card taskget
Get tasksget
Update card authenticationput
Confirmation of Payee
Get SRD Accountsget
Create an account name check for Direct Debit Payerpost
Create an account name checkpost
Customers
Create a new customerpost
Retrieve customers using filtersget
Edit a customerpatch
Edit a specific customer using a unique customer referenceput
Retrieve a specific customer using a unique customer referenceget
Direct Debits
Direct Debit Outbound Mandate Operations
Retrieve all Mandates for an accountget
Cancel a specific Mandatepost
Reject Collectionpost
Get all collection activities of an accountget
Get all collectionschedules for a mandateget
Get Mandates based on search criteria.get
Get Reconciliations based on search criteria.get
Create a Direct Debit mandate for the given account-id.post
Represent collection for given collection idpost
Cancel a Direct Debit collection for the given collection-id.post
Cancel a Direct Debit collection schedule for the given collection-id.post
Bulk mandate cancellation request for the given account-id.post
Bulk request of Direct Debit mandates for the given account-id.post
Cancel Mandate for given mandate-id.post
Create the collection schedule for the given mandate-id.post
Reinstate Mandate for given mandate-id.post
Suspend Mandate for given mandate-id.post
Payments
Inbound Payments
Endpoint to mock the credit of an accountpost
Cancel the batch paymentpost
Make a batch paymentpost
Get batch payments by a given set of parametersget
Create a paymentpost
Retrieve paymentsget
Rules
Retrieve a Rule by rule type on a specific accountget
Get all Rules for a specific Accountget
Delete a Ruledelete
Create a Rulepost
Edit a specific Ruleput
Transactions
Get transactions for a specific Accountget
Document
Uploads and stores documentpost
Access Group
Get access groupget
Create access grouppost
Get a list of access groupsget
Update access groupput
Card Simulator
Reverse the card authorisationpost
Settle the card authorisationpost
Create a card authorisationpost
File Upload
Get an upload file latest statusget
Create payments from an uploaded filepost
Upload payment file and store valid paymentspost
Notification
Check if a particular webhook has failedget
Set up a Notification for a Customerpost
Get all Notifications for a Customerget
Set up a Notification for a Partnerpost
Get all Notifications linked directly to a Partnerget
Update a specific notification by unique reference for a specific customerput
Retrieve a specific notification by unique reference for a specific customerget
Update a specific notification by unique reference for a specific partnerput
Retrieve a specific notification by unique reference for a specific partnerget
Variable Recurring Payments
Revoke a VRP consent.delete
Get VRP consent.get
Get Variable Recurring Paymentget
Confirm the availability of funds in an account.post
Create a VRP consentpost
Initiate a Variable Recurring Payment.post
Payment Initiations
Get supported ASPSPsget
Get payment initiation request detailsget
Get standing order initiation request detailsget
Initiate payment from ASPSPpost
Initiate standing order from ASPSPpost
Channel Manager Card
Channel Manager download a specific card reportget
Retrieve channel manager's card reportsget
Retrieve channel manager's card activitiesget
Retrieve channel manager's cardsget
Channel Manager Create cardpost
Channel Manager Card enquirypost
Channel Manager Update Card Custom Fieldspost
Channel Manager Update cardpatch
Channel Manager Update cardpost

201Variable Recurring Payment initiated.

400The consent cannot be processed as it does not exist.