Api
Click here for a complete list of operations.
CheckPayment
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/CheckPayment" <?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> <CheckPayment xmlns="https://api.bisglobal.net/"> <credentials> <Username>string</Username> <Password>string</Password> <AuthenticationToken>string</AuthenticationToken> <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType> </credentials> <parameters> <Payments> <CheckPaymentParameters> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <PaymentConfirmed>boolean</PaymentConfirmed> <Contact xsi:nil="true" /> <CheckNumber>string</CheckNumber> <CustomerBillingInfo xsi:nil="true" /> <Subscription_Id>long</Subscription_Id> <Attribution xsi:nil="true" /> <MakeAnonymous>boolean</MakeAnonymous> <DisplayNameOnlineAs>string</DisplayNameOnlineAs> <HideAmountOnline>boolean</HideAmountOnline> <ContactCopy xsi:nil="true" /> </CheckPaymentParameters> <CheckPaymentParameters> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <PaymentConfirmed>boolean</PaymentConfirmed> <Contact xsi:nil="true" /> <CheckNumber>string</CheckNumber> <CustomerBillingInfo xsi:nil="true" /> <Subscription_Id>long</Subscription_Id> <Attribution xsi:nil="true" /> <MakeAnonymous>boolean</MakeAnonymous> <DisplayNameOnlineAs>string</DisplayNameOnlineAs> <HideAmountOnline>boolean</HideAmountOnline> <ContactCopy xsi:nil="true" /> </CheckPaymentParameters> </Payments> </parameters> </CheckPayment> </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> <CheckPaymentResponse xmlns="https://api.bisglobal.net/"> <CheckPaymentResult> <Payments> <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> </Payments> </CheckPaymentResult> </CheckPaymentResponse> </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> <CheckPayment xmlns="https://api.bisglobal.net/"> <credentials> <Username>string</Username> <Password>string</Password> <AuthenticationToken>string</AuthenticationToken> <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType> </credentials> <parameters> <Payments> <CheckPaymentParameters> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <PaymentConfirmed>boolean</PaymentConfirmed> <Contact xsi:nil="true" /> <CheckNumber>string</CheckNumber> <CustomerBillingInfo xsi:nil="true" /> <Subscription_Id>long</Subscription_Id> <Attribution xsi:nil="true" /> <MakeAnonymous>boolean</MakeAnonymous> <DisplayNameOnlineAs>string</DisplayNameOnlineAs> <HideAmountOnline>boolean</HideAmountOnline> <ContactCopy xsi:nil="true" /> </CheckPaymentParameters> <CheckPaymentParameters> <Amount>double</Amount> <TaxDeductibleAmount>double</TaxDeductibleAmount> <PaymentConfirmed>boolean</PaymentConfirmed> <Contact xsi:nil="true" /> <CheckNumber>string</CheckNumber> <CustomerBillingInfo xsi:nil="true" /> <Subscription_Id>long</Subscription_Id> <Attribution xsi:nil="true" /> <MakeAnonymous>boolean</MakeAnonymous> <DisplayNameOnlineAs>string</DisplayNameOnlineAs> <HideAmountOnline>boolean</HideAmountOnline> <ContactCopy xsi:nil="true" /> </CheckPaymentParameters> </Payments> </parameters> </CheckPayment> </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> <CheckPaymentResponse xmlns="https://api.bisglobal.net/"> <CheckPaymentResult> <Payments> <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> </Payments> </CheckPaymentResult> </CheckPaymentResponse> </soap12:Body> </soap12:Envelope>