get https://api.mercury.com/api/v1/recipients
Retrieve information about all of your recipients
Response schema:
{
"recipients": [
{
"id": string,
"name": string,
"nickname": string | null,
"status": "active" | "deleted",
"emails": [string],
"dateLastPaid": date-time | null,
"defaultPaymentMethod": "ach" | "check" | "domesticWire" | "internationalWire",
"electronicRoutingInfo": {
"accountNumber": string,
"routingNumber": string,
"bankName": string | null,
"electronicAccountType": "businessChecking" | "businessSavings" | "personalChecking" | "personalSavings",
"address": {
"address1": string,
"address2": string | null,
"city": string,
"region": string,
"postalCode": string,
"country": iso3166Alpha2,
} | null
} | null,
"domesticWireRoutingInfo": {
"bankName": string | null,
"accountNumber": string,
"routingNumber": string,
"address": {
"address1": string,
"address2": string | null,
"city": string,
"region": string,
"postalCode": string,
"country": iso3166Alpha2,
} | null
} | null,
"internationalWireRoutingInfo": {
"iban": string,
"swiftCode": string,
"correspondentInfo": {
"routingNumber": string | null,
"swiftCode": string | null,
"bankName": string | null
} | null,
"bankDetails": {
"bankName": string,
"cityState": string,
"country": iso3166Alpha2
} | null,
"address": {
"address1": string,
"address2": string | null,
"city": string,
"region": string,
"postalCode": string,
"country": iso3166Alpha2
} | null,
"phoneNumber": string | null,
"countrySpecific": {
"canada": {
"bankCode": string,
"transitNumber": string
} | null,
"australia": {
"bsbCode": string
} | null,
"india": {
"ifscCode": string
} | null
}
} | null,
"checkInfo": {
"address": {
"address1": string,
"address2": string | null,
"city": string,
"region": string,
"postalCode": string,
"country": iso3166Alpha2,
}
} | null, // Check mailing address.
"address": {
"name": string,
"address1": string,
"address2": string | null,
"city": string,
"region": string,
"postalCode": string,
"country": iso3166Alpha2
} | null, // Deprecated. Use checkInfo instead.
}
],
"total": integer
}