| Description | Manage Payment Cards |
| Name | ManagePaymentCardIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Product | SAP Business ByDesign |
| Process component | Business Partner Data Management |
| Process component namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
| Deployment unit | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
|
| Release Status | Released |
| Technical documentation on the SAP API Business Hub | Manage Payment Cards |
| General web service documentation | A2X Web Services (SOAP) |
An interface to manage payment card data.
The Manage Payment Card In inbound service interface groups operations that read payment card data and create a payment card instance.
This web service has two operations:
Create Payment Card Token: Used to create an instance of the payment card with the payment card token
Read: Used to read payment card master data
For Create Payment Card operation, the payment Card ID sent must be the token provided by the payment service provider for the credit card. The plain text credit card number must not be sent due to PCI Data Security Standard compliance.
The payment service provider (PSP) which provides the token for the payment card must be set up as a supplier in the system and its DUNS number must be maintained.
The payment card token must already have been provided by the payment service provider (PSP).
The UUID of the Payment Card must be known for reading the payment card master data. The UUID is returned in the response of the Create Payment Card operation of the service.
For the Create Payment Card operation, the payment card ID sent must be the token provided by the payment service provider for the credit card. The plain text credit card number must not be sent due to PCI Data Security Standard compliance.
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
Create Payment Card Token
<n0:PaymentCardPaymentCardTokenCreateRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <PaymentCard> <UUID>12345678-90AB-CDEF-1621-201107061520</UUID> <ID schemeAgencyID="HTTP://WWW.PAYMETRIC.COM">-DEMO-0007-201107061520</ID> <TypeCode>2</TypeCode> </PaymentCard> </n0:PaymentCardPaymentCardTokenCreateRequest_sync>
Read
<n0:PaymentCardByIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <PaymentCard> <UUID>12345678-90AB-CDEF-1621-201107061520</UUID> </PaymentCard> </n0:PaymentCardByIDQuery_sync>
Create a Payment Card: The Create Payment Card is used to create an instance of the payment card for the payment card token.
Read Master Data of a Payment Card: The Read Master Data of Payment Card is used to Read master data of an existing payment card token.
| Description | Create payment card tokens |
| Name | CreatePaymentCardToken |
| Synchronous | yes |
| Release Status | Released |
To create an instance of the payment card for the payment card token.
Create Payment Card is used to create an instance of the payment card for the payment card token. The response of the operation is a UUID of the created instance, which can later be used to read the created master data record.
A payment service provider (PSP) must be set up as a supplier in the system.
*ID: ID is the identifier of a payment card. This is a token provided by the payment service provider which represents the payment card. For ID element the attribute schemeAgencyID must also be specified as below. Attribute shemeAgencyID The URL of the payment service provider which has provided the token (ID). E.g. HTTP://WWW.PAYMETRIC.COM for Paymetric or HTTPS://WWW.COMPUTOP.DE for Computop.
For example:
1 is for American Express
2 is for VISA
3 is for Master Card
4 is for Diners Club
Example
<n0:PaymentCardPaymentCardTokenCreateRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <PaymentCard> <UUID>12345678-90AB-CDEF-1621-201107061520</UUID> <ID schemeAgencyID="HTTP://WWW.PAYMETRIC.COM"> -DEMO-0007-201107061520 </ID> <TypeCode>2</TypeCode> </PaymentCard> </n0:PaymentCardPaymentCardTokenCreateRequest_sync>
Example
<?xml version="1.0" encoding="utf-16"?> <n0:PaymentCardPaymentCardTokenCreateConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <PaymentCard> <ChangeStateID>20110826000209.9063040</ChangeStateID> <UUID>12345678-90ab-cdef-1621-201107061520</UUID> </PaymentCard> </n0:PaymentCardPaymentCardTokenCreateConfirmation_sync>
The request message does not contain all of elements of the Payment Card business object. It only contains the UUID, the ID, and the payment card type code.
Show full documentation
Show full documentation
<n0:PaymentCardPaymentCardTokenCreateRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<PaymentCard>
<UUID>12345678-90AB-CDEF-1621-201107061520</UUID>
<ID schemeAgencyID="HTTP://WWW.PAYMETRIC.COM"> -DEMO-0007-201107061520 </ID>
<TypeCode>2</TypeCode>
</PaymentCard>
</n0:PaymentCardPaymentCardTokenCreateRequest_sync>
<?xml version="1.0" encoding="utf-16"?>
<n0:PaymentCardPaymentCardTokenCreateConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<PaymentCard>
<ChangeStateID>20110826000209.9063040</ChangeStateID>
<UUID>12345678-90ab-cdef-1621-201107061520</UUID>
</PaymentCard>
</n0:PaymentCardPaymentCardTokenCreateConfirmation_sync>
| Description | Read payment cards |
| Name | Read |
| Synchronous | yes |
| Release Status | Released |
To read payment card master data.
The Manage Payment Card In Read inbound operation reads the complete data of payment card business object, including the holder name and the payment card token.
The payment card token must already have been provided by the payment service provider (PSP) and the instance of the payment card for this token must exist.
<?xml version="1.0" encoding="utf-16"?> <n0:PaymentCardByIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <PaymentCard> <UUID>12345678-90AB-CDEF-1621-201108250723</UUID> </PaymentCard> </n0:PaymentCardByIDQuery_sync>
<?xml version="1.0" encoding="utf-16"?> <n0:PaymentCardByIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <PaymentCard> <UUID>12345678-90AB-CDEF-1621-201108250723</UUID> <ID schemeAgencyID="HTTP://WWW.PAYMETRIC.COM">-DEMO-0007-201108250723</ID> <TypeCode>2</TypeCode> <MaskedID>>******0007</MaskedID> <SupplierInternalID>MC32000</SupplierInternalID> <SupplierUUID>00300571-c924-02db-b8e7-6f41946c845b</SupplierUUID> <ValidityStartDate>0001-01-01</ValidityStartDate> <ExpirationDate>9999–12–31</ExpirationDate> <IssueDate>0001–01–01</IssueDate> <CategoryCode>1</CategoryCode> <ChangeStateID/> </PaymentCard> <Log/> </n0:PaymentCardByIDQuery_sync>
<?xml version="1.0" encoding="utf-16"?>
<n0:PaymentCardByIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<PaymentCard>
<UUID>12345678-90AB-CDEF-1621-201108250723</UUID>
</PaymentCard>
</n0:PaymentCardByIDQuery_sync>
<?xml version="1.0" encoding="utf-16"?>
<n0:PaymentCardByIDResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<PaymentCard>
<UUID>12345678-90ab-cdef-1621-201108250723</UUID>
<ID schemeAgencyID="HTTP://WWW.PAYMETRIC.COM">-DEMO-0007-201108250723</ID>
<TypeCode>2</TypeCode>
<MaskedID>************0007</MaskedID>
<SupplierInternalID>MC32000</SupplierInternalID>
<SupplierUUID>00300571-c924-02db-b8e7-6f41946c845b</SupplierUUID>
<ValidityStartDate>0001-01-01</ValidityStartDate>
<ExpirationDate>9999-12-31</ExpirationDate>
<ExpirationTimePointFormattedText>12/9999</ExpirationTimePointFormattedText>
<IssueDate>0001-01-01</IssueDate>
<CategoryCode>1</CategoryCode>
<ChangeStateID/>
</PaymentCard>
<Log/>
</n0:PaymentCardByIDResponse_sync>
The operation can be used to read payment card master data (including token, expiration date, holder name) which can then be used, for example, for initiating payment authorization requests with clearing house.