OSID Logo
OSID Specifications
billing payment batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.batch.PayerBatchAdminSession
Implementsosid.billing.payment.PayerAdminSession
Description

This session creates, updates, and deletes Payers 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 Payer, a PayerForm is requested using getPayerFormsForCreate() specifying the desired resources and record Types or none if no record Types are needed. Each of the returned PayerForms 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 PayerForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each PayerForm corresponds to an attempted transaction.

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

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

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

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

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

MethodgetPayerFormsForCreate
Description

Gets the payer forms for creating a bunch of new payers. A form is returned for each supplied resource.

Parametersosid.id.IdListresourceIdsa list of resources
osid.type.Type[]payerRecordTypesarray of payer record types to be included in each create operation or an empty list if none
Returnosid.billing.payment.batch.PayerBatchFormListthe payer forms
ErrorsNOT_FOUNDa resource is not found
NULL_ARGUMENT resourceIds or payerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreatePayers
Description

Creates a new set of Payers. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.billing.payment.batch.PayerBatchFormListpayerFormsthe payer forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT payerForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPayerFormsForUpdate
Description

Gets the payer forms for updating an existing set of payers. A new payer form should be requested for each update transaction.

Parametersosid.id.IdListpayerIdsthe Ids of the Payer
Returnosid.billing.payment.batch.PayerBatchFormListthe payer form
ErrorsNOT_FOUNDa payerId is not found
NULL_ARGUMENT payerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePayers
Description

Updates existing payers. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.billing.payment.batch.PayerBatchFormListpayerFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT payerForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllPayers
Description

Deletes all Payers in this Business .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeletePayers
Description

Deletes payers for the given Ids.

Parametersosid.id.IdListpayerIdsthe Ids of the payers to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT payerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeletePayersForResource
Description

Deletes payers for the given resource.

Parametersosid.id.IdresourceIdthe Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectivePayersByDate
Description

Deletes payers ineffective before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasPayers
Description

Adds an Id to a Payer for the purpose of creating compatibility. The primary Id of the Payer is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another payer, it is reassigned to the given payer Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.