POST v3/me/paymentmethods/setup

start saving a card: returns the gateway-hosted-capture payload ({kind:"braintreeHostedFields", clientToken} or {kind:"stripeSetupIntent", publishableKey, clientSecret}) plus the consent text (and its version) the client MUST display before save.

Request Information

Parameters

Name	Description	Additional information
inVO	networkId, scope	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "curUserId": "sample string 1",
  "isSSO": true,
  "requestHost": "sample string 3",
  "applicationPath": "sample string 4",
  "secureApplicationPath": "sample string 5",
  "absoluteApplicationPath": "sample string 6",
  "isHttps": true,
  "isMobileDevice": true,
  "isElectron": true,
  "isFullEmbed": true,
  "clientType": 0,
  "clientVersion": "sample string 11",
  "clientOS": "sample string 12",
  "clientBuild": "sample string 13",
  "premiumAppId": "sample string 14",
  "clientWidth": 15,
  "clientHeight": 16,
  "timezone": 17,
  "networkId": "sample string 1",
  "scope": 2
}

application/xml, text/xml

Sample:

<MePaymentMethodSetupInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input.Payment">
  <ClientHeight xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">16</ClientHeight>
  <ClientType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">Site</ClientType>
  <ClientWidth xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">15</ClientWidth>
  <absoluteApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 6</absoluteApplicationPath>
  <applicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 4</applicationPath>
  <cachedKey xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 3</cachedKey>
  <clientBuild xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 13</clientBuild>
  <clientOS xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 12</clientOS>
  <clientVersion xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 11</clientVersion>
  <curUserId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 1</curUserId>
  <isElectron xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isElectron>
  <isFullEmbed xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isFullEmbed>
  <isHttps xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isHttps>
  <isMobileDevice xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isMobileDevice>
  <isSSO xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isSSO>
  <premiumAppId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 14</premiumAppId>
  <requestHost xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 3</requestHost>
  <secureApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 5</secureApplicationPath>
  <timezone xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">17</timezone>
  <NetworkId>sample string 1</NetworkId>
  <Scope>2</Scope>
</MePaymentMethodSetupInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="NetworkId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Scope"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="cachedKey"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:

{
  "kind": "sample string 1",
  "clientToken": "sample string 2",
  "publishableKey": "sample string 3",
  "clientSecret": "sample string 4",
  "scope": 5,
  "effectiveScope": 6,
  "gatewayDisplayName": "sample string 7",
  "consentVersion": "sample string 8",
  "consentText": "sample string 9"
}

application/xml, text/xml

Sample:

<PaymentInstrumentSetupOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Payment">
  <ClientSecret>sample string 4</ClientSecret>
  <ClientToken>sample string 2</ClientToken>
  <ConsentText>sample string 9</ConsentText>
  <ConsentVersion>sample string 8</ConsentVersion>
  <EffectiveScope>6</EffectiveScope>
  <GatewayDisplayName>sample string 7</GatewayDisplayName>
  <Kind>sample string 1</Kind>
  <PublishableKey>sample string 3</PublishableKey>
  <Scope>5</Scope>
</PaymentInstrumentSetupOutVO>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Kind"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ClientToken"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PublishableKey"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ClientSecret"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Scope"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EffectiveScope"

6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GatewayDisplayName"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ConsentVersion"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ConsentText"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e--