POST v1/purchase-onboarding/{purchaseId}/limit/convert

Request Information

URI Parameters

Name	Description	Type	Additional information
purchaseId		globally unique identifier	Required

Body Parameters

ApplyForPurchaseConversionToLimit

Name	Type	Additional information
SessionId	globally unique identifier	Required
ExternalCollectionDataRetrievalApproved	boolean	None.
TermsAccepted	boolean	None.
IsPoliticallyInfluential	boolean	None.
TaxCountryId	globally unique identifier	None.
TaxCountryId2	globally unique identifier	None.
NationalityId	globally unique identifier	None.
NationalityId2	globally unique identifier	None.
NationalityId3	globally unique identifier	None.
SourceData	TransactionSourceData	None.

Request Formats

application/json, text/json

Sample:

{
  "SessionId": "4a0b80bc-0692-4940-a954-09ac7cf68509",
  "ExternalCollectionDataRetrievalApproved": true,
  "TermsAccepted": true,
  "IsPoliticallyInfluential": true,
  "TaxCountryId": "0be9d06f-35f4-47d5-82c5-3944cd5b38b1",
  "TaxCountryId2": "c0aff0d7-c595-4cde-aad8-7bdbd41d63b9",
  "NationalityId": "1ce2e466-2991-468a-905a-1b55047fff7b",
  "NationalityId2": "e5941237-c0ff-47ca-9817-862aac9f0bc2",
  "NationalityId3": "03fe0095-472e-4397-a58b-a439c4536b87",
  "SourceData": {
    "ChannelEnum": 0,
    "IdentificationTypeEnum": "NULL",
    "CreateTime": "2026-07-03T16:00:42.4374833+00:00",
    "IdentificationBankCode": "sample string 1",
    "IdentificationDetail": "sample string 2",
    "IpAddress": "sample string 3",
    "DeviceTypeCode": "sample string 4",
    "ApplicationSourceEnum": 0,
    "AffiliateSourceCode": "sample string 5",
    "AffiliateMediumCode": "sample string 6",
    "AffiliateCampaignCode": "sample string 7",
    "AffiliateTransactionCode": "sample string 8",
    "SearchEngineCode": "sample string 9",
    "SearchEngineTransactionCode": "sample string 10",
    "SearchKeyword": "sample string 11",
    "OperatingSystemCode": "sample string 12",
    "LandingPageUrl": "sample string 13",
    "PageUrl": "sample string 14",
    "IsMobileDevice": true,
    "TrackingCookieId": "sample string 15",
    "SessionCode": "sample string 16",
    "FirstVisitTime": "2026-07-03T16:00:42.4374833+00:00",
    "SessionStartTime": "2026-07-03T16:00:42.4374833+00:00",
    "PageVisitHistory": "sample string 17",
    "ReferrerUrl": "sample string 18",
    "ExternalCampaignCode": "sample string 19",
    "ExternalTransactionCode": "sample string 20",
    "UserName": "sample string 21",
    "UserRoleCode": "sample string 22",
    "ABTestingCode": "sample string 23"
  }
}

application/xml, text/xml

Sample:

<ApplyForPurchaseConversionToLimit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfMobileApi.Models.PurchaseOnboarding">
  <SourceData xmlns="http://schemas.datacontract.org/2004/07/FfMobileApi.Models">
    <ABTestingCode>sample string 23</ABTestingCode>
    <AffiliateCampaignCode>sample string 7</AffiliateCampaignCode>
    <AffiliateMediumCode>sample string 6</AffiliateMediumCode>
    <AffiliateSourceCode>sample string 5</AffiliateSourceCode>
    <AffiliateTransactionCode>sample string 8</AffiliateTransactionCode>
    <ApplicationSourceEnum>NULL</ApplicationSourceEnum>
    <ChannelEnum>NULL</ChannelEnum>
    <CreateTime>2026-07-03T16:00:42.4374833+00:00</CreateTime>
    <DeviceTypeCode>sample string 4</DeviceTypeCode>
    <ExternalCampaignCode>sample string 19</ExternalCampaignCode>
    <ExternalTransactionCode>sample string 20</ExternalTransactionCode>
    <FirstVisitTime>2026-07-03T16:00:42.4374833+00:00</FirstVisitTime>
    <IdentificationBankCode>sample string 1</IdentificationBankCode>
    <IdentificationDetail>sample string 2</IdentificationDetail>
    <IdentificationTypeEnum>NULL</IdentificationTypeEnum>
    <IpAddress>sample string 3</IpAddress>
    <IsMobileDevice>true</IsMobileDevice>
    <LandingPageUrl>sample string 13</LandingPageUrl>
    <OperatingSystemCode>sample string 12</OperatingSystemCode>
    <PageUrl>sample string 14</PageUrl>
    <PageVisitHistory>sample string 17</PageVisitHistory>
    <ReferrerUrl>sample string 18</ReferrerUrl>
    <SearchEngineCode>sample string 9</SearchEngineCode>
    <SearchEngineTransactionCode>sample string 10</SearchEngineTransactionCode>
    <SearchKeyword>sample string 11</SearchKeyword>
    <SessionCode>sample string 16</SessionCode>
    <SessionStartTime>2026-07-03T16:00:42.4374833+00:00</SessionStartTime>
    <TrackingCookieId>sample string 15</TrackingCookieId>
    <UserName>sample string 21</UserName>
    <UserRoleCode>sample string 22</UserRoleCode>
  </SourceData>
  <ExternalCollectionDataRetrievalApproved>true</ExternalCollectionDataRetrievalApproved>
  <IsPoliticallyInfluential>true</IsPoliticallyInfluential>
  <NationalityId>1ce2e466-2991-468a-905a-1b55047fff7b</NationalityId>
  <NationalityId2>e5941237-c0ff-47ca-9817-862aac9f0bc2</NationalityId2>
  <NationalityId3>03fe0095-472e-4397-a58b-a439c4536b87</NationalityId3>
  <SessionId>4a0b80bc-0692-4940-a954-09ac7cf68509</SessionId>
  <TaxCountryId>0be9d06f-35f4-47d5-82c5-3944cd5b38b1</TaxCountryId>
  <TaxCountryId2>c0aff0d7-c595-4cde-aad8-7bdbd41d63b9</TaxCountryId2>
  <TermsAccepted>true</TermsAccepted>
</ApplyForPurchaseConversionToLimit>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ApplyForPurchaseConversionToLimit'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.