POST v3/me/paymentmethods/revoke

remove one of my saved cards: the registry row is revoked (Status=2) and the gateway-side token is deleted best-effort (failures are logged; the card stays removed here regardless).

Request Information

Parameters

NameDescriptionAdditional information
inVO
instrumentId

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,
  "instrumentId": "sample string 1"
}

application/xml, text/xml

Sample:
<MePaymentMethodRevokeInVO 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 2</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>
  <InstrumentId>sample string 1</InstrumentId>
</MePaymentMethodRevokeInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="InstrumentId"

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

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "scope": 2,
  "scopeName": "sample string 3",
  "gatewayType": 4,
  "gatewayDisplayName": "sample string 5",
  "brand": "sample string 6",
  "last4": "sample string 7",
  "expMonth": 1,
  "expYear": 1,
  "isExpired": true,
  "cardholderName": "sample string 9",
  "fundingType": "sample string 10",
  "status": 11,
  "statusName": "sample string 12",
  "createdOn": "2026-08-13T13:19:08.724431-05:00",
  "consentVersion": "sample string 14",
  "consentAt": "2026-08-13T13:19:08.724431-05:00",
  "consentText": "sample string 16",
  "revokedOn": "2026-08-13T13:19:08.724431-05:00",
  "revokedByName": "sample string 17"
}

application/xml, text/xml

Sample:
<PaymentInstrumentOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Payment">
  <Brand>sample string 6</Brand>
  <CardholderName>sample string 9</CardholderName>
  <ConsentAt>2026-08-13T13:19:08.724431-05:00</ConsentAt>
  <ConsentText>sample string 16</ConsentText>
  <ConsentVersion>sample string 14</ConsentVersion>
  <CreatedOn>2026-08-13T13:19:08.724431-05:00</CreatedOn>
  <ExpMonth>1</ExpMonth>
  <ExpYear>1</ExpYear>
  <FundingType>sample string 10</FundingType>
  <GatewayDisplayName>sample string 5</GatewayDisplayName>
  <GatewayType>4</GatewayType>
  <Id>sample string 1</Id>
  <IsExpired>true</IsExpired>
  <Last4>sample string 7</Last4>
  <RevokedByName>sample string 17</RevokedByName>
  <RevokedOn>2026-08-13T13:19:08.724431-05:00</RevokedOn>
  <Scope>2</Scope>
  <ScopeName>sample string 3</ScopeName>
  <Status>11</Status>
  <StatusName>sample string 12</StatusName>
</PaymentInstrumentOutVO>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Id"

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

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

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

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

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Brand"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Last4"

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

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ExpYear"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsExpired"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CardholderName"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="FundingType"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Status"

11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StatusName"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedOn"

2026-08-13T13:19:08.7244310-05:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ConsentVersion"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ConsentAt"

2026-08-13T13:19:08.7244310-05:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ConsentText"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="RevokedOn"

2026-08-13T13:19:08.7244310-05:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="RevokedByName"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e--