Manage Sub Organization

Manage Sub Organization

The Manage Sub Organization API allows a given organization to define an additional organizational unit which it manages. It also allows performing update activities on the sub organizations. Note that Update activities are allowed only on the Address and Contact Details (not core organization details, e.g. type)

Input Parameters:

Name	Required	Definition	Comments
AccountName	N	Format: Alphanumeric, 1-60 Description: Processor Account Name
AccountNumber	N	Format: Numeric, 17
ACHSubmitDelay	N	Format: Numeric, 1-2
ACHSubmitTime	N	Format: HH:MM Description: 24 hours format
AddressLine1	Y	Format: Alphanumeric, 30
AddressLine2	N	Format: Alphanumeric, 30
AutomaticReconciliation	N	Format: Y/N
BankContactName	N	Format: Alphanumeric, 1-60
BankContactPhone	N	Format: Numeric, 6-15
BankName	N	Format: Alphanumeric, 1-60
BankRouting	N	Format: Numeric,9
City	Y	Format: Alphanumeric, 20
ContactEmail	Y	Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern: x@x.x
ContactFax	N	Format: Numeric, 6-15
ContactPhone	N	Format: Numeric, 6-15 Description: Required only if Result= Escalated
Country	Y	Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
DefaultLAOwnerStrategy	N	Format options: Self Store
Email	Y	Format General o An email address is made up of a local part, an @ symbol, then a domain part (XXXXX@XXXXX) o Full Email Address Maximum Size: 254 chars o Local part & domain consist of labels separated by dots — Each label max size is 64 — Two successive dots are forbidden — mail cannot start or end with a dot — Labels cannot not start with a hyphen, end with a hyphen, or contain two successive hyphens. Local part o Size: 1-64 chars o Allowed Chars: a-z, A-Z, 0-9, and special characters: - _ . ~ ! ' * Domain part o Size: 1-251 chars o Allowed Chars: a-z, A-Z, 0-9, and special characters: - _ .
ExternalOrgId	N	Format: Alphanumeric, 20
Fax	N	Format: Numeric, 6-10 Description: the fax number.
FirstName	N	Format: Alpha, 2-20
IsLAOwner	Y	Format: Y/N
LAAutoReplenishment	N	Format: Y/N
LAAutoReplenishmentDelay	N	Format: Y/N
LAAutoReplenishmentDelayTimeConsideration	N	Format: Y/N
LAAutoReplenishmentTime	N	Format: HH:MM Description: 24 hours format
LAOwnerOrg	N	Format: Alphanumeric, 20
LastName	N	Format: Alpha, 2-20
LoadMechanism	N	Format options: PRAXELL TMLLC
MiddleInitial	N	Format: Alpha,1 Description: Middle name char of the cardholder.
NewBrandStyle	N	Format: Alphanumeric, 5
NewOrgName	N	Format: Alphanumeric, 6-30
NewPassword	N	Format: 8 -15 chars. Alphanumeric, Including char: _ ! @ # $ % ^ * + ~ ? Required to have at least - One Upper (e.g. A, B...) - One Lower (e.g. a, b...) - One number (e.g. 1, 2…) - One special character (e.g. _ ! @...) Description: New password value provided by the user.
NewUserName	N	Format: Alphanumeric, 6-30
OperationType	Y	Operation type done in API - closed list of values (per API): Approve Card Order API Approve,Decline Instant Issue API CardNumber, RPID Manage Org To Orgs Relation API Create,Delete Manage Store API Create, Update Manage Sub Organization API Create,Update,View Manage Terminal API Create, Update Manage User API Create, Update Research Card API RPID, Blank (if RPID, RPID is required. If blank, CardNumber is required) Manage FBE API Create, ChangeStatus, Update Manage Praxell Code API View, Create, Update Manage Fee API Create, Update, Delete Manage Payee API Add, GetPayees, Delete, Update
Approve Card Order API	Approve,Decline
Instant Issue API	CardNumber, RPID
Manage Org To Orgs Relation API	Create,Delete
Manage Store API	Create, Update
Manage Sub Organization API	Create,Update,View
Manage Terminal API	Create, Update
Manage User API	Create, Update
Research Card API	RPID, Blank (if RPID, RPID is required. If blank, CardNumber is required)
Manage FBE API	Create, ChangeStatus, Update
Manage Praxell Code API	View, Create, Update
Manage Fee API	Create, Update, Delete
Manage Payee API	Add, GetPayees, Delete, Update
Approve Card Order API	Approve,Decline
Instant Issue API	CardNumber, RPID
Manage Org To Orgs Relation API	Create,Delete
Manage Store API	Create, Update
Manage Sub Organization API	Create,Update,View
Manage Terminal API	Create, Update
Manage User API	Create, Update
Research Card API	RPID, Blank (if RPID, RPID is required. If blank, CardNumber is required)
Manage FBE API	Create, ChangeStatus, Update
Manage Praxell Code API	View, Create, Update
Manage Fee API	Create, Update, Delete
Manage Payee API	Add, GetPayees, Delete, Update
OrgName	N	Format: Alphanumeric, 6-30
OrgType	Y	Format options: Store Reseller Distrib CallCenter
Phone	Y	Format: Numeric, 6-15 Description: Phone number
SettlementMethod	N	Format options:Praxell Originate Praxell Receive Reserve Description: It is relevant only if LA Owner=Y
ShouldCreateUser	N	Format: Y/N
State	Y	Format: Alphanumeric, 2
TargetOrgName	N	Format: Alphanumeric, 6-30
Zip	N	Format: Numeric, 5-9
OrderShippingDestination	N	Options: PM/Distributor/DistributorShipping/Reseller by default: None
OrderShippingCompany	N	Format: Alphanumeric, 40
OrderShippingAddress1	N	Format: Alphanumeric, 30
OrderShippingAddress2	N	Format: Alphanumeric, 30
OrderShippingCity	N	Format: Alphanumeric, 20
OrderShippingState	N	Format: Alphanumeric, 2
OrderShippingZip	N	Format: Alphanumeric, 5

