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.

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

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

Responses

Response body

object

string

Unique reference for the Beneficiary.

name

string

Name for the Beneficiary

birthdate

date

Date of birth for the Beneficiary in yyyy-MM-dd format

emailAddress

string

Email address for the Beneficiary

phoneNumber

string

Phone number for the Beneficiary in international pattern

destinationIdentifier

object

Account Identifier

type

string

accountNumber

string

Bank account Sort Code

accountType

string

Bank account type like PERSONAL/BUSINESS

PERSONAL BUSINESS

sortCode

string

Bank account Sort Code

iban

string

bic

string

currency

string

countrySpecificDetails

object

redirectedDestination

object

Provides new account details where the beneficiary's account details have been redirected by the scheme.

type

string

accountNumber

string

Bank account Sort Code

accountType

string

Bank account type like PERSONAL/BUSINESS

PERSONAL BUSINESS

sortCode

string

Bank account Sort Code

iban

string

bic

string

currency

string

countrySpecificDetails

object

defaultReference

string

Default reference used for payments to the Beneficiary.

status

string

Status of the Beneficiary. Can be:

ACTIVE DELETED PENDING BLOCKED

created

date-time

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

accountId

string

Id of the account if this beneficiary is a Modulr account, null otherwise

externalReference

string

External system reference for the Beneficiary

approvalRequired

boolean

Indicates if the beneficiary creation is pending approval

customerId

string

Id of the customer than owns this beneficiary

updated

date-time

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

address

object

address of the beneficiary

addressLine1

string

addressLine2

string

postTown

string

postCode

string

country

string

countrySubDivision

string

qualifier

string

Qualifier for this beneficiary

approvalRequestId

string

Approval request ID for pending records.

approvalStatus

string

Approval status of item.

NOTNEEDED PENDING APPROVED REJECTED DELETED

accessGroups

array of strings

Access groups associated with beneficiary.

accessGroups

createdBy

string

System or person who created the beneficiary

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.modulrfinance.com/api-sandbox-token/customers//beneficiaries \
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

*/*

201Created

400Validation errors