Payment Creation Request and Response - Tags in XML Format

Note: We recommend you to refer the Payment Creation Request in XML Format andPayment Creation Response in XML Format topics in parallel while understanding the below mentioned tags. This will help you to understand how the tags are nested in the XML format.

Before calling the C1-CreatePaymentService business service through an inbound web service, you need to ensure that the create payment request contains the following tags:

Tag Name Tag Description Mandatory (Yes or No)
payeeAccount Used to indicate the account for which you want to create a payment. Yes (Conditional)
Note: This data is required if accountNumberPayee and accountNumberTypeCdPayee is not specified.
accountNumberPayee Used to specify the value for the account identifier type of the payee.
Note: You must specify the account number which is already defined in the system.
 Yes (Conditional)
Note: This data is required if accountNumberTypeCdPayee is specified.
accountNumberTypeCdPayee Used to specify the account identifier type of the payee. Yes (Conditional)
Note: This data is required while creating a payment.
divisionCodePayee Used to indicate the division code of the payee.
Note: You must indicate the division code which is already defined in the application.
 Yes (Conditional)
Note: This data is required while creating a payment.
matchType Used to indicate the match type using which you want to match the payment.
Note: You must indicate the match type which is already defined in the application.
 Yes
matchTypeValue Used to specify a particular entity (such as bill ID or contract ID) for the match type.
Note:

The match value must be a valid bill ID or contract ID.

If you specify a match type where the entity type is set to Account, the match value should not be provided. The payee account ID is directly fetched from the dataset. If the payee account ID is not available in the dataset, it is derived using the payee account identifier type, identifier value, and division. The system then derives the unpaid bills of the payee account using the manual distribution algorithm attached to the respective match type.

If you specify a match type where the entity type is set to Statement, the match value should not be provided. The statement ID is directly fetched from the dataset. The system then derives the unpaid bills of the statement using the manual distribution algorithm attached to the respective match type.

 Yes
statementId Used to specify the statement ID. Yes (Conditional)
Note: This data is required while distributing the payment amount against the unpaid bills of the statement.
paymentDt Used to specify the date when the payment was made.
Note: If the payment date is not provided, system date is considered.
 No
sourceSystem Used to indicate the external system from where the create payment request is received. No
externalTransactionId Used to indicate the external transaction ID of the payment. No
externalSourceId Used to specify the external source system ID. No
tenderList Used to specify the tender details used for creating a payment. No
tenderType Used to indicate the type of tender in which a payment is created.
Note: You must at least select one tender type.
 Yes
tenderCurrency Used to indicate the currency in which a payment is created. No
tenderAmount Used to specify the tender amount.
Note: The tender amount must be a positive amount.
 Yes
checkNumber Used to specify the check number, if payment is made through check. No
payorAccount Used to indicate the payor account for which you want to create the payment. No
accountNumber Used to indicate the bank account number through which the payment is created. No
accountNumberTypeCd Used to specify the account number type code of the payor. No
divisionCode Used to indicate the division code.
Note: You must specify the division code which is already defined in the system.
 Yes (Conditional)
Note: This data is required while creating the payment.
micrId Used to specify the MICR code on the payment. No
externalReferenceId Used to specify the external reference number of the payment. No
name Used to indicate the person for whom the payment is created. No
paymentTenderCharacteristic Used to specify the characteristic details of the payment and tender. No
characteristicType Used to indicate the characteristic type. Yes (Conditional)
Note: This field is required when you are defining a characteristic for the payment tender.
characteristicValue Used to specify the value for the characteristic type. Yes (Conditional)
Note: This field is required when you are defining a characteristic for the payment tender.

The following table provides information about the response tags mentioned in the payment creation business service:

Tag Name Tag Description
paymentsDtls Displays the payment details.
paymentEventId Displays the payment event Id.
paymentId Displays the payment Id.
messageValue Indicates an error that occurred while creating a payment request.
paymentStatusDesc Indicates the reason why the create payment process is rejected.
statusCd Indicates whether the payment creation request is successfully processed or not. The valid values are:

  • Success

  • Fail
paymentStatus Indicates the payment status. The valid values are:

  • Frozen

  • Error

Related Topics

For more information on... See...
Sample Payment Creation Request and Response in XML Format Sample Payment Creation Request and Response in XML Format