| Description | Payment Confirmation In |
| Name | PaymentConfirmationIn |
| Namespace | http://sap.com/xi/AP/CRM/Global |
| Process Component Description | Retail Execution Processing |
| Process Component Name | RetailExecutionProcessing |
| Process Component Namespace | http://sap.com/xi/AP/CRM/Global |
| Deploymnent Unit Description | Customer Relationship Management |
| Endpoint Activation | By Comunication Arrangeent | Operations |
| Release Status | Released |
An interface to confirm the replication of payment.
The web service interface PaymentConfirmationIn enables you to connect external applications to Cloud for Customer system and confirm if the replication of payment in the external system was successful or not. The web service interface PaymentConfirmationIn is relevant if a payment replication was initiated from Cloud for Customer system to your external system. You must send back the confirmation to Cloud for Customer system if the replication was successful or not.
The web service interface PaymentConfirmationIn offers the operation PaymentReplicationConfirmation.
Existence of Payment for which the confirmation is being sent.
Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements.
| Action Code | Description |
|---|---|
| 01 | Create; the system returns an error message if the node element already exists. |
| 02 | Update; the system returns an error message if the node element does not exist. |
| 03 | Delete; the system returns an error message if the node element does not exist. |
| 04 | Save; the system creates or changes the node element data. |
| 05 | Remove; the system deletes the node element. If the node element does not exist, the system does not send an error message. |
| 06 | No Action; the system does not change the node element. |
Note: Currently, only action code 02 (update) is supported.
Severity code represents if the replication process in the external application completed successfuly or an error occurred, accordingly the Transfer Status of payment in Cloud for Customer system is set.
| Severity Code | Description |
|---|---|
| 1 | Information |
| 2 | Warning |
| 3 | Error |
| 4 | Abort |
Severity code must be sent with the conformation message as shown below:
Show full documentation
Show full documentation
<Messages>
<Item>
<SeverityCode>1</SeverityCode>
<Note>Information</Note>
</Item>
</Messages>
If the severity code sent with confirmation message is 3 or 4, then the Transfer Status of payment in the Cloud for Customer system is set to Interrupted, otherwise Finished.
PaymentReplicationConfirmation operation supports exactly one execution (idempotency). To ensure exactly one execution of web service requests, the web service consumer has to provide unique values for the elements ID or UUID of the BasicMessageHeader node element.
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Confirm a payment replication
The PaymentReplicationConfirmation operation is used confirm a payment replication. This will also update the transfer status of the payment in the Cloud for Customer system.
Example to confirm the payment replication:
<n0:PaymentReplicationBulkConfirmation xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<MessageHeader>
<ID/>
<UUID>00163E07-C021-1ED5-ABC0-835A702CF7FC</UUID>
<CreationDateTime>2016-01-04T05:11:32.26724Z</CreationDateTime>
<SenderBusinessSystemID>your_external_system_id</SenderBusinessSystemID>
<RecipientBusinessSystemID>C4C_system_ID</RecipientBusinessSystemID>
<SenderParty>
<InternalID schemeAgencyID="310" schemeID="BusinessSystemID">your_external_system_id</InternalID>
</SenderParty>
<RecipientParty>
<InternalID schemeAgencyID="310" schemeID="BusinessSystemID">C4C_system_ID</InternalID>
</RecipientParty>
</MessageHeader>
<PaymentReplicateConfirmationMessage>
<BasicMessageHeader>
<ID/>
<UUID>00163E07-C021-1ED5-ABC0-835A702CF7FC</UUID>
</BasicMessageHeader>
<PaymentConfirmationMessage actionCode="02">
<ID>100632</ID>
<RecipientID>632</RecipientID>
<Messages>
<Item>
<SeverityCode>1</SeverityCode>
<Note>Information</Note>
</Item>
</Messages>
</BusinessTransactionDocumentReference>
</PaymentConfirmationMessage>
</PaymentReplicateConfirmationMessage>
</n0:PaymentReplicationBulkConfirmation>
| Description | Operation confirm payment |
| Name | PaymentReplicationConfirmation |
| Synchronous | no |
| Release Status | Released |
To confirm a Payment replication.
The confirm message of the operation PaymentReplicationConfirmation contains a MessageHeader and PaymentReplicationBasicConfirmationMessage. PaymentReplicationBasicConfirmationMessage contains a BasicMessageHeader node element as well as a PaymentConfirmationMessage node element that contains the Payment conformation data that will be used to update the payment in Cloud for Customer system. The PaymentReplicationBasicConfirmationMessage node can occur multiple times in the confirm message. This means that multiple Payment conformation can be sent through a single web service request.
With this confirm message, the payment is updated in the Cloud for Customer system. The Transfer Status of the payment is set to Finished or Interrupted based on the severity code sent with the confirm message. The replicated payment's ID in the external application is also updated in the Cloud for Customer system.
The PaymentConfirmationMessage node contains all relevant information which is required for confirming payment's replication, such as
general information like identifications, type code, etc.
message log information
The unique identifier of the Payment that is generated after replication in the external application. The ID must be provided.
The unique identifier of the Payment in the Cloud for Customer system. The Recipient ID must be provided.
Message log information contains the severity code which must be provided.
Severity code represents if the replication process in the external application completed successfuly or an error occurred, accordingly the Transfer Status of payment in Cloud for Customer system is set.
| Severity Code | Description |
|---|---|
| 1 | Information |
| 2 | Warning |
| 3 | Error |
| 4 | Abort |
<Messages>
<Item>
<SeverityCode>3</SeverityCode>
<Note>Error</Note>
</Item>
</Messages>
Action code 02 must be provided with the confirm message as the payment confirmation will update the payment in Cloud for Customer system.
<PaymentConfirmationMessage actionCode="02">
Example to confirm the payment replication:
<n0:PaymentReplicationBulkConfirmation xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<MessageHeader>
<ID/>
<UUID>00163E07-C021-1ED5-ABC0-835A702CF7FC</UUID>
<CreationDateTime>2016-01-04T05:11:32.26724Z</CreationDateTime>
<SenderBusinessSystemID>your_external_system_id</SenderBusinessSystemID>
<RecipientBusinessSystemID>C4C_system_ID</RecipientBusinessSystemID>
<SenderParty>
<InternalID schemeAgencyID="310" schemeID="BusinessSystemID">your_external_system_id</InternalID>
</SenderParty>
<RecipientParty>
<InternalID schemeAgencyID="310" schemeID="BusinessSystemID">C4C_system_ID</InternalID>
</RecipientParty>
</MessageHeader>
<PaymentReplicateConfirmationMessage>
<BasicMessageHeader>
<ID/>
<UUID>00163E07-C021-1ED5-ABC0-835A702CF7FC</UUID>
</BasicMessageHeader>
<PaymentConfirmationMessage actionCode="02">
<ID>100632</ID>
<RecipientID>632</RecipientID>
<Messages>
<Item>
<SeverityCode>1</SeverityCode>
<Note>Information</Note>
</Item>
</Messages>
</PaymentConfirmationMessage>
</PaymentReplicateConfirmationMessage>
</n0:PaymentReplicationBulkConfirmation>