API Reference
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign In

Create a new beneficiary for a specified customer

post
https://api-sandbox.modulrfinance.com/api-sandbox-token/customers//beneficiaries

The ability to create a new beneficiary for a customer, using their customer ID as a reference.

Path Params
string
required

ID of customer to create beneficiary for

Body Params
string
length between 0 and 50

External Reference can only have alphanumeric characters plus underscore, hyphen and space up to 50 characters long

string
required
length between 0 and 100
date

The destination beneficiary's date of birth. Date in yyyy-MM-dd format

string

The destination beneficiary's email address

string

The destination beneficiary's phone number, will be formatted into international number pattern

destinationIdentifier
object
required
string
required
length ≥ 1
string
address
object

Optional address.

string
length between 0 and 100

Optional qualifier. Only to be supplied if multiple beneficiaries with same destination need to be supplied

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 7 months ago