Add Externally-Created Tokens/Authorizations to DPAO
Convert TMS Tokens to SAP Digital Payments (DP) Tokens
Merchants can convert TMS tokens to Digital Payments (DP) tokens using SAP's Get for Payment Card endpoint. This endpoint calls the Prepare Card endpoint (within the Paymetric DPAO Adapter) and attempts to detokenize using TMS.
If successful, the token is registered within the adapter with all available information, and the adapter sends the response to SAP DP. SAP returns a DP token and a TMS token to the merchant. These tokens can be used with other DP endpoints.
Calling the Get for Payment Card endpoint for a token that is already registered will update the registration values for that token.
Get for Payment Card Endpoint
/core/v1/tokens/getforpaymentcard
Payment Card Context
For the Get for Payment Card endpoint, the PaymentCardContext field has multiple fields within it to define the structure. The format of the structure and additional information about the fields are listed below.
"PayloadType": "",
"PaymentCardHolderName": "",
"PaymentCardExpirationMonth": "",
"PaymentCardExpirationYear": "",
"ECheckRoutingNumber": "",
"ECheckAccountType": "",
"ECheckCompanyName": "",
"ECheckEmail": "",
"ECheckPhone": "",
"AddressLine1": "",
"AddressLine2": "",
"AddressLine3": "",
"AddressPostalCode": "",
"AddressCityName": "",
"AddressCountryThreeDigitISOCode": "",
"AddressRegionCode": ""| PaymentCardContext Fields | Length |
|---|---|
|
PayloadType Note: Value for credit card = DPC2
Note: Value for eCheck = ACHE
|
|
| PaymentCardHolderName | 25 |
|
PaymentCardExpirationMonth Note: If an expiration field is sent, the other is required to be sent as well. For example, you cannot just send ExpirationMonth. Both ExpirationMonth and ExpirationYear must be sent.
|
2 |
|
PaymentCardExpirationYear Note: If an expiration field is sent, the other is required to be sent as well. For example, you cannot just send ExpirationYear. Both ExpirationMonth and ExpirationYear must be sent.
|
4 |
|
ECheckRoutingNumber |
9 |
|
ECheckAccountType |
Allowed values: checking, savings, or corporate |
|
ECheckCompanyName |
40 |
|
ECheckEmail |
255 |
|
ECheckPhone |
20 |
|
AddressLine1 |
50 |
|
AddressLine2 |
50 |
|
AddressLine3 |
50 |
|
AddressPostalCode |
50 |
|
AddressCityName |
50 |
|
AddressCountryThreeDigitISOCode |
2 |
|
AddressRegionCode |
3 |
Add XiPay Authorizations to SAP Digital Payments (DP)
The Prepare Payment Card Authorization endpoint is used by SAP to validate authorization information for XiPay authorizations created outside of SAP Digital Payments. Merchants can add the authorizations to SAP DP for further processing, such as charging/capturing the authorization.
Merchants can add externally-created XiPay authorizations by calling one of the two endpoints listed below.
Get for Payment Card Authorization
/core/v1/tokens/getforpaymentcardauthorization
This adds the authorization to SAP DP.
This endpoint calls the Prepare Payment Card Authorization endpoint within DPAO, which allows XiPay authorizations to be used in subsequent SAP DP requests, such as charging/ capturing the authorization.
Get for Payment Card WITH Authorization
/core/v1/tokens/getforpaymentcardwithauthorization
This registers the token and adds authorization to SAP DP.
This endpoint calls the Prepare Card endpoint (see Convert TMS Tokens to SAP Digital Payments (DP) Tokens), and then calls the Prepare Payment Card Authorization endpoint within DPAO.