The merchant creation process allows you to integrate the onboarding and merchant creation process with your own application.
\nAPI Endpoints for Merchant Creation:
\nThis collection shows working examples of the merchant creation process for a US based merchant and a Canadian based merchant.
\nBeneficial Ownership
As a financial services company we are required to verify the beneficial owners of each legal entity we create an account for.
The number of owners required to submit is conditional based on FINCEN beneficial ownership regulatory requirements. An officer is required every time.
\nA beneficial owner is defined as one of the following:
\nYou must include all beneficial owners that meet the criteria above when you onboard merchants to us through the API.
\nBy definition of the FinCen rule Sole Proprietorships and Non-Profit organizations do not have to submit owner information. However, they are required to submit the information for an officer. For a Sole Proprietor the owner is the officer.
\nUse the link below to see a live demo of what this could look like and how we recommend collecting the merchant information.
\nhttps://www.tfaforms.com/4914062
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1893747","collectionId":"74d63292-49a6-4767-bbdb-ed4ee5020f70","publishedId":"UUy39mG1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00acd8"},"publishDate":"2021-10-02T23:27:09.000Z"},"item":[{"name":"Merchant API Creation - US","event":[{"listen":"test","script":{"id":"abbe4740-b64e-49dd-86fb-4aff492f920d","exec":["pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"Approved\");","});"],"type":"text/javascript"}}],"id":"5687dd70-142a-4284-8290-86c867ce71e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestType","value":"create","type":"text","description":"Required
Type of operation to be performed.
Required
Your onboarding API username. Please contact us if you don't have one.
Required
Your onboarding API password. Please contact us if you don't have one.
Required
Defines how accounts, tax IDs, descriptors and deposit accounts of a merchant are going to be configured. - Please use SSSM as a default value. If you have a unique business case please work with us to determine what this value should be.
Required
Indicates the profile used to process the merchant application, value provided by Zift.
Required
Identifier of a reseller hierarchy associated with a merchant being created. Value provided by Zift.
Optional
IP-address or a host associated with a submitter that originated the onboarding request.
Required
Associates the merchant within a Zift portfolio hierarchy. Use 200 in sandbox testing.
Required
Indicates the processing fee template that will get applied to the merchant. Please work with us to determine the appropriate fee schedule for your clients. Use 200002 in sandbox testing.
Required
Value provided by Zift. Indicates the processing configuration that will be applied to the merchant.
Optional
This is a unique value from your system. Use this field as a definitive link between new onboarding applications and records in your system.
Required
This field should always be set to x.
Required
The trade name or DBA name of the merchant. Minimum of three characters in this field.
Required
This is the merchants legal business name. It needs to be exactly how the merchant has their legal name registered with the IRS (what they use to file their taxes) and needs to match with the Tax ID value provided in the business.taxId field.
This field does not support apostrophe's
\n"},{"key":"business.ownershipStructureType","value":"LLC","type":"text","description":"Required
Type of legal entity structure.
Required
Physical street address of the merchants business location. No PO Boxes
Required
Unit number, suite number etc. of the merchants business.
Required
City of the merchants business location.
Required
State of the merchants business location.
Required
Zip Code of the merchants business location.
Required
Country of the merchants business location.
Required
Customer service phone number of the merchants business. The field only supports a 10 digit phone number.
Optional
Use this field to specify the description on the cardholders statements. The field has a 21 character limit, supports letters, numbers, commas, apostrophe's, period's, and dash's. Does not support any other characters. If a value isn't specified in this field the cardholder descriptor will be pulled from the merchants DBA name which is the business.businessName field and will be combined with the customer service phone number from the business.descriptorPhone field.
Optional
Use this field to specify the description on the bank account holders statements. The field format is 10 characters : and then 10 more charcters. Supported characters are letters, numbers, commas, apostrophe's, period's, and dash's. Does not support any other characters. If a value isn't specified in this field the descriptor will be pulled from the merchants DBA name which is the business.businessName field and will be combined with the customer service phone number from the business.descriptorPhone field.
Required
This is the merchants 9 digit IRS issued TAX ID number. This value must match with the legal name provided and match the IRS records.
Required
Merchants website. This field doesn't support https:// in the address. For example, please submit as www.zift.io or zift.io, do not submit https://zift.io.
Required
Contact email for the business.
Required
Description of the merchants business, the products and/or sservices they sell.
Optional
Contact phone number for the business. The field only supports a 10 digit phone number.
Required
Please work with us to determine this value in production. It is an industry defined category code. While working in sandbox you can use 7399.
Required
Currency used for the merchants transactions. Default is USD.
Required
The year the merchants business was registered. yyyy
Required
Time zone the merchants business operates in. The field supports the following time zone values:
Required
Estimated annual ACH volume of the merchants business.
Required
Estimated annual credit card volume of the merchants business.
Required
The merchants average ACH transaction size.
Required
The merchants average credit card transaction size.
Required
The merchants highest potential single transaction size.
Required
Name of the merchants bank where they want us to send deposits.
Required
Name on the bank account - typically the name of the business.
This field does not support the following characters , & ' (comma, amersand, apostrophe).
Required
Routing number of the merchants business. Must be a valid 9 digit routing number to test in sandbox.
Required
Bank account number for the merchants business.
Required
Bank account type of the merchants business. Can be C for checking or S for savings.
Required
The following values are the only allowed values:
Required
\n"},{"key":"officer.lastName","value":"Hill","type":"text","description":"Required
\n"},{"key":"officer.street1","value":"251 North Bristol Avenue","type":"text","description":"Required
Physical street address of the officers personal home residence. No P.O. Boxes.
Optional
Apt. #, Unit # etc.
Required
City of the Officers personal residence.
Required
2 character State code
Required
6 digit zip code, no spaces.
Required
2 digit country code, US
RequiredyyyyMMdd
Required
Individuals 9 digit Social Security Number.
Required
Direct phone number for the officer, preferrably not the customer service number. The field only supports a 10 digit phone number.
Required
Personal contact or business email of the officer.
Required
The individuals driver license number. This field does not support dashes.
Required
2 character State code
Required
2 digit country code, US
Conditional
\n"},{"key":"owner.1.lastName","value":"Rogers","type":"text","description":"Conditional
\n"},{"key":"owner.1.street1","value":"251 North Bristol Avenue","type":"text","description":"Conditional
\n"},{"key":"owner.1.street2","value":"","type":"text","description":"Conditional
\n"},{"key":"owner.1.city","value":"Los Angeles","type":"text","description":"Conditional
\n"},{"key":"owner.1.state","value":"CA","type":"text","description":"Conditional
\n"},{"key":"owner.1.zipCode","value":"90001","type":"text","description":"Conditional
6 digit zip code, no spaces
Conditional
\n"},{"key":"owner.1.email","value":"stephen@mybiz.com","type":"text","description":"Conditional
\n"},{"key":"owner.1.birthDate","value":"19810429","type":"text","description":"ConditionalyyyyMMdd
Conditional
Individuals 9 digit Social Security Number.
Conditional
The field only supports a 10 digit phone number.
Conditional
Percentage ownership of the legal entity.
Conditional
The individuals driver license number. Does not support dashes.
Conditional
\n"},{"key":"owner.1.driverLicenseCountryCode","value":"US","type":"text","description":"Conditional
\n"},{"key":"owner.2.firstName","value":"Iron","type":"text","description":"Conditional
\n"},{"key":"owner.2.lastName","value":"Man","type":"text","description":"Conditional
\n"},{"key":"owner.2.street1","value":"251 North Bristol Avenue","type":"text","description":"Conditional
\n"},{"key":"owner.2.street2","value":"Apt 3","type":"text","description":"Conditional
\n"},{"key":"owner.2.city","value":"Los Angeles","type":"text","description":"Conditional
\n"},{"key":"owner.2.state","value":"CA","type":"text","description":"Conditional
\n"},{"key":"owner.2.zipCode","value":"90001","type":"text","description":"Conditional
6 digit zip code
Conditional
\n"},{"key":"owner.2.email","value":"owner.2.email@zift.io","type":"text","description":"Conditional
\n"},{"key":"owner.2.birthDate","value":"19740915","type":"text","description":"ConditionalyyyyMMdd
Conditional
Individuals 9 digit Social Security Number.
Conditional
\n"},{"key":"owner.2.stakePercentage","value":"25","type":"text","description":"Conditional
\n"},{"key":"owner.2.driverLicense","value":"23987298798723","type":"text","description":"Conditional
\n"},{"key":"owner.2.driverLicenseState","value":"CA","type":"text","description":"Conditional
State that issued the drivers license
Conditional
Country code for the drivers license, the state code will match with the country code.
Conditional
\n"},{"key":"owner.3.lastName","value":"Odinson","type":"text","description":"Conditional
\n"},{"key":"owner.3.street1","value":"750 Bel Air Road","type":"text","description":"Conditional
\n"},{"key":"owner.3.street2","value":"","type":"text","description":"Conditional
\n"},{"key":"owner.3.city","value":"Los Angeles","type":"text","description":"Conditional
\n"},{"key":"owner.3.state","value":"CA","type":"text","description":"Conditional
\n"},{"key":"owner.3.zipCode","value":"90001","type":"text","description":"Conditional
\n"},{"key":"owner.3.countryCode","value":"US","type":"text","description":"Conditional
\n"},{"key":"owner.3.email","value":"owner.3.email@zift.io","type":"text","description":"Conditional
\n"},{"key":"owner.3.birthDate","value":"19950625","type":"text","description":"Conditional
\n"},{"key":"owner.3.socialSecurity","value":"339833733","type":"text","description":"Conditional
Individuals 9 digit Social Security Number.
Conditional
\n"},{"key":"owner.3.stakePercentage","value":"25","type":"text","description":"Conditional
\n"},{"key":"owner.3.driverLicense","value":"308937098","type":"text","description":"Conditional
\n"},{"key":"owner.3.driverLicenseState","value":"CA","type":"text","description":"Conditional
\n"},{"key":"owner.3.driverLicenseCountryCode","value":"US","type":"text","description":"Conditional
\n"},{"key":"owner.4.firstName","value":"Loki","type":"text","description":"Conditional
\n"},{"key":"owner.4.lastName","value":"Odinson","type":"text","description":"Conditional
\n"},{"key":"owner.4.street1","value":"750 Bel Air Road","type":"text","description":"Conditional
\n"},{"key":"owner.4.street2","value":"","type":"text","description":"Conditional
\n"},{"key":"owner.4.city","value":"Los Angeles","type":"text","description":"Conditional
\n"},{"key":"owner.4.state","value":"CA","type":"text","description":"Conditional
\n"},{"key":"owner.4.zipCode","value":"90001","type":"text","description":"Conditional
\n"},{"key":"owner.4.countryCode","value":"US","type":"text","description":"Conditional
\n"},{"key":"owner.4.email","value":"owner.4.email@zift.io","type":"text","description":"Conditional
\n"},{"key":"owner.4.birthDate","value":"19641224","type":"text","description":"Conditional
\n"},{"key":"owner.4.socialSecurity","value":"687339822","type":"text","description":"Conditional
Individuals 9 digit Social Security Number.
Conditional
\n"},{"key":"owner.4.stakePercentage","value":"25","type":"text","description":"Conditional
\n"},{"key":"owner.4.driverLicense","value":"sk33908393","type":"text","description":"Conditional
\n"},{"key":"owner.4.driverLicenseState","value":"CA","type":"text","description":"Conditional
\n"},{"key":"owner.4.driverLicenseCountryCode","value":"US","type":"text","description":"Conditional
\n"}]},"url":"https://sandbox-portal.zift.io/gates/onboarding?","description":"Merchant Creation example for onboarding US based merchants.
\nAll phone numbers need to be 10 digit numbers.
\nAll owner fields have the same formatting requirements as described for the officer fields.
\nPlease do not allow your merchants to submit PO Boxes for the business legal address or for any personal addresses of the officer or owners.
\n","urlObject":{"protocol":"https","path":["gates","onboarding"],"host":["sandbox-portal","zift","io"],"query":[{"key":"","value":null}],"variable":[]}},"response":[],"_postman_id":"5687dd70-142a-4284-8290-86c867ce71e3"},{"name":"Merchant API Creation - Canada","event":[{"listen":"test","script":{"id":"da6a931b-19a8-4f88-97ad-be6569e8e4f3","exec":["pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"Approved\");","});"],"type":"text/javascript"}}],"id":"def159b7-b1d1-4ad2-bf52-a94294ab2f76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestType","value":"create","type":"text","description":"Required
Type of operation to be performed.
Required
Your onboarding API username. Please contact us if you don't have one.
Required
Your onboarding API password. Please contact us if you don't have one.
Required
Defines how accounts, tax IDs, descriptors and deposit accounts of a merchant are going to be configured. - Please use SSSM as a default value. If you have a unique business case please work with us to determine what this value should be.
Required
Indicates the profile used to process the merchant application, value provided by Zift. For sandbox testing in Canada use 22405412026.
Required
Identifier of a reseller hierarchy associated with a merchant being created. Value provided by Zift.
Optional
IP-address or a host associated with a submitter that originated the onboarding request.
Required
Associates the merchant within a Zift portfolio hierarchy. Use 200 in sandbox testing.
Required
Indicates the processing fee template that will get applied to the merchant. Please work with us to determine the appropriate fee schedule for your clients. Use 200002 in sandbox testing.
Required
Value provided by Zift. Indicates the processing configuration that will be applied to the merchant. Use sandbox in sandbox testing for Canada.
Optional
This is a unique value from your system. Use this field as a definitive link between new onboarding applications and records in your system.
Required
This field should always be set to x.
Required
The trade name or DBA name of the merchant.
Required
This is the merchants legal business name. It needs to be exactly how the merchant has their legal name registered with the IRS (what they use to file their taxes) and needs to match with the Tax ID value provided in the business.taxId field.
Required
Type of legal entity structure.
Required
Physical street address of the merchants business location.
Required
Unit number, suite number etc. of the merchants business.
Required
City of the merchants business location.
Required
State of the merchants business location.
Required
Zip Code of the merchants business location.
Required
Country of the merchants business location.
Required
Customer service phone number of the merchants business.
Optional
Use this field to specify the description on the cardholders statements. The field has a 21 character limit, supports letters, numbers, commas, apostrophe's, period's, and dash's. Does not support any other characters. If a value isn't specified in this field the cardholder descriptor will be pulled from the merchants DBA name which is the business.businessName field and will be combined with the customer service phone number from the business.descriptorPhone field.
Optional
Use this field to specify the description on the bank account holders statements. The field format is 10 characters : and then 10 more charcters. Supported characters are letters, numbers, commas, apostrophe's, period's, and dash's. Does not support any other characters. If a value isn't specified in this field the descriptor will be pulled from the merchants DBA name which is the business.businessName field and will be combined with the customer service phone number from the business.descriptorPhone field.
Required
Merchants Business Number assigned by the Canada Revenue Agency. The CRA assigns merchants a 15 digit account number. The account number consists of three parts.
Required
Merchants website. This field doesn't support https:// in the address. For example, please submit as www.zift.io or zift.io DO NOT submit https://zift.io
Required
Contact email for the business.
Required
Description of the merchants business, the products and/or sservices they sell.
Optional
\n","disabled":true},{"key":"business.merchantCategoryCode","value":"7399","type":"text","description":"Required
Please work with us to determine this value in production. It is an industry defined category code. While working in sandbox you can use 7399.
Required
Currency used for the merchants transactions. Default is USD. For Canadian merchants use CAD.
Required
The year the merchants business was registered. yyyy
Required
Time zone the merchants business operates in. The field supports the following time zone values:
Required
Estimated annual ACH volume of the merchants business.
Required
Estimated annual credit card volume of the merchants business.
Required
The merchants average ACH transaction size.
Required
The merchants average credit card transaction size.
Required
The merchants highest potential single transaction size.
Required
Name of the merchants bank where they want us to send deposits.
Required
Name on the bank account - typically the name of the business.
This field does not support the following characters , & ' (comma, amersand, apostrophe).
Required
Routing number of the merchants business. Must be a valid 9 digit routing number to test in sandbox.
Required
Bank account number for the business.
Required
Bank account type of the merchants business. Can be C for checking or S for savings.
Required
The following values are the only allowed values:
Required
\n"},{"key":"officer.lastName","value":"Hill","type":"text","description":"Required
\n"},{"key":"officer.street1","value":"3590 Woodvale Drive","type":"text","description":"Required
Street address of the owners personal residence.
Optional
\n"},{"key":"officer.city","value":"Lambeth","type":"text","description":"Required
City of the owners personal residence.
Required
2 character Provincial code
Required
6 digit zip code, no spaces.
Required
2 digit country code, CA for Canada.
RequiredyyyyMMdd
Required
Individuals 9 digit Social Insurance Number. This field is not required in Canada, however, we currently require it on the API.
If your Canadian merchants don't want to provide this value or you don't want to collect it from them you can hard code a 9 digit number in this field to get it through our API but need to notify us if you do that.
Required
Direct phone number for the officer, preferrably not the customer service number. Must only be 10 digits.
Required
\n"},{"key":"officer.driverLicense","value":"T309803A33393","type":"text","description":"Required
The individuals driver license number. Does not support dashes.
Required
2 character Provincial code
Required
2 digit country code, CA for Canada.
Conditional
\n"},{"key":"owner.1.lastName","value":"Rogers","type":"text","description":"Conditional
\n"},{"key":"owner.1.street1","value":"4625 Essendene Avenue","type":"text","description":"Conditional
\n"},{"key":"owner.1.street2","value":"","type":"text","description":"Conditional
\n"},{"key":"owner.1.city","value":"Abbotsford","type":"text","description":"Conditional
\n"},{"key":"owner.1.state","value":"BC","type":"text","description":"Conditional
\n"},{"key":"owner.1.zipCode","value":"V2S2H7","type":"text","description":"Conditional
6 digit zip code, no spaces
Conditional
\n"},{"key":"owner.1.email","value":"stephen@mybiz.com","type":"text","description":"Conditional
\n"},{"key":"owner.1.birthDate","value":"19810429","type":"text","description":"ConditionalyyyyMMdd
Conditional
Individuals 9 digit Social Insurance Number. This field is not required in Canada, however, we currently require it on the API.
If your Canadian merchants don't want to provide this value or you don't want to collect it from them you can hard code a 9 digit number in this field to get it through our API but need to notify us if you do that.
Conditional
10 digit phone number
Conditional
Percentage ownership of the legal entity.
Conditional
The individuals driver license number. Does not support dashes.
Conditional
\n"},{"key":"owner.1.driverLicenseCountryCode","value":"CA","type":"text","description":"Conditional
\n"},{"key":"owner.2.firstName","value":"Iron","type":"text","description":"Conditional
\n"},{"key":"owner.2.lastName","value":"Man","type":"text","description":"Conditional
\n"},{"key":"owner.2.street1","value":"696 Burdett Avenue","type":"text","description":"Conditional
\n"},{"key":"owner.2.street2","value":"Apt 3","type":"text","description":"Conditional
\n"},{"key":"owner.2.city","value":"Terrace","type":"text","description":"Conditional
\n"},{"key":"owner.2.state","value":"BC","type":"text","description":"Conditional
\n"},{"key":"owner.2.zipCode","value":"V8G1S2","type":"text","description":"Conditional
6 digit zip code
Conditional
\n"},{"key":"owner.2.email","value":"owner.2.email@zift.io","type":"text","description":"Conditional
\n"},{"key":"owner.2.birthDate","value":"19740915","type":"text","description":"ConditionalyyyyMMdd
Conditional
Individuals 9 digit Social Insurance Number. This field is not required in Canada, however, we currently require it on the API.
If your Canadian merchants don't want to provide this value or you don't want to collect it from them you can hard code a 9 digit number in this field to get it through our API but need to notify us if you do that.
Conditional
\n"},{"key":"owner.2.stakePercentage","value":"25","type":"text","description":"Conditional
\n"},{"key":"owner.2.driverLicense","value":"23987298798723","type":"text","description":"Conditional
\n"},{"key":"owner.2.driverLicenseState","value":"ON","type":"text","description":"Conditional
Province that issued the drivers license
Conditional
Country code for the drivers license, the province code will match with the country code.
Conditional
\n"},{"key":"owner.3.lastName","value":"Odinson","type":"text","description":"Conditional
\n"},{"key":"owner.3.street1","value":"1900 Bank St","type":"text","description":"Conditional
\n"},{"key":"owner.3.street2","value":"","type":"text","description":"Conditional
\n"},{"key":"owner.3.city","value":"Ottawa","type":"text","description":"Conditional
\n"},{"key":"owner.3.state","value":"ON","type":"text","description":"Conditional
\n"},{"key":"owner.3.zipCode","value":"K1H7Z1","type":"text","description":"Conditional
\n"},{"key":"owner.3.countryCode","value":"CA","type":"text","description":"Conditional
\n"},{"key":"owner.3.email","value":"owner.3.email@zift.io","type":"text","description":"Conditional
\n"},{"key":"owner.3.birthDate","value":"19950625","type":"text","description":"Conditional
\n"},{"key":"owner.3.socialSecurity","value":"339833733","type":"text","description":"Conditional
Individuals 9 digit Social Insurance Number. This field is not required in Canada, however, we currently require it on the API.
If your Canadian merchants don't want to provide this value or you don't want to collect it from them you can hard code a 9 digit number in this field to get it through our API but need to notify us if you do that.
Conditional
\n"},{"key":"owner.3.stakePercentage","value":"25","type":"text","description":"Conditional
\n"},{"key":"owner.3.driverLicense","value":"308937098","type":"text","description":"Conditional
\n"},{"key":"owner.3.driverLicenseState","value":"ON","type":"text","description":"Conditional
\n"},{"key":"owner.3.driverLicenseCountryCode","value":"CA","type":"text","description":"Conditional
\n"},{"key":"owner.4.firstName","value":"Loki","type":"text","description":"Conditional
\n"},{"key":"owner.4.lastName","value":"Odinson","type":"text","description":"Conditional
\n"},{"key":"owner.4.street1","value":"2402 Neilson Avenue","type":"text","description":"Conditional
\n"},{"key":"owner.4.street2","value":"","type":"text","description":"Conditional
\n"},{"key":"owner.4.city","value":"Toronto","type":"text","description":"Conditional
\n"},{"key":"owner.4.state","value":"ON","type":"text","description":"Conditional
\n"},{"key":"owner.4.zipCode","value":"M1M1V1","type":"text","description":"Conditional
\n"},{"key":"owner.4.countryCode","value":"CA","type":"text","description":"Conditional
\n"},{"key":"owner.4.email","value":"owner.4.email@zift.io","type":"text","description":"Conditional
\n"},{"key":"owner.4.birthDate","value":"19641224","type":"text","description":"Conditional
\n"},{"key":"owner.4.socialSecurity","value":"687339822","type":"text","description":"Conditional
Individuals 9 digit Social Insurance Number. This field is not required in Canada, however, we currently require it on the API.
If your Canadian merchants don't want to provide this value or you don't want to collect it from them you can hard code a 9 digit number in this field to get it through our API but need to notify us if you do that.
Conditional
\n"},{"key":"owner.4.stakePercentage","value":"25","type":"text","description":"Conditional
\n"},{"key":"owner.4.driverLicense","value":"sk33908393","type":"text","description":"Conditional
\n"},{"key":"owner.4.driverLicenseState","value":"ON","type":"text","description":"Conditional
\n"},{"key":"owner.4.driverLicenseCountryCode","value":"CA","type":"text","description":"Conditional
\n"}]},"url":"https://sandbox-portal.zift.io/gates/onboarding?","description":"Merchant Creation example for onboarding Canada based merchants.
\nAll phone numbers need to be 10 digit numbers.
\nAll owner fields have the same formatting requirements as described for the officer fields.
\nPlease do not allow your merchants to submit PO Boxes for the business legal address or for any personal addresses of the officer or owners.
\n","urlObject":{"protocol":"https","path":["gates","onboarding"],"host":["sandbox-portal","zift","io"],"query":[{"key":"","value":null}],"variable":[]}},"response":[{"id":"1882308d-118b-43d3-bed9-52d113da7736","name":"Merchant API Creation - Canada","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestType","value":"create","type":"text","description":"**Required** \nType of operation to be performed."},{"key":"userName","value":"{{username}}","type":"text","description":"**Required** \nYour onboarding API username. Please contact us if you don't have one. "},{"key":"password","value":"{{password}}","type":"text","description":"**Required** \nYour onboarding API password. Please contact us if you don't have one. "},{"key":"merchantProfile","value":"SSSSM","type":"text","description":"**Required** \nDefines how accounts, tax IDs, descriptors and deposit accounts of a merchant are going to be configured. - Please use `SSSM` as a default value. If you have a unique business case please work with us to determine what this value should be. "},{"key":"profileId","value":"22405412026","type":"text","description":"**Required** \nIndicates the profile used to process the merchant application, value provided by Zift. For sandbox testing in Canada use `22405412026`."},{"key":"resellerId","value":"","type":"text","description":"**Required** \nIdentifier of a reseller hierarchy associated with a merchant being created. Value provided by Zift."},{"key":"clientHost","value":"","type":"text","description":"**Optional** \nIP-address or a host associated with a submitter that originated the onboarding request."},{"key":"portfolioId","value":"200","type":"text","description":"**Required** \nAssociates the merchant within a Zift portfolio hierarchy. Use `200` in sandbox testing."},{"key":"feeTemplateId","value":"200002","type":"text","description":"**Required** \nIndicates the processing fee template that will get applied to the merchant. Please work with us to determine the appropriate fee schedule for your clients. Use `200002` in sandbox testing."},{"key":"processingConfigurationScript","value":"sandbox","type":"text","description":"**Required** \nValue provided by Zift. Indicates the processing configuration that will be applied to the merchant. Use `sandbox` in sandbox testing for Canada."},{"key":"applicationCode","value":"","type":"text","description":"**Optional** \nThis is a unique value from your system. Use this field as a definitive link between new onboarding applications and records in your system."},{"key":"notificationPolicy","value":"x","type":"text","description":"**Required** \nThis field should always be set to `x`. "},{"key":"business.businessName","value":"My Business DBA Name","type":"text","description":"**Required** \nThe trade name or DBA name of the merchant."},{"key":"business.legalName","value":"My Business Legal Name LLC","type":"text","description":"**Required** \nThis is the merchants legal business name. It needs to be exactly how the merchant has their legal name registered with the IRS (what they use to file their taxes) and needs to match with the Tax ID value provided in the business.taxId field."},{"key":"business.ownershipStructureType","value":"LLC","type":"text","description":"**Required** \nType of legal entity structure. \n\n| Value | Description |\n| ------------- |:-------------:|\n| C | Public Corporation |\n| GA | Government Agency |\n| GP | General Partnership |\n| LLC | Limited Liability Company |\n| NP | Nonprofit Corporation |\n| PC | Private Corporation |\n| SP | Sole Proprietorship | "},{"key":"business.street1","value":"3421 St Jean Baptiste St","type":"text","description":"**Required** \nPhysical street address of the merchants business location."},{"key":"business.street2","value":"Seventh Floor","type":"text","description":"**Required** \nUnit number, suite number etc. of the merchants business. "},{"key":"business.city","value":"St Fabien De Panet","type":"text","description":"**Required** \nCity of the merchants business location. "},{"key":"business.state","value":"QC","type":"text","description":"**Required** \nState of the merchants business location."},{"key":"business.zipCode","value":"G0R2J0","type":"text","description":"**Required** \nZip Code of the merchants business location."},{"key":"business.countryCode","value":"CA","type":"text","description":"**Required** \nCountry of the merchants business location."},{"key":"business.descriptorPhone","value":"8774561382","type":"text","description":"**Required** \nCustomer service phone number of the merchants business."},{"key":"business.paymentCardDescriptor","value":"","type":"text","description":"**Optional** \nUse this field to specify the description on the cardholders statements. The field has a 21 character limit, supports letters, numbers, commas, apostrophe's, period's, and dash's. Does not support any other characters. If a value isn't specified in this field the cardholder descriptor will be pulled from the merchants DBA name which is the `business.businessName` field and will be combined with the customer service phone number from the `business.descriptorPhone` field. ","disabled":true},{"key":"business.directDebitDescriptor","value":"","type":"text","description":"**Optional** \nUse this field to specify the description on the bank account holders statements. The field format is 10 characters `:` and then 10 more charcters. Supported characters are letters, numbers, commas, apostrophe's, period's, and dash's. Does not support any other characters. If a value isn't specified in this field the descriptor will be pulled from the merchants DBA name which is the `business.businessName` field and will be combined with the customer service phone number from the `business.descriptorPhone` field. ","disabled":true},{"key":"business.taxId","value":"451165801","type":"text","description":"**Required** \nMerchants Business Number assigned by the Canada Revenue Agency. The CRA assigns merchants a 15 digit account number. The account number consists of three parts. \n1. Nine-digit Business Number (BN) that identifies the business. \n2. Two-letter identifier for the program type. \n3. Four-digit reference number for the program account. \n**WE ONLY SUPPORT THE FIRST NINE DIDGETS IN THIS FIELD WHICH REPRESENTS THE BUSINESS NUMBER**. \nUse a value that ends in 01 to get an approved response in sandbox. "},{"key":"business.webSite","value":"zift.io","type":"text","description":"**Required** \nMerchants website. This field doesn't not support https:// in the address. For example, please submit as www.zift.io or zift.io"},{"key":"business.email","value":"business.email@zift.io","type":"text","description":"**Required** \nContact email for the busienss."},{"key":"business.description","value":"Description of the stuff I sell","type":"text","description":"**Required** \nDescription of the merchants business, the products and/or sservices they sell."},{"key":"business.contactPhone","value":"8014850524","type":"text","description":"**Optional**","disabled":true},{"key":"business.merchantCategoryCode","value":"7399","type":"text","description":"**Required** \nPlease work with us to determine this value in production. It is an industry defined category code. While working in sandbox you can use `7399`. "},{"key":"business.currencyCode","value":"CAD","type":"text","description":"**Required** \nCurrency used for the merchants transactions. Default is `USD`. For Canadian merchants use `CAD`."},{"key":"business.registrationYear","value":"2015","type":"text","description":"**Required** \nThe year the merchants business was registered. `yyyy`"},{"key":"business.timeZoneCode","value":"MST","type":"text","description":"**Required** \nTime zone the merchants business operates in. The field supports the following time zone values: \n- EST \n- CST \n- MST \n- PST"},{"key":"estimates.annualDirectDebitVolume","value":"900000","type":"text","description":"**Required** \nEstimated annual ACH volume of the merchants business."},{"key":"estimates.annualCardsVolume","value":"900000","type":"text","description":"**Required** \nEstimated annual credit card volume of the merchants business."},{"key":"estimates.avgDirectDebitTransactionAmount","value":"250","type":"text","description":"**Required** \nThe merchants average ACH transaction size."},{"key":"estimates.avgCardsTransactionAmount","value":"250","type":"text","description":"**Required** \nThe merchants average credit card transaction size."},{"key":"estimates.maxTransactionAmount","value":"3000","type":"text","description":"**Required** \nThe merchants highest potential single transaction size. "},{"key":"officer.title","value":"General Manager","type":"text","description":"**Required** \nThe following values are the only allowed values: \n- Owner \n- Partner \n- Director \n- President \n- CEO \n- CFO \n- Chairman \n- Comptroller \n- General Manager \n- Office Manager \n- Treasurer \n- Vice President"},{"key":"officer.firstName","value":"Maria","type":"text","description":"**Required**"},{"key":"officer.lastName","value":"Hill","type":"text","description":"**Required**"},{"key":"officer.street1","value":"3590 Woodvale Drive","type":"text","description":"**Required**"},{"key":"officer.street2","value":"","type":"text","description":"**Optional**"},{"key":"officer.city","value":"Lambeth","type":"text","description":"**Required**"},{"key":"officer.state","value":"ON","type":"text","description":"**Required** \n2 character Provincial code"},{"key":"officer.zipCode","value":"N0L1S2","type":"text","description":"**Required** \n6 digit zip code, no spaces."},{"key":"officer.countryCode","value":"CA","type":"text","description":"**Required** \n2 digit country code, `CA` for Canada."},{"key":"officer.birthDate","value":"19640906","type":"text","description":"**Required** \n`yyyyMMdd`"},{"key":"officer.socialSecurity","value":"555555555","type":"text","description":"**Required** \nIndividuals 9 digit Social Insurance Number. This field is not required in Canada, however, we currently require it on the API. \nIf your Canadian merchants don't want to provide this value or you don't want to collect it from them you can hard code a 9 digit number in this field to get it through our API but need to notify us if you do that. "},{"key":"officer.phone","value":"8018888888","type":"text","description":"**Required** \nDirect phone number for the officer, preferrably not the customer service number. "},{"key":"officer.email","value":"thor@asgard.com","type":"text","description":"**Required**"},{"key":"officer.driverLicense","value":"T309803A33393","type":"text","description":"**Required** \nThe individuals driver license number. Does not support dashes. "},{"key":"officer.driverLicenseState","value":"ON","type":"text","description":"**Required** \n2 character Provincial code"},{"key":"officer.driverLicenseCountryCode","value":"CA","type":"text","description":"**Required** \n2 digit country code, `CA` for Canada."},{"key":"owner.1.firstName","value":"Stephen","type":"text","description":"**Conditional**"},{"key":"owner.1.lastName","value":"Rogers","type":"text","description":"**Conditional**"},{"key":"owner.1.street1","value":"4625 Essendene Avenue","type":"text","description":"**Conditional**"},{"key":"owner.1.street2","value":"","type":"text","description":"**Conditional**"},{"key":"owner.1.city","value":"Abbotsford","type":"text","description":"**Conditional**"},{"key":"owner.1.state","value":"BC","type":"text","description":"**Conditional**"},{"key":"owner.1.zipCode","value":"V2S2H7","type":"text","description":"**Conditional** \n6 digit zip code, no spaces"},{"key":"owner.1.countryCode","value":"CA","type":"text","description":"**Conditional**"},{"key":"owner.1.email","value":"stephen@mybiz.com","type":"text","description":"**Conditional**"},{"key":"owner.1.birthDate","value":"19810429","type":"text","description":"**Conditional** \n`yyyyMMdd`"},{"key":"owner.1.socialSecurity","value":"354984476","type":"text","description":"**Conditional** \nIndividuals 9 digit Social Insurance Number. This field is not required in Canada, however, we currently require it on the API. \nIf your Canadian merchants don't want to provide this value or you don't want to collect it from them you can hard code a 9 digit number in this field to get it through our API but need to notify us if you do that. "},{"key":"owner.1.phone","value":"8018450524","type":"text","description":"**Conditional** \n10 digit phone number"},{"key":"owner.1.stakePercentage","value":"19","type":"text","description":"**Conditional** \nPercentage ownership of the legal entity."},{"key":"owner.1.driverLicense","value":"A191817625FX","type":"text","description":"**Conditional** \nThe individuals driver license number. Does not support dashes. "},{"key":"owner.1.driverLicenseState","value":"BC","type":"text","description":"**Conditional**"},{"key":"owner.1.driverLicenseCountryCode","value":"CA","type":"text","description":"**Conditional**"},{"key":"owner.2.firstName","value":"Iron","type":"text","description":"**Conditional**"},{"key":"owner.2.lastName","value":"Man","type":"text","description":"**Conditional**"},{"key":"owner.2.street1","value":"696 Burdett Avenue","type":"text","description":"**Conditional**"},{"key":"owner.2.street2","value":"Apt 3","type":"text","description":"**Conditional**"},{"key":"owner.2.city","value":"Terrace","type":"text","description":"**Conditional**"},{"key":"owner.2.state","value":"BC","type":"text","description":"**Conditional**"},{"key":"owner.2.zipCode","value":"V8G1S2","type":"text","description":"**Conditional** \n6 digit zip code"},{"key":"owner.2.countryCode","value":"CA","type":"text","description":"**Conditional**"},{"key":"owner.2.email","value":"owner.2.email@zift.io","type":"text","description":"**Conditional**"},{"key":"owner.2.birthDate","value":"19740915","type":"text","description":"**Conditional** \n`yyyyMMdd`"},{"key":"owner.2.socialSecurity","value":"453002298","type":"text","description":"**Conditional** \nIndividuals 9 digit Social Insurance Number. This field is not required in Canada, however, we currently require it on the API. \nIf your Canadian merchants don't want to provide this value or you don't want to collect it from them you can hard code a 9 digit number in this field to get it through our API but need to notify us if you do that. "},{"key":"owner.2.phone","value":"2222222222","type":"text","description":"**Conditional**"},{"key":"owner.2.stakePercentage","value":"25","type":"text","description":"**Conditional**"},{"key":"owner.2.driverLicense","value":"23987298798723","type":"text","description":"**Conditional**"},{"key":"owner.2.driverLicenseState","value":"ON","type":"text","description":"**Conditional** \nProvince that issued the drivers license"},{"key":"owner.2.driverLicenseCountryCode","value":"CA","type":"text","description":"**Conditional** \nCountry code for the drivers license, the province code will match with the country code. "},{"key":"owner.3.firstName","value":"Thor","type":"text","description":"**Conditional**"},{"key":"owner.3.lastName","value":"Odinson","type":"text","description":"**Conditional**"},{"key":"owner.3.street1","value":"1900 Bank St","type":"text","description":"**Conditional**"},{"key":"owner.3.street2","value":"","type":"text","description":"**Conditional**"},{"key":"owner.3.city","value":"Ottawa","type":"text","description":"**Conditional**"},{"key":"owner.3.state","value":"ON","type":"text","description":"**Conditional**"},{"key":"owner.3.zipCode","value":"K1H7Z1","type":"text","description":"**Conditional**"},{"key":"owner.3.countryCode","value":"CA","type":"text","description":"**Conditional**"},{"key":"owner.3.email","value":"owner.3.email@zift.io","type":"text","description":"**Conditional**"},{"key":"owner.3.birthDate","value":"19950625","type":"text","description":"**Conditional**"},{"key":"owner.3.socialSecurity","value":"339833733","type":"text","description":"**Conditional** \nIndividuals 9 digit Social Insurance Number. This field is not required in Canada, however, we currently require it on the API. \nIf your Canadian merchants don't want to provide this value or you don't want to collect it from them you can hard code a 9 digit number in this field to get it through our API but need to notify us if you do that. "},{"key":"owner.3.phone","value":"3333333333","type":"text","description":"**Conditional**"},{"key":"owner.3.stakePercentage","value":"25","type":"text","description":"**Conditional**"},{"key":"owner.3.driverLicense","value":"308937098","type":"text","description":"**Conditional**"},{"key":"owner.3.driverLicenseState","value":"ON","type":"text","description":"**Conditional**"},{"key":"owner.3.driverLicenseCountryCode","value":"CA","type":"text","description":"**Conditional**"},{"key":"owner.4.firstName","value":"Loki","type":"text","description":"**Conditional**"},{"key":"owner.4.lastName","value":"Odinson","type":"text","description":"**Conditional**"},{"key":"owner.4.street1","value":"2402 Neilson Avenue","type":"text","description":"**Conditional**"},{"key":"owner.4.street2","value":"","type":"text","description":"**Conditional**"},{"key":"owner.4.city","value":"Toronto","type":"text","description":"**Conditional**"},{"key":"owner.4.state","value":"ON","type":"text","description":"**Conditional**"},{"key":"owner.4.zipCode","value":"M1M1V1","type":"text","description":"**Conditional**"},{"key":"owner.4.countryCode","value":"CA","type":"text","description":"**Conditional**"},{"key":"owner.4.email","value":"owner.4.email@zift.io","type":"text","description":"**Conditional**"},{"key":"owner.4.birthDate","value":"19641224","type":"text","description":"**Conditional**"},{"key":"owner.4.socialSecurity","value":"687339822","type":"text","description":"**Conditional** \nIndividuals 9 digit Social Insurance Number. This field is not required in Canada, however, we currently require it on the API. \nIf your Canadian merchants don't want to provide this value or you don't want to collect it from them you can hard code a 9 digit number in this field to get it through our API but need to notify us if you do that. "},{"key":"owner.4.phone","value":"4444444444","type":"text","description":"**Conditional**"},{"key":"owner.4.stakePercentage","value":"25","type":"text","description":"**Conditional**"},{"key":"owner.4.driverLicense","value":"sk33908393","type":"text","description":"**Conditional**"},{"key":"owner.4.driverLicenseState","value":"ON","type":"text","description":"**Conditional**"},{"key":"owner.4.driverLicenseCountryCode","value":"CA","type":"text","description":"**Conditional**"},{"key":"deposit.bankName","value":"WELLS FARGO BANK","type":"text","description":"**Required** \nName of the merchants bank where they want us to send deposits. "},{"key":"deposit.holderName","value":"My Business Name","type":"text","description":"**Required** \nName on the bank account - typically the name of the business. "},{"key":"deposit.routingNumber","value":"000125039","type":"text","description":"**Required** \nRouting number of the merchants business. Must be a valid 9 digit routing number to test in sandbox. "},{"key":"deposit.accountNumber","value":"498568875","type":"text","description":"**Required**"},{"key":"deposit.accountType","value":"C","type":"text","description":"**Required** \nBank account type of the merchants business. Can be `C` for checking or `S` for savings. "}]},"url":"{{url}}"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 01 Sep 2021 22:46:51 GMT"},{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=63072000"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"6882094bc99b2707-DEN"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"responseType=create&applicationId=11004&officer.id=11004&merchantId=4508000&accountId=4508001&cardsDescriptor=ZFT*My Busines-8774561382&directDebitDescriptor=ZFT*My Business :8774561382&responseCode=A01&responseMessage=Approved&providerResponseCode=01&providerResponseMessage=Approved&owner.1.id=14494&owner.1.statusCode=P&owner.2.id=14504&owner.2.statusCode=P&owner.3.id=14514&owner.3.statusCode=P&owner.4.id=14524&owner.4.statusCode=P&"}],"_postman_id":"def159b7-b1d1-4ad2-bf52-a94294ab2f76"}],"event":[{"listen":"prerequest","script":{"id":"0de783bf-18e4-4acf-8315-6b981edc41c7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a512323f-5a32-49de-97cf-08716091e910","type":"text/javascript","exec":["pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"Approved\");","});"]}}]}