Service Directory > v31.2 > Settlement_Services > Get_Payment_Integrations
 

Operation: Get_Payment_Integrations

This service operation will get Payment Integrations for the specified criteria. The Payment Integration Request Criteria are based on Organization, Financial Institution, Bank Account, Payment Type, Payment Category, Country, Currency, Integration System, Check Print Layout, Outsourced Provider and Consolidate By. The request criteria can be for a single Payment Integration based on Reference, or all Payment Integrations can be retrieved if no criteria are specified.


@ - 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_Payment_Integrations_Request

This element is the top-level request element for all "Get" Payment Integrations operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payment_Integration_Request_References  [0..1]  Payment Integration Request References element contains the specific instance set containing the requested Payment Integration. The ID is either the Lookup ID or the Workday ID (GUID).   
Request_Criteria [Choice]   Payment_Integration_Request_Criteria  [0..1]  The Request Criteria is a wrapper element around a list of elements representing the operation specific criteria needed to search for Payment Integration instances   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Payment_Integration_Response_Group  [0..1]  The Response Group is a wrapper element around a list of elements representing the amount of data that should be included in the response.   
top
 

Response Element: Get_Payment_Integrations_Response

Element containing Payment Integration response elements including received criteria, references, data base.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payment_Integration_Request_References  [0..1]  Payment Integration Request References element contains the specific instance set containing the requested Payment Integration.   
Request_Criteria  Payment_Integration_Request_Criteria  [0..1]  Element used to Request certain Payment Integrations   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Payment_Integration_Response_Group  [0..1]  Element containing Payment Integration response grouping options.   
Response_Results  Response_Results  [0..1]  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.   
Response_Data  Payment_Integration_Response_Data  [0..1]  Wrapper Element that includes Payment Integration Reference Instance and Payment Integration data.   
top
 

Payment_Integration_Request_References

part of: Get_Payment_Integrations_Response, Get_Payment_Integrations_Request
Payment Integration Request References element contains the specific instance set containing the requested Payment Integration.
 
Parameter name Type/Value Cardinality Description Validations
Payment_Integration_Reference  Payment_IntegrationObject  [1..*]  Payment Integration Reference   
top
 

Payment_IntegrationObject

part of: Payment_Integration_WWS, Payment_Integration_Request_References
 
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  Payment_IntegrationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_IntegrationObjectID

part of: Payment_IntegrationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Integration_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
 

Payment_Integration_Request_Criteria

part of: Get_Payment_Integrations_Response, Get_Payment_Integrations_Request
Element used to Request certain Payment Integrations
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference  OrganizationObject  [0..*]  Organization   
Financial_Institution_Reference  Financial_InstitutionObject  [0..*]  Financial Institution   
Bank_Account_Reference  Bank_AccountObject  [0..*]  Bank Account   
Payment_Type_Reference  Payment_TypeObject  [0..*]  Payment Type   
Payment_Category_Reference  Payment_CategoryObject  [0..*]  Payment Category   
Country_Reference  CountryObject  [0..*]  Country   
Currency_Reference  CurrencyObject  [0..*]  Currency   
Integration_System_Reference  Integration_System__Audited_Object  [0..1]  Integration System   
Check_Print_Layout_Reference  Check_Print_Layout_AbstractObject  [0..1]  Check Print Layout   
Outsourced_Provider_Reference  Unique_IdentifierObject  [0..1]  Outsourced Provider   
Consolidate_By_Reference  Payment_Message_Consolidate_CriteriaObject  [0..*]  Consolidate By   
top
 

OrganizationObject

part of: Payment_Integration_Request_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  OrganizationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

OrganizationObjectID

part of: OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Organization_Reference_ID, Region_Reference_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
 

Financial_InstitutionObject

part of: Payment_Integration_Request_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  Financial_InstitutionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Financial_InstitutionObjectID

part of: Financial_InstitutionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Financial_Institution_ID, Financial_Institution_Reference_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
 

