API Reference

Get payment status

Aritma Banking API (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

API versioning

Over time there will be introduced changes to the API as we continuously introduce improvements. You have the option to use a specific version or the most recent version, supported versions are available in the response header api-supported-versions.

Use a specific version of the API by specifying the api-version header, for example api-version: 1.0. If you don't specify the header, the latest version will be used. If a version has been scheduled to be removed, it will be reported through the api-deprecated-versions header, for example api-deprecated-versions: 1.0, 1.1.

Idempotency

The API supports idempotency for safely retrying POST requests without accidentally performing the operation twice. To perform an idempotent request, specify the Idempotency-Key: UUID header with a value on UUID format, example: Idempotency-Key: 5bfa15da-0969-46a3-820d-be0ec7a16c24.

The idempotency works by storing the status code and body of the first response made for the idempotency key for a short timespan, regardless of whether if succeeds or fails. Subsequent request with the same key returns the response of the previous response. The presence of response header Idempotent-Replayed: true indicates that a previous response has been returned. Note that the replayed responses for created resources would change from status 201 to 200 ok, indicating that no resource was created.

Download OpenAPI description

banking-openapi.json

banking-openapi.yaml

Servers

Mock server

https://developer.aritma.com/_mock/apis/banking/v4/openapi/banking-openapi

https://banking.dev.zdata.io/api

Accounts

Access account information.

Operations

Banks

Access information about the available banks.

Operations

Consents

Obtaining a consent is the first thing you need to do in order to access bank information.

Start by sending a request to the create consent endpoint which will return a link you can redirect the user to. When the user visits the link, we will gather the necessary information needed to obtain a consent linked to the chosen bank.

When a consent has been obtained you can use it to access data through the available endpoints, keep in mind that a consent can potentially be withdrawn by the user at any point.

Operations

Payments

Operations

Bulk payment initiation

Request

Security

Api access(Required scopes:

services.banking

api

)

Path

paymentProductstringrequired

Enum"creditTransfer""directDebit"

Headers

TPP-Redirect-URIstring(uri)

The url to redirect the user to after authorization

PSU-IP-Addressstring

IP Address of the PSU.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring

The banking channel.

Enum"unspecified""openBanking""psd2"

Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

/: Use all resources available.
/subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
/subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.

Example: /subscriptions/7fdf00601dfb/resource-groups/my-company

api-versionstring

Body

Payment details

debtorAccountobjectrequired

debtorAccount.ibannull or string[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

IBAN of the account

Example: "FR7612345987650123456789014"

debtorAccount.bbannull or string[a-zA-Z0-9]{1,30}

BBAN of the account - ISO 20022

Example: "BARC12345612345678"

debtorAccount.othernull

Generic account reference.

debtorAccount.currencynull or string[A-Z]{3}

Currency code - ISO 4217

Example: "EUR"

debtorNamenull or string

Debtor name

debtorAddressnull

Debtor address

batchBookingPreferredboolean

requestedExecutionDatenull or string(date)

paymentLinesArray of objects(PaymentLine)non-empty

{
  "debtorAccount": {
    "iban": "FR7612345987650123456789014",
    "bban": "BARC12345612345678",
    "other": { … },
    "currency": "EUR"
  },
  "debtorName": null,
  "debtorAddress": {
    "streetName": null,
    "buildingNumber": null,
    "postCode": null,
    "townName": null,
    "country": "string"
  },
  "batchBookingPreferred": true,
  "requestedExecutionDate": null,
  "paymentLines": [
    { … }
  ]
}

Responses

Created

Bodyapplication/json

paymentIdstring

Id of the payment initiation

Example: "A30D7108-A584-4C32-95ED-8FF4BB5A7C2C"

transactionStatusstring

Status of the payment

Enum Value	Description
accc	`AcceptedSettlementCompleted` - Settlement on the creditor account has been completed.
accp	`AcceptedCustomerProfile` - Preceding check of technical validation was successful. Customer profile check was also successful.
acsc	`AcceptedSettlementCompleted` - Settlement on the debtor account has been completed. Usage: this can be used by the first agent to report to the debtor that the transaction has been completed. Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement.
acsp	`AcceptedSettlementInProcess` - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
actc	`AcceptedTechnicalValidation` - Authentication and syntactical and semantical validation are successful.
acwc	`AcceptedWithChange` - Instruction is accepted but a change will be made, such as date or remittance not sent.
acwp	`AcceptedWithoutPosting` - Payment instruction included in the credit transfer is accepted without being posted to the creditor customers account.
rcvd	`Received` - Payment initiation has been received by the receiving agent.
pdng	`Pending` - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
rjct	`Rejected` - Payment initiation or individual transaction included in the payment initiation has been rejected.

Example: "pdng"

_linksobject

paymentsArray of objects(PaymentReference)

A list of payment references.

Response

application/json

{
  "paymentId": "A30D7108-A584-4C32-95ED-8FF4BB5A7C2C",
  "transactionStatus": "pdng",
  "_links": {
    "self": { … },
    "status": { … },
    "startAuthorization": { … },
    "scaRedirect": { … }
  },
  "payments": [
    { … }
  ]
}

Get bulk payments

Request

Security

Api access(Required scopes:

services.banking

api

)

Path

paymentProductstringrequired

Enum"creditTransfer""directDebit"

Query

createdFromstring(date-time)

Only payments created after this date will be fetched

createdTostring(date-time)

Only payments created before this date will be fetched, should be a later date than createdAtDateFrom

updatedFromstring(date-time)

Only payments updated after this date will be fetched, payments that have never been updated will also be fetched

updatedTostring(date-time)

Only payments updated before this date will be fetched, payments that have never been updated will also be fetched, should be a later date than updatedAtDateFrom if it is specified

statusstring

Status of the payments to fetch

Enum Value	Description
accc	`AcceptedSettlementCompleted` - Settlement on the creditor account has been completed.
accp	`AcceptedCustomerProfile` - Preceding check of technical validation was successful. Customer profile check was also successful.
acsc	`AcceptedSettlementCompleted` - Settlement on the debtor account has been completed. Usage: this can be used by the first agent to report to the debtor that the transaction has been completed. Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement.
acsp	`AcceptedSettlementInProcess` - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
actc	`AcceptedTechnicalValidation` - Authentication and syntactical and semantical validation are successful.
acwc	`AcceptedWithChange` - Instruction is accepted but a change will be made, such as date or remittance not sent.
acwp	`AcceptedWithoutPosting` - Payment instruction included in the credit transfer is accepted without being posted to the creditor customers account.
rcvd	`Received` - Payment initiation has been received by the receiving agent.
pdng	`Pending` - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
rjct	`Rejected` - Payment initiation or individual transaction included in the payment initiation has been rejected.

accountIdstring

Resource uri of the account to get payments for

cursorstring

cursor to get next or previous page

Headers

PSU-IP-Addressstring

IP Address of the PSU.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring

The banking channel.

Enum"unspecified""openBanking""psd2"

Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

/: Use all resources available.
/subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
/subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.

Example: /subscriptions/7fdf00601dfb/resource-groups/my-company

api-versionstring

No request payload

Responses

Bodyapplication/json

paymentsArray of objects(PaymentLinksBulkPaymentResponse)

_linksobject

Links

Response

application/json

{
  "payments": [
    { … }
  ],
  "_links": {
    "next": { … },
    "previous": { … }
  }
}

Get bulk-payment information

Request

Security

Api access(Required scopes:

services.banking

api

)

Path

paymentProductstringrequired

Enum"creditTransfer""directDebit"

paymentIdstringrequired

Id of the payment initiation

Query

cursorstring

A reference to a specific page

Headers

PSU-IP-Addressstring

IP Address of the PSU.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring

The banking channel.

Enum"unspecified""openBanking""psd2"

Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

/: Use all resources available.
/subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
/subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.

Example: /subscriptions/7fdf00601dfb/resource-groups/my-company

api-versionstring

No request payload

Responses

Bodyapplication/json

paymentIdstring

Id of the payment initiation

Example: "A30D7108-A584-4C32-95ED-8FF4BB5A7C2C"

transactionStatusstring

Status of the payment

Enum Value	Description
accc	`AcceptedSettlementCompleted` - Settlement on the creditor account has been completed.
accp	`AcceptedCustomerProfile` - Preceding check of technical validation was successful. Customer profile check was also successful.
acsc	`AcceptedSettlementCompleted` - Settlement on the debtor account has been completed. Usage: this can be used by the first agent to report to the debtor that the transaction has been completed. Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement.
acsp	`AcceptedSettlementInProcess` - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
actc	`AcceptedTechnicalValidation` - Authentication and syntactical and semantical validation are successful.
acwc	`AcceptedWithChange` - Instruction is accepted but a change will be made, such as date or remittance not sent.
acwp	`AcceptedWithoutPosting` - Payment instruction included in the credit transfer is accepted without being posted to the creditor customers account.
rcvd	`Received` - Payment initiation has been received by the receiving agent.
pdng	`Pending` - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
rjct	`Rejected` - Payment initiation or individual transaction included in the payment initiation has been rejected.

Example: "pdng"

tppMessageArray of objects(TppMessage)

Messages on operational issues.

requestedExecutionDatenull or string(date)

debtorAccountobject

Account reference

debtorNamenull or string

Debtor name

debtorAddressnull

Debtor address

createdAtnull or string(date-time)

updatedAtnull or string(date-time)

_linksobject

batchBookingPreferredboolean

paymentsArray of objects(PaymentLineResponseDto)

Response

application/json

{
  "paymentId": "A30D7108-A584-4C32-95ED-8FF4BB5A7C2C",
  "transactionStatus": "pdng",
  "tppMessage": [
    { … }
  ],
  "requestedExecutionDate": null,
  "debtorAccount": {
    "iban": "FR7612345987650123456789014",
    "bban": "BARC12345612345678",
    "other": { … },
    "currency": "EUR",
    "pan": 5409050000000000,
    "maskedPan": "123456xxxxxx1234",
    "msisdn": "+491701234567"
  },
  "debtorName": null,
  "debtorAddress": {
    "streetName": null,
    "buildingNumber": null,
    "postCode": null,
    "townName": null,
    "country": "string"
  },
  "createdAt": null,
  "updatedAt": null,
  "_links": {
    "self": { … },
    "status": { … },
    "startAuthorization": { … },
    "scaRedirect": { … },
    "next": { … },
    "prev": { … }
  },
  "batchBookingPreferred": true,
  "payments": [
    { … }
  ]
}

Get payment status

Request

Security

Api access(Required scopes:

services.banking

api

)

Path

paymentServicestringrequired

Enum"payments""bulkPayments"

paymentProductstringrequired

Enum"creditTransfer""directDebit"

paymentIdstringrequired

Id of the payment initiation

Headers

PSU-IP-Addressstring

IP Address of the PSU.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring

The banking channel.

Enum"unspecified""openBanking""psd2"

Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

/: Use all resources available.
/subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
/subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.

Example: /subscriptions/7fdf00601dfb/resource-groups/my-company

api-versionstring

No request payload

Responses

Bodyapplication/json

paymentIdstring

Id of the payment initiation

Example: "A30D7108-A584-4C32-95ED-8FF4BB5A7C2C"

transactionStatusstring

Status of the payment

Enum Value	Description
accc	`AcceptedSettlementCompleted` - Settlement on the creditor account has been completed.
accp	`AcceptedCustomerProfile` - Preceding check of technical validation was successful. Customer profile check was also successful.
acsc	`AcceptedSettlementCompleted` - Settlement on the debtor account has been completed. Usage: this can be used by the first agent to report to the debtor that the transaction has been completed. Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement.
acsp	`AcceptedSettlementInProcess` - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
actc	`AcceptedTechnicalValidation` - Authentication and syntactical and semantical validation are successful.
acwc	`AcceptedWithChange` - Instruction is accepted but a change will be made, such as date or remittance not sent.
acwp	`AcceptedWithoutPosting` - Payment instruction included in the credit transfer is accepted without being posted to the creditor customers account.
rcvd	`Received` - Payment initiation has been received by the receiving agent.
pdng	`Pending` - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
rjct	`Rejected` - Payment initiation or individual transaction included in the payment initiation has been rejected.

Example: "pdng"

tppMessageArray of objects(TppMessage)

Messages on operational issues.

_linksobject

Response

application/json

{
  "paymentId": "A30D7108-A584-4C32-95ED-8FF4BB5A7C2C",
  "transactionStatus": "pdng",
  "tppMessage": [
    { … }
  ],
  "_links": {
    "self": { … },
    "status": { … },
    "startAuthorization": { … },
    "scaRedirect": { … }
  }
}

Start authorization

Request

Security

Api access(Required scopes:

services.banking

api

)

Path

paymentServicestringrequired

Enum"payments""bulkPayments"

paymentProductstringrequired

Enum"creditTransfer""directDebit"

paymentIdstringrequired

Id of the payment initiation

Headers

TPP-Redirect-URIstring(uri)

The url to redirect the user to after authorization.

PSU-IP-Addressstring

IP Address of the PSU.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring

The banking channel.

Enum"unspecified""openBanking""psd2"

Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

/: Use all resources available.
/subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
/subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.

Example: /subscriptions/7fdf00601dfb/resource-groups/my-company

api-versionstring

Body

Authentication method configuration.

authenticationMethodIdnull or string

Identification used for later authentication method selection.

authenticationMethodAcrValuesnull or string

Acr values used for later authentication method selection.

{
  "authenticationMethodId": null,
  "authenticationMethodAcrValues": null
}

Responses

Created

Bodyapplication/json

scaStatusstring

Status of the SCA.

Example:

received
psuIdentified
psuAuthenticated
scaMethodSelected
unconfirmed
started
finalised
failed
exempted

Example: "started"

authorizationIdstring

Resource identification of the related SCA.

Example: "auth9000"

_linksobject

Response

application/json

{
  "scaStatus": "started",
  "authorizationId": "auth9000",
  "_links": {
    "scaRedirect": { … },
    "scaOauth": "https://id.aritma.io",
    "confirmation": "https://banking.aritma.io/api/payments/1/authorizations/1",
    "self": { … }
  }
}

Update authorization

Request

Security

User access(Required scopes:

services.banking

)

Path

paymentServicestringrequired

Enum"payments""bulkPayments"

paymentProductstringrequired

Enum"creditTransfer""directDebit"

paymentIdstringrequired

Id of the payment initiation

authorizationIdstringrequired

Id of the payment authorization

Headers

PSU-IP-Addressstring

IP Address of the PSU.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring

The banking channel.

Enum"unspecified""openBanking""psd2"

Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

/: Use all resources available.
/subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
/subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.

Example: /subscriptions/7fdf00601dfb/resource-groups/my-company

api-versionstring

No request payload

Responses

Unauthorized

Bodyapplication/json

typenull or string

titlenull or string

statusnull or integer(int32)

detailnull or string

instancenull or string

property name*anyadditional property

Response

application/json

{
  "type": "https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized",
  "title": "Access unauthorized",
  "status": 401,
  "detail": "",
  "traceId": "00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01"
}

Cancel a payment.

Request

This endpoint is used to cancel/delete a payment resource based on the provided service, product, and payment Id.

Security

Api access(Required scopes:

services.banking

api

)

Path

paymentServicestringrequired

The payment service.

Enum"payments""bulkPayments"

paymentProductstringrequired

The payment product.

Enum"creditTransfer""directDebit"

paymentIdstringrequired

The unique identifier of the payment.

Headers

PSU-IP-Addressstring

IP Address of the PSU.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring

The banking channel.

Enum"unspecified""openBanking""psd2"

Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

/: Use all resources available.
/subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
/subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.

Example: /subscriptions/7fdf00601dfb/resource-groups/my-company

api-versionstring

No request payload

Responses

Accepted

Bodyapplication/json

paymentIdstring

Id of the payment initiation

Example: "A30D7108-A584-4C32-95ED-8FF4BB5A7C2C"

transactionStatusstring

Status of the payment

Enum Value	Description
accc	`AcceptedSettlementCompleted` - Settlement on the creditor account has been completed.
accp	`AcceptedCustomerProfile` - Preceding check of technical validation was successful. Customer profile check was also successful.
acsc	`AcceptedSettlementCompleted` - Settlement on the debtor account has been completed. Usage: this can be used by the first agent to report to the debtor that the transaction has been completed. Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement.
acsp	`AcceptedSettlementInProcess` - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
actc	`AcceptedTechnicalValidation` - Authentication and syntactical and semantical validation are successful.
acwc	`AcceptedWithChange` - Instruction is accepted but a change will be made, such as date or remittance not sent.
acwp	`AcceptedWithoutPosting` - Payment instruction included in the credit transfer is accepted without being posted to the creditor customers account.
rcvd	`Received` - Payment initiation has been received by the receiving agent.
pdng	`Pending` - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
rjct	`Rejected` - Payment initiation or individual transaction included in the payment initiation has been rejected.

Example: "pdng"

Response

application/json

{
  "paymentId": "A30D7108-A584-4C32-95ED-8FF4BB5A7C2C",
  "transactionStatus": "pdng"
}

Get payment information

Request

Security

Api access(Required scopes:

services.banking

api

)

Path

paymentProductstringrequired

Enum"creditTransfer""directDebit"

paymentIdstringrequired

Id of the payment initiation

Query

cursorstring

A reference to a specific page

Headers

PSU-IP-Addressstring

IP Address of the PSU.

Consent-IDstring

The consent id. Should be set unless a specific Subscription-Id is used.

Channel-Typestring

The banking channel.

Enum"unspecified""openBanking""psd2"

Subscription-Idstring^[A-Za-z0-9_-]+$

Id of the subscription to use. Only supported for Channel-Type openBanking.

Resource-Group-Namestring^[A-Za-z0-9_-]+$

Name of the resource group to use in the specified subscription. Only supported for Channel-Type openBanking

ScopesArray of strings

Resource scopes to use, mutually exclusive with subscriptionId.

/: Use all resources available.
/subscriptions/7fdf00601dfb: Use all resources in subscription 7fdf00601dfb.
/subscriptions/7fdf00601dfb/resource-groups/my-company: Use all resources within subscription 7fdf00601dfb and resource-group my-company.

Example: /subscriptions/7fdf00601dfb/resource-groups/my-company

api-versionstring

No request payload

Responses

Bodyapplication/json

paymentIdstring

Id of the payment initiation

Example: "A30D7108-A584-4C32-95ED-8FF4BB5A7C2C"

transactionStatusstring

Status of the payment

Enum Value	Description
accc	`AcceptedSettlementCompleted` - Settlement on the creditor account has been completed.
accp	`AcceptedCustomerProfile` - Preceding check of technical validation was successful. Customer profile check was also successful.
acsc	`AcceptedSettlementCompleted` - Settlement on the debtor account has been completed. Usage: this can be used by the first agent to report to the debtor that the transaction has been completed. Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement.
acsp	`AcceptedSettlementInProcess` - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
actc	`AcceptedTechnicalValidation` - Authentication and syntactical and semantical validation are successful.
acwc	`AcceptedWithChange` - Instruction is accepted but a change will be made, such as date or remittance not sent.
acwp	`AcceptedWithoutPosting` - Payment instruction included in the credit transfer is accepted without being posted to the creditor customers account.
rcvd	`Received` - Payment initiation has been received by the receiving agent.
pdng	`Pending` - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
rjct	`Rejected` - Payment initiation or individual transaction included in the payment initiation has been rejected.

Example: "pdng"

tppMessageArray of objects(TppMessage)

Messages on operational issues.

requestedExecutionDatenull or string(date)

debtorAccountobject

Account reference

debtorNamenull or string

Debtor name

debtorAddressnull

Debtor address

createdAtnull or string(date-time)

updatedAtnull or string(date-time)

_linksobject

endToEndIdentificationnull or string<= 35 characters

End to end identification

instructedAmountobjectrequired

Instructed amount

instructedAmount.currencynull or string

The three-letter currency code of the amount - ISO 4217

Example: "NOK"

instructedAmount.amountnull or string-?[0-9]{1,14}(\.[0-9]{1,3})?

The amount value. Negative amounts are signed by minus. The decimal separator is a dot.

Example:

0
154
-1.75
349.7
3632.78

Example: 3632.78

creditorAccountobjectrequired

Creditor account

creditorAccount.ibannull or string[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

IBAN of the account

Example: "FR7612345987650123456789014"

creditorAccount.bbannull or string[a-zA-Z0-9]{1,30}

BBAN of the account - ISO 20022

Example: "BARC12345612345678"

creditorAccount.othernull

Generic account reference.

creditorAccount.currencynull or string[A-Z]{3}

Currency code - ISO 4217

Example: "EUR"

creditorAgentnull or string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...

BICFI

Example: "DNBANOKK"

creditorAgentCountryCodenull or string[A-Z]{2}

Country code of the creditor agent.

Example: "NO"

creditorAgentClearingSystemnull

Information about a clearing system member, which might be required for payments to non EEA member states.

creditorNamestring[ 1 .. 70 ] charactersrequired

Creditor name

Example: "Ola"

creditorAddressnull

Creditor address

remittanceInformationUnstructurednull or string<= 140 characters

Unstructured remittance information

Example: "message"

remittanceInformationStructurednull

Structured remittance information

remittanceInformationStructuredArrayArray of objects or null(RemittanceInformation)

purposeCodenull or string

ISO 20022 ExternalPurpose1Code

purposeProprietarynull or string<= 35 characters

Purpose in a proprietary form.

regulatoryReportingAmountnull

Amount with currency

regulatoryReportingCodenull or string

Regulatory reporting code

Example: 26

regulatoryReportingInformationnull or string

Regulatory reporting info

Example: "Rent"

bundleReferencenull or string

Reference that can be used for choosing what payments will be bundled together

Example: "bundle-id-123456789"

instructionPrioritynull

Response

application/json

{
  "paymentId": "A30D7108-A584-4C32-95ED-8FF4BB5A7C2C",
  "transactionStatus": "pdng",
  "tppMessage": [
    { … }
  ],
  "requestedExecutionDate": null,
  "debtorAccount": {
    "iban": "FR7612345987650123456789014",
    "bban": "BARC12345612345678",
    "other": { … },
    "currency": "EUR",
    "pan": 5409050000000000,
    "maskedPan": "123456xxxxxx1234",
    "msisdn": "+491701234567"
  },
  "debtorName": null,
  "debtorAddress": {
    "streetName": null,
    "buildingNumber": null,
    "postCode": null,
    "townName": null,
    "country": "string"
  },
  "createdAt": null,
  "updatedAt": null,
  "_links": {
    "self": { … },
    "status": { … },
    "startAuthorization": { … },
    "scaRedirect": { … }
  },
  "endToEndIdentification": null,
  "instructedAmount": {
    "currency": "NOK",
    "amount": 3632.78
  },
  "creditorAccount": {
    "iban": "FR7612345987650123456789014",
    "bban": "BARC12345612345678",
    "other": { … },
    "currency": "EUR"
  },
  "creditorAgent": "DNBANOKK",
  "creditorAgentCountryCode": "NO",
  "creditorAgentClearingSystem": {
    "memberId": "USABA123456789"
  },
  "creditorName": "Ola",
  "creditorAddress": {
    "streetName": null,
    "buildingNumber": null,
    "postCode": null,
    "townName": null,
    "country": "string"
  },
  "remittanceInformationUnstructured": "message",
  "remittanceInformationStructured": {
    "reference": 777588823,
    "referenceType": "SCOR",
    "referenceIssuer": null
  },
  "remittanceInformationStructuredArray": null,
  "purposeCode": null,
  "purposeProprietary": null,
  "regulatoryReportingAmount": {
    "currency": "NOK",
    "amount": 3632.78
  },
  "regulatoryReportingCode": 26,
  "regulatoryReportingInformation": "Rent",
  "bundleReference": "bundle-id-123456789",
  "instructionPriority": "normal"
}

SigningBaskets

Signing baskets are short-lived vessels used for authorizing several payments with one SCA operation.

Operations

Aritma Banking API (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

API versioning

Idempotency

Accounts

Banks

Consents

Payments

Bulk payment initiation

Request

Responses

Was this helpful?

Get bulk payments

Request

Responses

Was this helpful?

Get bulk-payment information

Request

Responses

Was this helpful?

Get payment status

Request

Responses

Was this helpful?

Start authorization

Request

Responses

Was this helpful?

Update authorization

Request

Responses

Was this helpful?

Cancel a payment.

Request

Responses

Was this helpful?

Get payment information

Request

Responses

Was this helpful?

SigningBaskets

Aritma Banking API (1.0.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

API versioning

Idempotency

Accounts

Banks

Consents

Payments

Bulk payment initiation

RequestExpand all

Responses

Was this helpful?

Get bulk payments

Request

Responses

Was this helpful?

Get bulk-payment information

Request

Responses

Was this helpful?

Get payment status

Request

Responses

Was this helpful?

Start authorization

Request

Responses

Was this helpful?

Update authorization

Request

Responses

Was this helpful?

Cancel a payment.

Request

Responses

Was this helpful?

Get payment information

Request

Responses

Was this helpful?

SigningBaskets

Aritma Banking API (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Request