Payment endpoint

This topic provides a quick reference for the method signatures of payment API methods.

Location: http://smile.example.com:port/stage/smile/ws/v2/payment

WSDL: http://smile.example.com:port/stage/smile/ws/v2/payment?wsdl

Table 1. Payment API methods
Method	Method signature	Purpose
addStoredPaymentDetails()	`StoredPaymentDetails addStoredPaymentDetails( string usn, PaymentDetails paymentDetails)`	Adds stored payment details to an account.
cancelScheduledPayment()	`Payment cancelScheduledPayment( string paymentNumber)`	Cancels a payment.
computeSurcharge()	`SurchargeCalculation computeSurcharge( string usn, string paymentTypeCode, CurrencyValue amount, date timestamp)`	Calculates the surcharge payable on a payment.
deleteStoredPaymentDetails()	`void deleteStoredPaymentDetails( string usn, string storedPaymentDetailsId)`	Deletes the stored payment details on an account.
getAutoPaymentOption()	`getAutoPaymentOptionResponse getAutoPaymentOption( string usn)`	Returns the configured automatic payment option for an account.
getPayment()	`Payment getPayment( string paymentNumber)`	Returns information about a payment for a specified payment number.
getPaymentTypes()	`PaymentTypes getPaymentTypes( string currency)`	Returns information about the payment methods appropriate for the current user.
getPendingPayments()	`PaymentListType getPendingPayments( string accountUsn)`	Returns a list of all pending payments for a particular account.
getStoredPaymentDetails()	`StoredPaymentDetails getStoredPaymentDetails( string usn, string storedPaymentDetailsId)`	Returns the stored payment details for an account and ID.
getStoredPaymentdetailsList()	`StoredPaymentDetailsList getStoredPaymentDetailsList( string usn)`	Returns all stored payment details for an account.
processPayment()	`PaymentResponse processPayment( string usn, PaymentRequest paymentRequest, AllocationRequest allocationRequest)`	Processes a payment and queues the debits to be allocated to the payment, pending the payment's success.
recordFailedPayment()	`Payment recordFailedPayment( string usn, PaymentRequest paymentRequest, string message)`	Records failed payment to a Smile account.
reschedulePaymentWithNewDetails()	`Payment reschedulePaymentWithNewDetails( string paymentNumber, PaymentDetailsRequest request, date timestamp)`	Reschedules a payment to a specified time with specified new payment details.
updateStoredPaymentDetails()	`StoredPaymentDetails updateStoredPaymentDetails( string usn, string storedPaymentDetailsId, PaymentDetails paymentDetails)`	Updates the stored payment details on an account.
validatePayment()	`PaymentDetailsValidationResponse validatePayment( PaymentDetailsValidationRequest paymentDetailsValidationRequest)`	Validates credit card details.