Service Directory > v31.2 > Settlement_Services > Put_Payment_Integration
 

Operation: Put_Payment_Integration

This service operation will add or update Payment Integrations. Payment Integration data includes the Payment Integration ID, Bank Account(s), Payment Types, Payment Category, Country, Currency, Integration System, Check Print Layout, Outsourced Bank Provider, Payment Message Consolidate By Criteria, Maximum Payments per Group, Cut off Time, Receives Acknowledgement.


@ - 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: Put_Payment_Integration_Request

Contains data for adding or updating a Payment Integration.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Payment_Integration_Reference  Payment_IntegrationObject  [0..1]  Reference to an existing Payment Integration for update only purposes.   
Payment_Integration_Additional_Data  Payment_Integration_WWS_Additional_Data  [0..1]  Element containing additional Payment Integration data.   
Payment_Integration_Data  Payment_Integration_WWS_Data  [1..1]  Contains data for a Payment Integration. 
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.   
 
Validation Description
The current User does not have permission to perform this action. User does not have access to all Associated Bank Accounts.   
The Web Service is set to Add Only; but the Payment Integration already exists.   
top
 

Response Element: Put_Payment_Integration_Response

Put Payment Integration Response wrapper element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payment_Integration_Reference  Payment_IntegrationObject  [0..1]  Payment Integration Reference.   
top
 

Payment_IntegrationObject

part of: Put_Payment_Integration_Request, Put_Payment_Integration_Response
 
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_WWS_Additional_Data

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

Bank_AccountObject

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

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

Payment_TypeObject

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  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_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_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_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_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_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_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_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
 

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
 

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