SAP Banking APIs (beta)

Transcription

1 Administrator's Guide Document Version: CUSTOMER

2 Table of Contents 1 Use Functionality Note on Beta Shipment System Landscape Authentication and Authorization Accessing the APIs Consuming APIs SAP API Business Hub Consumer SCP Account Create a Subscription Connect On-Premise Systems Expose the API Used SAP Enterprise Services Code Samples Useful Links SAP SE or an SAP affiliate company. All rights reserved. Use

3 1 Use 1.1 Functionality enable banks to collaborate with external partners. The APIs enable customers to use Payment Service Providers (PSP) to execute transactions on their behalf enable Trusted Third Party Account Access under the Access to Accounts rule (XS2A) and initiate payments are delivered via a beta shipment with the aim of obtaining early feedback from customers. 1.2 Note on Beta Shipment Beta shipments are provided under a Test and Evaluation Agreement (TEA) and can be used for testing purposes only. Productive usage is not allowed and is not supported under the maintenance and support agreement. For any questions or feedback contact us directly at beta@sap.com. 1.3 System Landscape The APIs use: for deposits: banking services from SAP 9.0 for payments: SAP Payment Engine 8.0 Use 2017 SAP SE or an SAP affiliate company. All rights reserved. 3

4 2 Authentication and Authorization APIs are secured via SAP API Management with security features, such as API Key, OAuth and basic authentication. Additional interfaces are secured by SAP Cloud Platform means. Calls to back-end are secured by SAP Cloud Platform Destination and Cloud Connector capabilities SAP SE or an SAP affiliate company. All rights reserved. Authentication and Authorization

5 3 Accessing the APIs For information on how to access and test APIs go to Getting started with the SAP API Business Hub. On the SAP API Business Hub, go to API package. Accessing the APIs 2017 SAP SE or an SAP affiliate company. All rights reserved. 5

6 4 Consuming APIs You have the following options to consume the APIs: Use the environment provided by SAP API Business Hub Expose the API from your consumer SCP account To access the required data from the on-premise systems, the API implementation consumes the SAP Enterprise Services as listed in section SAP API Business Hub The APIs that are exposed via SAP API Business Hub run out of the box. The APIs are deployed as a SCP application on a SAP SCP account. This account is connected to a SAP on-premise backend which provides some test data. For testing you may use the following values: ID of Business Partner: UUID of Account: b13-1ee6-b1c f1ce To retrieve transactions of the account, use the above account UUID and fromdate Consumer SCP Account If you need to consume the API based on your own on-premise backend systems, you need to perform the following steps: Create a subscription of the API within your consumer SCP account Connect your on-premise systems Expose the API using SAP Cloud Platform API Management Create a Subscription Please contact your contact person from SAP to create an API subscription SAP SE or an SAP affiliate company. All rights reserved. Consuming APIs

7 4.2.2 Connect On-Premise Systems Connect your on-premise backend systems by using destinations at the level of your consumer account. These destinations provide access to the on-premise systems via SAP Cloud Platform Cloud Connector. Please follow these links for more information on Destinations and SAP Cloud Platform Cloud Connector You need to create two destinations, one for each backend software product: banking services from SAP 9.0 and SAP Payment Engine 8.0. You need to provide the following properties for each destination: Property Name Name Description Type URL Proxy Type Authentication User Password Property Value Can be freely chosen Can be freely chosen HTTP Can be freely chosen This URL needs to be mapped by the cloud connector to your onpremise backend On Premise BasicAuthentication User ID in backend system User password in backend system For the destination to the Payment Engine 8.0 backend you need to add the following properties: Property Name sap-client com.sap.psd2api.be.pto.mng.crte.sa com.sap.psd2api.be.pto.mng.ep For the destination to the banking services from SAP 9.0 backend you need to add the following properties: Property Name sap-client com.sap.psd2api.be.ba.mng.ep com.sap.psd2api.be.ba.mng.rtrar.sa com.sap.psd2api.be.bacor.qry.ep com.sap.psd2api.be.bacor.qry.fnd.sa com.sap.psd2api.be.bapec.act.calc.sa com.sap.psd2api.be.bapec.act.ep com.sap.psd2api.be.bp.mng.ep com.sap.psd2api.be.bp.mng.rtr.sa com.sap.psd2api.be.cac.mng.ep com.sap.psd2api.be.cac.mng.rtr.sa com.sap.psd2api.be.dac.mng.ep com.sap.psd2api.be.dac.mng.rtr.sa The value for the property sap-client is the SAP client that contains the published service endpoints. The value of the endpoint properties (suffix.ep) contains the path to the published endpoint of the corresponding service interface. If the endpoint URL is, for example, Consuming APIs 2017 SAP SE or an SAP affiliate company. All rights reserved. 7

