{"_id":"564b5f7e55cfbe0d00de3ba7","version":{"_id":"55de36ec9067202b00de0015","__v":33,"project":"55dd0853d2d97337001800e2","createdAt":"2015-08-26T22:00:12.384Z","releaseDate":"2015-08-26T22:00:12.383Z","categories":["55de36ed9067202b00de0016","55de36ed9067202b00de0017","55de36ed9067202b00de0018","55df7dcd437b3f0d004ba204","55e4e014177b6e0d00333141","55e4e01fe252ac0d00303a99","55e4e05240cda60d003bad67","55e4e070177b6e0d00333142","55e4e0753325e60d007fbee6","55e4e0803325e60d007fbee7","55e4e086177b6e0d00333143","55e4e0a1177b6e0d00333144","55e4e0aa3325e60d007fbee8","55e4e0b140cda60d003bad6b","55e4e0bae252ac0d00303a9d","55e4e0c5177b6e0d00333145","55e4e0ee3325e60d007fbeea","55e4e0fae252ac0d00303a9e","55e4e100177b6e0d00333147","55f85c8ba3271b0d00498d55","56092e1ac5cff70d007d0131","564b64a3ee12850d0095866e","564b64b5791099170071e9ea","565cd0bfd18ae50d007183d8","565f5f5d6bafd40d0030a063","565f790d6bafd40d0030a09f","56611c464851190d003f9f5d","56637d5b7988ab0d00d0522e","56637d687988ab0d00d0522f","567835df6928b40d009dd650","56e59c043c29b117008dae5b","5704013559c5190e000ab646","572be252de40590e00026934","58af1bf6ebd7370f0078ba09","5cdad81d912ece0039e9a939"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"__v":59,"project":"55dd0853d2d97337001800e2","user":"55f84b9660cc850d008a7afc","githubsync":"","parentDoc":null,"category":{"_id":"55df7dcd437b3f0d004ba204","pages":["55df7ef3a50de10d00062f70","55e0f40126f51b0d009b171c","55e0f57c7d91840d00824934","55e0f605c13a5a0d00880e6b","55e100eed052580d0038c993","55e1013d26f51b0d009b1759","55e101637d91840d0082493c","55e5f5af9416190d00dc3a59","55e6203dd101191900f30d11","55ea2468ba33bc3500b28cd9","55f85c32a3271b0d00498d51","55f8b70fc449610d002daf9f","56092bafa7cc2f0d00d975b2","56092bd58aedf50d0004cff1","563923d13539050d000820f0","563e732531f7580d00511edf","564a83ec4721851900a67614","564ab6274cd0521700523f17","564ab687c58bef0d0062070a","564ab6ee9f35450d00fc767a","564ab75f33fb500d00567ddd","564ab7c34cd0521700523f19","564ab82233fb500d00567ddf","564b5f0755cfbe0d00de3ba5","564b5f7e55cfbe0d00de3ba7","565cf59677f0090d00581807","565e4266f76b8d0d00554185","565f4119de5dc50d00acfe30","5665c0b8d7490819006a4fd6"],"project":"55dd0853d2d97337001800e2","version":"55de36ec9067202b00de0015","__v":29,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-27T21:14:53.972Z","from_sync":false,"order":2,"slug":"customers","title":"Customers"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-17T17:10:22.630Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":3,"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"A **merchant** refers to the actual business that this legal entity owns.\\n\\nA **legal entity** is an association, corporation, partnership, proprietorship, trust, or individual that has the legal capacity to enter into agreements or contracts, assume obligations, incur and pay debts, sue and be sued in its own right, and to be held responsible for its actions.\\n\\nFor most small or medium sized businesses there won't be much of a distinction between the legal entity and the merchant. The distinction comes when there is a legal entity that operates several different businesses that in this case would be referred to as merchants. Nevertheless both the legal entity and merchant information needs to be provided for verification purposes.\",\n  \"title\": \"Merchant and legal entity\"\n}\n[/block]\n## Request\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Verifying a merchant bank\",\n  \"body\": \"Adding a merchant bank will initiate a two drop deposit. The customer will need to check their bank account records for these two amounts and proceed to the [bank verification process](doc:verify-bank-drop-amounts).\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"statementDescriptor\",\n  \"body\": \"Pay special attention to the statementDescriptor. Statement descriptors show up on a Payer's bank account statement next to their purchase. Selecting an appropriate statement descriptor can help to make sure the payer remembers the purchase and does not attempt to Dispute the charges later. Allowable characters are 0-9, a-z, A-Z, &, *, #, period, comma, and space.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"merchantCategoryCode\",\n  \"body\": \"Make sure you send **merchantCategoryCode** if the plan requires **professional** validation.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Specification\",\n    \"0-0\": \"businessName\",\n    \"1-0\": \"businessUrl\",\n    \"2-0\": \"businessLogo\",\n    \"3-0\": \"supportEmail\",\n    \"4-0\": \"supportPhone\",\n    \"5-0\": \"supportUrl\",\n    \"6-0\": \"productDescription\",\n    \"7-0\": \"statementDescriptor\",\n    \"8-0\": \"defaultCurrency\",\n    \"9-0\": \"merchantCategoryCode\",\n    \"11-0\": \"businessAddress\",\n    \"12-0\": \"personalContact\",\n    \"10-0\": \"bank\",\n    \"0-1\": \"**Type**: String\\n**Length**: 1-256 characters\\n**Example**: PayStand\\n**Description**: The name of the business.\",\n    \"1-1\": \"**Type**: String\\n**Format**: Valid Url\\n**Length**: 1-128 characters\\n**Example**: \\\"https://www.mySite.com\\\"\\n**Description**: The url of the business.\",\n    \"2-1\": \"**Type**: String\\n**Format**: Valid Url\\n**Length**: 1-128 characters\\n**Example**: \\\"https://www.mySite.com/logo.png\\\"\\n**Description**: The url of the business logo.\",\n    \"3-1\": \"**Type**: String\\n**Format**: Email\\n**Length**: 1-128 characters\\n**Example**: support:::at:::mySite.com\\n**Description**: The support email for the business.\",\n    \"4-1\": \"**Type**: String\\n**Format**: Phone, valid area code required\\n**Length**: 1-16 characters\\n**Example**: (408) 518-2331\\n**Description**: The support phone number for the business.\",\n    \"5-1\": \"**Type**: String\\n**Format**: Valid Url\\n**Length**: 1-128 characters\\n**Example**: https://support.mySite.com\\n**Description**: The support website URL for the business.\",\n    \"6-1\": \"**Type**: String\\n**Length**: 1-512 characters\\n**Example**: \\\"Awesome payments.\\\"\\n**Description**: The support website URL for the business.\",\n    \"7-1\": \"**Type**: String\\n**Format**: 0-9, a-z, A-Z, &, *, #, period, comma, and space\\n**Length**: 20 characters\\n**Example**: \\\"PayStand\\\"\\n**Description**: The statement descriptor you would like to show up on the customer's bill when making a purchase.\",\n    \"8-1\": \"**Type**: String\\n**Format**: ISO4217 currency code\\n**Length**: 3 characters\\n**Example**: \\\"USD\\\"\\n**Description**: The default currency that will be set for this customer.\",\n    \"9-1\": \"**Type**: String of integers\\n**Length**: 4-7 characters\\n**Example**: \\\"4816\\\"\\n**More Info**: [IRS](https://www.irs.gov/irb/2004-31_IRB/ar17.html), [Visa](http://web.archive.org/web/20070710202209/http://usa.visa.com/download/corporate/resources/mcc_booklet.pdf)\\n**Description**: MCC is used to classify a business by the type of goods or services it provides.\",\n    \"10-1\": \"**Type**: JSON Object\\n**Format**: [Bank](doc:the-bank-resource) \\n**Description**: The bank account for this merchant.\",\n    \"11-1\": \"**Type**: JSON Object\\n**Format**: [Address](doc:address) \\n**Description**: The address for this business.\",\n    \"12-1\": \"**Type**: JSON Object\\n**Format**: [Contact](doc:contact) \\n**Description**: The personal contact for this business.\"\n  },\n  \"cols\": 2,\n  \"rows\": 13\n}\n[/block]\n## Response\n\nAll of the request parameters will be returned in the response.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"customer\\\": {\\n  \\t\\\"merchant\\\": {\\n    \\t\\\"businessName\\\": \\\"Pearl SeaBass Inc\\\",\\n      \\\"businessUrl\\\": \\\"https://www.theseabassfrancis.com\\\",\\n      \\\"businessLogo\\\": \\\"https://www.theseabassfrancis.com/images/logo.png\\\",\\n      \\\"supportEmail\\\": \\\"fseabass@paystand.com\\\",\\n      \\\"supportUrl\\\": \\\"https://support.pearl.com\\\",\\n      \\\"productDescription\\\": \\\"Seabass product description\\\",\\n      \\\"statementDescriptor\\\": \\\"Pearl Inc.\\\",\\n      \\\"defaultCurrency\\\": \\\"USD\\\",\\n      \\\"merchantCategoryCode\\\": \\\"4816\\\",\\n      \\\"bank\\\": {..},\\n      \\\"personalAddress\\\": {..}, \\n      \\\"businessAddress\\\": {..}\\n    }\\n  }\\n}   \",\n      \"language\": \"json\",\n      \"name\": \"Request\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"customer\\\": {\\n  \\t\\\"merchant\\\": {\\n    \\t\\\"businessName\\\": \\\"Pearl SeaBass Inc\\\",\\n      \\\"businessUrl\\\": \\\"https://www.theseabassfrancis.com\\\",\\n      \\\"businessLogo\\\": \\\"https://www.theseabassfrancis.com/images/logo.png\\\",\\n      \\\"supportEmail\\\": \\\"fseabass@paystand.com\\\",\\n      \\\"supportUrl\\\": \\\"https://support.pearl.com\\\",\\n      \\\"productDescription\\\": \\\"Seabass product description\\\",\\n      \\\"statementDescriptor\\\": \\\"Pearl Inc.\\\",\\n      \\\"defaultCurrency\\\": \\\"USD\\\",\\n      \\\"merchantCategoryCode\\\": \\\"4816\\\",\\n      \\\"bank\\\": {..},\\n      \\\"personalAddress\\\": {..},\\n      \\\"businessAddress\\\": {..}\\n    }\\n  }\\n}   \",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"The merchant object","slug":"customer-merchant","type":"basic","title":"Customer.merchant"}

Customer.merchant

The merchant object

[block:callout] { "type": "success", "body": "A **merchant** refers to the actual business that this legal entity owns.\n\nA **legal entity** is an association, corporation, partnership, proprietorship, trust, or individual that has the legal capacity to enter into agreements or contracts, assume obligations, incur and pay debts, sue and be sued in its own right, and to be held responsible for its actions.\n\nFor most small or medium sized businesses there won't be much of a distinction between the legal entity and the merchant. The distinction comes when there is a legal entity that operates several different businesses that in this case would be referred to as merchants. Nevertheless both the legal entity and merchant information needs to be provided for verification purposes.", "title": "Merchant and legal entity" } [/block] ## Request [block:callout] { "type": "success", "title": "Verifying a merchant bank", "body": "Adding a merchant bank will initiate a two drop deposit. The customer will need to check their bank account records for these two amounts and proceed to the [bank verification process](doc:verify-bank-drop-amounts)." } [/block] [block:callout] { "type": "warning", "title": "statementDescriptor", "body": "Pay special attention to the statementDescriptor. Statement descriptors show up on a Payer's bank account statement next to their purchase. Selecting an appropriate statement descriptor can help to make sure the payer remembers the purchase and does not attempt to Dispute the charges later. Allowable characters are 0-9, a-z, A-Z, &, *, #, period, comma, and space." } [/block] [block:callout] { "type": "info", "title": "merchantCategoryCode", "body": "Make sure you send **merchantCategoryCode** if the plan requires **professional** validation." } [/block] [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Specification", "0-0": "businessName", "1-0": "businessUrl", "2-0": "businessLogo", "3-0": "supportEmail", "4-0": "supportPhone", "5-0": "supportUrl", "6-0": "productDescription", "7-0": "statementDescriptor", "8-0": "defaultCurrency", "9-0": "merchantCategoryCode", "11-0": "businessAddress", "12-0": "personalContact", "10-0": "bank", "0-1": "**Type**: String\n**Length**: 1-256 characters\n**Example**: PayStand\n**Description**: The name of the business.", "1-1": "**Type**: String\n**Format**: Valid Url\n**Length**: 1-128 characters\n**Example**: \"https://www.mySite.com\"\n**Description**: The url of the business.", "2-1": "**Type**: String\n**Format**: Valid Url\n**Length**: 1-128 characters\n**Example**: \"https://www.mySite.com/logo.png\"\n**Description**: The url of the business logo.", "3-1": "**Type**: String\n**Format**: Email\n**Length**: 1-128 characters\n**Example**: support@mySite.com\n**Description**: The support email for the business.", "4-1": "**Type**: String\n**Format**: Phone, valid area code required\n**Length**: 1-16 characters\n**Example**: (408) 518-2331\n**Description**: The support phone number for the business.", "5-1": "**Type**: String\n**Format**: Valid Url\n**Length**: 1-128 characters\n**Example**: https://support.mySite.com\n**Description**: The support website URL for the business.", "6-1": "**Type**: String\n**Length**: 1-512 characters\n**Example**: \"Awesome payments.\"\n**Description**: The support website URL for the business.", "7-1": "**Type**: String\n**Format**: 0-9, a-z, A-Z, &, *, #, period, comma, and space\n**Length**: 20 characters\n**Example**: \"PayStand\"\n**Description**: The statement descriptor you would like to show up on the customer's bill when making a purchase.", "8-1": "**Type**: String\n**Format**: ISO4217 currency code\n**Length**: 3 characters\n**Example**: \"USD\"\n**Description**: The default currency that will be set for this customer.", "9-1": "**Type**: String of integers\n**Length**: 4-7 characters\n**Example**: \"4816\"\n**More Info**: [IRS](https://www.irs.gov/irb/2004-31_IRB/ar17.html), [Visa](http://web.archive.org/web/20070710202209/http://usa.visa.com/download/corporate/resources/mcc_booklet.pdf)\n**Description**: MCC is used to classify a business by the type of goods or services it provides.", "10-1": "**Type**: JSON Object\n**Format**: [Bank](doc:the-bank-resource) \n**Description**: The bank account for this merchant.", "11-1": "**Type**: JSON Object\n**Format**: [Address](doc:address) \n**Description**: The address for this business.", "12-1": "**Type**: JSON Object\n**Format**: [Contact](doc:contact) \n**Description**: The personal contact for this business." }, "cols": 2, "rows": 13 } [/block] ## Response All of the request parameters will be returned in the response. [block:code] { "codes": [ { "code": "{\n \"customer\": {\n \t\"merchant\": {\n \t\"businessName\": \"Pearl SeaBass Inc\",\n \"businessUrl\": \"https://www.theseabassfrancis.com\",\n \"businessLogo\": \"https://www.theseabassfrancis.com/images/logo.png\",\n \"supportEmail\": \"fseabass@paystand.com\",\n \"supportUrl\": \"https://support.pearl.com\",\n \"productDescription\": \"Seabass product description\",\n \"statementDescriptor\": \"Pearl Inc.\",\n \"defaultCurrency\": \"USD\",\n \"merchantCategoryCode\": \"4816\",\n \"bank\": {..},\n \"personalAddress\": {..}, \n \"businessAddress\": {..}\n }\n }\n} ", "language": "json", "name": "Request" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"customer\": {\n \t\"merchant\": {\n \t\"businessName\": \"Pearl SeaBass Inc\",\n \"businessUrl\": \"https://www.theseabassfrancis.com\",\n \"businessLogo\": \"https://www.theseabassfrancis.com/images/logo.png\",\n \"supportEmail\": \"fseabass@paystand.com\",\n \"supportUrl\": \"https://support.pearl.com\",\n \"productDescription\": \"Seabass product description\",\n \"statementDescriptor\": \"Pearl Inc.\",\n \"defaultCurrency\": \"USD\",\n \"merchantCategoryCode\": \"4816\",\n \"bank\": {..},\n \"personalAddress\": {..},\n \"businessAddress\": {..}\n }\n }\n} ", "language": "json", "name": "Response" } ], "sidebar": true } [/block]