Output Parameters:

Name	Definition	Failure Case	Success Case	Comments
AvailableBalance	Format: Numeric, 11	Not returned	Returned

XML Samples

Input XML

<?xml version="1.0" encoding="UTF-8"?>
<PraxellXMLRequest>
  <AuthenticationDetails>
    <SessionId></SessionId>
    <ClientSourceIP></ClientSourceIP>
  </AuthenticationDetails>
  <ServiceDetails>
    <ServiceName>ManageSubOrganization</ServiceName>
    <UniqueRequestId>1239076422</UniqueRequestId>
  </ServiceDetails>
  <Origin>
    <OriginType>ExtAPI</OriginType>
  </Origin>
  <ServiceParams>
    <AccountName>Test123</AccountName>
    <AccountNumber>123</AccountNumber>
    <ACHSubmitDelay>1</ACHSubmitDelay>
    <ACHSubmitTime>12:14</ACHSubmitTime>
    <AddressLine1>1,street</AddressLine1>
    <AddressLine2>lane,NY</AddressLine2>
    <AutomaticReconciliation>N</AutomaticReconciliation>
    <BankContactName>test</BankContactName>
    <BankContactPhone>123456</BankContactPhone>
    <BankName>United Bank</BankName>
    <BankRouting>456712312</BankRouting>
    <City>New York</City>
    <ContactEmail>[e-mail]</ContactEmail>
    <ContactFax>678123</ContactFax>
    <ContactPhone>897009</ContactPhone>
    <Country>United State</Country>
    <DefaultLAOwnerStrategy>N</DefaultLAOwnerStrategy>
    <Email>[e-mail]</Email>
    <ExternalOrgId>AL123QWAS123</ExternalOrgId>
    <Fax>897656</Fax>
    <FirstName>John</FirstName>
    <IsLAOwner>Y</IsLAOwner>
    <LAAutoReplenishment>N</LAAutoReplenishment>
    <LAAutoReplenishmentDelay>N</LAAutoReplenishmentDelay>
    <LAAutoReplenishmentDelayTimeConsideration>N</LAAutoReplenishmentDelayTimeConsideration>
    <LAAutoReplenishmentTime>N</LAAutoReplenishmentTime>
    <LAOwnerOrg>Juice Ltd</LAOwnerOrg>
    <LastName>Smith</LastName>
    <LoadMechanism>PRAXELLTMLLC</LoadMechanism>
    <MiddleInitial>Brown</MiddleInitial>
    <NewBrandStyle>JSB123</NewBrandStyle>
    <NewOrgName>Juice123</NewOrgName>
    <NewPassword>abc@#$123##</NewPassword>
    <NewUserName>adc123</NewUserName>
    <OperationType>Choose from list</OperationType>
    <OrgName>Caller</OrgName>
    <OrgType>CallCenter</OrgType>
    <Phone>1234567</Phone>
    <SettlementMethod>Y</SettlementMethod>
    <ShouldCreateUser>N</ShouldCreateUser>
    <State>Y</State>
    <TargetOrgName>Apple Store</TargetOrgName>
    <Zip>45001</Zip>
    <OrderShippingDestination>None</OrderShippingDestination>
    <OrderShippingCompany>Amazone XYZ</OrderShippingCompany>
    <OrderShippingAddress1>Ny, I23</OrderShippingAddress1>
    <OrderShippingAddress2>Port-23#qw</OrderShippingAddress2>
    <OrderShippingCity>NY</OrderShippingCity>
    <OrderShippingState>NY</OrderShippingState>
    <OrderShippingZip>12311</OrderShippingZip>
  </ServiceParams>
