{"resource_docs":[{"operation_id":"BGv1.3-getAccountList","implemented_by":{"version":"BGv1.3","function":"getAccountList"},"request_verb":"GET","request_url":"/berlin-group/v1.3/accounts","summary":"Read Account List","description":"
Read the identifiers of the available payment account together with
\nbooking balance information, depending on the consent granted.
It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.
\nThe addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId,
\nrespectively the OAuth2 access token.
Returns all identifiers of the accounts, to which an account access has been granted to through
\nthe /consents endpoint by the PSU.
\nIn addition, relevant information about the accounts and hyperlinks to corresponding account
\ninformation resources are provided if a related consent has been already granted.
Remark: Note that the /consents endpoint optionally offers to grant an access on all available
\npayment accounts of a PSU.
\nIn this case, this endpoint will deliver the information about all available payment accounts
\nof the PSU at this ASPSP.
Authentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Read the identifiers of the available payment account together with \nbooking balance information, depending on the consent granted.\n\nIt is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. \nThe addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId, \nrespectively the OAuth2 access token. \n\nReturns all identifiers of the accounts, to which an account access has been granted to through \nthe /consents endpoint by the PSU. \nIn addition, relevant information about the accounts and hyperlinks to corresponding account \ninformation resources are provided if a related consent has been already granted.\n\nRemark: Note that the /consents endpoint optionally offers to grant an access on all available \npayment accounts of a PSU. \nIn this case, this endpoint will deliver the information about all available payment accounts \nof the PSU at this ASPSP.\n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"resourceId":"3dc3d5b3-7023-4848-9853-f5400a64e80f","iban":"DE2310010010123456789","currency":"EUR","product":"Girokonto","cashAccountType":"CACC","name":"Main Account","_links":{"balances":{"href":"/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"}}},{"resourceId":"3dc3d5b3-7023-4848-9853-f5400a64e81g","iban":"DE2310010010123456788","currency":"USD","product":"Fremdwährungskonto","cashAccountType":"CACC","name":"US Dollar Account","_links":{"balances":{"href":"/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"}}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"product":{"type":"string"},"cashAccountType":{"type":"string"},"name":{"type":"string"},"iban":{"type":"string"},"resourceId":{"type":"string"},"currency":{"type":"string"},"_links":{"type":"object","properties":{"balances":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/accounts","connector_methods":[]},{"operation_id":"BGv1.3-initiatePayments","implemented_by":{"version":"BGv1.3","function":"initiatePayments"},"request_verb":"POST","request_url":"/berlin-group/v1.3/payments/PAYMENT_PRODUCT","summary":"Payment initiation request(payments)","description":"This method is used to initiate a payment at the ASPSP.
\n## Variants of Payment Initiation Requests
\nThis method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.
\nThere are the following payment products:
\nFurthermore the request body depends on the payment-service
\nThis is the first step in the API to initiate the related recurring/periodic payment.
\n## Single and mulitilevel SCA Processes
\nThe Payment Initiation Requests are independent from the need of one ore multilevel
\nSCA processing, i.e. independent from the number of authorisations needed for the execution of payments.
But the response messages are specific to either one SCA processing or multilevel SCA processing.
\nFor payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation,
\ni.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the
\nresponse message of a Payment Initation Request for a payment, where multiple authorisations are needed.
\nAlso if any data is needed for the next action, like selecting an SCA method is not supported in the response,
\nsince all starts of the multiple authorisations are fully equal.
\nIn these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.
Additional Instructions:
\nfor PAYMENT_SERVICE use payments
\nfor PAYMENT_PRODUCT use sepa-credit-transfers
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nJSON request body fields:
\namount: 10.12
\n\n\ncurrency: EUR
\n\niban: DE91 1000 0000 0123 4567 89
\ninstructedAmount: 100
\nchargeBearer: chargeBearer
\ncreditorAddress: creditorAddress
\ncreditorAgent: creditorAgent
\ncreditorAgentName: creditorAgentName
\ncreditorId: creditorId
\ncreditorNameAndAddress: creditorNameAndAddress
\ncurrencyOfTransfer: currencyOfTransfer
\ndebtorId: debtorId
\ndebtorName: debtorName
\nendToEndIdentification: endToEndIdentification
\nexchangeRateInformation: exchangeRateInformation
\ninstructionIdentification: instructionIdentification
\npurposeCode: purposeCode
\nremittanceInformationStructured: remittanceInformationStructured
\nremittanceInformationStructuredArray: remittanceInformationStructuredArray
\nremittanceInformationUnstructured: remittanceInformationUnstructured
\nremittanceInformationUnstructuredArray: remittanceInformationUnstructuredArray
\nrequestedExecutionDate: requestedExecutionDate
\nrequestedExecutionTime: requestedExecutionTime
\nserviceLevel: serviceLevel
\nultimateCreditor: ultimateCreditor
\nultimateDebtor: ultimateDebtor
\nJSON response body fields:
\n","description_markdown":"This method is used to initiate a payment at the ASPSP.\n\n ## Variants of Payment Initiation Requests\n\n This method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.\n\n There are the following **payment products**:\n\n - Payment products with payment information in *JSON* format:\n - ***sepa-credit-transfers***\n - ***instant-sepa-credit-transfers***\n - ***target-2-payments***\n - ***cross-border-credit-transfers***\n - Payment products with payment information in *pain.001* XML format:\n - ***pain.001-sepa-credit-transfers***\n - ***pain.001-instant-sepa-credit-transfers***\n - ***pain.001-target-2-payments***\n - ***pain.001-cross-border-credit-transfers***\n\n - Furthermore the request body depends on the **payment-service**\n - ***payments***: A single payment initiation request.\n - ***bulk-payments***: A collection of several payment iniatiation requests.\n In case of a *pain.001* message there are more than one payments contained in the *pain.001 message.\n In case of a *JSON* there are several JSON payment blocks contained in a joining list.\n - ***periodic-payments***:\n Create a standing order initiation resource for recurrent i.e. periodic payments addressable under {paymentId}\n with all data relevant for the corresponding payment product and the execution of the standing order contained in a JSON body.\n\n This is the first step in the API to initiate the related recurring/periodic payment.\n\n ## Single and mulitilevel SCA Processes\n\n The Payment Initiation Requests are independent from the need of one ore multilevel\n SCA processing, i.e. independent from the number of authorisations needed for the execution of payments.\n\n But the response messages are specific to either one SCA processing or multilevel SCA processing.\n\n For payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation,\n i.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the\n response message of a Payment Initation Request for a payment, where multiple authorisations are needed.\n Also if any data is needed for the next action, like selecting an SCA method is not supported in the response,\n since all starts of the multiple authorisations are fully equal.\n In these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.\n\n\n \nAdditional Instructions:\n\nfor PAYMENT_SERVICE use payments\n\nfor PAYMENT_PRODUCT use sepa-credit-transfers\n\n \n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[chargeBearer](/glossary#): chargeBearer\n\n\n\n[creditorAddress](/glossary#): creditorAddress\n\n\n\n[creditorAgent](/glossary#): creditorAgent\n\n\n\n[creditorAgentName](/glossary#): creditorAgentName\n\n\n\n[creditorId](/glossary#): creditorId\n\n\n\n[creditorNameAndAddress](/glossary#): creditorNameAndAddress\n\n\n\n[currencyOfTransfer](/glossary#): currencyOfTransfer\n\n\n\n[debtorId](/glossary#): debtorId\n\n\n\n[debtorName](/glossary#): debtorName\n\n\n\n[endToEndIdentification](/glossary#): endToEndIdentification\n\n\n\n[exchangeRateInformation](/glossary#): exchangeRateInformation\n\n\n\n[instructionIdentification](/glossary#): instructionIdentification\n\n\n\n[purposeCode](/glossary#): purposeCode\n\n\n\n[remittanceInformationStructured](/glossary#): remittanceInformationStructured\n\n\n\n[remittanceInformationStructuredArray](/glossary#): remittanceInformationStructuredArray\n\n\n\n[remittanceInformationUnstructured](/glossary#): remittanceInformationUnstructured\n\n\n\n[remittanceInformationUnstructuredArray](/glossary#): remittanceInformationUnstructuredArray\n\n\n\n[requestedExecutionDate](/glossary#): requestedExecutionDate\n\n\n\n[requestedExecutionTime](/glossary#): requestedExecutionTime\n\n\n\n[serviceLevel](/glossary#): serviceLevel\n\n\n\n[ultimateCreditor](/glossary#): ultimateCreditor\n\n\n\n[ultimateDebtor](/glossary#): ultimateDebtor\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"debtorAccount":{"iban":"GB33BUKB20201555555555"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"DE75512108001245126199"},"creditorName":"John Miles"},"success_response_body":{"transactionStatus":"RCVD","paymentId":"1234-wertiq-983","_links":{"scaRedirect":{"href":"https://apisandbox.openbankproject.com/otp?flow=payment&paymentService=payments&paymentProduct=sepa_credit_transfers&paymentId=b0472c21-6cea-4ee0-b036-3e253adb3b0b"},"self":{"href":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983"},"status":{"href":"/v1.3/payments/1234-wertiq-983/status"},"scaStatus":{"href":"/v1.3/payments/1234-wertiq-983/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"transactionStatus":{"type":"string"},"paymentId":{"type":"string"},"_links":{"type":"object","properties":{"scaRedirect":{"type":"object","properties":{"href":{"type":"string"}}},"self":{"type":"object","properties":{"href":{"type":"string"}}},"status":{"type":"object","properties":{"href":{"type":"string"}}},"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/payments/PAYMENT_PRODUCT","connector_methods":[]},{"operation_id":"BGv1.3-updatePaymentCancellationPsuDataTransactionAuthorisation","implemented_by":{"version":"BGv1.3","function":"updatePaymentCancellationPsuDataTransactionAuthorisation"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations/AUTHORISATION_ID","summary":"Update PSU Data for payment initiation cancellation (transactionAuthorisation)","description":"This method updates PSU data on the cancellation authorisation resource if needed.
\nIt may authorise a cancellation of the payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of
\nthe authentication method and a non-SCA PSU authentication.
This methods updates PSU data on the cancellation authorisation resource if needed.
\nThere are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services needed,
\nwhich depends on the SCA approach:
The SCA Approach might depend on the chosen SCA method.
\nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:
There are the following request types on this access path:
\n* Update PSU Identification
\n* Update PSU Authentication
\n* Select PSU Autorization Method
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATION_ID: AUTHORISATION_ID
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"This method updates PSU data on the cancellation authorisation resource if needed. \nIt may authorise a cancellation of the payment within the Embedded SCA Approach where needed.\n\nIndependently from the SCA Approach it supports e.g. the selection of \nthe authentication method and a non-SCA PSU authentication.\n\nThis methods updates PSU data on the cancellation authorisation resource if needed. \n\nThere are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services needed, \nwhich depends on the SCA approach:\n\n* Redirect SCA Approach:\nA specific Update PSU Data Request is applicable for\n * the selection of authentication methods, before choosing the actual SCA approach.\n* Decoupled SCA Approach:\nA specific Update PSU Data Request is only applicable for\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or\n* the selection of authentication methods.\n* Embedded SCA Approach: \nThe Update PSU Data Request might be used\n* to add credentials as a first factor authentication data of the PSU and\n* to select the authentication method and\n* transaction authorisation.\n\nThe SCA Approach might depend on the chosen SCA method. \nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:\n\n* Select an SCA method in case of several SCA methods are available for the customer.\n\nThere are the following request types on this access path:\n* Update PSU Identification\n* Update PSU Authentication\n* Select PSU Autorization Method\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n* Transaction Authorisation\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATION_ID](/glossary#): AUTHORISATION_ID\n\n\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"scaAuthenticationData":"123"},"success_response_body":{"scaStatus":"finalised","psuMessage":"Please check your SMS at a mobile device.","_links":{"scaStatus":"/v1.3/payments/sepa-credit-transfers/PAYMENT_ID/4f4a8b7f-9968-4183-92ab-ca512b396bfc"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"scaAuthenticationData":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"psuMessage":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations/AUTHORISATION_ID","connector_methods":[]},{"operation_id":"BGv1.3-initiatePeriodicPayments","implemented_by":{"version":"BGv1.3","function":"initiatePeriodicPayments"},"request_verb":"POST","request_url":"/berlin-group/v1.3/periodic-payments/PAYMENT_PRODUCT","summary":"Payment initiation request(periodic-payments)","description":"This method is used to initiate a payment at the ASPSP.
\n## Variants of Payment Initiation Requests
\nThis method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.
\nThere are the following payment products:
\nFurthermore the request body depends on the payment-service
\nThis is the first step in the API to initiate the related recurring/periodic payment.
\n## Single and mulitilevel SCA Processes
\nThe Payment Initiation Requests are independent from the need of one ore multilevel
\nSCA processing, i.e. independent from the number of authorisations needed for the execution of payments.
But the response messages are specific to either one SCA processing or multilevel SCA processing.
\nFor payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation,
\ni.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the
\nresponse message of a Payment Initation Request for a payment, where multiple authorisations are needed.
\nAlso if any data is needed for the next action, like selecting an SCA method is not supported in the response,
\nsince all starts of the multiple authorisations are fully equal.
\nIn these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.
Additional Instructions:
\nfor PAYMENT_SERVICE use payments
\nfor PAYMENT_PRODUCT use sepa-credit-transfers
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"This method is used to initiate a payment at the ASPSP.\n\n ## Variants of Payment Initiation Requests\n\n This method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.\n\n There are the following **payment products**:\n\n - Payment products with payment information in *JSON* format:\n - ***sepa-credit-transfers***\n - ***instant-sepa-credit-transfers***\n - ***target-2-payments***\n - ***cross-border-credit-transfers***\n - Payment products with payment information in *pain.001* XML format:\n - ***pain.001-sepa-credit-transfers***\n - ***pain.001-instant-sepa-credit-transfers***\n - ***pain.001-target-2-payments***\n - ***pain.001-cross-border-credit-transfers***\n\n - Furthermore the request body depends on the **payment-service**\n - ***payments***: A single payment initiation request.\n - ***bulk-payments***: A collection of several payment iniatiation requests.\n In case of a *pain.001* message there are more than one payments contained in the *pain.001 message.\n In case of a *JSON* there are several JSON payment blocks contained in a joining list.\n - ***periodic-payments***:\n Create a standing order initiation resource for recurrent i.e. periodic payments addressable under {paymentId}\n with all data relevant for the corresponding payment product and the execution of the standing order contained in a JSON body.\n\n This is the first step in the API to initiate the related recurring/periodic payment.\n\n ## Single and mulitilevel SCA Processes\n\n The Payment Initiation Requests are independent from the need of one ore multilevel\n SCA processing, i.e. independent from the number of authorisations needed for the execution of payments.\n\n But the response messages are specific to either one SCA processing or multilevel SCA processing.\n\n For payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation,\n i.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the\n response message of a Payment Initation Request for a payment, where multiple authorisations are needed.\n Also if any data is needed for the next action, like selecting an SCA method is not supported in the response,\n since all starts of the multiple authorisations are fully equal.\n In these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.\n\n\n \nAdditional Instructions:\n\nfor PAYMENT_SERVICE use payments\n\nfor PAYMENT_PRODUCT use sepa-credit-transfers\n\n \n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"instructedAmount":{"currency":"EUR","amount":"123"},"debtorAccount":{"iban":"DE40100100103307118608"},"creditorName":"Merchant123","creditorAccount":{"iban":"DE23100120020123456789"},"remittanceInformationUnstructured":"Ref Number Abonnement","startDate":"2018-03-01","executionRule":"preceding","frequency":"Monthly","dayOfExecution":"01"},"success_response_body":{"transactionStatus":"RCVD","paymentId":"1234-wertiq-983","_links":{"scaRedirect":{"href":"https://apisandbox.openbankproject.com/otp?flow=payment&paymentService=payments&paymentProduct=sepa_credit_transfers&paymentId=b0472c21-6cea-4ee0-b036-3e253adb3b0b"},"self":{"href":"/v1.3/periodic-payments/instant-sepa-credit-transfer/1234-wertiq-983"},"status":{"href":"/v1.3/periodic-payments/1234-wertiq-983/status"},"scaStatus":{"href":"/v1.3/periodic-payments/1234-wertiq-983/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"creditorName":{"type":"string"},"frequency":{"type":"string"},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"dayOfExecution":{"type":"string"},"startDate":{"type":"string"},"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"remittanceInformationUnstructured":{"type":"string"},"executionRule":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"transactionStatus":{"type":"string"},"paymentId":{"type":"string"},"_links":{"type":"object","properties":{"scaRedirect":{"type":"object","properties":{"href":{"type":"string"}}},"self":{"type":"object","properties":{"href":{"type":"string"}}},"status":{"type":"object","properties":{"href":{"type":"string"}}},"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/periodic-payments/PAYMENT_PRODUCT","connector_methods":[]},{"operation_id":"BGv1.3-getPaymentInitiationAuthorisation","implemented_by":{"version":"BGv1.3","function":"getPaymentInitiationAuthorisation"},"request_verb":"GET","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID/authorisations","summary":"Get Payment Initiation Authorisation Sub-Resources Request","description":"Read a list of all authorisation subresources IDs which have been created.
\nThis function returns an array of hyperlinks to all generated authorisation sub-resources.
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENTID: PAYMENTID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"Read a list of all authorisation subresources IDs which have been created.\n\nThis function returns an array of hyperlinks to all generated authorisation sub-resources.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENTID](/glossary#): PAYMENTID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jvalueToCaseclass":[{"scaStatus":"received","authorisationId":"940948c7-1c86-4d88-977e-e739bf2c1492","psuMessage":"Please check your SMS at a mobile device.","_links":{"scaStatus":"/v1.3/payments/sepa-credit-transfers/940948c7-1c86-4d88-977e-e739bf2c1492"}},{"scaStatus":"received","authorisationId":"0ae75eee-deba-41d6-8116-1a4d6e05dd83","psuMessage":"Please check your SMS at a mobile device.","_links":{"scaStatus":"/v1.3/payments/sepa-credit-transfers/0ae75eee-deba-41d6-8116-1a4d6e05dd83"}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"array","items":{"type":"object","properties":{"scaStatus":{"type":"string"},"authorisationId":{"type":"string"},"psuMessage":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID/authorisations","connector_methods":[]},{"operation_id":"BGv1.3-getPaymentInitiationCancellationAuthorisationInformation","implemented_by":{"version":"BGv1.3","function":"getPaymentInitiationCancellationAuthorisationInformation"},"request_verb":"GET","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID/cancellation-authorisations","summary":"Get Cancellation Authorisation Sub-Resources Request","description":"Retrieve a list of all created cancellation authorisation sub-resources.
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENTID: PAYMENTID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"Retrieve a list of all created cancellation authorisation sub-resources.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENTID](/glossary#): PAYMENTID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID/cancellation-authorisations","connector_methods":[]},{"operation_id":"BGv1.3-startConsentAuthorisationSelectPsuAuthenticationMethod","implemented_by":{"version":"BGv1.3","function":"startConsentAuthorisationSelectPsuAuthenticationMethod"},"request_verb":"POST","request_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations","summary":"Start the authorisation process for a consent(selectPsuAuthenticationMethod)","description":"Create an authorisation sub-resource and start the authorisation process of a consent.
\nThe message might in addition transmit authentication and authorisation related data.
\nhis method is iterated n times for a n times SCA authorisation in a corporate context,
\neach creating an own authorisation sub-endpoint for the corresponding PSU authorising the consent.
\nThe ASPSP might make the usage of this access method unnecessary, since the related authorisation
\nresource will be automatically created by the ASPSP after the submission of the consent data with the
\nfirst POST consents call. The start authorisation process is a process which is needed for creating
\na new authorisation or cancellation sub-resource.
This applies in the following scenarios: * The ASPSP has indicated with an 'startAuthorisation' hyperlink
\nin the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP.
\nThe 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using
\nthe extended forms.
\n* 'startAuthorisationWithPsuIdentfication',
\n* 'startAuthorisationWithPsuAuthentication'
\n* 'startAuthorisationWithEncryptedPsuAuthentication'
\n* 'startAuthorisationWithAuthentciationMethodSelection'
\n* The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
\n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation
\nResponse that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by
\nusing the extended forms as indicated above.
\n* The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
\n* The signing basket needs to be authorised yet.
Authentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Create an authorisation sub-resource and start the authorisation process of a consent. \nThe message might in addition transmit authentication and authorisation related data. \nhis method is iterated n times for a n times SCA authorisation in a corporate context, \neach creating an own authorisation sub-endpoint for the corresponding PSU authorising the consent. \nThe ASPSP might make the usage of this access method unnecessary, since the related authorisation\nresource will be automatically created by the ASPSP after the submission of the consent data with the \nfirst POST consents call. The start authorisation process is a process which is needed for creating \na new authorisation or cancellation sub-resource. \n\nThis applies in the following scenarios: * The ASPSP has indicated with an 'startAuthorisation' hyperlink \nin the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. \nThe 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using \nthe extended forms. \n* 'startAuthorisationWithPsuIdentfication', \n* 'startAuthorisationWithPsuAuthentication' \n* 'startAuthorisationWithEncryptedPsuAuthentication' \n* 'startAuthorisationWithAuthentciationMethodSelection' \n* The related payment initiation cannot yet be executed since a multilevel SCA is mandated. \n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation \nResponse that an explicit start of the authorisation process is needed by the TPP. \n\nThe 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by \nusing the extended forms as indicated above. \n* The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation. \n* The signing basket needs to be authorised yet.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"authenticationMethodId":""},"success_response_body":{"scaStatus":"received","psuMessage":"Please use your BankApp for transaction Authorisation.","authorisationId":"123auth456.","_links":{"scaStatus":{"href":"/v1.3/consents/qwer3456tzui7890/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"authenticationMethodId":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"psuMessage":{"type":"string"},"authorisationId":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations","connector_methods":[]},{"operation_id":"BGv1.3-getConsentScaStatus","implemented_by":{"version":"BGv1.3","function":"getConsentScaStatus"},"request_verb":"GET","request_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations/AUTHORISATIONID","summary":"Read the SCA status of the consent authorisation","description":"This method returns the SCA status of a consent initiation's authorisation sub-resource.
\nAuthentication is Mandatory
\nURL Parameters:
\nAUTHORISATIONID: AUTHORISATIONID
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"This method returns the SCA status of a consent initiation's authorisation sub-resource.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATIONID](/glossary#): AUTHORISATIONID\n\n\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"scaStatus":"started"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations/AUTHORISATIONID","connector_methods":[]},{"operation_id":"BGv1.3-getConsentInformation","implemented_by":{"version":"BGv1.3","function":"getConsentInformation"},"request_verb":"GET","request_url":"/berlin-group/v1.3/consents/CONSENTID","summary":"Get Consent Request","description":"Returns the content of an account information consent object.
\nThis is returning the data for the TPP especially in cases,
\nwhere the consent was directly managed between ASPSP and PSU e.g. in a re-direct SCA Approach.
Authentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"Returns the content of an account information consent object. \nThis is returning the data for the TPP especially in cases, \nwhere the consent was directly managed between ASPSP and PSU e.g. in a re-direct SCA Approach.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"access":{"accounts":[{"bban":"BARC12345612345678","maskedPan":"123456xxxxxx1234","iban":"FR7612345987650123456789014","currency":"EUR","msisdn":"+49 170 1234567","pan":"5409050000000000"},{"bban":"BARC12345612345678","maskedPan":"123456xxxxxx1234","iban":"FR7612345987650123456789014","currency":"EUR","msisdn":"+49 170 1234567","pan":"5409050000000000"}]},"recurringIndicator":false,"validUntil":"2020-12-31","frequencyPerDay":4,"combinedServiceIndicator":false,"lastActionDate":"2019-06-30","consentStatus":"received"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"access":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}}}},"consentStatus":{"type":"string"},"validUntil":{"type":"string"},"combinedServiceIndicator":{"type":"boolean"},"lastActionDate":{"type":"string"},"recurringIndicator":{"type":"boolean"},"frequencyPerDay":{"type":"integer"}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID","connector_methods":[]},{"operation_id":"BGv1.3-startPaymentAuthorisationUpdatePsuAuthentication","implemented_by":{"version":"BGv1.3","function":"startPaymentAuthorisationUpdatePsuAuthentication"},"request_verb":"POST","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations","summary":"Start the authorisation process for a payment initiation (updatePsuAuthentication)","description":"NOTE: This endpoint currently only returns example data.
\nCreate an authorisation sub-resource and start the authorisation process.
\nThe message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a
\ncorporate context, each creating an own authorisation sub-endpoint for
\nthe corresponding PSU authorising the transaction.
The ASPSP might make the usage of this access method unnecessary in case
\nof only one SCA process needed, since the related authorisation resource
\nmight be automatically created by the ASPSP after the submission of the
\npayment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation
\nor cancellation sub-resource.
This applies in the following scenarios:
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nCreate an authorisation sub-resource and start the authorisation process. \nThe message might in addition transmit authentication and authorisation related data. \n\nThis method is iterated n times for a n times SCA authorisation in a \ncorporate context, each creating an own authorisation sub-endpoint for \nthe corresponding PSU authorising the transaction.\n\nThe ASPSP might make the usage of this access method unnecessary in case \nof only one SCA process needed, since the related authorisation resource \nmight be automatically created by the ASPSP after the submission of the \npayment data with the first POST payments/{payment-product} call.\n\nThe start authorisation process is a process which is needed for creating a new authorisation \nor cancellation sub-resource. \n\nThis applies in the following scenarios:\n\n * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding Payment \n Initiation Response that an explicit start of the authorisation process is needed by the TPP. \n The 'startAuthorisation' hyperlink can transport more information about data which needs to be \n uploaded by using the extended forms.\n * 'startAuthorisationWithPsuIdentfication', \n * 'startAuthorisationWithPsuAuthentication' #TODO\n * 'startAuthorisationWithAuthentciationMethodSelection' \n * The related payment initiation cannot yet be executed since a multilevel SCA is mandated.\n * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding \n Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. \n The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded \n by using the extended forms as indicated above.\n * The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for \n executing the cancellation.\n * The signing basket needs to be authorised yet.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"scaStatus":"finalised","_links":{"status":{"href":"/v1/payments/sepa-credit-transfers/qwer3456tzui7890/status"}}},"success_response_body":{"challengeData":{"scaStatus":"received","authorisationId":"88695566-6642-46d5-9985-0d824624f507","psuMessage":"Please check your SMS at a mobile device.","_links":{"scaStatus":"/v1.3/payments/sepa-credit-transfers/88695566-6642-46d5-9985-0d824624f507"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"_links":{"type":"object","properties":{"status":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"challengeData":{"type":"object","properties":{"scaStatus":{"type":"string"},"authorisationId":{"type":"string"},"psuMessage":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations","connector_methods":[]},{"operation_id":"BGv1.3-getCardAccountTransactionList","implemented_by":{"version":"BGv1.3","function":"getCardAccountTransactionList"},"request_verb":"GET","request_url":"/berlin-group/v1.3/card-accounts/ACCOUNT_ID/transactions","summary":"Read transaction list of a card account","description":"Reads account data from a given card account addressed by "account-id".
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\n","description_markdown":"Reads account data from a given card account addressed by \"account-id\".\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"cardAccount":{"maskedPan":"525412******3241"},"transactions":{"booked":[{"cardTransactionId":"201710020036959","transactionAmount":{"currency":"EUR","amount":"256.67"},"transactionDate":"2017-10-25","bookingDate":"2017-10-26","originalAmount":{"currency":"SEK","amount":"2499"},"cardAcceptorAddress":{"city":"STOCKHOLM","country":"SE"},"maskedPan":"525412******3241","proprietaryBankTransactionCode":"PURCHASE","invoiced":false,"transactionDetails":"WIFIMARKET.SE"},{"cardTransactionId":"201710020091863","transactionAmount":{"currency":"EUR","amount":"10.72"},"transactionDate":"2017-10-25","bookingDate":"2017-10-26","originalAmount":{"currency":"SEK","amount":"99"},"cardAcceptorAddress":{"city":"STOCKHOLM","country":"SE"},"maskedPan":"525412******8999","proprietaryBankTransactionCode":"PURCHASE","invoiced":false,"transactionDetails":"ICA SUPERMARKET SKOGHA"}],"pending":[],"_links":{"cardAccount":{"href":"/v1.3/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99"}}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"cardAccount":{"type":"object","properties":{"maskedPan":{"type":"string"}}},"transactions":{"type":"object","properties":{"booked":{"type":"array","items":{"type":"object","properties":{"transactionDate":{"type":"string"},"bookingDate":{"type":"string"},"cardAcceptorAddress":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"}}},"originalAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"cardTransactionId":{"type":"string"},"invoiced":{"type":"boolean"},"transactionAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"proprietaryBankTransactionCode":{"type":"string"},"transactionDetails":{"type":"string"},"maskedPan":{"type":"string"}}}},"pending":{"type":"object","properties":{"arr":{"type":"object","properties":{}}}},"_links":{"type":"object","properties":{"cardAccount":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/card-accounts/ACCOUNT_ID/transactions","connector_methods":[]},{"operation_id":"BGv1.3-getTransactionList","implemented_by":{"version":"BGv1.3","function":"getTransactionList"},"request_verb":"GET","request_url":"/berlin-group/v1.3/accounts/ACCOUNT_ID/transactions","summary":"Read transaction list of an account","description":"Read transaction reports or transaction lists of a given account ddressed by "account-id",
\ndepending on the steering parameter "bookingStatus" together with balances.
\nFor a given account, additional parameters are e.g. the attributes "dateFrom" and "dateTo".
\nThe ASPSP might add balance information, if transaction lists without balances are not supported.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\n","description_markdown":"Read transaction reports or transaction lists of a given account ddressed by \"account-id\",\ndepending on the steering parameter \"bookingStatus\" together with balances.\nFor a given account, additional parameters are e.g. the attributes \"dateFrom\" and \"dateTo\".\nThe ASPSP might add balance information, if transaction lists without balances are not supported. \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"account":{"iban":"DE2310010010123456788"},"transactions":{"booked":[{"transactionId":"1234567","creditorName":"John Miles","creditorAccount":{"iban":"DE67100100101306118605"},"transactionAmount":{"currency":"EUR","amount":"256.67"},"bookingDate":"2017-10-25","valueDate":"2017-10-26","remittanceInformationUnstructured":"Example 1"},{"transactionId":"1234568","debtorName":"Paul Simpson","debtorAccount":{"iban":"NL76RABO0359400371"},"transactionAmount":{"currency":"EUR","amount":"343.01"},"bookingDate":"2017-10-25","valueDate":"2017-10-26","remittanceInformationUnstructured":"Example 2"}],"pending":[{"transactionId":"1234569","creditorName":"Claude Renault","creditorAccount":{"iban":"FR7612345987650123456789014"},"transactionAmount":{"currency":"EUR","amount":"-100.03"},"valueDate":"2017-10-26","remittanceInformationUnstructured":"Example 3"}],"_links":{"account":{"href":"/v1.3/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f"}}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"account":{"type":"object","properties":{"iban":{"type":"string"}}},"transactions":{"type":"object","properties":{"booked":{"type":"array","items":{"type":"object","properties":{"valueDate":{"type":"string"},"remittanceInformationUnstructured":{"type":"string"},"creditorName":{"type":"string"},"transactionAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"bookingDate":{"type":"string"},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"transactionId":{"type":"string"}}}},"pending":{"type":"array","items":{"type":"object","properties":{"valueDate":{"type":"string"},"transactionAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"remittanceInformationUnstructured":{"type":"string"},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"},"transactionId":{"type":"string"}}}},"_links":{"type":"object","properties":{"account":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/accounts/ACCOUNT_ID/transactions","connector_methods":[]},{"operation_id":"BGv1.3-startPaymentAuthorisationSelectPsuAuthenticationMethod","implemented_by":{"version":"BGv1.3","function":"startPaymentAuthorisationSelectPsuAuthenticationMethod"},"request_verb":"POST","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations","summary":"Start the authorisation process for a payment initiation (selectPsuAuthenticationMethod)","description":"NOTE: This endpoint currently only returns example data.
\nCreate an authorisation sub-resource and start the authorisation process.
\nThe message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a
\ncorporate context, each creating an own authorisation sub-endpoint for
\nthe corresponding PSU authorising the transaction.
The ASPSP might make the usage of this access method unnecessary in case
\nof only one SCA process needed, since the related authorisation resource
\nmight be automatically created by the ASPSP after the submission of the
\npayment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation
\nor cancellation sub-resource.
This applies in the following scenarios:
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nCreate an authorisation sub-resource and start the authorisation process. \nThe message might in addition transmit authentication and authorisation related data. \n\nThis method is iterated n times for a n times SCA authorisation in a \ncorporate context, each creating an own authorisation sub-endpoint for \nthe corresponding PSU authorising the transaction.\n\nThe ASPSP might make the usage of this access method unnecessary in case \nof only one SCA process needed, since the related authorisation resource \nmight be automatically created by the ASPSP after the submission of the \npayment data with the first POST payments/{payment-product} call.\n\nThe start authorisation process is a process which is needed for creating a new authorisation \nor cancellation sub-resource. \n\nThis applies in the following scenarios:\n\n * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding Payment \n Initiation Response that an explicit start of the authorisation process is needed by the TPP. \n The 'startAuthorisation' hyperlink can transport more information about data which needs to be \n uploaded by using the extended forms.\n * 'startAuthorisationWithPsuIdentfication', \n * 'startAuthorisationWithPsuAuthentication' #TODO\n * 'startAuthorisationWithAuthentciationMethodSelection' \n * The related payment initiation cannot yet be executed since a multilevel SCA is mandated.\n * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding \n Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. \n The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded \n by using the extended forms as indicated above.\n * The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for \n executing the cancellation.\n * The signing basket needs to be authorised yet.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"authenticationMethodId":""},"success_response_body":{"challengeData":{"scaStatus":"received","authorisationId":"88695566-6642-46d5-9985-0d824624f507","psuMessage":"Please check your SMS at a mobile device.","_links":{"scaStatus":"/v1.3/payments/sepa-credit-transfers/88695566-6642-46d5-9985-0d824624f507"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"authenticationMethodId":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"challengeData":{"type":"object","properties":{"scaStatus":{"type":"string"},"authorisationId":{"type":"string"},"psuMessage":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations","connector_methods":[]},{"operation_id":"BGv1.3-getBalances","implemented_by":{"version":"BGv1.3","function":"getBalances"},"request_verb":"GET","request_url":"/berlin-group/v1.3/accounts/ACCOUNT_ID/balances","summary":"Read Balance","description":"Reads account data from a given account addressed by "account-id".
\nRemark: This account-id can be a tokenised identification due to data protection reason since the path
\ninformation might be logged on intermediary servers within the ASPSP sphere.
\nThis account-id then can be retrieved by the "GET Account List" call.
The account-id is constant at least throughout the lifecycle of a given consent.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\n","description_markdown":"Reads account data from a given account addressed by \"account-id\". \n\n**Remark:** This account-id can be a tokenised identification due to data protection reason since the path \ninformation might be logged on intermediary servers within the ASPSP sphere. \nThis account-id then can be retrieved by the \"GET Account List\" call.\n\nThe account-id is constant at least throughout the lifecycle of a given consent.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"account":{"iban":"DE91 1000 0000 0123 4567 89"},"balances":[{"balanceAmount":{"currency":"EUR","amount":"50.89"},"balanceType":"AC","lastChangeDateTime":"yyyy-MM-dd'T'HH:mm:ss.SSSZ","lastCommittedTransaction":"String","referenceDate":"2018-03-08"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"account":{"type":"object","properties":{"iban":{"type":"string"}}},"balances":{"type":"array","items":{"type":"object","properties":{"lastCommittedTransaction":{"type":"string"},"balanceAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"referenceDate":{"type":"string"},"balanceType":{"type":"string"},"lastChangeDateTime":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/accounts/ACCOUNT_ID/balances","connector_methods":[]},{"operation_id":"BGv1.3-updatePaymentCancellationPsuDataSelectPsuAuthenticationMethod","implemented_by":{"version":"BGv1.3","function":"updatePaymentCancellationPsuDataSelectPsuAuthenticationMethod"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations/AUTHORISATION_ID","summary":"Update PSU Data for payment initiation cancellation (selectPsuAuthenticationMethod)","description":"NOTE: This endpoint currently only returns example data.
\nThis method updates PSU data on the cancellation authorisation resource if needed.
\nIt may authorise a cancellation of the payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of
\nthe authentication method and a non-SCA PSU authentication.
This methods updates PSU data on the cancellation authorisation resource if needed.
\nThere are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services needed,
\nwhich depends on the SCA approach:
The SCA Approach might depend on the chosen SCA method.
\nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:
There are the following request types on this access path:
\n* Update PSU Identification
\n* Update PSU Authentication
\n* Select PSU Autorization Method
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATION_ID: AUTHORISATION_ID
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nThis method updates PSU data on the cancellation authorisation resource if needed. \nIt may authorise a cancellation of the payment within the Embedded SCA Approach where needed.\n\nIndependently from the SCA Approach it supports e.g. the selection of \nthe authentication method and a non-SCA PSU authentication.\n\nThis methods updates PSU data on the cancellation authorisation resource if needed. \n\nThere are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services needed, \nwhich depends on the SCA approach:\n\n* Redirect SCA Approach:\nA specific Update PSU Data Request is applicable for\n * the selection of authentication methods, before choosing the actual SCA approach.\n* Decoupled SCA Approach:\nA specific Update PSU Data Request is only applicable for\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or\n* the selection of authentication methods.\n* Embedded SCA Approach: \nThe Update PSU Data Request might be used\n* to add credentials as a first factor authentication data of the PSU and\n* to select the authentication method and\n* transaction authorisation.\n\nThe SCA Approach might depend on the chosen SCA method. \nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:\n\n* Select an SCA method in case of several SCA methods are available for the customer.\n\nThere are the following request types on this access path:\n* Update PSU Identification\n* Update PSU Authentication\n* Select PSU Autorization Method\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n* Transaction Authorisation\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATION_ID](/glossary#): AUTHORISATION_ID\n\n\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"authenticationMethodId":""},"success_response_body":{"scaStatus":"scaMethodSelected","chosenScaMethod":{"authenticationType":"SMS_OTP","authenticationMethodId":"myAuthenticationID"},"challengeData":{"otpMaxLength":6,"otpFormat":"integer"},"_links":{"authoriseTransaction":{"href":"/psd2/v1.3/payments/1234-wertiq-983/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"authenticationMethodId":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"chosenScaMethod":{"type":"object","properties":{"authenticationType":{"type":"string"},"authenticationMethodId":{"type":"string"}}},"challengeData":{"type":"object","properties":{"otpMaxLength":{"type":"integer"},"otpFormat":{"type":"string"}}},"_links":{"type":"object","properties":{"authoriseTransaction":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations/AUTHORISATION_ID","connector_methods":[]},{"operation_id":"BGv1.3-updatePaymentPsuDataAuthorisationConfirmation","implemented_by":{"version":"BGv1.3","function":"updatePaymentPsuDataAuthorisationConfirmation"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations/AUTHORISATION_ID","summary":"Update PSU data for payment initiation (authorisationConfirmation)","description":"NOTE: This endpoint currently only returns example data.
\nThis methods updates PSU data on the authorisation resource if needed.
\nIt may authorise a payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of
\nthe authentication method and a non-SCA PSU authentication.
There are several possible Update PSU Data requests in the context of payment initiation services needed,
\nwhich depends on the SCA approach:
The SCA Approach might depend on the chosen SCA method.
\nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:
There are the following request types on this access path:
\n* Update PSU Identification
\n* Update PSU Authentication
\n* Select PSU Autorization Method
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
NOTE: For this endpoint, for sandbox mode, the scaAuthenticationData
is fixed value: 123. To make the process work.
\nNormally the app use will get SMS/EMAIL to get the value for this process.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATION_ID: AUTHORISATION_ID
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nThis methods updates PSU data on the authorisation resource if needed. \nIt may authorise a payment within the Embedded SCA Approach where needed.\n\nIndependently from the SCA Approach it supports e.g. the selection of \nthe authentication method and a non-SCA PSU authentication.\n\nThere are several possible Update PSU Data requests in the context of payment initiation services needed, \nwhich depends on the SCA approach:\n\n* Redirect SCA Approach:\nA specific Update PSU Data Request is applicable for\n * the selection of authentication methods, before choosing the actual SCA approach.\n* Decoupled SCA Approach:\nA specific Update PSU Data Request is only applicable for\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or\n* the selection of authentication methods.\n* Embedded SCA Approach: \nThe Update PSU Data Request might be used\n* to add credentials as a first factor authentication data of the PSU and\n* to select the authentication method and\n* transaction authorisation.\n\nThe SCA Approach might depend on the chosen SCA method. \nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:\n\n* Select an SCA method in case of several SCA methods are available for the customer.\n\nThere are the following request types on this access path:\n* Update PSU Identification\n* Update PSU Authentication\n* Select PSU Autorization Method\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n* Transaction Authorisation\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n\n NOTE: For this endpoint, for sandbox mode, the `scaAuthenticationData` is fixed value: 123. To make the process work.\n Normally the app use will get SMS/EMAIL to get the value for this process.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATION_ID](/glossary#): AUTHORISATION_ID\n\n\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"confirmationCode":"confirmationCode"},"success_response_body":{"scaStatus":"finalised","_links":{"status":{"href":"/v1.3/payments/sepa-credit-transfers/qwer3456tzui7890/status"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"confirmationCode":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"_links":{"type":"object","properties":{"status":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations/AUTHORISATION_ID","connector_methods":[]},{"operation_id":"BGv1.3-startPaymentAuthorisationTransactionAuthorisation","implemented_by":{"version":"BGv1.3","function":"startPaymentAuthorisationTransactionAuthorisation"},"request_verb":"POST","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations","summary":"Start the authorisation process for a payment initiation (transactionAuthorisation)","description":"Create an authorisation sub-resource and start the authorisation process.
\nThe message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a
\ncorporate context, each creating an own authorisation sub-endpoint for
\nthe corresponding PSU authorising the transaction.
The ASPSP might make the usage of this access method unnecessary in case
\nof only one SCA process needed, since the related authorisation resource
\nmight be automatically created by the ASPSP after the submission of the
\npayment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation
\nor cancellation sub-resource.
This applies in the following scenarios:
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Create an authorisation sub-resource and start the authorisation process. \nThe message might in addition transmit authentication and authorisation related data. \n\nThis method is iterated n times for a n times SCA authorisation in a \ncorporate context, each creating an own authorisation sub-endpoint for \nthe corresponding PSU authorising the transaction.\n\nThe ASPSP might make the usage of this access method unnecessary in case \nof only one SCA process needed, since the related authorisation resource \nmight be automatically created by the ASPSP after the submission of the \npayment data with the first POST payments/{payment-product} call.\n\nThe start authorisation process is a process which is needed for creating a new authorisation \nor cancellation sub-resource. \n\nThis applies in the following scenarios:\n\n * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding Payment \n Initiation Response that an explicit start of the authorisation process is needed by the TPP. \n The 'startAuthorisation' hyperlink can transport more information about data which needs to be \n uploaded by using the extended forms.\n * 'startAuthorisationWithPsuIdentfication', \n * 'startAuthorisationWithPsuAuthentication' #TODO\n * 'startAuthorisationWithAuthentciationMethodSelection' \n * The related payment initiation cannot yet be executed since a multilevel SCA is mandated.\n * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding \n Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. \n The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded \n by using the extended forms as indicated above.\n * The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for \n executing the cancellation.\n * The signing basket needs to be authorised yet.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"scaAuthenticationData":"123"},"success_response_body":{"challengeData":{"scaStatus":"received","authorisationId":"88695566-6642-46d5-9985-0d824624f507","psuMessage":"Please check your SMS at a mobile device.","_links":{"scaStatus":"/v1.3/payments/sepa-credit-transfers/88695566-6642-46d5-9985-0d824624f507"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"scaAuthenticationData":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"challengeData":{"type":"object","properties":{"scaStatus":{"type":"string"},"authorisationId":{"type":"string"},"psuMessage":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations","connector_methods":[]},{"operation_id":"BGv1.3-startConsentAuthorisationTransactionAuthorisation","implemented_by":{"version":"BGv1.3","function":"startConsentAuthorisationTransactionAuthorisation"},"request_verb":"POST","request_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations","summary":"Start the authorisation process for a consent(transactionAuthorisation)","description":"Create an authorisation sub-resource and start the authorisation process of a consent.
\nThe message might in addition transmit authentication and authorisation related data.
\nhis method is iterated n times for a n times SCA authorisation in a corporate context,
\neach creating an own authorisation sub-endpoint for the corresponding PSU authorising the consent.
\nThe ASPSP might make the usage of this access method unnecessary, since the related authorisation
\nresource will be automatically created by the ASPSP after the submission of the consent data with the
\nfirst POST consents call. The start authorisation process is a process which is needed for creating
\na new authorisation or cancellation sub-resource.
This applies in the following scenarios: * The ASPSP has indicated with an 'startAuthorisation' hyperlink
\nin the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP.
\nThe 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using
\nthe extended forms.
\n* 'startAuthorisationWithPsuIdentfication',
\n* 'startAuthorisationWithPsuAuthentication'
\n* 'startAuthorisationWithEncryptedPsuAuthentication'
\n* 'startAuthorisationWithAuthentciationMethodSelection'
\n* The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
\n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation
\nResponse that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by
\nusing the extended forms as indicated above.
\n* The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
\n* The signing basket needs to be authorised yet.
Authentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Create an authorisation sub-resource and start the authorisation process of a consent. \nThe message might in addition transmit authentication and authorisation related data. \nhis method is iterated n times for a n times SCA authorisation in a corporate context, \neach creating an own authorisation sub-endpoint for the corresponding PSU authorising the consent. \nThe ASPSP might make the usage of this access method unnecessary, since the related authorisation\nresource will be automatically created by the ASPSP after the submission of the consent data with the \nfirst POST consents call. The start authorisation process is a process which is needed for creating \na new authorisation or cancellation sub-resource. \n\nThis applies in the following scenarios: * The ASPSP has indicated with an 'startAuthorisation' hyperlink \nin the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. \nThe 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using \nthe extended forms. \n* 'startAuthorisationWithPsuIdentfication', \n* 'startAuthorisationWithPsuAuthentication' \n* 'startAuthorisationWithEncryptedPsuAuthentication' \n* 'startAuthorisationWithAuthentciationMethodSelection' \n* The related payment initiation cannot yet be executed since a multilevel SCA is mandated. \n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation \nResponse that an explicit start of the authorisation process is needed by the TPP. \n\nThe 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by \nusing the extended forms as indicated above. \n* The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation. \n* The signing basket needs to be authorised yet.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"scaAuthenticationData":""},"success_response_body":{"scaStatus":"received","psuMessage":"Please use your BankApp for transaction Authorisation.","authorisationId":"123auth456.","_links":{"scaStatus":{"href":"/v1.3/consents/qwer3456tzui7890/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"scaAuthenticationData":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"psuMessage":{"type":"string"},"authorisationId":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations","connector_methods":[]},{"operation_id":"BGv1.3-readAccountDetails","implemented_by":{"version":"BGv1.3","function":"readAccountDetails"},"request_verb":"GET","request_url":"/berlin-group/v1.3/accounts/ACCOUNT_ID","summary":"Read Account Details","description":"Reads details about an account, with balances where required.
\nIt is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.
\nThe addressed details of this account depends then on the stored consent addressed by consentId,
\nrespectively the OAuth2 access token. NOTE: The account-id can represent a multicurrency account.
\nIn this case the currency code is set to "XXX". Give detailed information about the addressed account.
\nGive detailed information about the addressed account together with balance information
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\n","description_markdown":"Reads details about an account, with balances where required. \nIt is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. \nThe addressed details of this account depends then on the stored consent addressed by consentId, \nrespectively the OAuth2 access token. **NOTE:** The account-id can represent a multicurrency account. \nIn this case the currency code is set to \"XXX\". Give detailed information about the addressed account. \nGive detailed information about the addressed account together with balance information\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"account":{"resourceId":"3dc3d5b3-7023-4848-9853-f5400a64e80f","iban":"FR7612345987650123456789014","currency":"EUR","product":"Girokonto","cashAccountType":"CACC","name":"Main Account","_links":{"balances":{"href":"/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"},"transactions":{"href":"/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"}}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"account":{"type":"object","properties":{"product":{"type":"string"},"_links":{"type":"object","properties":{"balances":{"type":"object","properties":{"href":{"type":"string"}}},"transactions":{"type":"object","properties":{"href":{"type":"string"}}}}},"cashAccountType":{"type":"string"},"name":{"type":"string"},"iban":{"type":"string"},"resourceId":{"type":"string"},"currency":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/accounts/ACCOUNT_ID","connector_methods":[]},{"operation_id":"BGv1.3-updateConsentsPsuDataTransactionAuthorisation","implemented_by":{"version":"BGv1.3","function":"updateConsentsPsuDataTransactionAuthorisation"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations/AUTHORISATIONID","summary":"Update PSU Data for consents (transactionAuthorisation)","description":"This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded
\nSCA Approach where needed. Independently from the SCA Approach it supports
\ne.g. the selection of the authentication method and a non-SCA PSU authentication.
\nThis methods updates PSU data on the cancellation authorisation resource if needed.
\nThere are several possible Update PSU Data requests in the context of a consent request if needed,
\nwhich depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU Data Request is applicable
\nfor
\n* the selection of authentication methods, before choosing the actual SCA approach.
\n* Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request,
\nor if no OAuth2 access token is used, or
\n* the selection of authentication methods.
\n* Embedded SCA Approach: The Update PSU Data Request might be used
\n* to add credentials as a first factor authentication data of the PSU and
\n* to select the authentication method and
\n* transaction authorisation.
\nThe SCA Approach might depend on the chosen SCA method. For that reason,
\nthe following possible Update PSU Data request can apply to all SCA approaches:
\n* Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path:
\n* Update PSU Identification * Update PSU Authentication
\n* Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present.
\nMaybe in a later version the access path will change.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATIONID: AUTHORISATIONID
\nCONSENTID: CONSENTID
\nJSON response body fields:
\nscaStatus: scaStatus
\n_links: _links
\n\nauthoriseTransaction: authoriseTransaction
\nbalances: balances
\ncardAccount: cardAccount
\ncardTransactions: cardTransactions
\nconfirmation: confirmation
\ndownload: download
\nfirst: first
\nhref: href
\nlast: last
\nnext: next
\nprevious: previous
\npsuMessage: psuMessage
\npsuName: psuName
\nscaOAuth: scaOAuth
\nscaRedirect: scaRedirect
\nscaStatus: scaStatus
\nselectAuthenticationMethod: selectAuthenticationMethod
\nself: self
\nstartAuthorisation: startAuthorisation
\nstartAuthorisationWithAuthenticationMethodSelection: startAuthorisationWithAuthenticationMethodSelection
\nstartAuthorisationWithEncryptedPsuAuthentication: startAuthorisationWithEncryptedPsuAuthentication
\nstartAuthorisationWithProprietaryData: startAuthorisationWithProprietaryData
\nstartAuthorisationWithPsuAuthentication: startAuthorisationWithPsuAuthentication
\nstartAuthorisationWithPsuIdentification: startAuthorisationWithPsuIdentification
\nstartAuthorisationWithTransactionAuthorisation: startAuthorisationWithTransactionAuthorisation
\n\ntppMessage: tppMessage
\ntransactionDetails: transactionDetails
\n\ntrustedBeneficiaryFlag: trustedBeneficiaryFlag
\nupdateAdditionalEncryptedPsuAuthentication: updateAdditionalEncryptedPsuAuthentication
\nupdateAdditionalPsuAuthentication: updateAdditionalPsuAuthentication
\nupdateEncryptedPsuAuthentication: updateEncryptedPsuAuthentication
\nupdateProprietaryData: updateProprietaryData
\nupdatePsuAuthentication: updatePsuAuthentication
\nupdatePsuIdentification: updatePsuIdentification
\n","description_markdown":"This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded \nSCA Approach where needed. Independently from the SCA Approach it supports \ne.g. the selection of the authentication method and a non-SCA PSU authentication. \nThis methods updates PSU data on the cancellation authorisation resource if needed. \nThere are several possible Update PSU Data requests in the context of a consent request if needed, \nwhich depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU Data Request is applicable \nfor \n* the selection of authentication methods, before choosing the actual SCA approach. \n* Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for \n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, \nor if no OAuth2 access token is used, or \n* the selection of authentication methods. \n* Embedded SCA Approach: The Update PSU Data Request might be used \n* to add credentials as a first factor authentication data of the PSU and \n* to select the authentication method and \n* transaction authorisation. \nThe SCA Approach might depend on the chosen SCA method. For that reason, \nthe following possible Update PSU Data request can apply to all SCA approaches: \n* Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path: \n* Update PSU Identification * Update PSU Authentication \n* Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. \nMaybe in a later version the access path will change. \n* Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. \nMaybe in a later version the access path will change.\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATIONID](/glossary#): AUTHORISATIONID\n\n\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**scaStatus**](/glossary#): scaStatus\n\n\n\n[_links](/glossary#): _links\n\n\n\n[account](/glossary#Account): \n\n\n\n[authoriseTransaction](/glossary#): authoriseTransaction\n\n\n\n[balances](/glossary#): balances\n\n\n\n[cardAccount](/glossary#): cardAccount\n\n\n\n[cardTransactions](/glossary#): cardTransactions\n\n\n\n[confirmation](/glossary#): confirmation\n\n\n\n[download](/glossary#): download\n\n\n\n[first](/glossary#): first\n\n\n\n[href](/glossary#): href\n\n\n\n[last](/glossary#): last\n\n\n\n[next](/glossary#): next\n\n\n\n[previous](/glossary#): previous\n\n\n\n[psuMessage](/glossary#): psuMessage\n\n\n\n[psuName](/glossary#): psuName\n\n\n\n[scaOAuth](/glossary#): scaOAuth\n\n\n\n[scaRedirect](/glossary#): scaRedirect\n\n\n\n[**scaStatus**](/glossary#): scaStatus\n\n\n\n[selectAuthenticationMethod](/glossary#): selectAuthenticationMethod\n\n\n\n[self](/glossary#): self\n\n\n\n[startAuthorisation](/glossary#): startAuthorisation\n\n\n\n[startAuthorisationWithAuthenticationMethodSelection](/glossary#): startAuthorisationWithAuthenticationMethodSelection\n\n\n\n[startAuthorisationWithEncryptedPsuAuthentication](/glossary#): startAuthorisationWithEncryptedPsuAuthentication\n\n\n\n[startAuthorisationWithProprietaryData](/glossary#): startAuthorisationWithProprietaryData\n\n\n\n[startAuthorisationWithPsuAuthentication](/glossary#): startAuthorisationWithPsuAuthentication\n\n\n\n[startAuthorisationWithPsuIdentification](/glossary#): startAuthorisationWithPsuIdentification\n\n\n\n[startAuthorisationWithTransactionAuthorisation](/glossary#): startAuthorisationWithTransactionAuthorisation\n\n\n\n[status](/glossary#status): \n\n\n\n[tppMessage](/glossary#): tppMessage\n\n\n\n[transactionDetails](/glossary#): transactionDetails\n\n\n\n[transactions](/glossary#transactions): \n\n\n\n[trustedBeneficiaryFlag](/glossary#): trustedBeneficiaryFlag\n\n\n\n[updateAdditionalEncryptedPsuAuthentication](/glossary#): updateAdditionalEncryptedPsuAuthentication\n\n\n\n[updateAdditionalPsuAuthentication](/glossary#): updateAdditionalPsuAuthentication\n\n\n\n[updateEncryptedPsuAuthentication](/glossary#): updateEncryptedPsuAuthentication\n\n\n\n[updateProprietaryData](/glossary#): updateProprietaryData\n\n\n\n[updatePsuAuthentication](/glossary#): updatePsuAuthentication\n\n\n\n[updatePsuIdentification](/glossary#): updatePsuIdentification\n\n\n","example_request_body":{"scaAuthenticationData":"123"},"success_response_body":{"scaStatus":"received","_links":{"scaStatus":{"href":"/v1.3/consents/1234-wertiq-983/authorisations"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"scaAuthenticationData":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"scaStatus":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations/AUTHORISATIONID","connector_methods":[]},{"operation_id":"BGv1.3-startPaymentInitiationCancellationAuthorisationSelectPsuAuthenticationMethod","implemented_by":{"version":"BGv1.3","function":"startPaymentInitiationCancellationAuthorisationSelectPsuAuthenticationMethod"},"request_verb":"POST","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations","summary":"Start the authorisation process for the cancellation of the addressed payment (selectPsuAuthenticationMethod)","description":"NOTE: This endpoint currently only returns example data.
\nCreates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment.
\nThe message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a
\ncorporate context, each creating an own authorisation sub-endpoint for
\nthe corresponding PSU authorising the cancellation-authorisation.
The ASPSP might make the usage of this access method unnecessary in case
\nof only one SCA process needed, since the related authorisation resource
\nmight be automatically created by the ASPSP after the submission of the
\npayment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation
\nor cancellation sub-resource.
This applies in the following scenarios:
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nCreates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. \nThe message might in addition transmit authentication and authorisation related data.\n\nThis method is iterated n times for a n times SCA authorisation in a \ncorporate context, each creating an own authorisation sub-endpoint for \nthe corresponding PSU authorising the cancellation-authorisation.\n\nThe ASPSP might make the usage of this access method unnecessary in case \nof only one SCA process needed, since the related authorisation resource \nmight be automatically created by the ASPSP after the submission of the \npayment data with the first POST payments/{payment-product} call.\n\nThe start authorisation process is a process which is needed for creating a new authorisation \nor cancellation sub-resource. \n\nThis applies in the following scenarios:\n\n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding Payment\n Initiation Response that an explicit start of the authorisation process is needed by the TPP.\n The 'startAuthorisation' hyperlink can transport more information about data which needs to be\n uploaded by using the extended forms.\n * 'startAuthorisationWithPsuIdentfication',\n * 'startAuthorisationWithPsuAuthentication' #TODO\n * 'startAuthorisationWithAuthentciationMethodSelection'\n* The related payment initiation cannot yet be executed since a multilevel SCA is mandated.\n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding\n Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP.\n The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded\n by using the extended forms as indicated above.\n* The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for\n executing the cancellation.\n* The signing basket needs to be authorised yet.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"authenticationMethodId":""},"success_response_body":{"scaStatus":"received","authorisationId":"123auth456","psuMessage":"Please use your BankApp for transaction Authorisation.","_links":{"scaStatus":{"href":"/v1.3/payments/qwer3456tzui7890/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"authenticationMethodId":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"authorisationId":{"type":"string"},"psuMessage":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations","connector_methods":[]},{"operation_id":"BGv1.3-getConsentStatus","implemented_by":{"version":"BGv1.3","function":"getConsentStatus"},"request_verb":"GET","request_url":"/berlin-group/v1.3/consents/CONSENTID/status","summary":"Consent status request","description":"Read the status of an account information consent resource.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"Read the status of an account information consent resource.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"consentStatus":"received"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"consentStatus":{"type":"string"}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID/status","connector_methods":[]},{"operation_id":"BGv1.3-updatePaymentPsuDataUpdatePsuAuthentication","implemented_by":{"version":"BGv1.3","function":"updatePaymentPsuDataUpdatePsuAuthentication"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations/AUTHORISATION_ID","summary":"Update PSU data for payment initiation (updatePsuAuthentication)","description":"NOTE: This endpoint currently only returns example data.
\nThis methods updates PSU data on the authorisation resource if needed.
\nIt may authorise a payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of
\nthe authentication method and a non-SCA PSU authentication.
There are several possible Update PSU Data requests in the context of payment initiation services needed,
\nwhich depends on the SCA approach:
The SCA Approach might depend on the chosen SCA method.
\nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:
There are the following request types on this access path:
\n* Update PSU Identification
\n* Update PSU Authentication
\n* Select PSU Autorization Method
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
NOTE: For this endpoint, for sandbox mode, the scaAuthenticationData
is fixed value: 123. To make the process work.
\nNormally the app use will get SMS/EMAIL to get the value for this process.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATION_ID: AUTHORISATION_ID
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nThis methods updates PSU data on the authorisation resource if needed. \nIt may authorise a payment within the Embedded SCA Approach where needed.\n\nIndependently from the SCA Approach it supports e.g. the selection of \nthe authentication method and a non-SCA PSU authentication.\n\nThere are several possible Update PSU Data requests in the context of payment initiation services needed, \nwhich depends on the SCA approach:\n\n* Redirect SCA Approach:\nA specific Update PSU Data Request is applicable for\n * the selection of authentication methods, before choosing the actual SCA approach.\n* Decoupled SCA Approach:\nA specific Update PSU Data Request is only applicable for\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or\n* the selection of authentication methods.\n* Embedded SCA Approach: \nThe Update PSU Data Request might be used\n* to add credentials as a first factor authentication data of the PSU and\n* to select the authentication method and\n* transaction authorisation.\n\nThe SCA Approach might depend on the chosen SCA method. \nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:\n\n* Select an SCA method in case of several SCA methods are available for the customer.\n\nThere are the following request types on this access path:\n* Update PSU Identification\n* Update PSU Authentication\n* Select PSU Autorization Method\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n* Transaction Authorisation\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n\n NOTE: For this endpoint, for sandbox mode, the `scaAuthenticationData` is fixed value: 123. To make the process work.\n Normally the app use will get SMS/EMAIL to get the value for this process.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATION_ID](/glossary#): AUTHORISATION_ID\n\n\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"psuData":{"password":"start12"}},"success_response_body":{"scaStatus":"finalised","_links":{"scaStatus":{"href":"/v1.3/payments/sepa-credit-transfers/88695566-6642-46d5-9985-0d824624f507"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"psuData":{"type":"object","properties":{"password":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations/AUTHORISATION_ID","connector_methods":[]},{"operation_id":"BGv1.3-getPaymentInitiationStatus","implemented_by":{"version":"BGv1.3","function":"getPaymentInitiationStatus"},"request_verb":"GET","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/status","summary":"Payment initiation status request","description":"Check the transaction status of a payment initiation.
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"Check the transaction status of a payment initiation.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transactionStatus":"ACCP"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"transactionStatus":{"type":"string"}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/status","connector_methods":[]},{"operation_id":"BGv1.3-updatePaymentPsuDataTransactionAuthorisation","implemented_by":{"version":"BGv1.3","function":"updatePaymentPsuDataTransactionAuthorisation"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations/AUTHORISATION_ID","summary":"Update PSU data for payment initiation (transactionAuthorisation)","description":"This methods updates PSU data on the authorisation resource if needed.
\nIt may authorise a payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of
\nthe authentication method and a non-SCA PSU authentication.
There are several possible Update PSU Data requests in the context of payment initiation services needed,
\nwhich depends on the SCA approach:
The SCA Approach might depend on the chosen SCA method.
\nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:
There are the following request types on this access path:
\n* Update PSU Identification
\n* Update PSU Authentication
\n* Select PSU Autorization Method
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
NOTE: For this endpoint, for sandbox mode, the scaAuthenticationData
is fixed value: 123. To make the process work.
\nNormally the app use will get SMS/EMAIL to get the value for this process.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATION_ID: AUTHORISATION_ID
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"This methods updates PSU data on the authorisation resource if needed. \nIt may authorise a payment within the Embedded SCA Approach where needed.\n\nIndependently from the SCA Approach it supports e.g. the selection of \nthe authentication method and a non-SCA PSU authentication.\n\nThere are several possible Update PSU Data requests in the context of payment initiation services needed, \nwhich depends on the SCA approach:\n\n* Redirect SCA Approach:\nA specific Update PSU Data Request is applicable for\n * the selection of authentication methods, before choosing the actual SCA approach.\n* Decoupled SCA Approach:\nA specific Update PSU Data Request is only applicable for\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or\n* the selection of authentication methods.\n* Embedded SCA Approach: \nThe Update PSU Data Request might be used\n* to add credentials as a first factor authentication data of the PSU and\n* to select the authentication method and\n* transaction authorisation.\n\nThe SCA Approach might depend on the chosen SCA method. \nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:\n\n* Select an SCA method in case of several SCA methods are available for the customer.\n\nThere are the following request types on this access path:\n* Update PSU Identification\n* Update PSU Authentication\n* Select PSU Autorization Method\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n* Transaction Authorisation\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n\n NOTE: For this endpoint, for sandbox mode, the `scaAuthenticationData` is fixed value: 123. To make the process work.\n Normally the app use will get SMS/EMAIL to get the value for this process.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATION_ID](/glossary#): AUTHORISATION_ID\n\n\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"scaAuthenticationData":"123"},"success_response_body":{"scaStatus":"finalised","psuMessage":"Please check your SMS at a mobile device.","_links":{"scaStatus":{"href":"/v1.3/payments/sepa-credit-transfers/88695566-6642-46d5-9985-0d824624f507"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"scaAuthenticationData":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"psuMessage":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations/AUTHORISATION_ID","connector_methods":[]},{"operation_id":"BGv1.3-checkAvailabilityOfFunds","implemented_by":{"version":"BGv1.3","function":"checkAvailabilityOfFunds"},"request_verb":"POST","request_url":"/berlin-group/v1.3/funds-confirmations","summary":"Confirmation of Funds Request","description":"Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point
\nof time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by
\nIBAN and TPP respectively. If the related extended services are used a conditional Consent-ID is contained
\nin the header. This field is contained but commented out in this specification.
Authentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point\nof time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by \nIBAN and TPP respectively. If the related extended services are used a conditional Consent-ID is contained \nin the header. This field is contained but commented out in this specification. \n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"instructedAmount":{"amount":"123","currency":"EUR"},"account":{"iban":"GR12 1234 5123 4511 3981 4475 477"}},"success_response_body":{"fundsAvailable":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Confirmation of Funds Service (PIIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"account":{"type":"object","properties":{"iban":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"fundsAvailable":{"type":"boolean"}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/funds-confirmations","connector_methods":[]},{"operation_id":"BGv1.3-getPaymentCancellationScaStatus","implemented_by":{"version":"BGv1.3","function":"getPaymentCancellationScaStatus"},"request_verb":"GET","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID/cancellation-authorisations/CANCELLATIONID","summary":"Read the SCA status of the payment cancellation's authorisation","description":"This method returns the SCA status of a payment initiation's authorisation sub-resource.
\nAuthentication is Mandatory
\nURL Parameters:
\nCANCELLATIONID: CANCELLATIONID
\nPAYMENTID: PAYMENTID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"This method returns the SCA status of a payment initiation's authorisation sub-resource.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CANCELLATIONID](/glossary#): CANCELLATIONID\n\n\n\n[PAYMENTID](/glossary#): PAYMENTID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"scaStatus":"psuAuthenticated"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID/cancellation-authorisations/CANCELLATIONID","connector_methods":[]},{"operation_id":"BGv1.3-updatePaymentPsuDataSelectPsuAuthenticationMethod","implemented_by":{"version":"BGv1.3","function":"updatePaymentPsuDataSelectPsuAuthenticationMethod"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations/AUTHORISATION_ID","summary":"Update PSU data for payment initiation (selectPsuAuthenticationMethod)","description":"NOTE: This endpoint currently only returns example data.
\nThis methods updates PSU data on the authorisation resource if needed.
\nIt may authorise a payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of
\nthe authentication method and a non-SCA PSU authentication.
There are several possible Update PSU Data requests in the context of payment initiation services needed,
\nwhich depends on the SCA approach:
The SCA Approach might depend on the chosen SCA method.
\nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:
There are the following request types on this access path:
\n* Update PSU Identification
\n* Update PSU Authentication
\n* Select PSU Autorization Method
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
NOTE: For this endpoint, for sandbox mode, the scaAuthenticationData
is fixed value: 123. To make the process work.
\nNormally the app use will get SMS/EMAIL to get the value for this process.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATION_ID: AUTHORISATION_ID
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nThis methods updates PSU data on the authorisation resource if needed. \nIt may authorise a payment within the Embedded SCA Approach where needed.\n\nIndependently from the SCA Approach it supports e.g. the selection of \nthe authentication method and a non-SCA PSU authentication.\n\nThere are several possible Update PSU Data requests in the context of payment initiation services needed, \nwhich depends on the SCA approach:\n\n* Redirect SCA Approach:\nA specific Update PSU Data Request is applicable for\n * the selection of authentication methods, before choosing the actual SCA approach.\n* Decoupled SCA Approach:\nA specific Update PSU Data Request is only applicable for\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or\n* the selection of authentication methods.\n* Embedded SCA Approach: \nThe Update PSU Data Request might be used\n* to add credentials as a first factor authentication data of the PSU and\n* to select the authentication method and\n* transaction authorisation.\n\nThe SCA Approach might depend on the chosen SCA method. \nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:\n\n* Select an SCA method in case of several SCA methods are available for the customer.\n\nThere are the following request types on this access path:\n* Update PSU Identification\n* Update PSU Authentication\n* Select PSU Autorization Method\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n* Transaction Authorisation\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n\n NOTE: For this endpoint, for sandbox mode, the `scaAuthenticationData` is fixed value: 123. To make the process work.\n Normally the app use will get SMS/EMAIL to get the value for this process.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATION_ID](/glossary#): AUTHORISATION_ID\n\n\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"authenticationMethodId":""},"success_response_body":{"scaStatus":"scaMethodSelected","chosenScaMethod":{"authenticationType":"SMS_OTP","authenticationMethodId":"myAuthenticationID"},"challengeData":{"otpMaxLength":6,"otpFormat":"integer"},"_links":{"authoriseTransaction":{"href":"/psd2/v1.3/payments/1234-wertiq-983/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"authenticationMethodId":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"chosenScaMethod":{"type":"object","properties":{"authenticationType":{"type":"string"},"authenticationMethodId":{"type":"string"}}},"challengeData":{"type":"object","properties":{"otpMaxLength":{"type":"integer"},"otpFormat":{"type":"string"}}},"_links":{"type":"object","properties":{"authoriseTransaction":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations/AUTHORISATION_ID","connector_methods":[]},{"operation_id":"BGv1.3-updateConsentsPsuDataUpdateAuthorisationConfirmation","implemented_by":{"version":"BGv1.3","function":"updateConsentsPsuDataUpdateAuthorisationConfirmation"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations/AUTHORISATIONID","summary":"Update PSU Data for consents (authorisationConfirmation)","description":"This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded
\nSCA Approach where needed. Independently from the SCA Approach it supports
\ne.g. the selection of the authentication method and a non-SCA PSU authentication.
\nThis methods updates PSU data on the cancellation authorisation resource if needed.
\nThere are several possible Update PSU Data requests in the context of a consent request if needed,
\nwhich depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU Data Request is applicable
\nfor
\n* the selection of authentication methods, before choosing the actual SCA approach.
\n* Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request,
\nor if no OAuth2 access token is used, or
\n* the selection of authentication methods.
\n* Embedded SCA Approach: The Update PSU Data Request might be used
\n* to add credentials as a first factor authentication data of the PSU and
\n* to select the authentication method and
\n* transaction authorisation.
\nThe SCA Approach might depend on the chosen SCA method. For that reason,
\nthe following possible Update PSU Data request can apply to all SCA approaches:
\n* Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path:
\n* Update PSU Identification * Update PSU Authentication
\n* Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present.
\nMaybe in a later version the access path will change.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATIONID: AUTHORISATIONID
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded \nSCA Approach where needed. Independently from the SCA Approach it supports \ne.g. the selection of the authentication method and a non-SCA PSU authentication. \nThis methods updates PSU data on the cancellation authorisation resource if needed. \nThere are several possible Update PSU Data requests in the context of a consent request if needed, \nwhich depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU Data Request is applicable \nfor \n* the selection of authentication methods, before choosing the actual SCA approach. \n* Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for \n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, \nor if no OAuth2 access token is used, or \n* the selection of authentication methods. \n* Embedded SCA Approach: The Update PSU Data Request might be used \n* to add credentials as a first factor authentication data of the PSU and \n* to select the authentication method and \n* transaction authorisation. \nThe SCA Approach might depend on the chosen SCA method. For that reason, \nthe following possible Update PSU Data request can apply to all SCA approaches: \n* Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path: \n* Update PSU Identification * Update PSU Authentication \n* Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. \nMaybe in a later version the access path will change. \n* Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. \nMaybe in a later version the access path will change.\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATIONID](/glossary#): AUTHORISATIONID\n\n\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"confirmationCode":"confirmationCode"},"success_response_body":{"scaStatus":"finalised","_links":{"status":{"href":"/v1/payments/sepa-credit-transfers/qwer3456tzui7890/status"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"confirmationCode":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"_links":{"type":"object","properties":{"status":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations/AUTHORISATIONID","connector_methods":[]},{"operation_id":"BGv1.3-initiateBulkPayments","implemented_by":{"version":"BGv1.3","function":"initiateBulkPayments"},"request_verb":"POST","request_url":"/berlin-group/v1.3/bulk-payments/PAYMENT_PRODUCT","summary":"Payment initiation request(bulk-payments)","description":"This method is used to initiate a payment at the ASPSP.
\n## Variants of Payment Initiation Requests
\nThis method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.
\nThere are the following payment products:
\nFurthermore the request body depends on the payment-service
\nThis is the first step in the API to initiate the related recurring/periodic payment.
\n## Single and mulitilevel SCA Processes
\nThe Payment Initiation Requests are independent from the need of one ore multilevel
\nSCA processing, i.e. independent from the number of authorisations needed for the execution of payments.
But the response messages are specific to either one SCA processing or multilevel SCA processing.
\nFor payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation,
\ni.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the
\nresponse message of a Payment Initation Request for a payment, where multiple authorisations are needed.
\nAlso if any data is needed for the next action, like selecting an SCA method is not supported in the response,
\nsince all starts of the multiple authorisations are fully equal.
\nIn these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.
Additional Instructions:
\nfor PAYMENT_SERVICE use payments
\nfor PAYMENT_PRODUCT use sepa-credit-transfers
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"This method is used to initiate a payment at the ASPSP.\n\n ## Variants of Payment Initiation Requests\n\n This method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.\n\n There are the following **payment products**:\n\n - Payment products with payment information in *JSON* format:\n - ***sepa-credit-transfers***\n - ***instant-sepa-credit-transfers***\n - ***target-2-payments***\n - ***cross-border-credit-transfers***\n - Payment products with payment information in *pain.001* XML format:\n - ***pain.001-sepa-credit-transfers***\n - ***pain.001-instant-sepa-credit-transfers***\n - ***pain.001-target-2-payments***\n - ***pain.001-cross-border-credit-transfers***\n\n - Furthermore the request body depends on the **payment-service**\n - ***payments***: A single payment initiation request.\n - ***bulk-payments***: A collection of several payment iniatiation requests.\n In case of a *pain.001* message there are more than one payments contained in the *pain.001 message.\n In case of a *JSON* there are several JSON payment blocks contained in a joining list.\n - ***periodic-payments***:\n Create a standing order initiation resource for recurrent i.e. periodic payments addressable under {paymentId}\n with all data relevant for the corresponding payment product and the execution of the standing order contained in a JSON body.\n\n This is the first step in the API to initiate the related recurring/periodic payment.\n\n ## Single and mulitilevel SCA Processes\n\n The Payment Initiation Requests are independent from the need of one ore multilevel\n SCA processing, i.e. independent from the number of authorisations needed for the execution of payments.\n\n But the response messages are specific to either one SCA processing or multilevel SCA processing.\n\n For payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation,\n i.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the\n response message of a Payment Initation Request for a payment, where multiple authorisations are needed.\n Also if any data is needed for the next action, like selecting an SCA method is not supported in the response,\n since all starts of the multiple authorisations are fully equal.\n In these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.\n\n\n \nAdditional Instructions:\n\nfor PAYMENT_SERVICE use payments\n\nfor PAYMENT_PRODUCT use sepa-credit-transfers\n\n \n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"batchBookingPreferred":"true","debtorAccount":{"iban":"DE40100100103307118608"},"paymentInformationId":"my-bulk-identification-1234","requestedExecutionDate":"2018-08-01","payments":[{"instructedAmount":{"currency":"EUR","amount":"123.50"},"creditorName":"Merchant123","creditorAccount":{"iban":"DE02100100109307118603"},"remittanceInformationUnstructured":"Ref Number Merchant 1"},{"instructedAmount":{"currency":"EUR","amount":"34.10"},"creditorName":"Merchant456","creditorAccount":{"iban":"FR7612345987650123456789014"},"remittanceInformationUnstructured":"Ref Number Merchant 2"}]},"success_response_body":{"transactionStatus":"RCVD","paymentId":"1234-wertiq-983","_links":{"scaRedirect":{"href":"https://apisandbox.openbankproject.com/otp?flow=payment&paymentService=payments&paymentProduct=sepa_credit_transfers&paymentId=b0472c21-6cea-4ee0-b036-3e253adb3b0b"},"self":{"href":"/v1.3/bulk-payments/sepa-credit-transfers/1234-wertiq-983"},"status":{"href":"/v1.3/bulk-payments/1234-wertiq-983/status"},"scaStatus":{"href":"/v1.3/bulk-payments/1234-wertiq-983/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"requestedExecutionDate":{"type":"string"},"batchBookingPreferred":{"type":"string"},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"payments":{"type":"array","items":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"creditorName":{"type":"string"},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"remittanceInformationUnstructured":{"type":"string"}}}},"paymentInformationId":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"transactionStatus":{"type":"string"},"paymentId":{"type":"string"},"_links":{"type":"object","properties":{"scaRedirect":{"type":"object","properties":{"href":{"type":"string"}}},"self":{"type":"object","properties":{"href":{"type":"string"}}},"status":{"type":"object","properties":{"href":{"type":"string"}}},"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/bulk-payments/PAYMENT_PRODUCT","connector_methods":[]},{"operation_id":"BGv1.3-updatePaymentCancellationPsuDataAuthorisationConfirmation","implemented_by":{"version":"BGv1.3","function":"updatePaymentCancellationPsuDataAuthorisationConfirmation"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations/AUTHORISATION_ID","summary":"Update PSU Data for payment initiation cancellation (authorisationConfirmation)","description":"NOTE: This endpoint currently only returns example data.
\nThis method updates PSU data on the cancellation authorisation resource if needed.
\nIt may authorise a cancellation of the payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of
\nthe authentication method and a non-SCA PSU authentication.
This methods updates PSU data on the cancellation authorisation resource if needed.
\nThere are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services needed,
\nwhich depends on the SCA approach:
The SCA Approach might depend on the chosen SCA method.
\nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:
There are the following request types on this access path:
\n* Update PSU Identification
\n* Update PSU Authentication
\n* Select PSU Autorization Method
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATION_ID: AUTHORISATION_ID
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nThis method updates PSU data on the cancellation authorisation resource if needed. \nIt may authorise a cancellation of the payment within the Embedded SCA Approach where needed.\n\nIndependently from the SCA Approach it supports e.g. the selection of \nthe authentication method and a non-SCA PSU authentication.\n\nThis methods updates PSU data on the cancellation authorisation resource if needed. \n\nThere are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services needed, \nwhich depends on the SCA approach:\n\n* Redirect SCA Approach:\nA specific Update PSU Data Request is applicable for\n * the selection of authentication methods, before choosing the actual SCA approach.\n* Decoupled SCA Approach:\nA specific Update PSU Data Request is only applicable for\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or\n* the selection of authentication methods.\n* Embedded SCA Approach: \nThe Update PSU Data Request might be used\n* to add credentials as a first factor authentication data of the PSU and\n* to select the authentication method and\n* transaction authorisation.\n\nThe SCA Approach might depend on the chosen SCA method. \nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:\n\n* Select an SCA method in case of several SCA methods are available for the customer.\n\nThere are the following request types on this access path:\n* Update PSU Identification\n* Update PSU Authentication\n* Select PSU Autorization Method\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n* Transaction Authorisation\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATION_ID](/glossary#): AUTHORISATION_ID\n\n\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"confirmationCode":"confirmationCode"},"success_response_body":{"scaStatus":"finalised","_links":{"status":{"href":"/v1.3/payments/sepa-credit-transfers/qwer3456tzui7890/status"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"confirmationCode":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"_links":{"type":"object","properties":{"status":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations/AUTHORISATION_ID","connector_methods":[]},{"operation_id":"BGv1.3-startPaymentInitiationCancellationAuthorisationUpdatePsuAuthentication","implemented_by":{"version":"BGv1.3","function":"startPaymentInitiationCancellationAuthorisationUpdatePsuAuthentication"},"request_verb":"POST","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations","summary":"Start the authorisation process for the cancellation of the addressed payment (updatePsuAuthentication)","description":"NOTE: This endpoint currently only returns example data.
\nCreates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment.
\nThe message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a
\ncorporate context, each creating an own authorisation sub-endpoint for
\nthe corresponding PSU authorising the cancellation-authorisation.
The ASPSP might make the usage of this access method unnecessary in case
\nof only one SCA process needed, since the related authorisation resource
\nmight be automatically created by the ASPSP after the submission of the
\npayment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation
\nor cancellation sub-resource.
This applies in the following scenarios:
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nCreates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. \nThe message might in addition transmit authentication and authorisation related data.\n\nThis method is iterated n times for a n times SCA authorisation in a \ncorporate context, each creating an own authorisation sub-endpoint for \nthe corresponding PSU authorising the cancellation-authorisation.\n\nThe ASPSP might make the usage of this access method unnecessary in case \nof only one SCA process needed, since the related authorisation resource \nmight be automatically created by the ASPSP after the submission of the \npayment data with the first POST payments/{payment-product} call.\n\nThe start authorisation process is a process which is needed for creating a new authorisation \nor cancellation sub-resource. \n\nThis applies in the following scenarios:\n\n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding Payment\n Initiation Response that an explicit start of the authorisation process is needed by the TPP.\n The 'startAuthorisation' hyperlink can transport more information about data which needs to be\n uploaded by using the extended forms.\n * 'startAuthorisationWithPsuIdentfication',\n * 'startAuthorisationWithPsuAuthentication' #TODO\n * 'startAuthorisationWithAuthentciationMethodSelection'\n* The related payment initiation cannot yet be executed since a multilevel SCA is mandated.\n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding\n Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP.\n The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded\n by using the extended forms as indicated above.\n* The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for\n executing the cancellation.\n* The signing basket needs to be authorised yet.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"psuData":{"password":"start12"}},"success_response_body":{"scaStatus":"received","authorisationId":"123auth456","psuMessage":"Please use your BankApp for transaction Authorisation.","_links":{"scaStatus":{"href":"/v1.3/payments/qwer3456tzui7890/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"psuData":{"type":"object","properties":{"password":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"authorisationId":{"type":"string"},"psuMessage":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations","connector_methods":[]},{"operation_id":"BGv1.3-startConsentAuthorisationUpdatePsuAuthentication","implemented_by":{"version":"BGv1.3","function":"startConsentAuthorisationUpdatePsuAuthentication"},"request_verb":"POST","request_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations","summary":"Start the authorisation process for a consent(updatePsuAuthentication)","description":"Create an authorisation sub-resource and start the authorisation process of a consent.
\nThe message might in addition transmit authentication and authorisation related data.
\nhis method is iterated n times for a n times SCA authorisation in a corporate context,
\neach creating an own authorisation sub-endpoint for the corresponding PSU authorising the consent.
\nThe ASPSP might make the usage of this access method unnecessary, since the related authorisation
\nresource will be automatically created by the ASPSP after the submission of the consent data with the
\nfirst POST consents call. The start authorisation process is a process which is needed for creating
\na new authorisation or cancellation sub-resource.
This applies in the following scenarios: * The ASPSP has indicated with an 'startAuthorisation' hyperlink
\nin the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP.
\nThe 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using
\nthe extended forms.
\n* 'startAuthorisationWithPsuIdentfication',
\n* 'startAuthorisationWithPsuAuthentication'
\n* 'startAuthorisationWithEncryptedPsuAuthentication'
\n* 'startAuthorisationWithAuthentciationMethodSelection'
\n* The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
\n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation
\nResponse that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by
\nusing the extended forms as indicated above.
\n* The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
\n* The signing basket needs to be authorised yet.
Authentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Create an authorisation sub-resource and start the authorisation process of a consent. \nThe message might in addition transmit authentication and authorisation related data. \nhis method is iterated n times for a n times SCA authorisation in a corporate context, \neach creating an own authorisation sub-endpoint for the corresponding PSU authorising the consent. \nThe ASPSP might make the usage of this access method unnecessary, since the related authorisation\nresource will be automatically created by the ASPSP after the submission of the consent data with the \nfirst POST consents call. The start authorisation process is a process which is needed for creating \na new authorisation or cancellation sub-resource. \n\nThis applies in the following scenarios: * The ASPSP has indicated with an 'startAuthorisation' hyperlink \nin the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. \nThe 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using \nthe extended forms. \n* 'startAuthorisationWithPsuIdentfication', \n* 'startAuthorisationWithPsuAuthentication' \n* 'startAuthorisationWithEncryptedPsuAuthentication' \n* 'startAuthorisationWithAuthentciationMethodSelection' \n* The related payment initiation cannot yet be executed since a multilevel SCA is mandated. \n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation \nResponse that an explicit start of the authorisation process is needed by the TPP. \n\nThe 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by \nusing the extended forms as indicated above. \n* The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation. \n* The signing basket needs to be authorised yet.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"psuData":{"password":"start12"}},"success_response_body":{"scaStatus":"received","psuMessage":"Please use your BankApp for transaction Authorisation.","authorisationId":"123auth456.","_links":{"scaStatus":{"href":"/v1.3/consents/qwer3456tzui7890/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"psuData":{"type":"object","properties":{"password":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"psuMessage":{"type":"string"},"authorisationId":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations","connector_methods":[]},{"operation_id":"BGv1.3-updatePaymentCancellationPsuDataUpdatePsuAuthentication","implemented_by":{"version":"BGv1.3","function":"updatePaymentCancellationPsuDataUpdatePsuAuthentication"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations/AUTHORISATION_ID","summary":"Update PSU Data for payment initiation cancellation (updatePsuAuthentication)","description":"NOTE: This endpoint currently only returns example data.
\nThis method updates PSU data on the cancellation authorisation resource if needed.
\nIt may authorise a cancellation of the payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of
\nthe authentication method and a non-SCA PSU authentication.
This methods updates PSU data on the cancellation authorisation resource if needed.
\nThere are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services needed,
\nwhich depends on the SCA approach:
The SCA Approach might depend on the chosen SCA method.
\nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:
There are the following request types on this access path:
\n* Update PSU Identification
\n* Update PSU Authentication
\n* Select PSU Autorization Method
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation
\nWARNING: This method need a reduced header,
\ntherefore many optional elements are not present.
\nMaybe in a later version the access path will change.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATION_ID: AUTHORISATION_ID
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nThis method updates PSU data on the cancellation authorisation resource if needed. \nIt may authorise a cancellation of the payment within the Embedded SCA Approach where needed.\n\nIndependently from the SCA Approach it supports e.g. the selection of \nthe authentication method and a non-SCA PSU authentication.\n\nThis methods updates PSU data on the cancellation authorisation resource if needed. \n\nThere are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services needed, \nwhich depends on the SCA approach:\n\n* Redirect SCA Approach:\nA specific Update PSU Data Request is applicable for\n * the selection of authentication methods, before choosing the actual SCA approach.\n* Decoupled SCA Approach:\nA specific Update PSU Data Request is only applicable for\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or\n* the selection of authentication methods.\n* Embedded SCA Approach: \nThe Update PSU Data Request might be used\n* to add credentials as a first factor authentication data of the PSU and\n* to select the authentication method and\n* transaction authorisation.\n\nThe SCA Approach might depend on the chosen SCA method. \nFor that reason, the following possible Update PSU Data request can apply to all SCA approaches:\n\n* Select an SCA method in case of several SCA methods are available for the customer.\n\nThere are the following request types on this access path:\n* Update PSU Identification\n* Update PSU Authentication\n* Select PSU Autorization Method\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n* Transaction Authorisation\n WARNING: This method need a reduced header,\n therefore many optional elements are not present.\n Maybe in a later version the access path will change.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATION_ID](/glossary#): AUTHORISATION_ID\n\n\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"psuData":{"password":"start12"}},"success_response_body":{"scaStatus":"psuAuthenticated","_links":{"authoriseTransaction":{"href":"/psd2/v1.3/payments/1234-wertiq-983/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"psuData":{"type":"object","properties":{"password":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"_links":{"type":"object","properties":{"authoriseTransaction":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations/AUTHORISATION_ID","connector_methods":[]},{"operation_id":"BGv1.3-updateConsentsPsuDataUpdateSelectPsuAuthenticationMethod","implemented_by":{"version":"BGv1.3","function":"updateConsentsPsuDataUpdateSelectPsuAuthenticationMethod"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations/AUTHORISATIONID","summary":"Update PSU Data for consents (selectPsuAuthenticationMethod)","description":"This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded
\nSCA Approach where needed. Independently from the SCA Approach it supports
\ne.g. the selection of the authentication method and a non-SCA PSU authentication.
\nThis methods updates PSU data on the cancellation authorisation resource if needed.
\nThere are several possible Update PSU Data requests in the context of a consent request if needed,
\nwhich depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU Data Request is applicable
\nfor
\n* the selection of authentication methods, before choosing the actual SCA approach.
\n* Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request,
\nor if no OAuth2 access token is used, or
\n* the selection of authentication methods.
\n* Embedded SCA Approach: The Update PSU Data Request might be used
\n* to add credentials as a first factor authentication data of the PSU and
\n* to select the authentication method and
\n* transaction authorisation.
\nThe SCA Approach might depend on the chosen SCA method. For that reason,
\nthe following possible Update PSU Data request can apply to all SCA approaches:
\n* Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path:
\n* Update PSU Identification * Update PSU Authentication
\n* Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present.
\nMaybe in a later version the access path will change.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATIONID: AUTHORISATIONID
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded \nSCA Approach where needed. Independently from the SCA Approach it supports \ne.g. the selection of the authentication method and a non-SCA PSU authentication. \nThis methods updates PSU data on the cancellation authorisation resource if needed. \nThere are several possible Update PSU Data requests in the context of a consent request if needed, \nwhich depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU Data Request is applicable \nfor \n* the selection of authentication methods, before choosing the actual SCA approach. \n* Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for \n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, \nor if no OAuth2 access token is used, or \n* the selection of authentication methods. \n* Embedded SCA Approach: The Update PSU Data Request might be used \n* to add credentials as a first factor authentication data of the PSU and \n* to select the authentication method and \n* transaction authorisation. \nThe SCA Approach might depend on the chosen SCA method. For that reason, \nthe following possible Update PSU Data request can apply to all SCA approaches: \n* Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path: \n* Update PSU Identification * Update PSU Authentication \n* Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. \nMaybe in a later version the access path will change. \n* Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. \nMaybe in a later version the access path will change.\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATIONID](/glossary#): AUTHORISATIONID\n\n\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"authenticationMethodId":"myAuthenticationID"},"success_response_body":{"scaStatus":"scaMethodSelected","chosenScaMethod":{"authenticationType":"SMS_OTP","authenticationMethodId":"myAuthenticationID"},"challengeData":{"otpMaxLength":6,"otpFormat":"integer"},"_links":{"authoriseTransaction":{"href":"/psd2/v1/payments/1234-wertiq-983/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"authenticationMethodId":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"chosenScaMethod":{"type":"object","properties":{"authenticationType":{"type":"string"},"authenticationMethodId":{"type":"string"}}},"challengeData":{"type":"object","properties":{"otpMaxLength":{"type":"integer"},"otpFormat":{"type":"string"}}},"_links":{"type":"object","properties":{"authoriseTransaction":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations/AUTHORISATIONID","connector_methods":[]},{"operation_id":"BGv1.3-getPaymentInformation","implemented_by":{"version":"BGv1.3","function":"getPaymentInformation"},"request_verb":"GET","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID","summary":"Get Payment Information","description":"Returns the content of a payment object
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENTID: PAYMENTID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"Returns the content of a payment object\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENTID](/glossary#): PAYMENTID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"debtorAccount":{"iban":"GR12 1234 5123 4511 3981 4475 477"},"instructedAmount":{"currency":"EUR","amount":"1234"},"creditorAccount":{"iban":"GR12 1234 5123 4514 4575 3645 077"},"creditorName":"70charname"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID","connector_methods":[]},{"operation_id":"BGv1.3-getPaymentInitiationScaStatus","implemented_by":{"version":"BGv1.3","function":"getPaymentInitiationScaStatus"},"request_verb":"GET","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations/AUTHORISATION_ID","summary":"Read the SCA Status of the payment authorisation","description":"This method returns the SCA status of a payment initiation's authorisation sub-resource.
\nAuthentication is Mandatory
\nURL Parameters:
\nAUTHORISATION_ID: AUTHORISATION_ID
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON response body fields:
\n","description_markdown":"This method returns the SCA status of a payment initiation's authorisation sub-resource.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATION_ID](/glossary#): AUTHORISATION_ID\n\n\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"scaStatus":"psuAuthenticated"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations/AUTHORISATION_ID","connector_methods":[]},{"operation_id":"BGv1.3-updateConsentsPsuDataUpdatePsuAuthentication","implemented_by":{"version":"BGv1.3","function":"updateConsentsPsuDataUpdatePsuAuthentication"},"request_verb":"PUT","request_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations/AUTHORISATIONID","summary":"Update PSU Data for consents (updatePsuAuthentication)","description":"This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded
\nSCA Approach where needed. Independently from the SCA Approach it supports
\ne.g. the selection of the authentication method and a non-SCA PSU authentication.
\nThis methods updates PSU data on the cancellation authorisation resource if needed.
\nThere are several possible Update PSU Data requests in the context of a consent request if needed,
\nwhich depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU Data Request is applicable
\nfor
\n* the selection of authentication methods, before choosing the actual SCA approach.
\n* Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
\n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request,
\nor if no OAuth2 access token is used, or
\n* the selection of authentication methods.
\n* Embedded SCA Approach: The Update PSU Data Request might be used
\n* to add credentials as a first factor authentication data of the PSU and
\n* to select the authentication method and
\n* transaction authorisation.
\nThe SCA Approach might depend on the chosen SCA method. For that reason,
\nthe following possible Update PSU Data request can apply to all SCA approaches:
\n* Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path:
\n* Update PSU Identification * Update PSU Authentication
\n* Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present.
\nMaybe in a later version the access path will change.
\n* Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present.
\nMaybe in a later version the access path will change.
Authentication is Mandatory
\nURL Parameters:
\nAUTHORISATIONID: AUTHORISATIONID
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded \nSCA Approach where needed. Independently from the SCA Approach it supports \ne.g. the selection of the authentication method and a non-SCA PSU authentication. \nThis methods updates PSU data on the cancellation authorisation resource if needed. \nThere are several possible Update PSU Data requests in the context of a consent request if needed, \nwhich depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU Data Request is applicable \nfor \n* the selection of authentication methods, before choosing the actual SCA approach. \n* Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for \n* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, \nor if no OAuth2 access token is used, or \n* the selection of authentication methods. \n* Embedded SCA Approach: The Update PSU Data Request might be used \n* to add credentials as a first factor authentication data of the PSU and \n* to select the authentication method and \n* transaction authorisation. \nThe SCA Approach might depend on the chosen SCA method. For that reason, \nthe following possible Update PSU Data request can apply to all SCA approaches: \n* Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path: \n* Update PSU Identification * Update PSU Authentication \n* Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. \nMaybe in a later version the access path will change. \n* Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. \nMaybe in a later version the access path will change.\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[AUTHORISATIONID](/glossary#): AUTHORISATIONID\n\n\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"psuData":{"password":"start12"}},"success_response_body":{"scaStatus":"psuAuthenticated","_links":{"authoriseTransaction":{"href":"/psd2/v1/payments/1234-wertiq-983/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"psuData":{"type":"object","properties":{"password":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"_links":{"type":"object","properties":{"authoriseTransaction":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations/AUTHORISATIONID","connector_methods":[]},{"operation_id":"BGv1.3-startPaymentInitiationCancellationAuthorisationTransactionAuthorisation","implemented_by":{"version":"BGv1.3","function":"startPaymentInitiationCancellationAuthorisationTransactionAuthorisation"},"request_verb":"POST","request_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations","summary":"Start the authorisation process for the cancellation of the addressed payment (transactionAuthorisation)","description":"Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment.
\nThe message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a
\ncorporate context, each creating an own authorisation sub-endpoint for
\nthe corresponding PSU authorising the cancellation-authorisation.
The ASPSP might make the usage of this access method unnecessary in case
\nof only one SCA process needed, since the related authorisation resource
\nmight be automatically created by the ASPSP after the submission of the
\npayment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation
\nor cancellation sub-resource.
This applies in the following scenarios:
\nAuthentication is Mandatory
\nURL Parameters:
\nPAYMENT_ID: PAYMENT_ID
\nPAYMENT_PRODUCT: PAYMENT_PRODUCT
\nPAYMENT_SERVICE: PAYMENT_SERVICE
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. \nThe message might in addition transmit authentication and authorisation related data.\n\nThis method is iterated n times for a n times SCA authorisation in a \ncorporate context, each creating an own authorisation sub-endpoint for \nthe corresponding PSU authorising the cancellation-authorisation.\n\nThe ASPSP might make the usage of this access method unnecessary in case \nof only one SCA process needed, since the related authorisation resource \nmight be automatically created by the ASPSP after the submission of the \npayment data with the first POST payments/{payment-product} call.\n\nThe start authorisation process is a process which is needed for creating a new authorisation \nor cancellation sub-resource. \n\nThis applies in the following scenarios:\n\n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding Payment\n Initiation Response that an explicit start of the authorisation process is needed by the TPP.\n The 'startAuthorisation' hyperlink can transport more information about data which needs to be\n uploaded by using the extended forms.\n * 'startAuthorisationWithPsuIdentfication',\n * 'startAuthorisationWithPsuAuthentication' #TODO\n * 'startAuthorisationWithAuthentciationMethodSelection'\n* The related payment initiation cannot yet be executed since a multilevel SCA is mandated.\n* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding\n Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP.\n The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded\n by using the extended forms as indicated above.\n* The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for\n executing the cancellation.\n* The signing basket needs to be authorised yet.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[PAYMENT_ID](/glossary#): PAYMENT_ID\n\n\n\n[PAYMENT_PRODUCT](/glossary#): PAYMENT_PRODUCT\n\n\n\n[PAYMENT_SERVICE](/glossary#): PAYMENT_SERVICE\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"scaAuthenticationData":""},"success_response_body":{"scaStatus":"received","authorisationId":"123auth456","psuMessage":"Please use your BankApp for transaction Authorisation.","_links":{"scaStatus":{"href":"/v1.3/payments/qwer3456tzui7890/authorisations/123auth456"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"scaAuthenticationData":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"scaStatus":{"type":"string"},"authorisationId":{"type":"string"},"psuMessage":{"type":"string"},"_links":{"type":"object","properties":{"scaStatus":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations","connector_methods":[]},{"operation_id":"BGv1.3-deleteConsent","implemented_by":{"version":"BGv1.3","function":"deleteConsent"},"request_verb":"DELETE","request_url":"/berlin-group/v1.3/consents/CONSENTID","summary":"Delete Consent","description":"The TPP can delete an account information consent object if needed.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"The TPP can delete an account information consent object if needed.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID","connector_methods":[]},{"operation_id":"BGv1.3-createConsent","implemented_by":{"version":"BGv1.3","function":"createConsent"},"request_verb":"POST","request_url":"/berlin-group/v1.3/consents","summary":"Create consent","description":"This method create a consent resource, defining access rights to dedicated accounts of
\na given PSU-ID. These accounts are addressed explicitly in the method as
\nparameters as a core function.
Side Effects
\nWhen this Consent Request is a request where the "recurringIndicator" equals "true",
\nand if it exists already a former consent for recurring access on account information
\nfor the addressed PSU, then the former consent automatically expires as soon as the new
\nconsent request is authorised by the PSU.
Optional Extension:
\nAs an option, an ASPSP might optionally accept a specific access right on the access on all psd2 related services for all available accounts.
As another option an ASPSP might optionally also accept a command, where only access rights are inserted without mentioning the addressed account.
\nThe relation to accounts is then handled afterwards between PSU and ASPSP.
\nThis option is not supported for the Embedded SCA Approach.
\nAs a last option, an ASPSP might in addition accept a command with access rights
\n* to see the list of available payment accounts or
\n* to see the list of available payment accounts with balances.
Authentication is Mandatory
\nJSON request body fields:
\naccess: access
\ncombinedServiceIndicator: combinedServiceIndicator
\nfrequencyPerDay: frequencyPerDay
\nrecurringIndicator: recurringIndicator
\nvalidUntil: validUntil
\n\nallPsd2: allPsd2
\navailableAccounts: availableAccounts
\nbalances: balances
\nbban: bban
\ncurrency: EUR
\niban: DE91 1000 0000 0123 4567 89
\nmaskedPan: maskedPan
\nmsisdn: msisdn
\npan: pan
\n\nJSON response body fields:
\n_links: _links
\nconsentId: consentId
\nconsentStatus: consentStatus
\nstartAuthorisation: startAuthorisation
\n","description_markdown":"This method create a consent resource, defining access rights to dedicated accounts of \na given PSU-ID. These accounts are addressed explicitly in the method as \nparameters as a core function.\n\n**Side Effects**\nWhen this Consent Request is a request where the \"recurringIndicator\" equals \"true\", \nand if it exists already a former consent for recurring access on account information \nfor the addressed PSU, then the former consent automatically expires as soon as the new \nconsent request is authorised by the PSU.\n\nOptional Extension:\nAs an option, an ASPSP might optionally accept a specific access right on the access on all psd2 related services for all available accounts. \n\nAs another option an ASPSP might optionally also accept a command, where only access rights are inserted without mentioning the addressed account. \nThe relation to accounts is then handled afterwards between PSU and ASPSP. \nThis option is not supported for the Embedded SCA Approach. \nAs a last option, an ASPSP might in addition accept a command with access rights\n * to see the list of available payment accounts or\n * to see the list of available payment accounts with balances.\n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**access**](/glossary#): access\n\n\n\n[**combinedServiceIndicator**](/glossary#): combinedServiceIndicator\n\n\n\n[**frequencyPerDay**](/glossary#): frequencyPerDay\n\n\n\n[**recurringIndicator**](/glossary#): recurringIndicator\n\n\n\n[**validUntil**](/glossary#): validUntil\n\n\n\n[accounts](/glossary#accounts): \n\n\n\n[allPsd2](/glossary#): allPsd2\n\n\n\n[availableAccounts](/glossary#): availableAccounts\n\n\n\n[balances](/glossary#): balances\n\n\n\n[bban](/glossary#): bban\n\n\n\n[currency](/glossary#): EUR\n\n\n\n[iban](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[maskedPan](/glossary#): maskedPan\n\n\n\n[msisdn](/glossary#): msisdn\n\n\n\n[pan](/glossary#): pan\n\n\n\n[transactions](/glossary#transactions): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**_links**](/glossary#): _links\n\n\n\n[**consentId**](/glossary#): consentId\n\n\n\n[**consentStatus**](/glossary#): consentStatus\n\n\n\n[**startAuthorisation**](/glossary#): startAuthorisation\n\n\n","example_request_body":{"access":{"accounts":[{"iban":"DE91 1000 0000 0123 4567 89"}]},"recurringIndicator":true,"validUntil":"2020-12-31","frequencyPerDay":4,"combinedServiceIndicator":false},"success_response_body":{"consentId":"1234-wertiq-983","consentStatus":"received","_links":{"startAuthorisation":"/v1.3/consents/1234-wertiq-983/authorisations"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"access":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"iban":{"type":"string"}}}}}},"recurringIndicator":{"type":"boolean"},"combinedServiceIndicator":{"type":"boolean"},"validUntil":{"type":"string"},"frequencyPerDay":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"consentStatus":{"type":"string"},"consentId":{"type":"string"},"_links":{"type":"object","properties":{"startAuthorisation":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents","connector_methods":[]},{"operation_id":"BGv1.3-getConsentAuthorisation","implemented_by":{"version":"BGv1.3","function":"getConsentAuthorisation"},"request_verb":"GET","request_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations","summary":"Get Consent Authorisation Sub-Resources Request","description":"Return a list of all authorisation subresources IDs which have been created.
\nThis function returns an array of hyperlinks to all generated authorisation sub-resources.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"Return a list of all authorisation subresources IDs which have been created.\n\nThis function returns an array of hyperlinks to all generated authorisation sub-resources.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"authorisationIds":"faa3657e-13f0-4feb-a6c3-34bf21a9ae8e"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Information Service (AIS)","Berlin-Group-M"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"authorisationIds":{"type":"string"}}}},"is_featured":false,"special_instructions":"","specified_url":"/berlin-group/v1.3/consents/CONSENTID/authorisations","connector_methods":[]}]}