{"info":{"_postman_id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","name":"Worldpay for Platforms Merchant Onboarding API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"<html><head></head><body></body></html>","owner":"26700943","collectionId":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","publishedId":"2sB2cSgijh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"A18CDE"},"publishDate":"2025-04-03T01:43:04.000Z"},"item":[{"name":"Getting Started","item":[],"id":"693705de-662e-46c6-9777-b785e238412f","description":"<p>To start using our APIs, you'll first need to talk to us about your business and its requirements. We love helping, but sometimes we just can't assist. If we're not going to be able to help you, that's something you want to know right away! See the Contact Us section below for more details.</p>\n<p>Once we've had a chat and confirmed that we can help you, we will require an email address to create a user and provide you with a username. We recommend providing a central email address for the user creation. Once a user has been created we will also send you a client_id and client secret for Oauth, and a <code>PartnerId</code> to use in your Onboarding API requests. It's what identifies the requests as being for your customers.</p>\n<p>After you get your setup email with the <code>username</code>, <code>client_id</code>, <code>client_secret</code> and<code>PartnerId</code> you're all good to go: you can start onboarding your customers! Of course, you might be using some of our other APIs to integrate with our online payments or other services. If so, it's not a bad idea to wait until that's all finished and certified before you onboard real customers, but you can always try it out with some \"made up\" test customers. All we ask is that you add Test to the customer's business name, so it's obviously not a real customer; e.g. \"XYZ Corporation Test\".</p>\n<h1 id=\"contact-us\">Contact Us</h1>\n<ul>\n<li><p>Australia: 1300 592 283</p>\n</li>\n<li><p>New Zealand: 0800 480 054</p>\n</li>\n<li><p>OR by email:</p>\n<ul>\n<li><p><a href=\"https://mailto:sales@worldpayforplatforms.com\">sales@worldpayforplatforms.com</a></p>\n</li>\n<li><p><a href=\"https://mailto:admin@worldpayforplatforms.com\">admin@worldpayforplatforms.com</a></p>\n</li>\n</ul>\n</li>\n<li><p>If you are operating in the United Kingdom contact our team by email:</p>\n<ul>\n<li><p><a href=\"https://mailto:salesuk@worldpayforplatforms.com\">salesuk@worldpayforplatforms.com</a></p>\n</li>\n<li><p><a href=\"https://mailto:asupportuk@worldpayforplatforms.com\">supportuk@worldpayforplatforms.com</a></p>\n</li>\n</ul>\n</li>\n<li><p>For Technical Integration Support:</p>\n<ul>\n<li><a href=\"https://mailto:customerintegration@worldpayforplatforms.com\">customerintegration@worldpayforplatforms.com</a></li>\n</ul>\n</li>\n</ul>\n<h1 id=\"versioning\">Versioning</h1>\n<p>A new version of the API will be issued for any breaking changes.</p>\n<p>The addition of new fields to request and response models are not considered breaking changes. New fields can therefore be added at any time.</p>\n<p>Please ensure that your result and model parsing software is able to handle the appearance of new fields.</p>\n<h1 id=\"steps-in-order-to-test-onboarding-flow\">Steps in order to test onboarding flow</h1>\n<p>Whilst completing UAT / sandbox testing please ensure Account status is passed as -1 (Test). We can assist you and test the end to end process by following the below steps in the test environment.</p>\n<ol>\n<li><p>Generate Access Token</p>\n</li>\n<li><p>Create Merchant / Lead</p>\n</li>\n<li><p>Complete hosted digital application form or supply required data via API</p>\n</li>\n<li><p>Reach out to our technical support team at <a href=\"https://mailto:customerintegration@worldpayforplatforms.com\">customerintegration@worldpayforplatforms.com</a> with the business name and applicationid to simulate the onboarding process</p>\n</li>\n<li><p>We will advise when the application has simulated to progress to onboarding complete and merchant acount created</p>\n</li>\n<li><p>Once application has been progressed manually, retrieve merchant data and credentials via API to connect to your platform to begin processing in the test environment</p>\n</li>\n<li><p>End</p>\n</li>\n</ol>\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6df29802-9be1-4535-ba08-c04a4be2dd87","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4b703653-b1eb-4b17-9d17-08441f546b2c","type":"text/javascript","exec":[""]}}],"_postman_id":"693705de-662e-46c6-9777-b785e238412f"},{"name":"Process","item":[],"id":"b0d301a2-cd1d-49b7-b9f3-ad91e683bf15","description":"<p>POST calls made to the API data will be stored in the onboarding system returning the Application Id as part of the response object.</p>\n<p>A GET call using the Application Id can then be made to retrieve the status of the Application including returning any validation errors.</p>\n<p>Further POSTS can be made to the API using the Application Id to update the existing Onboarding until all validation errors are cleared.</p>\n<p>Once the following have been completed the application will then progress through the Onboarding System:</p>\n<ul><li><div>All Data has been passed to the API</div></li><li><div>All validation errors have been addressed and rectified</div></li><li><div>Worldpay for Platforms supply Terms of Service document and form to merchant for acceptance</div></li></ul>\n\n<p>GET Calls can continue to be made to check the status of the Application as it progresses through the system.</p>\n<p>Once onboarding is complete the GET call will return a Business Id.</p>\n<p>An example of the flow to onboard your merchant via API is below:</p>\n<img src=\"https://content.pstmn.io/09cca2fc-5df1-4d74-af9a-f14b76f7efd4/QVBJIG9uYm9hcmRpbmcgZGlhZ3JhbS5qcGVn\" width=\"263\" height=\"708\" />\n\n<ol>\n<li><p>In production, as you create the application or merchant, set the status to = 0</p>\n</li>\n<li><p>Retrieve the merchant details to identify any validation errors or missing data.</p>\n</li>\n<li><p>Once all the data required and validation errors are completed and the application is ready to be submitted, you can send an update with the status = 1. This will submit the application for review.</p>\n</li>\n</ol>\n<p>Please note - once an application is submitted with the status = 1, the application form will no longer be able to edited. If the application form needs to be edited, please contact our Sales team.</p>\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"ab2f1e75-bab9-4dde-acac-0bffed9c24c3","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"b45ea851-fb5f-48aa-a414-d592a4ba4ea8","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"b0d301a2-cd1d-49b7-b9f3-ad91e683bf15"},{"name":"Generate Access Token","item":[{"name":"Depreciation - Generate Access Token v1","id":"99759e08-16ca-4970-9a7d-62aef9e6fd8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://login.salesforce.com/services/oauth2/token?grant_type=refresh_token&client_id={{client-id}}&client_secret={{client-secret}}&redirect_uri=https://login.salesforce.com/services/oauth2/success&refresh_token={{refresh_token}}","description":"<p>This API request is under depreciation. The POST - Generate Access Token v2 is the correct API request to implement.</p>\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"69e898f6-eaa5-457d-9808-5cfa13f423be","id":"69e898f6-eaa5-457d-9808-5cfa13f423be","name":"Generate Access Token","type":"folder"}},"urlObject":{"protocol":"https","path":["services","oauth2","token"],"host":["login","salesforce","com"],"query":[{"key":"grant_type","value":"refresh_token"},{"key":"client_id","value":"{{client-id}}"},{"key":"client_secret","value":"{{client-secret}}"},{"key":"redirect_uri","value":"https://login.salesforce.com/services/oauth2/success"},{"key":"refresh_token","value":"{{refresh_token}}"}],"variable":[]}},"response":[],"_postman_id":"99759e08-16ca-4970-9a7d-62aef9e6fd8b"},{"name":"Generate Access Token v2","id":"c4483bba-a093-41d4-bd3b-4b1ac946e959","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://login.salesforce.com/services/oauth2/token?client_id={{client-id}}&client_secret={{client-secret}}&redirect_uri=https://login.salesforce.com/services/oauth2/success&username=TBA&password=TBA&grant_type=password","description":"<p>The new version 'Generate Access Token v2' has been implemented to add a further layer of data privacy and security. The change is minimal but required for the increase in security.</p>\n<p>There are 4 changes to the paramaters which include:</p>\n<ul>\n<li><p>refresh_token is no longer a paramater</p>\n</li>\n<li><p>username is a new paramater</p>\n</li>\n<li><p>password is a new parameter</p>\n</li>\n<li><p>grant_type paramater = password</p>\n<ul>\n<li>no changes to client_id, client_secret, redirect_uri</li>\n</ul>\n</li>\n</ul>\n<p>In order for your to retrieve and generate an access token, we will require an email address to create a user and provide you with a <code>username</code>. We recommend providing a central email address for the user creation. The <code>password</code> paramater will be the <code>password</code> you set during the setup phase after you receive the setup email.</p>\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"69e898f6-eaa5-457d-9808-5cfa13f423be","id":"69e898f6-eaa5-457d-9808-5cfa13f423be","name":"Generate Access Token","type":"folder"}},"urlObject":{"protocol":"https","path":["services","oauth2","token"],"host":["login","salesforce","com"],"query":[{"key":"client_id","value":"{{client-id}}"},{"key":"client_secret","value":"{{client-secret}}"},{"key":"redirect_uri","value":"https://login.salesforce.com/services/oauth2/success"},{"description":{"content":"<p>To be provided during the set up process. We will require an email addess to set up your access. Recommend a central email address.</p>\n","type":"text/plain"},"key":"username","value":"TBA"},{"description":{"content":"<p>This will be the password you create when finalising user setup via the setup email received.</p>\n","type":"text/plain"},"key":"password","value":"TBA"},{"key":"grant_type","value":"password"}],"variable":[]}},"response":[],"_postman_id":"c4483bba-a093-41d4-bd3b-4b1ac946e959"}],"id":"69e898f6-eaa5-457d-9808-5cfa13f423be","description":"<p>Currently <code>Generate Access Token v1</code> is in use for existing partners, however <code>Generate Access Token v2</code> will override the previous version and <code>Generate Access Token v1</code>will no longer be in use in the future.</p>\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e19ba1ae-b96b-44a2-88ee-f0b80d08c660","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"4f71eadd-9692-4530-af34-020914f803f0","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"69e898f6-eaa5-457d-9808-5cfa13f423be"},{"name":"API Functions","item":[{"name":"Create Merchant","item":[{"name":"Create Merchant Application","id":"9885dc0f-f470-49dc-88df-58922da503bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n  \"partnerid\": \"{{partnerId}}\",\r\n  \"status\": 0,\r\n  \"entity\": {\r\n    \"name\": \"Smith Company\",\r\n    \"fulllegalname\": \"Smith Co Pty Ltd\",\r\n    \"abn\": \"63135196397\",\r\n    \"country\": \"Australia\",\r\n    \"public\": 1\r\n  },\r\n  \"Members\": [\r\n    {\r\n      \"first\": \"James\",\r\n      \"last\": \"Smith\",\r\n      \"email\": \"test@worldpayforplatforms.com\",\r\n      \"phone\": \"+61422242242\",\r\n      \"emailFormtoMerchant\": true,\r\n      \"primary\": 1\r\n    }\r\n  ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://integrapay.my.Salesforce.com/services/apexrest/v2.0/onboarding","description":"<h3 id=\"add-onboarding-data\">Add Onboarding Data</h3>\n<p>This endpoint allows you to begin the application process for your merchants to onboard your merchants via API or retrieve the hosted digital application URL form to re-direct your merchants through to our digital application form.</p>\n<p>The response body will return information on what data is missing and is required, a URL to our hosted digital application form to re-direct your merchant users to our application form to complete the application.</p>\n","urlObject":{"protocol":"https","path":["services","apexrest","v2.0","onboarding"],"host":["integrapay","my","Salesforce","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9885dc0f-f470-49dc-88df-58922da503bc"}],"id":"7cfd37ae-3f06-49a9-84d6-76ddf3412d39","description":"<p>Create a merchant application to start the application process for your merchants.</p>\n","event":[{"listen":"prerequest","script":{"id":"bb196973-cd51-4db5-aaf5-07453a155543","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"68a49738-ef3a-4bbf-88c0-6b4791f81c52","type":"text/javascript","exec":[""]}}],"_postman_id":"7cfd37ae-3f06-49a9-84d6-76ddf3412d39","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"47f599e9-97cd-4898-af66-298ecfe8fa91","id":"47f599e9-97cd-4898-af66-298ecfe8fa91","name":"API Functions","type":"folder"}}},{"name":"Update Merchant","item":[{"name":"Update Merchant Data","id":"e061dcdf-bed8-40e8-8048-ff80bf79bf11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n   \"partnerid\": \"{{PartnerId}}\",\r\n   \"id\":\"{{MerchantId}}\",\r\n   \"established\":20101020,\r\n   \"annualCCSales\":1000000,\r\n   \"status\": 0,\r\n   \"entity\": {\r\n      \"type\":1,\r\n      \"name\":\"Smith Company Pty Ltd\",\r\n      \"address1\":\"123 North 12 St\",\r\n      \"city\":\"South Brisbane\",\r\n      \"state\":\"QLD\",\r\n      \"zip\":\"4001\",\r\n      \"country\":\"Australia\",\r\n      \"phone\":\"+61412345678\",\r\n      \"email\":\"support@example.com\",\r\n      \"abn\":\"63135196397\",\r\n      \"public\":1,\r\n      \"website\":\"https://platforms.worldpay.com/en/\",\r\n      \"transactionsFor\": \"Test sales of goods and services\",\r\n      \"maxTransaction\": 1000,\r\n      \"avgTransaction\": 500,\r\n      \"qtyTransactions\": 20,\r\n      \"paidInArrears\": true,\r\n      \"accounts\": [\r\n         {\r\n               \"account\": {\r\n               \"accountnumber\":\"12345678\",\r\n               \"routing\":\"123456\",\r\n               \"accountname\": \"Test SettlementAccountName\",\r\n               \"accountType\": 1\r\n            }\r\n         },\r\n         {\r\n            \"account\": {\r\n                 \"accountnumber\":\"12345678\",\r\n               \"routing\":\"123456\",\r\n               \"accountname\": \"Test BillingAccountName\",\r\n               \"accountType\": 2\r\n            }\r\n         }\r\n      ]\r\n   },\r\n   \"pricing\" : {\r\n\t\t\"pricingTemplate\" : \"Business Pays\"\r\n  },\r\n   \"Members\": [\r\n      {\r\n        \"id\": \"003IS000009Z57yYAC\",\r\n         \"title\":\"CEO\",\r\n         \"first\":\"John\",\r\n         \"last\":\"Doe\",\r\n         \"Dob\": 19790301,\r\n         \"ownership\":8000,\r\n         \"email\":\"support@example.com.au\",\r\n         \"phone\": \"+61412345678\",\r\n         \"address1\":\"123 Example St.\",\r\n         \"address2\":\"Suite 403\",\r\n         \"city\":\"Eight Mile Plains\",\r\n         \"state\":\"QLD\",\r\n         \"zip\":\"4013\",\r\n         \"country\":\"Australia\",\r\n         \"timezone\":\"aest\",\r\n         \"typeofid\": 1,\r\n         \"idnumber\":\"063885212\",\r\n         \"dlstate\":\"QLD\",\r\n         \"primary\":1,\r\n         \"biometrics\": true,\r\n         \"isowner\": true,\r\n         \"issignatory\": true,\r\n         \"cardnumber\":\"1234567890\"\r\n      }\r\n   ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://integrapay.my.Salesforce.com/services/apexrest/v2.0/onboarding","description":"<p>This endpoint is used to update the merchant onboarding information to reflect correct information to complete the application process.</p>\n<p>The response of this request will be a JSON schema representing the updated onboarding information.</p>\n","urlObject":{"protocol":"https","path":["services","apexrest","v2.0","onboarding"],"host":["integrapay","my","Salesforce","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e061dcdf-bed8-40e8-8048-ff80bf79bf11"}],"id":"94e7ed41-6cde-4843-b6b0-4271d87a5d2c","event":[{"listen":"prerequest","script":{"id":"bab796dd-16a2-409f-b59a-32b915b71958","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1764b49d-5f9e-4a7e-ba0f-0074859929ce","type":"text/javascript","exec":[""]}}],"_postman_id":"94e7ed41-6cde-4843-b6b0-4271d87a5d2c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"47f599e9-97cd-4898-af66-298ecfe8fa91","id":"47f599e9-97cd-4898-af66-298ecfe8fa91","name":"API Functions","type":"folder"}}},{"name":"Retrieve Merchant","item":[{"name":"Retrieve Merchant Data","id":"65743266-33e5-468e-9438-e9ce6d0e7ebf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://integrapay.my.Salesforce.com/services/apexrest/v2.0/onboarding?appid={{merchantId}}&partnerid={{partnerId}}","description":"<p>This API endpoint retrieves merchant information using the Merchant ID and Partner ID as query parameters.</p>\n<p>The response of this request is a JSON object representing the onboarding information, such as REST API credentials, BusinessID, Pricing / Fee information.</p>\n","urlObject":{"protocol":"https","path":["services","apexrest","v2.0","onboarding"],"host":["integrapay","my","Salesforce","com"],"query":[{"key":"appid","value":"{{merchantId}}"},{"key":"partnerid","value":"{{partnerId}}"}],"variable":[]}},"response":[],"_postman_id":"65743266-33e5-468e-9438-e9ce6d0e7ebf"}],"id":"9ed9a535-9207-4dc4-a501-ca746ea7fd14","description":"<p>Retrieves specifics regarding the merchant data such as BusinessID, Rest API credentials, BusinessGUID and fee setup.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"182151ff-51bb-4b92-b50e-4691f6b58228","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"544ca319-5b93-4f24-aca0-6aa3360c1c54","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"9ed9a535-9207-4dc4-a501-ca746ea7fd14"},{"name":"Retrieve Merchant List","item":[{"name":"Merchant List API","id":"f5ab686a-375c-48cd-8ed5-f012e0bd31d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://integrapay.my.salesforce.com/services/apexrest/v2.0/merchants/?partnerId={{partnerId}}&secret={{secret-key}}&type=&test","description":"<p>This endpoint makes a GET request to retrieve a data set about your merchants. The request parameters include partnerId, secret, type, and test. The partnerId and secret are used for authentication, while the type parameter specifies the type of data to be retrieved, and the test parameter indicates whether the application is a test record or not.</p>\n<p>The response will contain information about the merchants such as the merchantid/applicationid to utilise the GET Retrieve Merchant to retrieve more specific details of the merchant.</p>\n","urlObject":{"protocol":"https","path":["services","apexrest","v2.0","merchants",""],"host":["integrapay","my","salesforce","com"],"query":[{"key":"partnerId","value":"{{partnerId}}"},{"key":"secret","value":"{{secret-key}}"},{"description":{"content":"<p>applications or merchants</p>\n","type":"text/plain"},"key":"type","value":""},{"description":{"content":"<p>true or false</p>\n","type":"text/plain"},"key":"test","value":null}],"variable":[]}},"response":[],"_postman_id":"f5ab686a-375c-48cd-8ed5-f012e0bd31d7"}],"id":"76fff35e-1bed-4432-9667-6d525a68aa40","description":"<p>Retrieves a full list of merchants that are currently onboarded or in the application process.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"cbfed23c-a010-4eb2-b2ea-7f805c0e6e40","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"f136b33d-2db1-440e-922a-35a7b7128dc3","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"76fff35e-1bed-4432-9667-6d525a68aa40"},{"name":"Add File","item":[{"name":"Attachments","id":"57302475-b6ed-48b4-a8e9-2e87fcc5e000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"FileName\" : \"drivers license.png\",\r\n    \"typeofattachment\" : \"1\",\r\n    \"parentid\" : \"\",\r\n    \"attachment\" : \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://integrapay.my.Salesforce.com/services/apexrest/v2.0/onboarding/attach/","urlObject":{"protocol":"https","path":["services","apexrest","v2.0","onboarding","attach",""],"host":["integrapay","my","Salesforce","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"57302475-b6ed-48b4-a8e9-2e87fcc5e000"}],"id":"90c82846-b693-4749-bcbd-726c70231417","_postman_id":"90c82846-b693-4749-bcbd-726c70231417","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"47f599e9-97cd-4898-af66-298ecfe8fa91","id":"47f599e9-97cd-4898-af66-298ecfe8fa91","name":"API Functions","type":"folder"}}}],"id":"47f599e9-97cd-4898-af66-298ecfe8fa91","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"ef86f914-26d7-4158-a130-50061e648da6","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"c7df0f5f-e5a1-4ccb-a0f2-4379bde0f640","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"47f599e9-97cd-4898-af66-298ecfe8fa91","description":""},{"name":"Objects","item":[{"name":"Merchant","item":[],"id":"63dcf6e1-5533-4ff5-bfb4-d6fc5569b96d","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th></th>\n<th></th>\n<th></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>partnerid  <br />REQUIRED</td>\n<td>String(1300)</td>\n<td>18 Character Partner Id supplied by our onboarding team.</td>\n</tr>\n<tr>\n<td>id  <br />OPTIONAL/RETURNED</td>\n<td>String(1300)</td>\n<td>Returned as part of the initial Upload of merchant.  <br />REQUIRED as part of update.</td>\n</tr>\n<tr>\n<td>businessid  <br />RETURNED</td>\n<td>String(1300)</td>\n<td>Worldpay for Platforms Business Id</td>\n</tr>\n<tr>\n<td>error  <br />RETURNED</td>\n<td>textarea (32768)</td>\n<td>Validation errors returned by the Onboarding Process.</td>\n</tr>\n<tr>\n<td>missingfields  <br />RETURNED</td>\n<td>list string</td>\n<td>Validation errors returned by the Onboarding Process.</td>\n</tr>\n<tr>\n<td>Requires3dSecure  <br />RETURNED</td>\n<td>String</td>\n<td>Identifies if this application will require 3dSecure. (Pending/Yes/No)</td>\n</tr>\n<tr>\n<td>status  <br />REQUIRED</td>\n<td>Integer</td>\n<td>Determines the Status of the Application, Data will not be processed until passed as \"1 - Application Complete\".  <br />  <br />Valid Values are:  <br />( -1 = Testing)  <br />(0 = pending / data capture)  <br />(1 = complete / submit)  <br />Note - Only send through the status of 1 when the application is complete as this submits and locks the application for review.</td>\n</tr>\n<tr>\n<td>entity  <br />REQUIRED</td>\n<td>Entity</td>\n<td>The Entity associated with this Merchant.</td>\n</tr>\n<tr>\n<td>established  <br />OPTIONAL</td>\n<td>String</td>\n<td>The date on which the Merchant was established. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.</td>\n</tr>\n<tr>\n<td>externalid  <br />OPTIONAL</td>\n<td>String(60)</td>\n<td>The identifying value from your system to allow cross referencing if reqiured.</td>\n</tr>\n<tr>\n<td>annualCCSales  <br />OPTIONAL</td>\n<td>Integer(18,0)</td>\n<td>The value of the annual credit card sales of this Merchant. This field is specified as an integer in cents. For example, $25.30 is expressed as '2530'.</td>\n</tr>\n<tr>\n<td>onboardingFormUrl  <br />RETURNED</td>\n<td>String(1300)</td>\n<td>Url of the Online Application form to complete this Application.</td>\n</tr>\n</tbody>\n</table>\n</div>","event":[{"listen":"prerequest","script":{"id":"f13d9754-2888-49d0-a607-4a46f7203ee0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4814ba9c-5513-4217-9400-df5a004fb326","type":"text/javascript","exec":[""]}}],"_postman_id":"63dcf6e1-5533-4ff5-bfb4-d6fc5569b96d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","name":"Worldpay for Platforms Merchant Onboarding API","type":"collection"}}},{"name":"Entity","item":[],"id":"341e0da0-de15-4113-8af6-9acdb96c93de","description":"<p>An Entity is the top-level resource of a business in the API. It describes the details of that business in its fields. Each Entity can describe either a Merchant or a Facilitator (payment facilitator).</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th></th>\n<th></th>\n<th></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>type  <br />OPTIONAL</td>\n<td>Integer</td>\n<td>The type of Entity.  <br />VALID VALUES:  <br />  <br />0 = Individual / Sole Proprietorship  <br />1 = Company  <br />3 = Partnership  <br />4 = Trustee  <br />5 = Non-Profit Organization  <br />6 = Government / Council / Statutory Authority  <br />7 = Association</td>\n</tr>\n<tr>\n<td>name  <br />REQUIRED</td>\n<td>String(255)</td>\n<td>The Trading name of this Entity.</td>\n</tr>\n<tr>\n<td>fulllegalname  <br />REQUIRED</td>\n<td>String(255)</td>\n<td>The full legal name for this entity</td>\n</tr>\n<tr>\n<td>address1  <br />OPTIONAL</td>\n<td>String(255)</td>\n<td>The first line of the address associated with this Entity.</td>\n</tr>\n<tr>\n<td>city  <br />OPTIONAL</td>\n<td>String(50)</td>\n<td>The name of the City/Suburb in the address associated with this Entity.</td>\n</tr>\n<tr>\n<td>state  <br />OPTIONAL</td>\n<td>String(150)</td>\n<td>The name of the State in the address associated with this Entity.</td>\n</tr>\n<tr>\n<td>zip  <br />OPTIONAL</td>\n<td>String(9)</td>\n<td>The Postal/Zip code in the address associated with this Entity.</td>\n</tr>\n<tr>\n<td>country  <br />REQUIRED</td>\n<td>String(50)</td>\n<td>The Country in the address associated with this Entity.</td>\n</tr>\n<tr>\n<td>phone  <br />OPTIONAL</td>\n<td>String(40)</td>\n<td>The phone number associated with this Entity.</td>\n</tr>\n<tr>\n<td>email  <br />REQUIRED</td>\n<td>String(80)</td>\n<td>The email associated with this Entity.</td>\n</tr>\n<tr>\n<td>abn  <br />REQUIRED</td>\n<td>String(17)</td>\n<td>The ABN associated to this Entity</td>\n</tr>\n<tr>\n<td>website  <br />OPTIONAL</td>\n<td>String(255)</td>\n<td>The Entity's website</td>\n</tr>\n<tr>\n<td>Industry  <br />OPTIONAL</td>\n<td>String</td>\n<td>The industry which the company trades within.  <br />  <br />See Allowable values for Industries:</td>\n</tr>\n<tr>\n<td>transactionsFor  <br />OPTIONAL</td>\n<td>String(2000)</td>\n<td>The short description of the primary purpose for the transactions to be processed</td>\n</tr>\n<tr>\n<td>maxTransaction  <br />OPTIONAL</td>\n<td>Integer(8,0)</td>\n<td>Maximum anticipated value of a transaction</td>\n</tr>\n<tr>\n<td>avgTransaction  <br />OPTIONAL</td>\n<td>Integer(12,0)</td>\n<td>Average transaction value of transactions</td>\n</tr>\n<tr>\n<td>qtyTransactions  <br />OPTIONAL</td>\n<td>Integer(6,0)</td>\n<td>Approximate number of transactions per month</td>\n</tr>\n<tr>\n<td>paidInArrears  <br />OPTIONAL</td>\n<td>Boolean</td>\n<td>Are Items paid for in Arrears?</td>\n</tr>\n<tr>\n<td>daysinAdvance  <br />OPTIONAL</td>\n<td>Integer</td>\n<td>If items or services are paid for in advance how many days in advance?</td>\n</tr>\n</tbody>\n</table>\n</div>","event":[{"listen":"prerequest","script":{"id":"0daece33-df97-4bf4-b3c2-5a88f3b8e029","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab1e287f-94f3-44b4-ad24-7000b0644052","type":"text/javascript","exec":[""]}}],"_postman_id":"341e0da0-de15-4113-8af6-9acdb96c93de","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","name":"Worldpay for Platforms Merchant Onboarding API","type":"collection"}}},{"name":"Member","item":[],"id":"c6738845-1570-4698-bb50-8030089b556b","description":"<p>A Member is a person who is associated with a Merchant. One Member associated with each Merchant can be the 'primary' Member, meaning the Member with the most share of ownership in the Merchant.</p>\n<table><tbody><tr><td><div>Id<br />OPTIONAL/RETURNED</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Returned as part of the initial Upload of member.<br /><br />Required as part of update of member</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>merchant<br />REQUIRED</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(75)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The Merchant that the Member belongs to.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>title<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(255)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Job title of the Member.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>first<br />REQUIRED</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(50)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The First Name of the Member.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>last<br />REQUIRED</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(50)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The Last Name ofthe Member.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>dob<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The Date Of Birth of the Member. (YYYYDDMM)</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>email<br />REQUIRED</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(80)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The Member's Email address.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Phone<br />REQUIRED</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(40)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The Member's Phone number.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>Biometrics<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Boolean</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Set to <code>true </code>if you to use the WorldPay for Platforms Biometrics tool. We will send an SMS to the member through the Phone number provided to trigger the biometric scan.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>address1<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(255)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The first line of the address associated with this Entity.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>city<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(50)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The name of the City/Suburb in the address associated with this Entity.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>state<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(150)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The name of the State in the address associated with this Entity.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>zip<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(9)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The Postal/Zip code in the address associated with this Entity.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>country<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(50)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The Country in the address associated with this Entity.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>emailFormtoMerchant<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Boolean</div><div><div><div><div></div></div></div><div></div></div></td><td><div>IF <code>true</code> will email a link to the online application form to this member for completion</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>emailtoOwnerForDetails<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Boolean</div><div><div><div><div></div></div></div><div></div></div></td><td><div>if <code>true</code> will email a link to the member to enable them to enter their details including Id formation.<br /></div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>isowner<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Boolean<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Is this contact an Owner of the business.<br /><br />if true Ownership value is required.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>isdirector<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Boolean</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Is this contact a Director of the business.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>isrepresentative<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Boolean</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Is this contact a Representative of the business.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>isexecutive<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Boolean</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Is this contact an Executive of the business.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>isSignatory<br />REQUIRED</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Boolean</div><div><div><div><div></div></div></div><div></div></div></td><td><div>This contact will receive the application verification acceptance email. At least 1 owner must have this set to <code>true</code>.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ownership<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The share of the Member's ownership of the associated Merchant, expressed in basis points. For example, 25.3% is expressed as '2530'. This field is stored as an integer and must be between 1 and 10000 characters long.<br /></div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>typeofid<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Integer</div><div><div><div><div></div></div></div><div></div></div></td><td><div><p>If ID is provided by the Member this field is REQUIRED.<br /></p><div><table><tbody><tr><td><div><b>AVAILABLE VALUES</b></div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>1</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Australian Driver's License</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>2</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Australian Passport</div><div><div><div><div></div></div></div><div></div></div></td></tr></tbody></table></div></div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>idnumber<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div><div><div><div></div></div></div><div></div></div></td><td><div>The id number for the specified type of Identification</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>dlstate<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Drivers license state (Required if Australian Drivers license is Supplied)</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>primary<br />REQUIRED</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Integer</div><div><div><div><div></div></div></div><div></div></div></td><td><div><div><table><tbody><tr><td><div><b>AVAILABLE VALUES</b></div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>0</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Not the Primary Contact for this merchant</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>1</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Is the Primary contact for this Merchant</div><div><div><div><div></div></div></div><div></div></div></td></tr></tbody></table></div></div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>cardnumber<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Alphanumeric, 6-10 char and required if Australian Drivers license is Supplied. See here for more detail:<a href=\"https://vixverify.atlassian.net/wiki/spaces/GREEN/pages/2159345665/Tooltips+Images+for+Card+Number\">https://vixverify.atlassian.net/wiki/spaces/GREEN/pages/2159345665/Tooltips+Images+for+Card+Number</a></div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div></div><div><div><div><div></div></div></div><div></div></div></td><td><div></div><div><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>","event":[{"listen":"prerequest","script":{"id":"ca9540ff-bea5-423f-97cb-d0d75ab7d5e5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4f154629-866c-436c-9ec4-75ab333747f8","type":"text/javascript","exec":[""]}}],"_postman_id":"c6738845-1570-4698-bb50-8030089b556b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","name":"Worldpay for Platforms Merchant Onboarding API","type":"collection"}}},{"name":"Account","item":[],"id":"2d8814df-978e-4655-b2de-cec142612865","description":"<table><tbody><tr><td><div>accountNumber<br />REQUIRED</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(20)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Bank Account number</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>routing<br />REQUIRED</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(9)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>US - Routing number<br />AUS / NZL - BSB<br />UK - Sort Code</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>primary<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Integer</div><div><div><div><div></div></div></div><div></div></div></td><td><div><p>Indicates whether the Account is the 'primary' Account for the associated Entity. Only one Account associated with each Entity can be the 'primary' Account.<br /><br /><b>VALID VALUES</b><br /><br /></p><div><table><tbody><tr><td><div>0</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Not primary</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>1</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Primary</div><div><div><div><div></div></div></div><div></div></div></td></tr></tbody></table></div></div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>accountName<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(100)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>A client-supplied name for this bank account. This field is stored as a text string and must be between 0 and 100 characters long.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>description<br />OPTIONAL</div><div><div><div><div></div></div></div><div></div></div></td><td><div>String(100)</div><div><div><div><div></div></div></div><div></div></div></td><td><div>A client-supplied description for this bank account. This field is stored as a text string and must be between 0 and 100 characters long.</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>accounttype</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Integer</div><div><div><div><div></div></div></div><div></div></div></td><td><div><p><br />Type of account being specified, Settlement or Billing.<br /><br /><b>VALID VALUES</b><br /><br /></p><div><table><tbody><tr><td><div>1</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Settlement</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>2</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Billing</div><div><div><div><div></div></div></div><div></div></div></td></tr></tbody></table></div></div><div><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>","event":[{"listen":"prerequest","script":{"id":"30e334f2-fc5d-4667-a67e-ccea70214891","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"698a66ee-d4bf-416a-9ef3-cafe168c9fa3","type":"text/javascript","exec":[""]}}],"_postman_id":"2d8814df-978e-4655-b2de-cec142612865","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","name":"Worldpay for Platforms Merchant Onboarding API","type":"collection"}}},{"name":"Attachment","item":[],"id":"0fdee333-380f-4080-9a48-ffe8d6ee93de","description":"<table>\n    <tr>\n        <td>FileName<br />REQUIRED</td>\n        <td>String</td>\n        <td>File Name of the attachment.</td>\n    </tr><tr>\n    </tr><tr>\n        <td>typeofattachment<br />REQUIRED</td>\n        <td>Integer</td>\n        <td>\n            <b>VALID VALUES</b><br />\n            <table>\n            <tr>\n                <td>1</td>\n                <td>Identification Front</td>\n            </tr>\n            <tr>\n                <td>2</td>\n                <td>Identification Back</td>\n            </tr>\n            <tr>\n                <td>3</td>\n                <td>Bank Statement</td>\n            </tr>\n            <tr>\n                <td>4</td>\n                <td>Trust Agreement</td>\n            </tr>\n            <tr>\n                <td>5</td>\n                <td>Proof of address</td>\n            </tr>\n            <tr>\n                <td>6</td>\n                <td>Logo</td>\n            </tr>\n            </table> \n        </td>\n    </tr>\n    <tr>\n        <td>parentid<br />REQUIRED</td>\n        <td>String </td>\n        <td>Id of Merchant or Entity. </td>\n    </tr>\n    <tr>\n        <td>attachment<br />REQUIRED</td>\n        <td>Blob</td>\n        <td>Body of the attachment</td>\n    </tr>\n</table>","_postman_id":"0fdee333-380f-4080-9a48-ffe8d6ee93de","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","name":"Worldpay for Platforms Merchant Onboarding API","type":"collection"}}},{"name":"Allowable Values","item":[{"name":"Industry","item":[],"id":"ed981963-cbb2-44c1-a84b-f439eaf5fb27","description":"<table>\n<tr><td>\nSpecialty Health Services\n</td></tr><tr><td>\nPhotography\n</td></tr><tr><td>\nMassage Therapist\n</td></tr><tr><td>\nFlooring\n</td></tr><tr><td>\nRubbish Removal\n</td></tr><tr><td>\nTutor\n</td></tr><tr><td>\nWeight Management\n</td></tr><tr><td>\nMoving and Removalists\n</td></tr><tr><td>\nRoofing\n</td></tr><tr><td>\nTiling and Carpeting\n</td></tr><tr><td>\nPodiatrist\n</td></tr><tr><td>\nVeterinary Services\n</td></tr><tr><td>\nEquipment Hire / Rental\n</td></tr><tr><td>\nGlazing\n</td></tr><tr><td>\nLandscaping\n</td></tr><tr><td>\nPlastering and Ceiling Services\n</td></tr><tr><td>\nOther Trade Services / Home and Repair\n</td></tr><tr><td>\nPhysiotherapist\n</td></tr><tr><td>\nStorage / Self Storage\n</td></tr><tr><td>\nHeating / Air Conditioning\n</td></tr><tr><td>\nDietitian\n</td></tr><tr><td>\nOther Healthcare Services\n</td></tr><tr><td>\nChiropractor/Osteopath\n</td></tr><tr><td>\nPest Control\n</td></tr><tr><td>\nSpeciality Shop\n</td></tr><tr><td>\nSporting Goods\n</td></tr><tr><td>\nUniversity\n</td></tr><tr><td>\nPainting\n</td></tr><tr><td>\nCheer Leading\n</td></tr><tr><td>\nYoga\n</td></tr><tr><td>\nGeneral Contracting\n</td></tr><tr><td>\nLocksmith Services\n</td></tr><tr><td>\nSwimming Pools\n</td></tr><tr><td>\nLaundry Services\n</td></tr><tr><td>\nBarber and Beauty Shops\n</td></tr><tr><td>\nBlueprinting and Photocopying\n</td></tr><tr><td>\nExterminating and Disinfecting\n</td></tr><tr><td>\nEmployment Agencies\n</td></tr><tr><td>\nComputer Maintenance and repair\n</td></tr><tr><td>\nAir Conditioning and Refrigeration Repair\n</td></tr><tr><td>\nMotion Picture and Video Tape Production and Distribution\n</td></tr><tr><td>\nSports Promoter\n</td></tr><tr><td>\nSchools, Business and Secretarial\n</td></tr><tr><td>\nArchitectural, Engineering and Surveying\n</td></tr><tr><td>\nProfessional Services\n</td></tr><tr><td>\nFarm Products, Refrigerated and Household Goods Storage\n</td></tr><tr><td>\nTravel Agencies\n</td></tr><tr><td>\nTelecommunication Servicesphone services\n</td></tr><tr><td>\nComputer Network/Information Services\n</td></tr><tr><td>\nCable, Satellite, and Pay Television\n</td></tr><tr><td>\nMotor Vehicle Supplies\n</td></tr><tr><td>\nMedical Supplies\n</td></tr><tr><td>\nHardware Equipment and Supplies\n</td></tr><tr><td>\nUniforms and Commercial Clothing\n</td></tr><tr><td>\nBuilding Materials, Lumber Stores\n</td></tr><tr><td>\nGeneral Merchandise Stores\n</td></tr><tr><td>\nConfectionery Stores\n</td></tr><tr><td>\nConvenience Stores and Vending Machines\n</td></tr><tr><td>\nAutomotive Parts and Accessories\n</td></tr><tr><td>\nMen's and Boys' Clothing Stores\n</td></tr><tr><td>\nWomen's Ready to Wear Stores\n</td></tr><tr><td>\nSports Apparel, and Riding Apparel Stores\n</td></tr><tr><td>\nShoe Stores\n</td></tr><tr><td>\nAlterations and Seamstresses\n</td></tr><tr><td>\nFireplace, Fireplace Screens\n</td></tr><tr><td>\nFurnishing Specialty Shops\n</td></tr><tr><td>\nComputer Software Stores\n</td></tr><tr><td>\nCaterers\n</td></tr><tr><td>\nFast Food Restaurants\n</td></tr><tr><td>\nBeer, Wine and Liquor\n</td></tr><tr><td>\nBicycle Shops\n</td></tr><tr><td>\nOffice, School Stationery Stores\n</td></tr><tr><td>\nBookkeeping\n</td></tr><tr><td>\nGovernment\n</td></tr><tr><td>\nComputer Sales/Service\n</td></tr><tr><td>\nBricklaying\n</td></tr><tr><td>\nBuilding / Construction\n</td></tr><tr><td>\nCarpentry\n</td></tr><tr><td>\nCarpet Cleaning\n</td></tr><tr><td>\nConcreting\n</td></tr><tr><td>\nArt, Photographer and Film\n</td></tr><tr><td>\nBooks, Mags, Music and Video\n</td></tr><tr><td>\nClothing and Accessories\n</td></tr><tr><td>\nEyeware\n</td></tr><tr><td>\nFlowers and Gifts\n</td></tr><tr><td>\nFurniture / Home Goods\n</td></tr><tr><td>\nGrocery / Market\n</td></tr><tr><td>\nHobby Shop\n</td></tr><tr><td>\nHome Improvement and Building Supplies\n</td></tr><tr><td>\nOffice Supply\n</td></tr><tr><td>\nOther Retail / Online Retail\n</td></tr><tr><td>\nCollege\n</td></tr><tr><td>\nPolitical Organisation\n</td></tr><tr><td>\nReligious Organisation\n</td></tr><tr><td>\nSchools\n</td></tr><tr><td>\nOther Charities, Education and Membership\n</td></tr><tr><td>\nCrossFit\n</td></tr><tr><td>\nGym / Health Club\n</td></tr><tr><td>\nSports and Recreation\n</td></tr><tr><td>\nOther Sport / Fitness and Leisure Membership\n</td></tr><tr><td>\nBed and Breakfast\n</td></tr><tr><td>\nTour Operator\n</td></tr><tr><td>\nOther Tourism\n</td></tr><tr><td>\nInsurance Broker\n</td></tr><tr><td>\nLeasing / Finance\n</td></tr><tr><td>\nShort Term Loans\n</td></tr><tr><td>\nSyndications\n</td></tr><tr><td>\nOther Financial Services\n</td></tr><tr><td>\nAccommodation\n</td></tr><tr><td>\nAccounting\n</td></tr><tr><td>\nArts Studio\n</td></tr><tr><td>\nAssociation\n</td></tr><tr><td>\nBusiness Coach\n</td></tr><tr><td>\nCharity\n</td></tr><tr><td>\nChildcare\n</td></tr><tr><td>\nConsulting\n</td></tr><tr><td>\nDance School\n</td></tr><tr><td>\nElectrical Services\n</td></tr><tr><td>\nEvent Management\n</td></tr><tr><td>\nFinancial Planner\n</td></tr><tr><td>\nGolf Club\n</td></tr><tr><td>\nHome Services\n</td></tr><tr><td>\nInsurance\n</td></tr><tr><td>\nLegal Services\n</td></tr><tr><td>\nMarketing/Advertising\n</td></tr><tr><td>\nMartial Arts\n</td></tr><tr><td>\nMedia Services\n</td></tr><tr><td>\nMedical / Clinic\n</td></tr><tr><td>\nMusic School\n</td></tr><tr><td>\nNon Profit Organisation\n</td></tr><tr><td>\nPersonal Trainer\n</td></tr><tr><td>\nPet Shop / Grooming\n</td></tr><tr><td>\nPlumbing\n</td></tr><tr><td>\nPrinting Services\n</td></tr><tr><td>\nReal Estate Rental\n</td></tr><tr><td>\nSporting Club\n</td></tr><tr><td>\nSwim School\n</td></tr><tr><td>\nTraining RTO\n</td></tr><tr><td>\nUtility\n</td></tr><tr><td>\nVendor Finance\n</td></tr><tr><td>\nAutomotive Services\n</td></tr><tr><td>\nBeauty and Skincare\n</td></tr><tr><td>\nRestaurants / Bars / Eating Places\n</td></tr><tr><td>\nAged Care\n</td></tr><tr><td>\nCleaning - Commercial\n</td></tr><tr><td>\nAir Conditioning Services\n</td></tr><tr><td>\nDentist/Orthodontist\n</td></tr><tr><td>\nGymnastics\n</td></tr><tr><td>\nWineries\n</td></tr>\n</table>","_postman_id":"ed981963-cbb2-44c1-a84b-f439eaf5fb27","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","name":"Worldpay for Platforms Merchant Onboarding API","type":"collection"}}}],"id":"11549559-efa4-4455-987b-f29970055707","_postman_id":"11549559-efa4-4455-987b-f29970055707","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","name":"Worldpay for Platforms Merchant Onboarding API","type":"collection"}}}],"id":"4e9bc030-6a3d-49c1-a928-d575b2ac493e","_postman_id":"4e9bc030-6a3d-49c1-a928-d575b2ac493e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","name":"Worldpay for Platforms Merchant Onboarding API","type":"collection"}}},{"name":"Examples","item":[{"name":"Create Merchant & Email Form","id":"c444c1ea-a220-4d11-b02f-96560a802496","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n  \"partnerid\": \"{{partnerId}}\",\r\n  \"status\": 1,\r\n  \"entity\": {\r\n    \"name\": \"Smith Company\",\r\n    \"fulllegalname\": \"Smith Co Pty Ltd\",\r\n    \"abn\": \"63135196397\",\r\n    \"country\": \"Australia\",\r\n    \"public\": 1\r\n  },\r\n  \"Members\": [\r\n    {\r\n      \"first\": \"James\",\r\n      \"last\": \"Smith\",\r\n      \"email\": james@smith.com.au,\r\n      \"phone\": \"0422242242\",\r\n      \"emailFormtoMerchant\": true,\r\n      \"primary\": 1\r\n    }\r\n  ]\r\n}\r\n"},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"c444c1ea-a220-4d11-b02f-96560a802496"}],"id":"b425da65-f217-4898-a4b6-cdaba1b27b3d","_postman_id":"b425da65-f217-4898-a4b6-cdaba1b27b3d","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]},"isInherited":true,"source":{"_postman_id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","id":"d7beb646-bc46-4ad3-8ab2-f5cda394023a","name":"Worldpay for Platforms Merchant Onboarding API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer-token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"6872fecc-c1fe-4a5e-bfee-78fa2afa5657","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e60bd21e-8843-4408-ab79-be6a9caca517","type":"text/javascript","exec":[""]}}]}