</PraxellXMLRequest>

<?xml version="1.0" encoding="UTF-8"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>Manage Sub Organization</ServiceName>
    <SessionId>1234567890</SessionId>
    <StatusCode>0</StatusCode>
    <StatusName>StatusOK</StatusName>
    <StatusDescription>Success</StatusDescription>
    <ServiceDate>2023-06-24 10:00:00</ServiceDate>
    <ServiceId>1234567890</ServiceId>
  </ResponseDetails>
  <ResponseParams>
      <AccountName>Test123</AccountName>
      <AccountNumber>123</AccountNumber>
      <ACHSubmitDelay>1</ACHSubmitDelay>
      <ACHSubmitTime>12:14</ACHSubmitTime>
      <AddressLine1>1,street</AddressLine1>
      <AddressLine2>lane,NY</AddressLine2>
      <AutomaticReconciliation>N</AutomaticReconciliation>
      <BankContactName>test</BankContactName>
      <BankContactPhone>123456</BankContactPhone>
      <BankName>United Bank</BankName>
      <BankRouting>456712312</BankRouting>
      <City>New York</City>
      <ContactEmail>[e-mail]</ContactEmail>
      <ContactFax>678123</ContactFax>
      <ContactPhone>897009</ContactPhone>
      <Country>United State</Country>
      <DefaultLAOwnerStrategy>N</DefaultLAOwnerStrategy>
      <Email>[e-mail]</Email>
      <ExternalOrgId>AL123QWAS123</ExternalOrgId>
      <Fax>897656</Fax>
      <FirstName>John</FirstName>
      <IsLAOwner>Y</IsLAOwner>
      <LAAutoReplenishment>N</LAAutoReplenishment>
      <LAAutoReplenishmentDelay>N</LAAutoReplenishmentDelay>
      <LAAutoReplenishmentDelayTimeConsideration>N</LAAutoReplenishmentDelayTimeConsideration>
      <LAAutoReplenishmentTime>N</LAAutoReplenishmentTime>
      <LAOwnerOrg>Juice Ltd</LAOwnerOrg>
      <LastName>Smith</LastName>
      <LoadMechanism>PRAXELLTMLLC</LoadMechanism>
      <MiddleInitial>Brown</MiddleInitial>
      <NewBrandStyle>JSB123</NewBrandStyle>
      <NewOrgName>Juice123</NewOrgName>
      <NewPassword>abc@#$123##</NewPassword>
      <NewUserName>adc123</NewUserName>
      <OperationType>Choose from list</OperationType>
      <OrgName>Caller</OrgName>
      <OrgType>CallCenter</OrgType>
      <Phone>1234567</Phone>
      <SettlementMethod>Y</SettlementMethod>
      <ShouldCreateUser>N</ShouldCreateUser>
      <State>Y</State>
      <TargetOrgName>Apple Store</TargetOrgName>
      <Zip>45001</Zip>
      <OrderShippingDestination>None</OrderShippingDestination>
      <OrderShippingCompany>Amazone XYZ</OrderShippingCompany>
      <OrderShippingAddress1>Ny, I23</OrderShippingAddress1>
      <OrderShippingAddress2>Port-23#qw</OrderShippingAddress2>
      <OrderShippingCity>NY</OrderShippingCity>
      <OrderShippingState>NY</OrderShippingState>
      <OrderShippingZip>12311</OrderShippingZip>
  </ResponseParams>
</PraxellXMLResponse>

<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>ManageSubOrganization</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70012</StatusCode>
    <StatusName>ServiceNotAllowed</StatusName>
    <StatusDescription>ServiceNotAllowed</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>