External Payer

Service that creates or updates payer and payment instrument assignment.

Life Cycle Status: Active

QName: {http://xmlns.oracle.com/apps/financials/payments/shared/payeePayerInstruments/externalPayerServiceV2/}PayerDetailService

Service WSDL URL: https://servername/fscmService/PayerDetailServiceV2?WSDL

Relationships

The following table describes how this service data object is related to other service data objects or business object services.

Relationship Type	Object or Service
Handles	Credit Card SDO
Handles	Intermediary Bank Account Owner SDO
Handles	Party-Owned Payment Instrument SDO
Handles	External Payer SDO
Handles	Assigned Payment Instrument SDO
Handles	Bank Account Assignment SDO
Handles	External Bank Account SDO
Handles	Instrument Use Attributes SDO
Handles	External Bank Account Owner SDO
Handles	Credit Card Assignment SDO
Handles	External Bank Account SDO
Handles	Credit Card Attributes SDO

Operations

• processPayerPaymentCard

• findAssignedInstrumentsByPayer

• processPayerBankAccount

• getPayerDetails

• findPayer

• findInstrumentsOwnedByParty

• getAssignedInstrumentDetails

• findAssignedInstrumentsByPayer

• getDfltObjAttrHints

• getServiceLastUpdateTime

• getEntityList

processPayerPaymentCard

An operation that assigns the payment card.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
payer	External Payer	A parameter that specifies the external payer.
creditCard	Credit Card	A parameter that specifies the credit card.

Response Payload

Element Name	Type	Description
result	Credit Card Assignment	A parameter that returns the credit card assignment.

findAssignedInstrumentsByPayer

An operation that searches for assigned instruments by payer using specified criteria.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
partyId	long	A parameter that specifies the party identifier for searching the instrument assignments.
customerAccountId	long	A parameter that specifies the customer account identifier for searching the instrument assignments.
accountSiteUseId	long	A parameter that specifies the use of the account site identifier for searching the instrument assignments.
orgId	long	A parameter that specifies the organization identifier for searching the instrument assignments.
orgType	string	A parameter that specifies the organization type for searching the instrument assignments.
paymentFunction	string	A parameter that specifies the payment function for searching the instrument assignments.
instrumentType	string	A parameter that specifies the instrument type for searching the instrument assignments.

Response Payload

Element Name	Type	Description
result	Assigned Payment Instrument	A parameter that returns the list of instrument assignments that satisfies the search criteria.

processPayerBankAccount

An operation that merges two bank accounts.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
payer	External Payer	A parameter that specifies the external payer to perform the merge operation for the bank account.
bankAccount	External Bank Account	A parameter that specifies the bank account details to create or update the bank account.

Response Payload

Element Name	Type	Description
result	Bank Account Assignment	A parameter that returns the bank account assignment that satisfies the search criteria.

getPayerDetails

A parameter that retrieves the payer details.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
externalPayerId	long	A parameter that specifies the identifier of the external payer to be retrieved.

Response Payload

Element Name	Type	Description
result	External Payer	A parameter that returns the external payer that matches the external payer identifier.

findPayer

An operation that searches for a payer using specified criteria.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	A parameter that specifies the search criteria for a payer and the maximum records that can be returned at a time.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	A parameter that controls the search for the payer.

Response Payload

Element Name	Type	Description
result	External Payer	A parameter that returns the list of external payers that satisfy the search criteria.

findInstrumentsOwnedByParty

An operation that searches for instruments owned by a party using specified criteria.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	A parameter that specifies the search criteria for instruments owned by a party and the maximum records that can be returned at a time.
BindPayerPartyId	long	Identifier of the party.
BindInstrumentType	string	Type of payment instrument, such as credit card or bank account transfer.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	A parameter that controls the search for instruments owned by a party.

Response Payload

Element Name	Type	Description
result	Party-Owned Payment Instrument	A parameter that returns the list of payment instruments that satisfies the search criteria.

getAssignedInstrumentDetails

An operation that retrieves the details of an assigned instrument.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
instrAssignmentId	long	A parameter that specifies the identifier of the instrument assignment to be retrieved.

Response Payload

Element Name	Type	Description
result	Assigned Payment Instrument	A parameter that returns the instrument assignment record.

findAssignedInstrumentsByPayer

Find instrument assignments by payer

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	Find criteria
BindPayerId	long	External Payer Id
BindInstrumentType	string	Instrument Type
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	Find Control

Response Payload

Element Name	Type	Description
result	Assigned Payment Instrument	List of instrument assignments

getDfltObjAttrHints

An operation that retrieves the default object attribute hints.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
viewName	string	A parameter that specifies the name of the view for the default object attribute hints to be retrieved.
localeName	string	A parameter that specifies the locale name of the view for the default object attribute hints to be retrieved.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints	A parameter that returns the default object attribute hints that matches the view and local name.

getServiceLastUpdateTime

An operation that retrieves the last update time of the service.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	A parameter that returns the last update time of the service.

getEntityList

An operation that retrieves the entity list.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo	A parameter that returns the entity list.

Security

The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.

Service Operations to Privileges Mapping

Operation Name	Privilege Code	Privilege Name	Privilege Description
All Operations	IBY_MANAGE_EXTERNAL_PAYER_PAYMENT_DETAILS_PRIV	Manage External Payer Payment Details	Allows management of payer payment details.

Privileges to Duty Roles Mapping

Privilege Code	Granted to Duty Role Code	Granted to Duty Role Name	Granted To Duty Role Description
IBY_MANAGE_EXTERNAL_PAYER_PAYMENT_DETAILS_PRIV	ORA_IBY_CUSTOMER_PAYMENT_INSTRUMENT_MANAGEMENT_DUTY	Customer Payment Instrument Management	Manages customer bank accounts and credit cards and other payment details.