Api
Click here for a complete list of operations.
ChargeContactPaymentProfile
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /v/2/Api.asmx HTTP/1.1 Host: api.charityengine.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://api.bisglobal.net/ChargeContactPaymentProfile" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ChargeContactPaymentProfile xmlns="https://api.bisglobal.net/"> <credentials> <Username>string</Username> <Password>string</Password> <AuthenticationToken>string</AuthenticationToken> <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType> </credentials> <parameters> <PaymentProfiles> <ChargeContactPaymentProfileParameters> <PaymentProfile_Id>long</PaymentProfile_Id> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <CustomCode1>string</CustomCode1> <CustomCode2>string</CustomCode2> <CustomCode3>string</CustomCode3> <CustomCode4>string</CustomCode4> <CustomCode5>string</CustomCode5> <CustomCode6>string</CustomCode6> <CustomCode7>string</CustomCode7> <CustomCode8>string</CustomCode8> </ChargeContactPaymentProfileParameters> <ChargeContactPaymentProfileParameters> <PaymentProfile_Id>long</PaymentProfile_Id> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <CustomCode1>string</CustomCode1> <CustomCode2>string</CustomCode2> <CustomCode3>string</CustomCode3> <CustomCode4>string</CustomCode4> <CustomCode5>string</CustomCode5> <CustomCode6>string</CustomCode6> <CustomCode7>string</CustomCode7> <CustomCode8>string</CustomCode8> </ChargeContactPaymentProfileParameters> </PaymentProfiles> </parameters> </ChargeContactPaymentProfile> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ChargeContactPaymentProfileResponse xmlns="https://api.bisglobal.net/"> <ChargeContactPaymentProfileResult> <Transactions> <TransactionDetail> <Transaction_Id>long</Transaction_Id> <PaymentSuccessful>boolean</PaymentSuccessful> <DeclineDetails>string</DeclineDetails> </TransactionDetail> <TransactionDetail> <Transaction_Id>long</Transaction_Id> <PaymentSuccessful>boolean</PaymentSuccessful> <DeclineDetails>string</DeclineDetails> </TransactionDetail> </Transactions> </ChargeContactPaymentProfileResult> </ChargeContactPaymentProfileResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /v/2/Api.asmx HTTP/1.1 Host: api.charityengine.net Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <ChargeContactPaymentProfile xmlns="https://api.bisglobal.net/"> <credentials> <Username>string</Username> <Password>string</Password> <AuthenticationToken>string</AuthenticationToken> <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType> </credentials> <parameters> <PaymentProfiles> <ChargeContactPaymentProfileParameters> <PaymentProfile_Id>long</PaymentProfile_Id> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <CustomCode1>string</CustomCode1> <CustomCode2>string</CustomCode2> <CustomCode3>string</CustomCode3> <CustomCode4>string</CustomCode4> <CustomCode5>string</CustomCode5> <CustomCode6>string</CustomCode6> <CustomCode7>string</CustomCode7> <CustomCode8>string</CustomCode8> </ChargeContactPaymentProfileParameters> <ChargeContactPaymentProfileParameters> <PaymentProfile_Id>long</PaymentProfile_Id> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <CustomCode1>string</CustomCode1> <CustomCode2>string</CustomCode2> <CustomCode3>string</CustomCode3> <CustomCode4>string</CustomCode4> <CustomCode5>string</CustomCode5> <CustomCode6>string</CustomCode6> <CustomCode7>string</CustomCode7> <CustomCode8>string</CustomCode8> </ChargeContactPaymentProfileParameters> </PaymentProfiles> </parameters> </ChargeContactPaymentProfile> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <ChargeContactPaymentProfileResponse xmlns="https://api.bisglobal.net/"> <ChargeContactPaymentProfileResult> <Transactions> <TransactionDetail> <Transaction_Id>long</Transaction_Id> <PaymentSuccessful>boolean</PaymentSuccessful> <DeclineDetails>string</DeclineDetails> </TransactionDetail> <TransactionDetail> <Transaction_Id>long</Transaction_Id> <PaymentSuccessful>boolean</PaymentSuccessful> <DeclineDetails>string</DeclineDetails> </TransactionDetail> </Transactions> </ChargeContactPaymentProfileResult> </ChargeContactPaymentProfileResponse> </soap12:Body> </soap12:Envelope>