POST api/DeletePayment

Deletes a stored credit card payment method.

Request Information

URI Parameters

None.

Body Parameters

DeletePaymentRequest
NameDescriptionTypeAdditional information
SessionKey

string

Required
ConstituentId

integer

Required
PaymentId

integer

Required
TransactionOrigin

string

Required

Request Formats

application/json, text/json

Sample: 
{
  "SessionKey": "sample string 1",
  "ConstituentId": 2,
  "PaymentId": 3,
  "TransactionOrigin": "sample string 4"
}

application/xml, text/xml

Sample: 
<DeletePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Account">
  <ConstituentId>2</ConstituentId>
  <PaymentId>3</PaymentId>
  <SessionKey>sample string 1</SessionKey>
  <TransactionOrigin>sample string 4</TransactionOrigin>
</DeletePaymentRequest>

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

Response Information

Resource Description

SetPaymentResult object

ApiSuccessOfBoolean
NameDescriptionTypeAdditional information
Success

boolean
Data

boolean

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Data": true
}

application/xml, text/xml

Sample: 
<ApiSuccessOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data>true</Data>
</ApiSuccessOfboolean>