Overview
This web service updates the payment workflow status for one or more cost cards.
Request Format
PwsSetCostCardPaymentWorkflowStatus Request
- PwsSetCostCardPaymentWorkflowStatus
- serviceRequest: PwsSetCostCardPaymentWorkflowStatusRq
- RequestId: Int32
- SessionTicket: String
- PaymentWorkflowStatus: String
- SendApprovalEmailFlag: Boolean
- SendApprovalToPayEmailFlag: Boolean
- SendPaidEmailFlag: Boolean
- StatusOrders: PwsCostPwsChangeOrder[]
- serviceRequest: PwsSetCostCardPaymentWorkflowStatusRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
RequestId | Int32 | ||||
SessionTicket | String | ||||
PaymentWorkflowStatus | String | ||||
SendApprovalEmailFlag | Boolean | ||||
SendApprovalToPayEmailFlag | Boolean | ||||
SendPaidEmailFlag | Boolean | ||||
StatusOrders |
Request Usage Example(s)
Response Format
PwsSetCostCardPaymentWorkflowStatus Response
- PwsSetCostCardPaymentWorkflowStatusResponse
- PwsSetCostCardPaymentWorkflowStatusResult: PwsSetCostCardPaymentWorkflowStatusRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- CostCardIdentities: PwsCostCardRef[]
- PwsSetCostCardPaymentWorkflowStatusResult: PwsSetCostCardPaymentWorkflowStatusRs
Response Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
RequestId | Int32 | ||||
SessionTicket | String | ||||
PaymentWorkflowStatus | String | ||||
SendApprovalEmailFlag | Boolean | ||||
SendApprovalToPayEmailFlag | Boolean | ||||
SendPaidEmailFlag | Boolean | ||||
StatusOrders |
Response Usage Example(s)
PwsSetCostCardApprovalWorkflowStatus - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
19052 | InvalidValueForCostCardPaymentWorkflowStatus | The specified value for cost card payment workflow status is invalid. Valid values are N for Not Approved to Pay, F for Approved to Pay, T for Transmitted, P for Paid and C for Received. |
65723 | StatusChangeCannotBeCompletedCostCardsChangedOrIneligible | Status change cannot be completed because one or more cards has changed or is ineligible. |