Interface PaymentBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PaymentAdminSession
public interface PaymentBatchAdminSession extends PaymentAdminSession

This session creates, updates, and deletes Payments in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Payment , a PaymentForm is requested using getPaymentFormsForCreate() specifying the desired payer, customer, and record Types or none if no record Types are needed. Each of the returned PaymentForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a PaymentForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each PaymentForm corresponds to an attempted transaction.

The PaymentForms returned from getPaymentFormsForCreate() may be linked to the originating request through the peer Ids of the PaymentForm . In the case where there may be duplicates, any PaymentForm of the same peer Ids may be used for a create operation.

Once a batch of PaymentForms are submitted for create, a CreateResponse is returned for each PaymentForm , although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createPayments() , errors specific to an individual PaymentForm are indicated in the corresponding CreateResponse . CreateResponses may be linked to the originating PaymentForm through the PaymentForm Id .

For updates, PaymentForms are requested to the Payment Id that is to be updated using getPaymentFormsForUpdate() where the reference Id in the PaymentForm may be used to link the request. Similarly, the PaymentForm has metadata about the data that can be updated and it can perform validation before submitting the update. The PaymentForm can only be used once for a successful update and cannot be reused.

Once a batch of PaymentForms are submitted for update, an UpdateResponse is returned for each PaymentForm , although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updatePayments() , errors specific to an individual PaymentForm are indicated in the corresponding UpdateResponse . UpdateResponses may be linked to the originating PaymentForm through the PaymentForm Id .

The delete operations delete Payments in bulk. To unmap a Payment from the current Business , the PaymentBusinessAssignmentSession should be used. These delete operations attempt to remove the Payment itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses .