Mercury: Recipients schemas
32 Mercury schemas with complete fields and constraints.
← Recipients operations · All schemas
Add a new recipient — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
address | JSON | Optional | Deprecated. Use checkInfo instead. |
address (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body address address1, address2, city, postal Code, state |
checkInfo | JSON | Optional | Information needed to send a physical check. |
checkInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body check Info address |
contactEmail | JSON | Optional | Contact email address of the recipient |
contactEmail (allOf 1) | string | All variants apply | |
domesticWireRoutingInfo | JSON | Optional | Information needed to send a domestic wire. |
domesticWireRoutingInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body domestic Wire Routing Info account Number, address, routing Number |
electronicRoutingInfo | JSON | Optional | Information needed to send an ACH. |
electronicRoutingInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body electronic Routing Info account Number, address, electronic Account Type, routing Number |
emails | array | Required within parent | |
emails[] | string | Each item | |
name | string | Required within parent | Maximum length: 299 Minimum length: 1 |
nickname | string | Optional | Maximum length: 299 |
realTimePaymentRoutingInfo | JSON | Optional | Information needed to send a real-time payment. |
realTimePaymentRoutingInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body real Time Payment Routing Info Routing information for real-time payments |
Referenced models: Add a new recipient — request body — body address address1, address2, city, postal Code, state, Add a new recipient — request body — body check Info address, Add a new recipient — request body — body domestic Wire Routing Info account Number, address, routing Number, Add a new recipient — request body — body electronic Routing Info account Number, address, electronic Account Type, routing Number, Add a new recipient — request body — body real Time Payment Routing Info Routing information for real-time payments
Add a new recipient — request body — body address address1, address2, city, postal Code, state
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
address1 | string | Required within parent | |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | |
postalCode | string | Required within parent | |
state | JSON | Optional | |
state (anyOf 1) | JSON | Alternative | |
state (anyOf 1) (allOf 1) | string | All variants apply | One of: AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY |
state (anyOf 2) | null | Alternative |
Add a new recipient — request body — body check Info address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
address | JSON | Required within parent | |
address (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region |
address (allOf 2) | JSON | All variants apply | Mailing address for sending a physical check. |
Referenced models: Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region
Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
address1 | string | Required within parent | |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | |
country | JSON | Required within parent | |
country (allOf 1) | string | All variants apply | |
postalCode | string | Required within parent | |
region | JSON | Required within parent | |
region (allOf 1) | string | All variants apply |
Add a new recipient — request body — body domestic Wire Routing Info account Number, address, routing Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
accountNumber | string | Required within parent | The account number of the bank account to use for domestic wire payments. |
address | JSON | Required within parent | |
address (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region |
address (allOf 2) | JSON | All variants apply | The address of the bank account to use for domestic wire payments. This has to be the recipient's legal address. |
routingNumber | string | Required within parent | The routing number of the bank account to use for domestic wire payments. |
Referenced models: Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region
Add a new recipient — request body — body electronic Routing Info account Number, address, electronic Account Type, routing Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
accountNumber | string | Required within parent | The account number of the bank account to use for ACH payments. |
address | JSON | Required within parent | |
address (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region |
address (allOf 2) | JSON | All variants apply | The address of the bank account to use for ACH payments. This has to be the recipient's legal address. |
electronicAccountType | JSON | Required within parent | |
electronicAccountType (allOf 1) | string | All variants apply | One of: businessChecking, businessSavings, personalChecking, personalSavings, businessGeneralLedger, personalGeneralLedger, businessLoan, personalLoan |
electronicAccountType (allOf 2) | JSON | All variants apply | The type of bank account to use for ACH payments. |
routingNumber | string | Required within parent | The routing number of the bank account to use for ACH payments. |
Referenced models: Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region
Add a new recipient — request body — body real Time Payment Routing Info Routing information for real-time payments
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Routing information for real-time payments. Additional keys: not allowed |
accountNumber | string | Required within parent | The account number of the bank account to use for real-time payments. |
address | JSON | Required within parent | |
address (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region |
address (allOf 2) | JSON | All variants apply | The address of the bank account to use for real-time payments. |
routingNumber | string | Required within parent | The routing number of the bank account to use for real-time payments. |
Referenced models: Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region
Add a new recipient — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | |
address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region |
address (anyOf 2) | null | Alternative | |
attachments | array | Required within parent | |
attachments[] | Model | Each item | Expand Add a new recipient — response body — attachments item |
checkInfo | JSON | Optional | |
checkInfo (anyOf 1) | JSON | Alternative | |
checkInfo (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — check Info address address |
checkInfo (anyOf 2) | null | Alternative | |
contactEmail | JSON | Optional | |
contactEmail (anyOf 1) | JSON | Alternative | |
contactEmail (anyOf 1) (allOf 1) | string | All variants apply | |
contactEmail (anyOf 2) | null | Alternative | |
dateLastPaid | JSON | Optional | |
dateLastPaid (anyOf 1) | JSON | Alternative | |
dateLastPaid (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
dateLastPaid (anyOf 2) | null | Alternative | |
defaultAddress | JSON | Optional | |
defaultAddress (anyOf 1) | JSON | Alternative | |
defaultAddress (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region |
defaultAddress (anyOf 2) | null | Alternative | |
defaultPaymentMethod | JSON | Required within parent | |
defaultPaymentMethod (allOf 1) | string | All variants apply | Known values: ach, check, domesticWire, internationalWire, realTimePayment |
domesticWireRoutingInfo | JSON | Optional | |
domesticWireRoutingInfo (anyOf 1) | JSON | Alternative | |
domesticWireRoutingInfo (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — domestic Wire Routing Info account Number, address, bank Name, routing Number account Number, address, bank Name, routing Number |
domesticWireRoutingInfo (anyOf 2) | null | Alternative | |
electronicRoutingInfo | JSON | Optional | |
electronicRoutingInfo (anyOf 1) | JSON | Alternative | |
electronicRoutingInfo (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — electronic Routing Info account Number, address, bank Name, electronic Account Type, routing Number account Number, address, bank Name, electronic Account Type, routing Number |
electronicRoutingInfo (anyOf 2) | null | Alternative | |
emails | array | Required within parent | |
emails[] | string | Each item | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
internationalWireRoutingInfo | JSON | Optional | |
internationalWireRoutingInfo (anyOf 1) | JSON | Alternative | |
internationalWireRoutingInfo (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code |
internationalWireRoutingInfo (anyOf 2) | null | Alternative | |
inviteId | JSON | Optional | |
inviteId (anyOf 1) | JSON | Alternative | |
inviteId (anyOf 1) (allOf 1) | string | All variants apply | |
inviteId (anyOf 2) | null | Alternative | |
isBusiness | JSON | Optional | |
isBusiness (anyOf 1) | boolean | Alternative | |
isBusiness (anyOf 2) | null | Alternative | |
name | string | Required within parent | |
nickname | JSON | Optional | |
nickname (anyOf 1) | string | Alternative | |
nickname (anyOf 2) | null | Alternative | |
realTimePaymentRoutingInfo | JSON | Optional | |
realTimePaymentRoutingInfo (anyOf 1) | JSON | Alternative | |
realTimePaymentRoutingInfo (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — domestic Wire Routing Info account Number, address, bank Name, routing Number account Number, address, bank Name, routing Number |
realTimePaymentRoutingInfo (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: active, deleted |
Referenced models: Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region, Add a new recipient — response body — domestic Wire Routing Info account Number, address, bank Name, routing Number account Number, address, bank Name, routing Number, Add a new recipient — response body — electronic Routing Info account Number, address, bank Name, electronic Account Type, routing Number account Number, address, bank Name, electronic Account Type, routing Number, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code, Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region, Add a new recipient — response body — check Info address address, Add a new recipient — response body — attachments item
Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address1 | string | Required within parent | Maximum length: 299 Minimum length: 1 |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | Maximum length: 299 Minimum length: 1 |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | Maximum length: 299 Minimum length: 1 |
country | JSON | Required within parent | |
country (allOf 1) | string | All variants apply | |
name | string | Required within parent | |
postalCode | string | Required within parent | Maximum length: 299 Minimum length: 1 |
region | JSON | Required within parent | |
region (allOf 1) | string | All variants apply |
Add a new recipient — response body — attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fileName | string | Required within parent | Name of the uploaded file |
formType | JSON | Optional | |
formType (anyOf 1) | JSON | Alternative | |
formType (anyOf 1) (allOf 1) | string | All variants apply | Known values: w9, w8BEN, w8BENE, unknown |
formType (anyOf 1) (allOf 2) | JSON | All variants apply | The tax form type (W-9 for US persons, W-8BEN for foreign individuals, W-8BEN-E for foreign entities) |
formType (anyOf 2) | null | Alternative | |
uploadedAt | JSON | Required within parent | |
uploadedAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
uploadedAt (allOf 2) | JSON | All variants apply | Timestamp when the attachment was uploaded |
url | string | Required within parent | Presigned URL to download the attachment (valid for 12 hours) |
Add a new recipient — response body — check Info address address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Required within parent | |
address (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region |
Referenced models: Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region
Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address1 | string | Required within parent | |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | |
country | JSON | Required within parent | |
country (allOf 1) | string | All variants apply | |
postalCode | string | Required within parent | |
region | JSON | Required within parent | |
region (allOf 1) | string | All variants apply |
Add a new recipient — response body — domestic Wire Routing Info account Number, address, bank Name, routing Number account Number, address, bank Name, routing Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountNumber | string | Required within parent | |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | |
address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region |
address (anyOf 2) | null | Alternative | |
bankName | JSON | Optional | |
bankName (anyOf 1) | string | Alternative | |
bankName (anyOf 2) | null | Alternative | |
routingNumber | string | Required within parent |
Referenced models: Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region
Add a new recipient — response body — electronic Routing Info account Number, address, bank Name, electronic Account Type, routing Number account Number, address, bank Name, electronic Account Type, routing Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountNumber | string | Required within parent | |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | |
address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region |
address (anyOf 2) | null | Alternative | |
bankName | JSON | Optional | |
bankName (anyOf 1) | string | Alternative | |
bankName (anyOf 2) | null | Alternative | |
electronicAccountType | JSON | Required within parent | |
electronicAccountType (allOf 1) | string | All variants apply | Known values: businessChecking, businessSavings, personalChecking, personalSavings, businessGeneralLedger, personalGeneralLedger, businessLoan, personalLoan |
routingNumber | string | Required within parent |
Referenced models: Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code
Referenced models: Add a new recipient — response body — default Address address1, address2, city, country, postal Code, region address1, address2, city, country, postal Code, region, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code correspondent Info bank Name, routing Number, swift Code bank Name, routing Number, swift Code, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code bank Details bank City State, bank Country, bank Name bank City State, bank Country, bank Name
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code bank Details bank City State, bank Country, bank Name bank City State, bank Country, bank Name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bankCityState | string | Required within parent | |
bankCountry | JSON | Required within parent | |
bankCountry (allOf 1) | string | All variants apply | |
bankName | string | Required within parent |
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code correspondent Info bank Name, routing Number, swift Code bank Name, routing Number, swift Code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bankName | JSON | Optional | |
bankName (anyOf 1) | string | Alternative | |
bankName (anyOf 2) | null | Alternative | |
routingNumber | JSON | Optional | |
routingNumber (anyOf 1) | string | Alternative | |
routingNumber (anyOf 2) | null | Alternative | |
swiftCode | JSON | Optional | |
swiftCode (anyOf 1) | string | Alternative | |
swiftCode (anyOf 2) | null | Alternative |
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa
Referenced models: Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa australia bsb Code bsb Code, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa chile legal Id legal Id, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa canada bank Code, transit Number bank Code, transit Number, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa honduras account Type, legal Id account Type, legal Id, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa india ifsc Code ifsc Code, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa pakistan legal Id, legal Id Type legal Id, legal Id Type, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa philippines routing Number routing Number, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa russia inn inn, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa south Africa branch Code branch Code
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa australia bsb Code bsb Code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bsbCode | string | Required within parent |
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa canada bank Code, transit Number bank Code, transit Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bankCode | string | Required within parent | |
transitNumber | string | Required within parent |
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa chile legal Id legal Id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
legalId | string | Required within parent |
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa honduras account Type, legal Id account Type, legal Id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountType | JSON | Required within parent | |
accountType (allOf 1) | string | All variants apply | Known values: checking, savings |
legalId | string | Required within parent |
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa india ifsc Code ifsc Code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ifscCode | string | Required within parent |
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa pakistan legal Id, legal Id Type legal Id, legal Id Type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
legalId | string | Required within parent | |
legalIdType | JSON | Required within parent | |
legalIdType (allOf 1) | string | All variants apply | Known values: CNIC, SNIC, Passport, NTN |
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa philippines routing Number routing Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
routingNumber | string | Required within parent |
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa russia inn inn
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inn | string | Required within parent |
Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code country Specific australia, brazil, canada, chile, colombia, dominican Republic, honduras, india, kazakhstan, pakistan, paraguay, philippines, russia, south Africa south Africa branch Code branch Code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
branchCode | string | Required within parent |
Edit information about a specific recipient — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
address | JSON | Optional | Deprecated. Use checkInfo instead. |
address (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body address address1, address2, city, postal Code, state |
checkInfo | JSON | Optional | Information needed to send a check. |
checkInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body check Info address |
contactEmail | JSON | Optional | Contact email address of the recipient |
contactEmail (allOf 1) | string | All variants apply | |
domesticWireRoutingInfo | JSON | Optional | Information needed to send a domestic wire. |
domesticWireRoutingInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body domestic Wire Routing Info account Number, address, routing Number |
electronicRoutingInfo | JSON | Optional | Information needed to send an ACH. |
electronicRoutingInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body electronic Routing Info account Number, address, electronic Account Type, routing Number |
emails | array | Optional | |
emails[] | string | Each item | |
name | string | Optional | Maximum length: 299 Minimum length: 1 |
nickname | string | Optional | |
realTimePaymentRoutingInfo | JSON | Optional | Information needed to send a real-time payment. |
realTimePaymentRoutingInfo (allOf 1) | Model | All variants apply | Expand Add a new recipient — request body — body real Time Payment Routing Info Routing information for real-time payments |
Referenced models: Add a new recipient — request body — body address address1, address2, city, postal Code, state, Add a new recipient — request body — body check Info address, Add a new recipient — request body — body domestic Wire Routing Info account Number, address, routing Number, Add a new recipient — request body — body electronic Routing Info account Number, address, electronic Account Type, routing Number, Add a new recipient — request body — body real Time Payment Routing Info Routing information for real-time payments
Get all recipients — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
page | object | Required within parent | Pagination information including cursors for navigating to next/previous pages |
page.nextPage | string | Optional | ID for the recipient Format: uuid |
page.previousPage | string | Optional | ID for the recipient Format: uuid |
recipients | array | Required within parent | List of recipients in the current page |
recipients[] | Model | Each item | Expand Add a new recipient — response body |
total | JSON | Required within parent | |
total (allOf 1) | Model | All variants apply | Expand Get all recipients — response body — total value |
total (allOf 2) | JSON | All variants apply | Total number of recipients in the current page |
Referenced models: Add a new recipient — response body, Get all recipients — response body — total value
Get all recipients — response body — total value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | integer | Alternative | Format: int32 Maximum: 1000 Minimum: 0 |
$ (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List all recipient attachments — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachments | array | Required within parent | List of attachments with recipient IDs |
attachments[] | Model | Each item | Expand List all recipient attachments — response body — attachments item |
page | object | Required within parent | Pagination information |
page.nextPage | string | Optional | ID for the recipient tax form attachment Format: uuid |
page.previousPage | string | Optional | ID for the recipient tax form attachment Format: uuid |
total | JSON | Required within parent | |
total (allOf 1) | Model | All variants apply | Expand Get all recipients — response body — total value |
total (allOf 2) | JSON | All variants apply | Total number of attachments in the current page |
Referenced models: Get all recipients — response body — total value, List all recipient attachments — response body — attachments item
List all recipient attachments — response body — attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fileName | string | Required within parent | Name of the uploaded file |
formType | JSON | Optional | |
formType (anyOf 1) | JSON | Alternative | |
formType (anyOf 1) (allOf 1) | string | All variants apply | Known values: w9, w8BEN, w8BENE, unknown |
formType (anyOf 1) (allOf 2) | JSON | All variants apply | The tax form type (W-9, W-8BEN, W-8BEN-E, or Unknown) |
formType (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the recipient tax form attachment Format: uuid |
id (allOf 2) | JSON | All variants apply | The unique identifier for this attachment |
recipientId | JSON | Required within parent | |
recipientId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
recipientId (allOf 2) | JSON | All variants apply | The external ID of the recipient this attachment belongs to |
uploadedAt | JSON | Required within parent | |
uploadedAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
uploadedAt (allOf 2) | JSON | All variants apply | Timestamp when the attachment was uploaded |
url | string | Required within parent | Presigned URL to download the attachment (valid for 12 hours) |