Service Directory > v32.1 > Revenue_Management > Get_Credit_Card_Authorization
 

Operation: Get_Credit_Card_Authorization

This service operation returns Credit Card Authorizations. Data includes: Currency, Amount, Merchant Account ID, Merchant Customer Profile, Merchant Processing ID, Reply Reason Code, Reply Reason Description, and Credit Card Authorization ID


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Credit_Card_Authorization_Request

Request Element for Get Credit Card Authorization Web Service. Pass in references, criteria, and filters to retrieve specific Credit Card Authorizations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Credit_Card_Authorization_References  [0..1]  This element content contains the Credit Card Authorization Reference element used to return the Credit Card Authorization by unique indentifier   
Request_Criteria [Choice]   Credit_Card_Authorization_Criteria  [0..1]  This element content contains the wrapper element for the list of criteria representing the Credit Card Authorization specific criteria needed to search for instances.   
Response_Filter  Response_Filter  [0..1]  Element content containing response filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Credit_Card_Authorization_Response

Element containing Credit Card Authorization response elements include echoed request data and request result data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Credit_Card_Authorization_References  [0..*]  This element content contains the echoed Credit Card Authorization Request References Element   
Request_Criteria  Credit_Card_Authorization_Criteria  [0..*]  This element content contains the echoed Credit Card Authorization Request Criteria Element   
Response_Filter  Response_Filter  [0..*]  This element content contains the echoed Response Filter Element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..*]  This element content contains the Credit Card Authorization Response Results element, including total results and paging   
Response_Data  Credit_Card_Authorization_Response_Data  [0..*]  This element content contains the Credit Card Authorization Response Data Element   
top
 

Credit_Card_Authorization_References

part of: Get_Credit_Card_Authorization_Request, Get_Credit_Card_Authorization_Response
The Request References element contains the specific instance set that should be returned in the Get
 
Parameter name Type/Value Cardinality Description Validations
Credit_Card_Authorization_Request_Reference  Unique_IdentifierObject  [1..*]  Instance set containing Credit Card Authorizations   
top
 

Unique_IdentifierObject

part of: Credit_Card_Authorization_References, Credit_Card_Authorization
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Credit_Card_Authorization_Criteria

part of: Get_Credit_Card_Authorization_Request, Get_Credit_Card_Authorization_Response
This element is the wrapper around a list of elements representing the Credit Card Authorization Request specific criteria needed to search for instances.
 
Parameter name Type/Value Cardinality Description Validations
Transaction_Log_Reference  Transaction_LogObject  [0..1]  Instance of Transaction Log to filter results   
top
 

Transaction_LogObject

part of: Credit_Card_Authorization_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Transaction_LogObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Transaction_LogObjectID

part of: Transaction_LogObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Case_ID, Alternate_Supplier_Contract_ID, Assign_Pay_Group_Event_ID, Assignable_Payroll_ID, Background_Check_ID, Background_Process_Instance_ID, Backorder_Event_ID, Budget_Amendment_ID, Change_Order_Reference_ID, Compensation_Review_Event_ID, Customer_Request_ID, Customer_Request_Reference_ID, Eligibility_Override_Event_ID, Employee_Review_ID, Employee_Severance_Worksheet_Event_ID, Goods_Delivery_Group_ID, Goods_Delivery_Run_ID, Historical_Student_Charge_ID, Invite_Committee_Candidate_Event_ID, IRS_1099_MISC_Adjustment_ID, Mass_Change_Requisition_Requester_ID, Medicare_Information_Event_ID, Position_Budget_Group_ID, Procurement_Mass_Close_ID, Procurement_Mass_ReOpen_ID, Procurement_Roll_Forward_ID, Quick_Issue_Reference_ID, Receipt_Number, Request_Leave_of_Absence_ID, Requisition_Sourcing_Event_ID, Spend_Authorization_ID, Spend_Authorization_Mass_Close_ID, Student_Charge_Adjustment_ID, Student_Charge_Document_ID, Student_Charge_ID, Student_Dismissal_Event_ID, Student_Employment_Eligibility_Event_ID, Student_Hold_Assignment_Override_Event_ID, Student_Institutional_Withdrawal_Event_ID, Student_Leave_of_Absence_Event_ID, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID, Supplier_Invoice_Contract_ID, Workday_Project_ID, Worker_Time_Card_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_Credit_Card_Authorization_Request, Get_Credit_Card_Authorization_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Credit_Card_Authorization_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Credit_Card_Authorization_Response_Data

part of: Get_Credit_Card_Authorization_Response
Wrapper element containing Credit Card Authorization Response Data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Credit_Card_Authorization  Credit_Card_Authorization  [0..*]  Element content containing Credit Card Authorization element   
top
 

Credit_Card_Authorization

part of: Credit_Card_Authorization_Response_Data
Response element containing Credit Card Authorization Data
 
Parameter name Type/Value Cardinality Description Validations
Credit_Card_Authorization_Reference  Unique_IdentifierObject  [0..1]  Instance of Credit Card Authorization.   
Credit_Card_Authorization_Data  Credit_Card_Authorization_Data  [0..*]  Element containing data for Credit Card Authorization   
top
 

Credit_Card_Authorization_Data

part of: Credit_Card_Authorization
Data for Credit Card Authorization
 
Parameter name Type/Value Cardinality Description Validations
Currency_Reference  CurrencyObject  [0..1]  Currency for Credit Card Authorization.   
Credit_Card_Authorization_Amount  decimal (26, 6)   [0..1]  Credit Card Authorization Amount for Credit Card Authorization.   
Merchant_Account_ID  string  [0..1]  Merchant Account ID for Credit Card Authorization.   
Merchant_Customer_Profile  string  [0..1]  Customer Credit Card Profile ID for Credit Card Authorization.   
Merchant_Processing_ID  string  [0..1]  Merchant Processing ID for Credit Card Authorization.   
Reply_Reason_Code  string  [0..1]  Reply Reason Code for Credit Card Authorization.   
Reply_Reason_Description  string  [0..1]  Reply Reason Description for Credit Card Authorization.   
Credit_Card_Authorization_ID  string  [0..1]  Credit Card Authorization ID for Credit Card Authorization.   
top
 

CurrencyObject

part of: Credit_Card_Authorization_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

part of: CurrencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Currency_ID, Currency_Numeric_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Transaction_LogReferenceEnumeration

part of: Transaction_LogObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top