openapi: 3.0.1
info:
title: Payment Order API
description: Initiates payment orders.
version: v1.44.15
x-api-status-urls: false
x-konfig-ignore:
object-with-no-properties: true
servers:
- url: https://TENANT_NAME.mambu.com/api/v1
tags:
- description: >
These endpoints are used for making and receiving SEPA credit transfers
through the Mambu Payment Gateway.
For more information on supported messages, flows and technical
information, including examples of generated XML messages and how the
fields map to these API requests, please refer to the [SEPA Credit
Transfer](https://support.mambu.com/docs/sepa-credit-transfers) section of
our User Guide.
name: SEPA Credit Transfers
- description: >
SEPA Direct Debit Payments are one time or recurring payments made using
the Single European Payment Area scheme for transactions made in Euros
between accounts at banks within the SEPA area, which includes all EU
countries as well as other territories such as Liechtenstein, Switzerland,
the United Kingdom, Andorra and Nordic countries.
Mambu supports both the Core SEPA rulebook for individuals and the B2B
scheme for companies. For more information on supported messages, flows
and technical information, please refer to the [SEPA Direct
Debit](https://support.mambu.com/docs/sepa-direct-debit) section of our
user guide.
name: SEPA Direct Debit
- description: >
These APIs allow you to submit inquiries for SEPA payments including for
cases where the customer claims to have not received the funds, the value
date was not correctly recorded or to request a status update for payments
which have been cancelled.
For more information on the types of inquiry supported and how to submit
and respond to inquiries via the Mambu Payment Gateway UI, please refer to
the relevant section of our User Guide, such as the [SEPA credit transfer
inquiries](https://support.mambu.com/docs/sct-inquiries) article for SEPA
credit transfers.
name: SEPA Credit Transfer Inquiries
- description: >-
The External Account Representation (EAR) endpoints are used to associate
IBANs with Mambu account IDs so that payments made using the Mambu Payment
Gateway are routed to the correct accounts.
An IBAN can be mapped to multiple accounts but can only be associated to
one account per currency, so, for example, the same IBAN can be mapped to
one underlying Mambu account using EUR, another using GBP and another
using CHF, but not to two accounts both in EUR denomination.
name: External Account Representation
- name: Standing Order
- description: >
If you are using an external service to check payments as part of your
Anti Money Laundering obligations, these endpoints receive responses which
will lead to unblocking funds and transferring them to the recipient
account in the case of an all clear or returning funds to the payer in
cases where there a compliance issue has been identified.
For more general information on AML flows, including how the necessary
suspense accounting should be set up in Mambu, please refer to the [AML
and Suspense
Accounts](https://support.mambu.com/docs/aml-suspense-accounting) section
of our User Guide.
name: AML
- description: >
This endpoint is the main entry point to the Mambu Payment Gateway for
external systems.
For more information on the types of messages accepted by this endpoint,
please refer to the [supported
flows](https://support.mambu.com/docs/payment-gateway-introduction#supported-flows)
section of the introduction to the Mambu Payment Gateway article in our
User Guide.
name: Incoming Messages
- description: >
Use this endpoint to search for SEPA Credit Transfer and Direct Debit
messages received by the Mambu Payment Gateway.
name: Search Messages
- name: CreditTransfer
- description: >
These endpoints allow you to configure settings for the Mambu Payment
Gateway such as setting callback URLs which will be notified on certain
actions.
name: Settings
paths:
/accounts/{accountId}/blocking-rules:
post:
tags:
- SEPA Direct Debit
operationId: SepaDirectDebit_addBlockingRule
description: >-
Request a blocking rule to be added to a specific Mambu account. When a
blocking rule has been added for a specific mandate ID, collection
requests for that mandate will be rejected and a pacs.002 message sent
as response with reason code MS02. If no specific mandate ID is
provided, all direct debit collection requests for the given account
will be rejected. For more information on blocking SEPA Direct Debits,
consult the [Blocking SEPA Direct
Debits](https://support.mambu.com/docs/blocking-sepa-direct-debits)
article in our user guide.
parameters:
- name: accountId
in: path
required: true
schema:
description: ID of the Mambu Deposit account.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBlockingRule'
examples:
createProductBlockingRule:
summary: >-
Request blocking all SEPA Direct Debits for the specified
account.
description: createProductBlockingRule
value:
product: SEPA_DIRECT_DEBIT
createCeditorMandateBlockingRule:
summary: >-
Request blocking SEPA Direct Debits for a specific mandate for
the specified account.
description: createCeditorMandateBlockingRule
value:
product: SEPA_DIRECT_DEBIT
creditorMandate:
mandateRelatedInformation:
mandateIdentification: '578798984'
creditorSchemeIdentification:
identification:
privateIdentification: ID777444887
responses:
'202':
description: Accepted - The Blocking Rule has been prepared for processing.
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
productCannotBeBlocked:
summary: Specified payment product cannot be blocked.
description: productCannotBeBlocked
value:
tppMessages:
- category: ERROR
code: PARAMETER_NOT_SUPPORTED
path: product
text: SEPA_CREDIT_TRANSFER cannot be blocked
'405':
description: >-
Method Not Allowed - This code is only sent when the HTTP method
(PUT, POST, DELETE, GET etc.) is not supported by a specific
endpoint. It has nothing to do with the content, payment or account
information data model.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedHttpMethod:
summary: The request was submitted with an unsupported HTTP method.
description: unsupportedHttpMethod
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'415':
description: >-
Unsupported Media Type - A media type which the serves does not
support has been supplied.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedContentType:
summary: >-
The request was submitted with an unsupported content type.
For example "application/xml" instead of "application/json".
description: unsupportedContentType
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
delete:
tags:
- SEPA Direct Debit
operationId: SepaDirectDebit_removeBlockingRules
description: >-
Request deletion of blocking rules for the specified Mambu account. If
no request body is provided, all rules for the account will be removed,
if you provide a JSON body with a specific mandate ID, only the rule for
that mandate will be removed. For more information on blocking SEPA
Direct Debits, consult the [Blocking SEPA Direct
Debits](https://support.mambu.com/docs/blocking-sepa-direct-debits)
article in our user guide.
parameters:
- name: accountId
in: path
required: true
schema:
description: ID of the Mambu Deposit account.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteBlockingRule'
examples:
deleteAllBlockingRules:
summary: Delete all blocking rules for the specified account.
description: deleteAllBlockingRules
value: null
deleteProductBlockingRule:
summary: Delete product blocking rule for the specified account.
description: deleteProductBlockingRule
value:
product: SEPA_DIRECT_DEBIT
deleteCreditorMandateBlockingRule:
summary: >-
Delete creditor mandate blocking rule for the specified
account.
description: deleteCreditorMandateBlockingRule
value:
product: SEPA_DIRECT_DEBIT
creditorMandate:
mandateRelatedInformation:
mandateIdentification: '578798984'
creditorSchemeIdentification:
identification:
privateIdentification: ID777444887
responses:
'202':
description: >-
Accepted - Blocking rules for the specified account have been
submitted for deletion.
'405':
description: >-
Method Not Allowed - This code is only sent when the HTTP method
(PUT, POST, DELETE, GET etc.) is not supported by a specific
endpoint. It has nothing to do with the consent, payment or account
information data model.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedHttpMethod:
summary: The request was submitted with an unsupported HTTP method.
description: unsupportedHttpMethod
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'415':
description: >-
Unsupported Media Type - A media type which the serves does not
support has been supplied.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedContentType:
summary: >-
The request was submitted with an unsupported content type.
For example "application/xml" instead of "application/json".
description: unsupportedContentType
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/accounts/{accountId}/identifications:
get:
tags:
- External Account Representation
operationId: ExternalAccountRepresentation_getIdentifications
description: >-
Gets associations of an external account identification (IBAN or
proprietary) to a Mambu Account.
parameters:
- name: accountId
in: path
required: true
schema:
type: string
- name: limit
in: query
schema:
description: >-
Limit the number of identifications retrieved. The default limit
is 50, can be specified up to 1000.
maximum: 1000
minimum: 1
type: integer
format: int32
default: 50
- name: offset
in: query
schema:
description: >-
Offset determines how many records will be skipped before being
included in the returned results. The default offset value is 0.
minimum: 0
type: integer
format: int64
default: 0
responses:
'200':
description: OK - List existing external identifications.
headers:
Items-Offset:
description: The index of the first returned item.
required: true
style: simple
schema:
type: integer
Items-Limit:
description: The requested page size.
required: true
style: simple
schema:
type: integer
Items-Total:
description: The total count of available items.
required: true
style: simple
schema:
type: integer
content:
application/json:
schema:
$ref: >-
#/components/schemas/ExternalAccountRepresentationGetIdentificationsResponse
examples:
Identification:
summary: List of identifications
description: Identification
value:
- iban: DE46606951125202071272
- currency: USD
- other:
identification: ABCDE1234F
scheme: PAN
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
post:
tags:
- External Account Representation
operationId: ExternalAccountRepresentation_addIdentificationAssociation
description: >-
Adds association of an external account identification (IBAN or
proprietary) to a Mambu Account. The currency of the association will be
the one of the underlining Mambu account. If an IBAN is supposed to be a
multi-currency one, this API needs to be invoked multiple times with
different Mambu accounts (for the different currencies).
parameters:
- name: accountId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAccountMapping'
examples:
createMambuAccountMapping:
summary: >-
Create mapping between a proprietary identification and a
Mambu Account
description: createMambuAccountMapping
value:
identification:
other:
identification: ABCDE1234F
scheme: PAN
iban: DE46606951125202071272
currency: USD
responses:
'201':
description: Created - Association successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountMappingResponse'
examples:
accountMappingResponse:
summary: Successful account identification request.
description: accountMappingResponse
value: {}
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
invalidIdentification:
summary: IBAN is not valid.
description: invalidIdentification
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: iban
text: iban size must be between 15 and 34
- category: ERROR
code: FORMAT_ERROR
path: iban
text: iban invalid IBAN value
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/accounts/identifications:
put:
tags:
- External Account Representation
operationId: ExternalAccountRepresentation_associateIban
description: >-
Create or replace associations of an external account identification
(IBAN or proprietary) to one of Mambu Accounts. The currency of the
association will be the one of the underlining Mambu account.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAccountMappings'
examples:
createMambuAccountMappings:
summary: >-
Create mapping between a proprietary identification and
multiple Mambu Accounts with different currencies
description: createMambuAccountMappings
value: |-
{
"identification": {
"iban": "DE46606951125202071272"
},
"accountIds": [
"123",
]
}
responses:
'201':
description: Created - Association successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountMappingResponse'
examples:
accountMappingResponse:
summary: Successful account identification request.
description: accountMappingResponse
value: {}
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
invalidIdentification:
summary: IBAN is not valid.
description: invalidIdentification
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: iban
text: iban size must be between 15 and 34
- category: ERROR
code: FORMAT_ERROR
path: iban
text: iban invalid IBAN value
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/accounts/identifications:search:
post:
tags:
- External Account Representation
operationId: ExternalAccountRepresentation_searchIdentifications
description: >-
Searches identifications (with MambuID included) based on provided
filter criteria
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountIdentificationsSearchRequestDTO'
responses:
'200':
description: OK - List of found identifications with accountId
content:
application/json:
schema:
$ref: >-
#/components/schemas/ExternalAccountRepresentationSearchIdentificationsResponse
examples:
AccountIdentificationsSearchResponse:
summary: Successful account identification search response.
description: AccountIdentificationsSearchResponse
value:
- accountId: test123
currency: EUR
type: DEPOSIT
identification:
iban: DE46606951125202071272
identification: ABCDE1234F
scheme: PAN
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
invalidSearchFilter:
summary: Search filter is not valid
description: invalidSearchFilter
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: >-
searchAccountIdentifications.arg0.filterCriteria[0].field
text: >-
filterCriteria[0].field Should be one of: schema,
iban, currency, identification
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/collections:
post:
tags:
- SEPA Direct Debit
operationId: SepaDirectDebit_createCollectionInitiationRequest
description: >-
Creates a collection initiation request. This covers the flows as
described in the [SEPA Direct
Debit](https://support.mambu.com/docs/sepa-direct-debit-creditor-flow)
section of our user guide.
parameters:
- name: X-Request-ID
in: header
required: true
schema:
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
type: string
- name: Idempotency-Key
in: header
schema:
description: >-
Prevents retried requests to be executed multiple times.
Subsequent requests with the same Idempotency Key will not be
processed and will return a cached result.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionDTO'
examples:
initiateCollectionRequest:
summary: >-
Initiate collection request for accounts identified by IBAN
and creditor agent identified by BIC.
description: initiateCollectionRequest
value:
debtorAccount:
identification:
iban: DE46606951125202071272
currency: EUR
debtorName: John Doe
serviceLevel: SEPA
instructedAmount:
currency: EUR
amount: '500'
creditorAccount:
identification:
iban: DE16195554277485442959
currency: EUR
creditorName: Merchant123
paymentIdentification:
transactionIdentification: 113T9bs6ad48ga1216d772430401s01sd2
requestedExecutionDate: '2020-09-01'
mandateRelatedInformation:
mandateIdentification: 16ead91c975c4881a60c
dateOfSignature: '2020-01-31'
paymentTypeInformation:
sequenceType: FRST
creditorSchemeIdentification:
identification:
privateIdentification: I48799148795
responses:
'201':
description: >-
Created - Collection Initiation request was correctly performed (but
not yet accepted) nor executed.
headers:
Location:
description: >-
Location of the created collection order request resource, for
future reference or status polling.
required: true
style: simple
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionResponse'
examples:
initiateCollectionResponse:
summary: Successful collection initiation response.
description: initiateCollectionResponse
value:
transactionStatus: RCVD
collectionId: e38458a4-d955-4a39-8e21-9608e9600b3d
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
missingMandatoryField:
summary: Identification for debtor account was not provided.
description: missingMandatoryField
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: debtorAccount.identification
text: debtorAccount.identification may not be null
'405':
description: >-
Method Not Allowed - This code is only sent when the HTTP method
(PUT, POST, DELETE, GET etc.) is not supported on a specific
endpoint. It has nothing to do with the content, payment or account
information data model.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedHttpMethod:
summary: The request was submitted with an unsupported HTTP method.
description: unsupportedHttpMethod
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'415':
description: >-
Unsupported Media Type - A media type which the serves does not
support has been supplied.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedContentType:
summary: >-
The request was submitted with an unsupported content type.
For example "application/xml" instead of "application/json".
description: unsupportedContentType
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/log:
post:
tags:
- External Account Representation
operationId: ExternalAccountRepresentation_createOrUpdateLog
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogRequest'
required: true
responses:
default:
description: default response
content:
application/json:
schema:
$ref: >-
#/components/schemas/ExternalAccountRepresentationCreateOrUpdateLogResponse
/payments/financial-institution-credit-transfers:
post:
tags:
- CreditTransfer
operationId: CreditTransfer_submitPaymentRequest
parameters:
- name: X-Request-ID
in: header
required: true
schema:
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
type: string
- name: Idempotency-Key
in: header
schema:
description: >-
Prevents retried requests to be executed multiple times.
Subsequent requests with the same Idempotency Key will not be
processed and will return a cached result.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialInstitutionPaymentDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: >-
#/components/schemas/CreditTransferSubmitPaymentRequestResponse
/payments/credit-transfers:
post:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_createRequest
parameters:
- name: X-Request-ID
in: header
required: true
schema:
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
type: string
- name: Idempotency-Key
in: header
schema:
description: >-
Prevents retried requests to be executed multiple times.
Subsequent requests with the same Idempotency Key will not be
processed and will return a cached result.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Iso20022PaymentDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/SepaCreditTransfersCreateRequestResponse'
/payments:
post:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_createPaymentRequest
description: >-
Creates a payment initiation request. Payments using the SEPA Credit
Transfer scheme can only be created for the current date. A pacs.008
message will be generated from the data provided in this request. For
more information on how these fields map to SEPA XML messages, refer to
the [SEPA Credit Transfer Techincal
Information](https://support.mambu.com/docs/sepa-credit-transfer-technical-information#pacs00800102)
article in our user guide.
parameters:
- name: X-Request-ID
in: header
required: true
schema:
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
type: string
- name: Idempotency-Key
in: header
schema:
description: >-
Prevents retried requests to be executed multiple times.
Subsequent requests with the same Idempotency Key will not be
processed and will return a cached result.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InitiationPaymentDTO'
examples:
initiatePaymentRequest:
summary: >-
Initiate same day payment request for accounts identified by
IBAN and creditor agent identified by BIC with creditor and
debtor address information.
description: initiatePaymentRequest
value:
debtorAccount:
identification:
iban: DE46606951125202071272
currency: EUR
debtorName: John Doe
debtorAddress:
street: Karl-Liebknecht-Str. 5
buildingNumber: '5234'
city: Berlin
postalCode: '10178'
countryCode: DE
serviceLevel: SEPA
instructedAmount:
currency: EUR
amount: '500'
creditorAccount:
identification:
iban: DE16195554277485442959
currency: EUR
creditorAgent:
institutionIdentification:
bicfi: DEUTDEFF
creditorName: Merchant123
creditorAddress:
street: Am Olympiapark 1
buildingNumber: '1'
city: Munchen
postalCode: '80809'
countryCode: DE
responses:
'201':
description: >-
Created - Payment Initiation request was correctly performed (but
not yet accepted) nor executed.
headers:
Location:
description: >-
Location of the created payment order request resource, for
future reference or status polling.
required: true
style: simple
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse'
examples:
initiatePaymentResponse:
summary: Successful payment initiation request.
description: initiatePaymentResponse
value:
transactionStatus: RCVD
paymentId: e38458a4-d955-4a39-8e21-9608e9600b3d
transactionFeeIndicator: false
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
missingMandatoryField:
summary: Identification for debtor account was not provided.
description: missingMandatoryField
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: debtorAccount.identification
text: debtorAccount.identification may not be null
'405':
description: >-
Method Not Allowed - This code is only sent when the HTTP method
(PUT, POST, DELETE, GET etc.) is not supported by a specific
endpoint. It has nothing to do with the consent, payment or account
information data model.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedHttpMethod:
summary: The request was submitted with an unsupported HTTP method.
description: unsupportedHttpMethod
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'415':
description: >-
Unsupported Media Type - A media type which the serves does not
support has been supplied.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedContentType:
summary: >-
The request was submitted with an unsupported content type.
For example "application/xml" instead of "application/json".
description: unsupportedContentType
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/payments/standing-orders/{id}/executions:
get:
tags:
- Standing Order
operationId: StandingOrder_listExecutions
description: Get executions of standing order
parameters:
- description: ApiKey header that is used for authentication
name: ApiKey
in: header
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK - Standing orders executions retrieval was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/StandingOrderExecutionResponse'
examples:
StandingOrderExecutionResponse:
description: StandingOrderExecutionResponse
value:
- standingOrderId: standing-order-id-qwerty
paymentOrderId: paymentorderid54
requestedExecuteOn: '2023-01-26T15:51:27'
status: FAILED
creationDate: '2023-01-26T15:52:27.865848Z'
type: RETRY
failReason: INSUFFICIENT_FUNDS
/payments/standing-orders/{id}:
get:
tags:
- Standing Order
operationId: StandingOrder_getInformation
description: Gets Standing order information
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK - Returns Standing order item.
content:
application/json:
schema:
$ref: '#/components/schemas/StandingOrderGetResponse'
examples:
standingOrderGetResponse:
summary: Standing order get response.
description: standingOrderGetResponse
value:
id: 9726992c-bda4-4867-9264-f9168337d0ec
payment:
scheme: SEPA
instructedAmount:
currency: EUR
amount: '500'
debtorAccount:
identification:
iban: DE87200500001234567890
currency: EUR
creditorAccount:
identification:
other:
identification: '1234'
scheme: PAN
currency: EUR
creditorName: CreditorName
debtorName: DebtorName
remittanceInformationUnstructured: Remittance Info
startDate: '2022-11-10'
frequency: DAILY
endDate: '2023-11-10'
creationDateTime: '2022-11-09T21:41:29+02:00'
status: ACTIVE
lastExecution: '2022-11-17'
nextExecution: '2022-11-18'
paymentsCount: 2
ownerId: some-owner-id
retryCount: 3
suspendDateFrom: null
suspendDateTo: null
'404':
description: Not found - cannot find the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
standingOrderNotFound:
summary: Unable to get Standing order
description: standingOrderNotFound
value:
tppMessages:
- category: ERROR
code: RESOURCE_UNKNOWN
text: >-
Unable to find Standing order with id:
9726992c-bda4-4867-9264-f9168337d0ec.
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
delete:
tags:
- Standing Order
operationId: StandingOrder_cancel
description: Cancel Standing order
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: Standing order canceled.
'404':
description: Not found - cannot find the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
standingOrderNotFound:
summary: Unable to find Standing order
description: standingOrderNotFound
value:
tppMessages:
- category: ERROR
code: RESOURCE_UNKNOWN
text: >-
Unable to find Standing order with id:
9726992c-bda4-4867-9264-f9168337d0ec.
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/payments/standing-orders:
post:
tags:
- Standing Order
operationId: StandingOrder_createStandingOrderRequest
description: >-
API creates standing orders. Standing order creation will trigger
periodic payments for provided frequency from start date until the end
date.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StandingOrderDTO'
examples:
createStandingOrder:
summary: Create standing orders
description: createStandingOrder
value: |
{
"payment": {
"scheme": "SEPA",
"instructedAmount": {
"currency": "EUR",
"amount": "500"
},
"debtorAccount": {
"identification": {
"iban": "DE87200500001234567890"
},
"currency": "EUR"
},
"creditorAccount": {
"identification": {
"other": {
"identification": "1234",
"scheme": "PAN"
}
},
"currency": "EUR"
},
"creditorName": "CreditorName",
"debtorName": "DebtorName",
"remittanceInformationUnstructured": "Remittance Info"
},
"startDate": [
2022,
11,
8
],
"frequency": "DAILY",
"endDate": [
2022,
11,
8
],
"ownerId": "some-owner-id",
"retryPolicy": {
“ + "retryCount": "3"
}
}
responses:
'201':
description: Created - Standing order successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/StandingOrderCreateResponse'
examples:
standingOrderCreateResponse:
summary: Successful standing order request.
description: standingOrderCreateResponse
value:
id: 9726992c-bda4-4867-9264-f9168337d0ecX
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
invalidStandingOrderRequest:
summary: IBAN is not valid.
description: invalidStandingOrderRequest
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: iban
text: iban size must be between 15 and 34
- category: ERROR
code: FORMAT_ERROR
path: iban
text: iban invalid IBAN value
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/payments/standing-orders:search:
post:
tags:
- Standing Order
operationId: StandingOrder_searchByFilters
description: Search for standing orders by search filters such as ownerId
parameters:
- description: ApiKey header that is used for authentication
name: ApiKey
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StandingOrderSearchRequest'
examples:
standingOrderSearchRequest:
summary: Search for standing orders by search filters
description: standingOrderSearchRequest
value: |-
{
"filterCriteria": [
{
"field": "OWNER_ID",
"operator": "EQUALS",
"value": "string"
}
{
"field": "STATUS",
"operator": "EQUALS",
"value": "string"
}
],
"limit": 500,
"offset": 0
}
responses:
'200':
description: OK - Standing orders search was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/StandingOrderSearchResponse'
examples:
StandingOrderSearchResponse:
description: StandingOrderSearchResponse
value:
- ownerId: some_kind_of_id_from_client
id: 9726992c-bda4-4867-9264-f9168337d0ecX
payment:
scheme: SEPA
instructedAmount:
currency: EUR
amount: '500'
debtorAccount:
identification:
iban: DE87200500001234567890
currency: EUR
creditorAccount:
identification:
other:
identification: '1234'
scheme: PAN
currency: EUR
creditorName: CreditorName
debtorName: DebtorName
remittanceInformationUnstructured: Remittance Info
startDate: '2022-11-10'
frequency: DAILY
endDate: '2023-11-10'
creationDateTime: '2022-11-09T21:41:29+02:00'
status: ACTIVE
- ownerId: some_kind_of_id_from_client
id: 9726992c-bda4-4867-9264-13245679fe
payment:
scheme: SEPA
instructedAmount:
currency: EUR
amount: '100'
debtorAccount:
identification:
iban: DE87200500001234567890
currency: EUR
creditorAccount:
identification:
other:
identification: '1234'
scheme: PAN
currency: EUR
creditorName: CreditorName
debtorName: DebtorName
remittanceInformationUnstructured: Remittance Info
startDate: '2022-11-10'
frequency: DAILY
endDate: '2023-11-10'
creationDateTime: '2022-11-09T21:41:29+02:00'
status: ACTIVE
suspendDateFrom: null
suspendDateTo: null
/payments/standing-orders:suspend:
post:
tags:
- Standing Order
operationId: StandingOrder_suspendRequest
description: API suspends standing order for a particular period of time.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StandingOrderSuspendDTO'
examples:
suspendStandingOrder:
summary: Suspend standing order
description: suspendStandingOrder
value:
id: 9726992c-bda4-4867-9264-f9168337d0ecX
startDate:
- 2022
- 11
- 8
endDate:
- 2022
- 11
- 9
responses:
'200':
description: OK - Standing order successfully suspended.
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
invalidStandingOrderSuspendRequest:
summary: request is invalid
description: invalidStandingOrderSuspendRequest
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: id
text: id must not be null
- category: ERROR
code: FORMAT_ERROR
path: endDate
text: endDate must not be null
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/collections/{collectionId}:
get:
tags:
- SEPA Direct Debit
operationId: SepaDirectDebit_getCollectionDetails
parameters:
- name: collectionId
in: path
required: true
schema:
description: >-
ID of the collection order, as received in the response to a `POST
/collections` request or from the instruction ID field of a
collection. You can retrieve the instruction ID in the Payment
Gateway UI by opening up the detail view of a collection and
looking for the value of `InstId` in the Payment Identification
object.
type: string
- name: detailsLevel
in: query
schema:
description: >-
Details level of the response. `STATUS` and `FULL` detail levels
are supported. `STATUS` will return the current status and a
timestamp of when the collection order was last modified. The
default value of `FULL` will return a complete set of information
about the collection order.
type: string
default: FULL
responses:
default:
description: default response
content:
application/json:
schema:
$ref: >-
#/components/schemas/SepaDirectDebitGetCollectionDetailsResponse
/payments/credit-transfers/{paymentId}:
get:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_getPaymentDetails
parameters:
- name: paymentId
in: path
required: true
schema:
description: >-
ID of the payment order, as received in the response to a `POST
/payments` request
type: string
- name: detailsLevel
in: query
schema:
description: >-
Details level of the response. STATUS and FULL detail levels are
supported. `STATUS` will return the current status and a timestamp
of when the payment order was last modified. The default value of
`FULL` will return a complete set of information about the payment
order.
type: string
default: FULL
responses:
default:
description: default response
content:
application/json:
schema:
$ref: >-
#/components/schemas/SepaCreditTransfersGetPaymentDetailsResponse
/payments/{paymentId}:
get:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_getPaymentDetails
parameters:
- name: paymentId
in: path
required: true
schema:
description: >-
ID of the payment order, as received in the response to a `POST
/payments` request
type: string
- name: detailsLevel
in: query
schema:
description: >-
Details level of the response. STATUS and FULL detail levels are
supported. `STATUS` will return the current status and a timestamp
of when the payment order was last modified. The default value of
`FULL` will return a complete set of information about the payment
order.
type: string
default: FULL
responses:
default:
description: default response
content:
application/json:
schema:
$ref: >-
#/components/schemas/SepaCreditTransfersGetPaymentDetailsdefaultResponse
/payments:settleInstantPayment:
post:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_acceptInstantPaymentSettlement
description: Accepts requests for an instant payment settlement.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InstantPaymentSettlement'
examples:
instantPaymentSettlementRequest:
summary: Request settlement for an instant payment.
description: instantPaymentSettlementRequest
value:
groupHeader:
messageIdentification: SCTORD200020190305ORD000011119
transaction:
debtorAgent:
institutionIdentification:
bicfi: FUBKDE71
paymentIdentification:
transactionIdentification: 00730100632BHGCRWC
acceptanceDateTime: '2023-04-05T09:07:37'
required: true
responses:
'202':
description: >-
Accepted - The instant payment settlement request has been accepted
for processing.
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
missingMandatoryField:
summary: Message identification for group header was not provided.
description: missingMandatoryField
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: groupHeader.messageIdentification
text: groupHeader.messageIdentification may not be null
'405':
description: >-
Method Not Allowed - This code is only sent when the HTTP method
(PUT, POST, DELETE, GET etc.) is not supported by a specific
endpoint. It has nothing to do with the content, payment or account
information data model.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
unsupportedHttpMethod:
summary: The request was submitted with an unsupported HTTP method.
description: unsupportedHttpMethod
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'415':
description: >-
Unsupported Media Type - A media type which the serves does not
support has been supplied.
content:
'*/*':
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
unsupportedContentType:
summary: >-
The request was submitted with an unsupported content type.
For example "application/xml" instead of "application/json".
description: unsupportedContentType
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/payments/{paymentOrderId}:reject:
post:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_manuallyRejectPayment
description: Manually Reject an Outgoing Payment.
parameters:
- name: paymentOrderId
in: path
required: true
schema:
type: string
responses:
'200':
description: >-
OK - The specified payment order has been marked to be manually
rejected.
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
invalidTransactionStatus:
summary: Transaction status is invalid for manual rejection.
description: invalidTransactionStatus
value:
tppMessages:
- category: ERROR
code: INVALID_TRANSACTION_STATUS
text: >-
Transaction has invalid status: TO_BE_REJECTED.
Expected status is: TO_BE_SENT.
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/payments/{paymentOrderId}:recall:
post:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_recallPaymentRequest
description: Recall an outgoing payment.
parameters:
- name: paymentOrderId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Recall'
required: true
responses:
'200':
description: OK - Payment marked to be recalled successfully.
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
'*/*':
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
badRecallReasonCode:
summary: A non SEPA compliant recall reason code was provided.
description: badRecallReasonCode
value:
tppMessages:
- category: ERROR
code: INVALID_REQUEST_BODY
text: ''
'500':
description: Internal Server Error - Internal server error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value: |-
{
"tppMessages": [
{
"category": "ERROR",
"code": "SERVICE_INVALID",
"text": "There was an error processing your request. }
]
}
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/payments/{paymentOrderId}:denyOutgoingRecall:
post:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_denyOutgoingRecallAction
description: Deny an Outgoing Recall.
parameters:
- name: paymentOrderId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK - The specified outgoing recall has been marked to be rejected.
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
invalidPaymentOrderId:
summary: No payment order found for given id.
description: invalidPaymentOrderId
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
original transaction for Payment Order
bac5161bd53348fa8dfc143cae49ba13 not found
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/payments/{paymentOrderId}:denyIncomingRecall:
post:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_denyIncomingRecallAction
description: Deny an Incoming Recall.
parameters:
- name: paymentOrderId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CancellationDetails'
required: true
responses:
'200':
description: OK - The specified incoming recall has been marked to be rejected.
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
invalidRequest:
summary: >-
The request is invalid for the current state of the
transaction.
description: invalidRequest
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
Database update failed due to invalid request,
expected number of updated rows is 1, actual number
is: 0. The error message is: pending.authorized.failed
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/payments/{paymentOrderId}:approveOutgoingRecall:
post:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_approveOutgoingRecallAction
description: Approve an Outgoing Recall.
parameters:
- name: paymentOrderId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK - The specified outgoing recall has been authorized.
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
invalidPaymentOrderId:
summary: No payment order found for given id.
description: invalidPaymentOrderId
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
original transaction for Payment Order
bac5161bd53348fa8dfc143cae49ba13 not found
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/payments/{paymentOrderId}:approveIncomingRecall:
post:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_approveIncomingRecall
description: Approve an Incoming Recall.
parameters:
- name: paymentOrderId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK - The specified incoming recall has been authorized.
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
invalidRequest:
summary: >-
The request is invalid for the current state of the
transaction.
description: invalidRequest
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
Database update failed due to invalid request,
expected number of updated rows is 1, actual number
is: 0. The error message is: pending.authorized.failed
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/payments/{paymentOrderId}/aml:resendCallout:
post:
tags:
- AML
operationId: Aml_resendCallout
description: Resends the AML callout for an Outgoing payment.
parameters:
- name: paymentOrderId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK - The AML callout was resent for the provided payment order.
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
invalidRequestBody:
summary: >-
No transactions that allow resending the AML callout were
found.
description: invalidRequestBody
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
Failed to find any valid Sepa Transaction for the
given request. The error message is:
resend.aml.callout.failed
'405':
description: >-
Method Not Allowed - This code is only sent when the HTTP method
(PUT, POST, DELETE, GET etc.) is not supported on a specific
endpoint. It has nothing to do with the consent, payment or account
information data model.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
unsupportedHttpMethod:
summary: The request was submitted with an unsupported HTTP method.
description: unsupportedHttpMethod
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse-TPP'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/payments/incoming:
post:
tags:
- Incoming Messages
operationId: IncomingMessages_createRequest
description: Creates an incoming message request.
parameters:
- description: >-
ID of the request, unique to the call, as determined by the
initiating party.
name: X-Request-ID
in: header
required: true
schema:
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
type: string
- description: Specifies payment scheme for processing.
name: X-Payment-Scheme
in: header
required: false
schema:
description: Specifies payment scheme for processing.
type: string
requestBody:
content:
application/xml:
schema:
$ref: '#/components/schemas/IncomingMessagesCreateRequestRequest'
examples:
incomingCreditTransferRequest:
summary: Request processing for the given incoming pacs.008 message.
description: incomingCreditTransferRequest
value: >-