Create a new beneficiary for a specified customer

post

https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/{customerId}/beneficiaries

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

string

required

ID of customer to create beneficiary for

Body Params

externalReference

string

length between 0 and 50

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

name

string

required

length between 0 and 100

birthdate

date

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

emailAddress

string

The destination beneficiary's email address

phoneNumber

string

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

destinationIdentifier

object

required

defaultReference

string

required

length ≥ 1

idToReplace

string

address

object

Optional address.

qualifier

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

Language

Credentials

Header

Loading…

Response

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

application/json

*/*

201Created

400Validation errors