8 the corresponding property value for the endpoint is /sap/bc/srt/xip/sap/bacp/100/sn_bacp_cac_mng_v1/bn_bacp_cac_mng_v1 The value for the soap action properties (suffix.sa) contains the soap action for the corresponding operation within a service interface. The default values for all service operations used are listed in section 4.3. The property values should not contain any line breaks or spaces Expose the API Please see the following documentation on how to expose an API using SAP Cloud Platform API Management. 4.3 Used SAP Enterprise Services The application uses the following service operations from banking services from SAP 9.0: SAP_BS_FOUNDATION Version 748 Namespace Interface Name BusinessPartnerDataManagementManageBusinessPartnerIn Operation Name RetrieveBusinessPartner Destination property name for com.sap.psd2api.be.bp.mng.ep endpoint Destination Property Name com.sap.psd2api.be.bp.mng.rtr.sa for Soap Action Default Soap Action /BusinessPartnerDataManagementManageBusinessPartnerIn /RetrieveBusinessPartnerRequest Version Namespace Interface Name Operation Name Destination Property Name for Endpoint Destination Property name for Soap Action Default Soap Action FSAPPL 500 BankAccountContractProcessingQueryBankAccountContractOverviewRetrievaIIn FindOverviewRetrievalByElements_V1 com.sap.psd2api.be.bacor.qry.ep com.sap.psd2api.be.bacor.qry.fnd.sa /BankAccountContractProcessingQueryBankAccountContractOverviewRetrievalIn /FindOverviewRetrievalByElements_V1Request SAP SE or an SAP affiliate company. All rights reserved. Consuming APIs

9 Version Namespace Interface Name Operation Name Destination Property Name for Endpoint Destination Property Name for Soap Action Default Soap Action FSAPPL 500 BankAccountContractProcessingManageBankAccountIn RetrieveActivityReport_V2 com.sap.psd2api.be.ba.mng.ep com.sap.psd2api.be.ba.mng.rtrar.sa /BankAccountContractProcessingManageBankAccountIn /RetrieveActivityReport_V2Request FSAPPL Version 500 Namespace Interface Name BankAccountContractProcessingManageDepositAccountContractIn_V1 Operation Name RetrieveDepositAccountContractByIdentifyingElements Destination Property Name com.sap.psd2api.be.dac.mng.ep for Endpoint Destination Property Name com.sap.psd2api.be.dac.mng.rtr.sa for Soap Action Default Soap Action /BankAccountContractProcessingManageDepositAccountContractIn_V1 /RetrieveDepositAccountContractByIdentifyingElementsRequest Version Namespace Interface Name Operation Name Destination Property Name for Endpoint Destination Property name for Soap Action Default Soap Action FSAPPL 500 BankAccountContractProcessingBankAccountPaymentEntryCalculationActionIn CalculatePaymentEntry com.sap.psd2api.be.bapec.act.ep com.sap.psd2api.be.bapec.act.calc.sa /BankAccountContractProcessingBankAccountPaymentEntryCalculationActionIn /CalculatePaymentEntryRequest Consuming APIs 2017 SAP SE or an SAP affiliate company. All rights reserved. 9

10 FSAPPL Version 500 Namespace Interface Name BankAccountContractProcessingManageCurrentAccountContractIn Operation Name RetrieveCurrentAccountContractByIdentifyingElements_V1 Destination Property Name com.sap.psd2api.be.cac.mng.ep for Endpoint Destination Property Name com.sap.psd2api.be.cac.mng.rtr.sa for Soap Action Default Soap Action /BankAccountContractProcessingManageCurrentAccountContractIn /RetrieveCurrentAccountContractByIdentifyingElements_V1Request The application uses the following service operations from SAP Payment Engine 8.0: PAY-ENGINE Version 400 Namespace Interface Name PaymentTransactionProcessingManagePaymentTransactionOrderIn Operation Name CreateOrder Destination Property Name com.sap.psd2api.be.pto.mng.ep for Endpoint Destination Property Name com.sap.psd2api.be.pto.mng.crte.sa for Soap Action Default Soap Action /PaymentTransactionProcessingManagePaymentTransactionOrderIn /CreateOrderRequest SAP SE or an SAP affiliate company. All rights reserved. Consuming APIs

11 5 Code Samples Try out the API in the SAP API Business Hub. Code Samples 2017 SAP SE or an SAP affiliate company. All rights reserved. 11

12 6 Useful Links Content Documentation for the SAP Cloud Platform SAP API Business Hub: Getting Started URL bbc107264b8eccf4b/cloud/en- US/e bb c6858c8d6b0b62.html SAP SE or an SAP affiliate company. All rights reserved. Useful Links

13

14 SAP SE or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP AG and its affiliated companies ( SAP Group ) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Please see for additional trademark information and notices.