Onboarding APIs

Examples

Create with Full Information

https://[server-name]?requestType=create&userName=myUsername&password=myP%40ssword&profileId=100001&isEmbedded=0&pageFormat=OBDA&cancelURL=http%3A%2F%2Fyour.domain.com%2Fcancel&returnURL=http%3A%2F%2Fyour.domain.com%2Freturn&portfolioId=100&business.businessName=Z-O-O%20Planet%20LLC&business.ownershipStructureType=LLC&business.street1=1357%20Poplar%20Lane&business.city=Berwick&business.zipCode=03901&business.taxId=978726802&business.state=ME&business.legalName=Z-O-O%20Planet%20LLC&business.descriptorPhone=6624903046&business.email=loganlogan%40angelfire.com&business.merchantCategoryCode=5411&estimates.annualDirectDebitVolume=21474836&estimates.annualCardsVolume=21474836&estimates.avgDirectDebitTransactionAmount=21474836&estimates.avgCardsTransactionAmount=21474836&estimates.maxTransactionAmount=21474836&owner.X.firstName=Logan&owner.X.lastName=Logan&owner.X.email=loganlogan%40angelfire.com&owner.X.street1=1357%20Poplar%20Lane&owner.X.city=Berwick&owner.X.countryCode=US&owner.X.zipCode=03901&owner.X.birthDate=19850101&owner.X.socialSecurity=004-98-9205&owner.X.phone=6624903046&owner.X.stakePercentage=52&owner.X.state=ME&deposit.holderName=Miles%20O%27Brian&deposit.routingNumber=021000021&deposit.accountNumber=4099999992
Operation        

Operation Type        


//More examples this http://curl.haxx.se/docs/httpscripting.html 
 curl -X POST https://[server-name]? \         
 	 -d "requestType=create" \ 
	 -d "userName=myUsername" \ 
	 -d "password=myP%40ssword" \ 
	 -d "profileId=100001" \ 
	 -d "isEmbedded=0" \ 
	 -d "pageFormat=OBDA" \ 
	 -d "cancelURL=http%3A%2F%2Fyour.domain.com%2Fcancel" \ 
	 -d "returnURL=http%3A%2F%2Fyour.domain.com%2Freturn" \ 
	 -d "portfolioId=100" \ 
	 -d "business.businessName=Z-O-O%20Planet%20LLC" \ 
	 -d "business.ownershipStructureType=LLC" \ 
	 -d "business.street1=1357%20Poplar%20Lane" \ 
	 -d "business.city=Berwick" \ 
	 -d "business.zipCode=03901" \ 
	 -d "business.taxId=978726802" \ 
	 -d "business.state=ME" \ 
	 -d "business.legalName=Z-O-O%20Planet%20LLC" \ 
	 -d "business.descriptorPhone=6624903046" \ 
	 -d "business.email=loganlogan%40angelfire.com" \ 
	 -d "business.merchantCategoryCode=5411" \ 
	 -d "estimates.annualDirectDebitVolume=21474836" \ 
	 -d "estimates.annualCardsVolume=21474836" \ 
	 -d "estimates.avgDirectDebitTransactionAmount=21474836" \ 
	 -d "estimates.avgCardsTransactionAmount=21474836" \ 
	 -d "estimates.maxTransactionAmount=21474836" \ 
	 -d "owner.X.firstName=Logan" \ 
	 -d "owner.X.lastName=Logan" \ 
	 -d "owner.X.email=loganlogan%40angelfire.com" \ 
	 -d "owner.X.street1=1357%20Poplar%20Lane" \ 
	 -d "owner.X.city=Berwick" \ 
	 -d "owner.X.countryCode=US" \ 
	 -d "owner.X.zipCode=03901" \ 
	 -d "owner.X.birthDate=19850101" \ 
	 -d "owner.X.socialSecurity=004-98-9205" \ 
	 -d "owner.X.phone=6624903046" \ 
	 -d "owner.X.stakePercentage=52" \ 
	 -d "owner.X.state=ME" \ 
	 -d "deposit.holderName=Miles%20O%27Brian" \ 
	 -d "deposit.routingNumber=021000021" \ 
	 -d "deposit.accountNumber=4099999992" 
 
 
 

key: requestType create
key: userName myUsername
key: password myP%40ssword
key: profileId 100001
key: isEmbedded 0
key: pageFormat OBDA
key: cancelURL http%3A%2F%2Fyour.domain.com%2Fcancel
key: returnURL http%3A%2F%2Fyour.domain.com%2Freturn
key: portfolioId 100
key: business.businessName Z-O-O%20Planet%20LLC
key: business.ownershipStructureType LLC
key: business.street1 1357%20Poplar%20Lane
key: business.city Berwick
key: business.zipCode 03901
key: business.taxId 978726802
key: business.state ME
key: business.legalName Z-O-O%20Planet%20LLC
key: business.descriptorPhone 6624903046
key: business.email loganlogan%40angelfire.com
key: business.merchantCategoryCode 5411
key: estimates.annualDirectDebitVolume 21474836
key: estimates.annualCardsVolume 21474836
key: estimates.avgDirectDebitTransactionAmount 21474836
key: estimates.avgCardsTransactionAmount 21474836
key: estimates.maxTransactionAmount 21474836
key: owner.X.firstName Logan
key: owner.X.lastName Logan
key: owner.X.email loganlogan%40angelfire.com
key: owner.X.street1 1357%20Poplar%20Lane
key: owner.X.city Berwick
key: owner.X.countryCode US
key: owner.X.zipCode 03901
key: owner.X.birthDate 19850101
key: owner.X.socialSecurity 004-98-9205
key: owner.X.phone 6624903046
key: owner.X.stakePercentage 52
key: owner.X.state ME
key: deposit.holderName Miles%20O%27Brian
key: deposit.routingNumber 021000021
key: deposit.accountNumber 4099999992
https://[server-name]?requestType=create&userName=myUsername&password=myP%40ssword&profileId=100001&isEmbedded=0&pageFormat=OBDA&cancelURL=http%3A%2F%2Fyour.domain.com%2Fcancel&returnURL=http%3A%2F%2Fyour.domain.com%2Freturn&portfolioId=100&business.businessName=Z-O-O%20Planet%20LLC&business.ownershipStructureType=LLC&business.street1=1357%20Poplar%20Lane&business.city=Berwick&business.zipCode=03901&business.taxId=978726802&business.state=ME&business.legalName=Z-O-O%20Planet%20LLC&business.descriptorPhone=6624903046&business.email=loganlogan%40angelfire.com&business.merchantCategoryCode=5411&estimates.annualDirectDebitVolume=21474836&estimates.annualCardsVolume=21474836&estimates.avgDirectDebitTransactionAmount=21474836&estimates.avgCardsTransactionAmount=21474836&estimates.maxTransactionAmount=21474836&owner.X.firstName=Logan&owner.X.lastName=Logan&owner.X.email=loganlogan%40angelfire.com&owner.X.street1=1357%20Poplar%20Lane&owner.X.city=Berwick&owner.X.countryCode=US&owner.X.zipCode=03901&owner.X.birthDate=19850101&owner.X.socialSecurity=004-98-9205&owner.X.phone=6624903046&owner.X.stakePercentage=52&owner.X.state=ME&deposit.holderName=Miles%20O%27Brian&deposit.routingNumber=021000021&deposit.accountNumber=4099999992