GET api/Dashboard/GetPayIdOnboardingDetails?entityCode={entityCode}&userName={userName}&isManagerOnly={isManagerOnly}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityCode

string

Required

userName

string

Required

isManagerOnly

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

PayIdOnboarding
NameDescriptionTypeAdditional information
EntityCode

string

None.

MerchantName

string

None.

MerchantAction

string

None.

UserName

string

None.

IsPayIdEnabled

boolean

None.

IsPayIdOnboardingEnabled

boolean

None.

BillingStructureFee

decimal number

None.

ActionedUserFullName

string

None.

ActionedUserName

string

None.

ActionedUserDate

string

None.

ActionedUserTitle

string

None.

MerchantABN

string

None.

MerchantEmail

string

None.

MerchantContactNumber

string

None.

MerchantWebsite

string

None.

MerchantAddress

string

None.

MerchantFax

string

None.

MerchantContactName

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EntityCode": "sample string 1",
  "MerchantName": "sample string 2",
  "MerchantAction": "sample string 3",
  "UserName": "sample string 4",
  "IsPayIdEnabled": true,
  "IsPayIdOnboardingEnabled": true,
  "BillingStructureFee": 7.0,
  "ActionedUserFullName": "sample string 8",
  "ActionedUserName": "sample string 9",
  "ActionedUserDate": "sample string 10",
  "ActionedUserTitle": "sample string 11",
  "MerchantABN": "sample string 12",
  "MerchantEmail": "sample string 13",
  "MerchantContactNumber": "sample string 14",
  "MerchantWebsite": "sample string 15",
  "MerchantAddress": "sample string 16",
  "MerchantFax": "sample string 17",
  "MerchantContactName": "sample string 18"
}

application/xml, text/xml

Sample:
<PayIdOnboarding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.External.Models.PayId">
  <ActionedUserDate>sample string 10</ActionedUserDate>
  <ActionedUserFullName>sample string 8</ActionedUserFullName>
  <ActionedUserName>sample string 9</ActionedUserName>
  <ActionedUserTitle>sample string 11</ActionedUserTitle>
  <BillingStructureFee>7</BillingStructureFee>
  <EntityCode>sample string 1</EntityCode>
  <IsPayIdEnabled>true</IsPayIdEnabled>
  <IsPayIdOnboardingEnabled>true</IsPayIdOnboardingEnabled>
  <MerchantABN>sample string 12</MerchantABN>
  <MerchantAction>sample string 3</MerchantAction>
  <MerchantAddress>sample string 16</MerchantAddress>
  <MerchantContactName>sample string 18</MerchantContactName>
  <MerchantContactNumber>sample string 14</MerchantContactNumber>
  <MerchantEmail>sample string 13</MerchantEmail>
  <MerchantFax>sample string 17</MerchantFax>
  <MerchantName>sample string 2</MerchantName>
  <MerchantWebsite>sample string 15</MerchantWebsite>
  <UserName>sample string 4</UserName>
</PayIdOnboarding>