Bank_AccountObject

part of: Payment_Integration_Request_Criteria, Payment_Integration_WWS_Additional_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  Bank_AccountObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Bank_AccountObjectID

part of: Bank_AccountObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Bank_Account_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
 

Payment_TypeObject

part of: Payment_Integration_Request_Criteria, Payment_Integration_WWS_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  Payment_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_TypeObjectID

part of: Payment_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Type_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
 

Payment_CategoryObject

part of: Payment_Integration_Request_Criteria, Payment_Integration_WWS_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  Payment_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_CategoryObjectID

part of: Payment_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Category_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
 

CountryObject

part of: Payment_Integration_Request_Criteria, Payment_Integration_WWS_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  CountryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_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
 

CurrencyObject

part of: Payment_Integration_Request_Criteria, Payment_Integration_WWS_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
 

Integration_System__Audited_Object

part of: Payment_Integration_Request_Criteria, Payment_Integration_WWS_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  Integration_System__Audited_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Integration_System__Audited_ObjectID

part of: Integration_System__Audited_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Integration_System_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
 

Check_Print_Layout_AbstractObject

part of: Payment_Integration_Request_Criteria, Payment_Integration_WWS_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  Check_Print_Layout_AbstractObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Check_Print_Layout_AbstractObjectID

part of: Check_Print_Layout_AbstractObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Check_Print_Layout_ID, Check_Print_Layout_with_Report_Design_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
 

Unique_IdentifierObject

part of: Payment_Integration_Request_Criteria, Payment_Integration_WWS_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  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
 

Payment_Message_Consolidate_CriteriaObject

part of: Payment_Integration_Request_Criteria, Payment_Integration_WWS_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  Payment_Message_Consolidate_CriteriaObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_Message_Consolidate_CriteriaObjectID

part of: Payment_Message_Consolidate_CriteriaObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Message_Consolidate_Criteria_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_Payment_Integrations_Response, Get_Payment_Integrations_Request
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
 

Payment_Integration_Response_Group

part of: Get_Payment_Integrations_Response, Get_Payment_Integrations_Request
Element containing Payment Integration response grouping options.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Payment Integration reference is to be included in the response.   
top
 

Response_Results

part of: Get_Payment_Integrations_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
 

Payment_Integration_Response_Data

part of: Get_Payment_Integrations_Response
Wrapper Element that includes Payment Integration Reference Instance and Payment Integration data.
 
Parameter name Type/Value Cardinality Description Validations
Payment_Integration  Payment_Integration_WWS  [0..*]  Payment Integration wrapper element that contains the Payment Integration "Data" elements that are included in the response.   
top
 

Payment_Integration_WWS

part of: Payment_Integration_Response_Data
This element is the wrapper element for all Payment Integration data.
 
Parameter name Type/Value Cardinality Description Validations
Payment_Integration_Reference  Payment_IntegrationObject  [0..1]  Payment Integration Reference   
Payment_Integration_Additional_Data  Payment_Integration_WWS_Additional_Data  [0..*]  Element containing additional Payment Integration data.   
Payment_Integration_Data  Payment_Integration_WWS_Data  [0..*]  This Element contains Payment Integration attributes. 
Validation Description
Selected Payment Types cannot be combined due to divergent subsequent processes. Combination of more than one non-electronic Payment Type is not allowed.   
Selected Payment Types cannot be combined due to divergent subsequent processes. Combination of electronic and non-electronic Payment Types is not allowed.   
You can't select a payment integration system that is country-specific when the payment type is tied to the Credit Card payment method. Remove the country from your settlement configuration, or change the payment type that is tied to the Credit Card payment method.   
If Payment Method "[Direct Deposit]" is combined with another Payment Method then Outsourced Bank Provider is not allowed   
Selected Payment Types should be a subset of the intersection of all Allowed Payment Types from the selected Bank Accounts.   
 
