POST v1/purchase-onboarding/{purchaseId}/additional-details

Request Information

URI Parameters

Name	Description	Type	Additional information
purchaseId		globally unique identifier	Required

Body Parameters

SaveAdditionalDetailsRequest

Name	Type	Additional information
SessionId	globally unique identifier	Required
InvoicingDeliveryMethod	InvoiceDeliveryMethodEnumeration	None.
InvoicingEmailAddress	string	Required
InvoicingReferenceNumber	string	Max length: 50
InvoicingMessage	string	Max length: 50
InvoicingCostCenterCode	string	Max length: 50
CompanyEInvoicingAddress	string	Matching regular expression pattern: ^[0-9]+$ String length: inclusive between 12 and 17
CompanyEInvoicingIntermediatorCode	string	Matching regular expression pattern: ^[0-9]+$ String length: inclusive between 12 and 17
InvoicingAddressStreet	string	Max length: 70
InvoicingAddressZip	string	Max length: 10
InvoicingAddressCity	string	Max length: 70
SourceData	TransactionSourceData	None.

Request Formats

application/json, text/json

Sample:

{
  "SessionId": "528e2073-8982-418e-a511-c9ad050628a3",
  "InvoicingDeliveryMethod": "NULL",
  "InvoicingEmailAddress": "sample string 2",
  "InvoicingReferenceNumber": "sample string 3",
  "InvoicingMessage": "sample string 4",
  "InvoicingCostCenterCode": "sample string 5",
  "CompanyEInvoicingAddress": "sample string 6",
  "CompanyEInvoicingIntermediatorCode": "sample string 7",
  "InvoicingAddressStreet": "sample string 8",
  "InvoicingAddressZip": "sample string 9",
  "InvoicingAddressCity": "sample string 10",
  "SourceData": {
    "ChannelEnum": 0,
    "IdentificationTypeEnum": "NULL",
    "CreateTime": "2026-07-03T16:00:24.765097+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:24.765097+00:00",
    "SessionStartTime": "2026-07-03T16:00:24.765097+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:

<SaveAdditionalDetailsRequest 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:24.765097+00:00</CreateTime>
    <DeviceTypeCode>sample string 4</DeviceTypeCode>
    <ExternalCampaignCode>sample string 19</ExternalCampaignCode>
    <ExternalTransactionCode>sample string 20</ExternalTransactionCode>
    <FirstVisitTime>2026-07-03T16:00:24.765097+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:24.765097+00:00</SessionStartTime>
    <TrackingCookieId>sample string 15</TrackingCookieId>
    <UserName>sample string 21</UserName>
    <UserRoleCode>sample string 22</UserRoleCode>
  </SourceData>
  <CompanyEInvoicingAddress>sample string 6</CompanyEInvoicingAddress>
  <CompanyEInvoicingIntermediatorCode>sample string 7</CompanyEInvoicingIntermediatorCode>
  <InvoicingAddressCity>sample string 10</InvoicingAddressCity>
  <InvoicingAddressStreet>sample string 8</InvoicingAddressStreet>
  <InvoicingAddressZip>sample string 9</InvoicingAddressZip>
  <InvoicingCostCenterCode>sample string 5</InvoicingCostCenterCode>
  <InvoicingDeliveryMethod>NULL</InvoicingDeliveryMethod>
  <InvoicingEmailAddress>sample string 2</InvoicingEmailAddress>
  <InvoicingMessage>sample string 4</InvoicingMessage>
  <InvoicingReferenceNumber>sample string 3</InvoicingReferenceNumber>
  <SessionId>528e2073-8982-418e-a511-c9ad050628a3</SessionId>
</SaveAdditionalDetailsRequest>

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 'SaveAdditionalDetailsRequest'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.