OnlineAPI


Click here for a complete list of operations.

GetCustomPayoutMethodDetailsForRepDID

This method allows one to pull the custom detail information for a payout method that was defined from the backoffice. Since the format of the payout method can change from selections within the Freedom BackOffice. This method and the related update method are completely dynamic. One can use this method without passing a RepDID to see the format of the detail items needed for the payout method, or pass the payout method ID and the RepDID to return the format and the current values for the passed RepDID.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/GetCustomPayoutMethodDetailsForRepDID"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCustomPayoutMethodDetailsForRepDID xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <PayoutMethodID>int</PayoutMethodID>
      <RepDID>string</RepDID>
    </GetCustomPayoutMethodDetailsForRepDID>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCustomPayoutMethodDetailsForRepDIDResponse xmlns="http://www.securefreedom.com/">
      <GetCustomPayoutMethodDetailsForRepDIDResult>
        <CustomPayoutMethodLineItems>
          <CustomPayoutMethodLineItem>
            <DetailNumber>int</DetailNumber>
            <Caption>string</Caption>
            <AdminOnly>int</AdminOnly>
            <Editable>int</Editable>
            <Type>string</Type>
            <CurrentValue>string</CurrentValue>
          </CustomPayoutMethodLineItem>
          <CustomPayoutMethodLineItem>
            <DetailNumber>int</DetailNumber>
            <Caption>string</Caption>
            <AdminOnly>int</AdminOnly>
            <Editable>int</Editable>
            <Type>string</Type>
            <CurrentValue>string</CurrentValue>
          </CustomPayoutMethodLineItem>
        </CustomPayoutMethodLineItems>
      </GetCustomPayoutMethodDetailsForRepDIDResult>
    </GetCustomPayoutMethodDetailsForRepDIDResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetCustomPayoutMethodDetailsForRepDID xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <PayoutMethodID>int</PayoutMethodID>
      <RepDID>string</RepDID>
    </GetCustomPayoutMethodDetailsForRepDID>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetCustomPayoutMethodDetailsForRepDIDResponse xmlns="http://www.securefreedom.com/">
      <GetCustomPayoutMethodDetailsForRepDIDResult>
        <CustomPayoutMethodLineItems>
          <CustomPayoutMethodLineItem>
            <DetailNumber>int</DetailNumber>
            <Caption>string</Caption>
            <AdminOnly>int</AdminOnly>
            <Editable>int</Editable>
            <Type>string</Type>
            <CurrentValue>string</CurrentValue>
          </CustomPayoutMethodLineItem>
          <CustomPayoutMethodLineItem>
            <DetailNumber>int</DetailNumber>
            <Caption>string</Caption>
            <AdminOnly>int</AdminOnly>
            <Editable>int</Editable>
            <Type>string</Type>
            <CurrentValue>string</CurrentValue>
          </CustomPayoutMethodLineItem>
        </CustomPayoutMethodLineItems>
      </GetCustomPayoutMethodDetailsForRepDIDResult>
    </GetCustomPayoutMethodDetailsForRepDIDResponse>
  </soap12:Body>
</soap12:Envelope>