top
 

Payment_Integration_WWS_Additional_Data

part of: Payment_Integration_WWS
Element containing additional Payment Integration data.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Accounts_Reference  Bank_AccountObject  [1..*]  Bank Account Name.   
top
 

Payment_Integration_WWS_Data

part of: Payment_Integration_WWS
Element containing all Payment Integration data.
 
Parameter name Type/Value Cardinality Description Validations
Payment_Integration_ID  string  [0..1]  Payment Integration Identifier   
Payment_Types_Reference  Payment_TypeObject  [1..*]  Reference to an existing Payment Type.   
Payment_Category_Reference  Payment_CategoryObject  [0..*]  Reference to an existing Payment Category.   
Country_Reference  CountryObject  [0..*]  Reference to an existing Country.   
Currency_Reference  CurrencyObject  [0..*]  Reference to an existing Currency.   
Integration_System_Reference  Integration_System__Audited_Object  [0..1]  Reference to an existing Integration System.   
Check_Print_Layout_Abstract_Reference  Check_Print_Layout_AbstractObject  [0..1]  Reference to an existing Check Print Layout.   
Outsourced_Bank_Provider_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing Outsourced Bank Provider that can be used for outsourced banking or check printing.   
Payment_Message_Consolidate_Criteria_Reference  Payment_Message_Consolidate_CriteriaObject  [0..*]  Reference to existing Payment Message Consolidate By Criteria.   
Maximum_Payments_per_Group  decimal (12, 0) >0   [0..1]  Maximum Payments Per Group limits the number of payments that can be included in a single electronic payment file.   
Cut_Off_Time_Reference  Twenty_Four_Hour_TimeObject  [0..1]  Reference to an existing instance of Twenty Four Hour Time. ex: 01:00 for 1 am, 21:30 for 9:30 pm   
Receives_Acknowledgement  boolean  [0..1]  Receives Acknowledgement. 
Validation Description
[Outsourced Sequence Generator ID] must include either an alphabetic or a special character.   
 
Validation Description
Selected Payment Types cannot be combined due to divergent subsequent processes. Combination of more than one non-electronic Payment Type is not allowed.   
Selected Payment Types cannot be combined due to divergent subsequent processes. Combination of electronic and non-electronic Payment Types is not allowed.   
You can't select a payment integration system that is country-specific when the payment type is tied to the Credit Card payment method. Remove the country from your settlement configuration, or change the payment type that is tied to the Credit Card payment method.   
If Payment Method "[Direct Deposit]" is combined with another Payment Method then Outsourced Bank Provider is not allowed   
Selected Payment Types should be a subset of the intersection of all Allowed Payment Types from the selected Bank Accounts.   
top
 

Twenty_Four_Hour_TimeObject

part of: Payment_Integration_WWS_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  Twenty_Four_Hour_TimeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Twenty_Four_Hour_TimeObjectID

part of: Twenty_Four_Hour_TimeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Twenty_Four_Hour_Time_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
 

Payment_IntegrationReferenceEnumeration

part of: Payment_IntegrationObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Financial_InstitutionReferenceEnumeration

part of: Financial_InstitutionObjectID
Base Type
string
top
 

Bank_AccountReferenceEnumeration

part of: Bank_AccountObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Payment_CategoryReferenceEnumeration

part of: Payment_CategoryObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Integration_System__Audited_ReferenceEnumeration

part of: Integration_System__Audited_ObjectID
Base Type
string
top
 

Check_Print_Layout_AbstractReferenceEnumeration

part of: Check_Print_Layout_AbstractObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Payment_Message_Consolidate_CriteriaReferenceEnumeration

part of: Payment_Message_Consolidate_CriteriaObjectID
Base Type
string
top
 

Twenty_Four_Hour_TimeReferenceEnumeration

part of: Twenty_Four_Hour_TimeObjectID
Base Type
string
top