Skip to content

Mercury: Recipients schemas

32 Mercury schemas with complete fields and constraints.

← Recipients operations · All schemas

Add a new recipient — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
addressJSONOptionalDeprecated. Use checkInfo instead.
address (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body address address1, address2, city, postal Code, state
checkInfoJSONOptionalInformation needed to send a physical check.
checkInfo (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body check Info address
contactEmailJSONOptionalContact email address of the recipient
contactEmail (allOf 1)stringAll variants apply
domesticWireRoutingInfoJSONOptionalInformation needed to send a domestic wire.
domesticWireRoutingInfo (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body domestic Wire Routing Info account Number, address, routing Number
electronicRoutingInfoJSONOptionalInformation needed to send an ACH.
electronicRoutingInfo (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body electronic Routing Info account Number, address, electronic Account Type, routing Number
emailsarrayRequired within parent
emails[]stringEach item
namestringRequired within parentMaximum length: 299
Minimum length: 1
nicknamestringOptionalMaximum length: 299
realTimePaymentRoutingInfoJSONOptionalInformation needed to send a real-time payment.
realTimePaymentRoutingInfo (allOf 1)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
address1stringRequired within parent
address2JSONOptional
address2 (anyOf 1)stringAlternative
address2 (anyOf 2)nullAlternative
citystringRequired within parent
postalCodestringRequired within parent
stateJSONOptional
state (anyOf 1)JSONAlternative
state (anyOf 1) (allOf 1)stringAll variants applyOne 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)nullAlternative

Add a new recipient — request body — body check Info address

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
addressJSONRequired within parent
address (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region
address (allOf 2)JSONAll variants applyMailing 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
address1stringRequired within parent
address2JSONOptional
address2 (anyOf 1)stringAlternative
address2 (anyOf 2)nullAlternative
citystringRequired within parent
countryJSONRequired within parent
country (allOf 1)stringAll variants apply
postalCodestringRequired within parent
regionJSONRequired within parent
region (allOf 1)stringAll variants apply

Add a new recipient — request body — body domestic Wire Routing Info account Number, address, routing Number

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
accountNumberstringRequired within parentThe account number of the bank account to use for domestic wire payments.
addressJSONRequired within parent
address (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region
address (allOf 2)JSONAll variants applyThe address of the bank account to use for domestic wire payments. This has to be the recipient's legal address.
routingNumberstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
accountNumberstringRequired within parentThe account number of the bank account to use for ACH payments.
addressJSONRequired within parent
address (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region
address (allOf 2)JSONAll variants applyThe address of the bank account to use for ACH payments. This has to be the recipient's legal address.
electronicAccountTypeJSONRequired within parent
electronicAccountType (allOf 1)stringAll variants applyOne of: businessChecking, businessSavings, personalChecking, personalSavings, businessGeneralLedger, personalGeneralLedger, businessLoan, personalLoan
electronicAccountType (allOf 2)JSONAll variants applyThe type of bank account to use for ACH payments.
routingNumberstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootRouting information for real-time payments.
Additional keys: not allowed
accountNumberstringRequired within parentThe account number of the bank account to use for real-time payments.
addressJSONRequired within parent
address (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body check Info address address address1, address2, city, country, postal Code, region
address (allOf 2)JSONAll variants applyThe address of the bank account to use for real-time payments.
routingNumberstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
attachmentsarrayRequired within parent
attachments[]ModelEach itemExpand Add a new recipient — response body — attachments item
checkInfoJSONOptional
checkInfo (anyOf 1)JSONAlternative
checkInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand Add a new recipient — response body — check Info address address
checkInfo (anyOf 2)nullAlternative
contactEmailJSONOptional
contactEmail (anyOf 1)JSONAlternative
contactEmail (anyOf 1) (allOf 1)stringAll variants apply
contactEmail (anyOf 2)nullAlternative
dateLastPaidJSONOptional
dateLastPaid (anyOf 1)JSONAlternative
dateLastPaid (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
dateLastPaid (anyOf 2)nullAlternative
defaultAddressJSONOptional
defaultAddress (anyOf 1)JSONAlternative
defaultAddress (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
defaultPaymentMethodJSONRequired within parent
defaultPaymentMethod (allOf 1)stringAll variants applyKnown values: ach, check, domesticWire, internationalWire, realTimePayment
domesticWireRoutingInfoJSONOptional
domesticWireRoutingInfo (anyOf 1)JSONAlternative
domesticWireRoutingInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
electronicRoutingInfoJSONOptional
electronicRoutingInfo (anyOf 1)JSONAlternative
electronicRoutingInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
emailsarrayRequired within parent
emails[]stringEach item
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
internationalWireRoutingInfoJSONOptional
internationalWireRoutingInfo (anyOf 1)JSONAlternative
internationalWireRoutingInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
inviteIdJSONOptional
inviteId (anyOf 1)JSONAlternative
inviteId (anyOf 1) (allOf 1)stringAll variants apply
inviteId (anyOf 2)nullAlternative
isBusinessJSONOptional
isBusiness (anyOf 1)booleanAlternative
isBusiness (anyOf 2)nullAlternative
namestringRequired within parent
nicknameJSONOptional
nickname (anyOf 1)stringAlternative
nickname (anyOf 2)nullAlternative
realTimePaymentRoutingInfoJSONOptional
realTimePaymentRoutingInfo (anyOf 1)JSONAlternative
realTimePaymentRoutingInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
address1stringRequired within parentMaximum length: 299
Minimum length: 1
address2JSONOptional
address2 (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
address2 (anyOf 2)nullAlternative
citystringRequired within parentMaximum length: 299
Minimum length: 1
countryJSONRequired within parent
country (allOf 1)stringAll variants apply
namestringRequired within parent
postalCodestringRequired within parentMaximum length: 299
Minimum length: 1
regionJSONRequired within parent
region (allOf 1)stringAll variants apply

Add a new recipient — response body — attachments item

FieldTypePresenceDescription and constraints
$objectRoot
fileNamestringRequired within parentName of the uploaded file
formTypeJSONOptional
formType (anyOf 1)JSONAlternative
formType (anyOf 1) (allOf 1)stringAll variants applyKnown values: w9, w8BEN, w8BENE, unknown
formType (anyOf 1) (allOf 2)JSONAll variants applyThe tax form type (W-9 for US persons, W-8BEN for foreign individuals, W-8BEN-E for foreign entities)
formType (anyOf 2)nullAlternative
uploadedAtJSONRequired within parent
uploadedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
uploadedAt (allOf 2)JSONAll variants applyTimestamp when the attachment was uploaded
urlstringRequired within parentPresigned URL to download the attachment (valid for 12 hours)

Add a new recipient — response body — check Info address address

FieldTypePresenceDescription and constraints
$objectRoot
addressJSONRequired within parent
address (allOf 1)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
address1stringRequired within parent
address2JSONOptional
address2 (anyOf 1)stringAlternative
address2 (anyOf 2)nullAlternative
citystringRequired within parent
countryJSONRequired within parent
country (allOf 1)stringAll variants apply
postalCodestringRequired within parent
regionJSONRequired within parent
region (allOf 1)stringAll 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

FieldTypePresenceDescription and constraints
$objectRoot
accountNumberstringRequired within parent
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
bankNameJSONOptional
bankName (anyOf 1)stringAlternative
bankName (anyOf 2)nullAlternative
routingNumberstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
accountNumberstringRequired within parent
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
bankNameJSONOptional
bankName (anyOf 1)stringAlternative
bankName (anyOf 2)nullAlternative
electronicAccountTypeJSONRequired within parent
electronicAccountType (allOf 1)stringAll variants applyKnown values: businessChecking, businessSavings, personalChecking, personalSavings, businessGeneralLedger, personalGeneralLedger, businessLoan, personalLoan
routingNumberstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
bankDetailsJSONOptional
bankDetails (anyOf 1)JSONAlternative
bankDetails (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
bankDetails (anyOf 2)nullAlternative
correspondentInfoJSONOptional
correspondentInfo (anyOf 1)JSONAlternative
correspondentInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
correspondentInfo (anyOf 2)nullAlternative
countrySpecificJSONRequired within parent
countrySpecific (allOf 1)ModelAll variants applyExpand 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
emailAddressJSONOptional
emailAddress (anyOf 1)stringAlternative
emailAddress (anyOf 2)nullAlternative
ibanstringRequired within parent
phoneNumberJSONOptional
phoneNumber (anyOf 1)stringAlternative
phoneNumber (anyOf 2)nullAlternative
swiftCodestringRequired 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 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

FieldTypePresenceDescription and constraints
$objectRoot
bankCityStatestringRequired within parent
bankCountryJSONRequired within parent
bankCountry (allOf 1)stringAll variants apply
bankNamestringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
bankNameJSONOptional
bankName (anyOf 1)stringAlternative
bankName (anyOf 2)nullAlternative
routingNumberJSONOptional
routingNumber (anyOf 1)stringAlternative
routingNumber (anyOf 2)nullAlternative
swiftCodeJSONOptional
swiftCode (anyOf 1)stringAlternative
swiftCode (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
australiaJSONOptional
australia (anyOf 1)JSONAlternative
australia (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
australia (anyOf 2)nullAlternative
brazilJSONOptional
brazil (anyOf 1)JSONAlternative
brazil (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
brazil (anyOf 2)nullAlternative
canadaJSONOptional
canada (anyOf 1)JSONAlternative
canada (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
canada (anyOf 2)nullAlternative
chileJSONOptional
chile (anyOf 1)JSONAlternative
chile (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
chile (anyOf 2)nullAlternative
colombiaJSONOptional
colombia (anyOf 1)JSONAlternative
colombia (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
colombia (anyOf 2)nullAlternative
dominicanRepublicJSONOptional
dominicanRepublic (anyOf 1)JSONAlternative
dominicanRepublic (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
dominicanRepublic (anyOf 2)nullAlternative
hondurasJSONOptional
honduras (anyOf 1)JSONAlternative
honduras (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
honduras (anyOf 2)nullAlternative
indiaJSONOptional
india (anyOf 1)JSONAlternative
india (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
india (anyOf 2)nullAlternative
kazakhstanJSONOptional
kazakhstan (anyOf 1)JSONAlternative
kazakhstan (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
kazakhstan (anyOf 2)nullAlternative
pakistanJSONOptional
pakistan (anyOf 1)JSONAlternative
pakistan (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
pakistan (anyOf 2)nullAlternative
paraguayJSONOptional
paraguay (anyOf 1)JSONAlternative
paraguay (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
paraguay (anyOf 2)nullAlternative
philippinesJSONOptional
philippines (anyOf 1)JSONAlternative
philippines (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
philippines (anyOf 2)nullAlternative
russiaJSONOptional
russia (anyOf 1)JSONAlternative
russia (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
russia (anyOf 2)nullAlternative
southAfricaJSONOptional
southAfrica (anyOf 1)JSONAlternative
southAfrica (anyOf 1) (allOf 1)ModelAll variants applyExpand 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
southAfrica (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
bsbCodestringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
bankCodestringRequired within parent
transitNumberstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
legalIdstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
accountTypeJSONRequired within parent
accountType (allOf 1)stringAll variants applyKnown values: checking, savings
legalIdstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
ifscCodestringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
legalIdstringRequired within parent
legalIdTypeJSONRequired within parent
legalIdType (allOf 1)stringAll variants applyKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
routingNumberstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
innstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
branchCodestringRequired within parent

Edit information about a specific recipient — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
addressJSONOptionalDeprecated. Use checkInfo instead.
address (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body address address1, address2, city, postal Code, state
checkInfoJSONOptionalInformation needed to send a check.
checkInfo (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body check Info address
contactEmailJSONOptionalContact email address of the recipient
contactEmail (allOf 1)stringAll variants apply
domesticWireRoutingInfoJSONOptionalInformation needed to send a domestic wire.
domesticWireRoutingInfo (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body domestic Wire Routing Info account Number, address, routing Number
electronicRoutingInfoJSONOptionalInformation needed to send an ACH.
electronicRoutingInfo (allOf 1)ModelAll variants applyExpand Add a new recipient — request body — body electronic Routing Info account Number, address, electronic Account Type, routing Number
emailsarrayOptional
emails[]stringEach item
namestringOptionalMaximum length: 299
Minimum length: 1
nicknamestringOptional
realTimePaymentRoutingInfoJSONOptionalInformation needed to send a real-time payment.
realTimePaymentRoutingInfo (allOf 1)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
pageobjectRequired within parentPagination information including cursors for navigating to next/previous pages
page.nextPagestringOptionalID for the recipient
Format: uuid
page.previousPagestringOptionalID for the recipient
Format: uuid
recipientsarrayRequired within parentList of recipients in the current page
recipients[]ModelEach itemExpand Add a new recipient — response body
totalJSONRequired within parent
total (allOf 1)ModelAll variants applyExpand Get all recipients — response body — total value
total (allOf 2)JSONAll variants applyTotal 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)integerAlternativeFormat: int32
Maximum: 1000
Minimum: 0
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List all recipient attachments — response body

FieldTypePresenceDescription and constraints
$objectRoot
attachmentsarrayRequired within parentList of attachments with recipient IDs
attachments[]ModelEach itemExpand List all recipient attachments — response body — attachments item
pageobjectRequired within parentPagination information
page.nextPagestringOptionalID for the recipient tax form attachment
Format: uuid
page.previousPagestringOptionalID for the recipient tax form attachment
Format: uuid
totalJSONRequired within parent
total (allOf 1)ModelAll variants applyExpand Get all recipients — response body — total value
total (allOf 2)JSONAll variants applyTotal 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

FieldTypePresenceDescription and constraints
$objectRoot
fileNamestringRequired within parentName of the uploaded file
formTypeJSONOptional
formType (anyOf 1)JSONAlternative
formType (anyOf 1) (allOf 1)stringAll variants applyKnown values: w9, w8BEN, w8BENE, unknown
formType (anyOf 1) (allOf 2)JSONAll variants applyThe tax form type (W-9, W-8BEN, W-8BEN-E, or Unknown)
formType (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the recipient tax form attachment
Format: uuid
id (allOf 2)JSONAll variants applyThe unique identifier for this attachment
recipientIdJSONRequired within parent
recipientId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
recipientId (allOf 2)JSONAll variants applyThe external ID of the recipient this attachment belongs to
uploadedAtJSONRequired within parent
uploadedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
uploadedAt (allOf 2)JSONAll variants applyTimestamp when the attachment was uploaded
urlstringRequired within parentPresigned URL to download the attachment (valid for 12 hours)

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.