Create Recipient

Streamline recipient management and enhance transaction security with the Beneficiary Registry API. By pre-registering beneficiaries, you create a reusable profile that ensures data integrity across multiple payment rails—including ACH, WIRE, and SWIFT—while significantly reducing the operational complexity of subsequent transfer requests.

This centralized registry captures essential routing instructions, bank metadata, and mandatory regulatory address data in a single, indexable record.

Implementation & Compliance Steps

To successfully register a beneficiary, follow this recommended sequence:

  1. Categorization: Identify if the recipient is an Individual or an Entity and determine the primary payment rails they support (e.g., ACH vs. SWIFT).
  2. Routing Configuration: Collect and validate bank account numbers, routing numbers (ABA), or international SWIFT/BIC codes.
  3. Regulatory Mandate: For WIRE and SWIFT rails, a physical recipient address is a mandatory requirement. You must provide valid stateCode and countryCode values to clear downstream compliance checks.
  4. Transaction Integration: Once created, utilize the returned resourceId as the recipientId when initiating transfers via the Transfers API.

Operational Benefits

  • Reduced Payload Complexity: Eliminate the need to repeat sensitive banking and address details for every transaction.
  • Improved Accuracy: Centralized management minimizes risk by preventing typographical errors in critical routing fields during transfer initiation.
  • Cross-Rail Flexibility: Configure a single recipient profile with multiple set of instructions to support diverse regional or international payment methods.

Useful References

Path Params
integer
required
Defaults to 123

The associated client Id.

Body Params

Use this API for create recipient for ACH Payment. A successful response from this API indicates that the recipient for ACH Payment was successfully created.

Common properties for all ACH recipient types

string
required
^[a-zA-Z]+$
Defaults to ACH

The payment rail for the recipient.

accountDetails
object
required

Details of the recipient's account.

string
length ≤ 40
^[a-zA-Z0-9\\s]*$

The nickname of the recipient.
Allowed Characters:
Alphanumeric: a-z, A-Z, 0-9 (ASCII only)
No special characters
No accented or international characters

string
length ≤ 100
^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$

The email address of the recipient.

string
length ≤ 16
^\\+?[1-9]\\d{1,14}$

The phone number of the recipient.

boolean
Defaults to false

Indicates if the recipient owns the account.

address
object

The address of the recipient.

string
enum
required
Defaults to INDIVIDUAL

Type of recipient - Individual person

Allowed:
string
required
length ≤ 100
^[a-zA-Z]+$
Defaults to John

The first name of the recipient.

string
required
length ≤ 100
^[a-zA-Z]+$
Defaults to Doe

The last name of the recipient.

Headers
string
required

The ID of your banking instance visible in the MBANQ Console.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json