Skip to content
API Reference
/
/
Get bulk payments

Aritma Banking API (1.0.0)

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
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/banking/v4/openapi/banking-openapi
https://banking.zdata.io/api

Accounts

Read account information. Provides access to account lists, account details, balances and transaction 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

Initiate bulk payment

Request

All payments in the bulk must share the same debtor account (or creditor account for direct-debit payments) and requested execution date.

Security
Api access(Required scopes:
services.banking
api
)
Path
paymentProductstring(PaymentProduct)required

The payment product type.

Enum ValueDescription
credit-transfer

Represents a payment made using the credit transfer method.

credit-transfer

direct-debit

Represents a payment method where funds are withdrawn directly from a bank account using direct debit.

direct-debit

Example: credit-transfer
Headers
TPP-Redirect-URIstring(uri)

The URI to redirect the PSU to after authorisation.

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(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
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
Bodyapplication/json

Bulk payment details including debtor account (or creditor account for direct-debit payments) and payment lines.

debtorAccountobject(AccountNumbers)required
ibannull or string[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

IBAN of the account

Example: "FR7612345987650123456789014"
bbannull or string[a-zA-Z0-9]{1,30}

BBAN of the account - ISO 20022

Example: "BARC12345612345678"
otherobject(GenericAccountDto)

Generic account reference.

currencynull or string[A-Z]{3}

Currency code - ISO 4217

Example: "EUR"
debtorNamenull or string

Debtor name.

Example: "Max Mustermann"
debtorAddressobject(Address)

Postal address.

batchBookingPreferredboolean

If set to true, the payment service provider should attempt to book all transactions in a single batch.

requestedExecutionDatenull or string(date)

The requested execution date of the payment.

paymentLinesArray of objects(PaymentLine)non-empty

The individual payment lines within the bulk payment.

application/json
{
  "debtorAccount": {
    "iban": "FR7612345987650123456789014",
    "bban": "BARC12345612345678",
    "other": { … },
    "currency": "EUR"
  },
  "debtorName": "Max Mustermann",
  "debtorAddress": {
    "streetName": "Storgata",
    "buildingNumber": "56",
    "postCode": "0182",
    "townName": "Oslo",
    "country": "NO"
  },
  "batchBookingPreferred": true,
  "requestedExecutionDate": null,
  "paymentLines": [
    { … }
  ]
}

Responses

Created

Bodyapplication/json
paymentIdstring

Resource identifier of the bulk payment initiation.

Example: "p1b52718ebabcd14affa29261a32d864557"
transactionStatusstring(TransactionStatus)
Enum ValueDescription
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.

_linksobject(PaymentInitiationLinks)

Links related to a payment initiation, including authorisation links.

paymentsArray of objects(PaymentReference)

A list of payment references.

Response
application/json
{
  "paymentId": "p1b52718ebabcd14affa29261a32d864557",
  "transactionStatus": "accc",
  "_links": {
    "self": { … },
    "status": { … },
    "startAuthorization": { … },
    "scaRedirect": { … }
  },
  "payments": [
    { … }
  ]
}

Get bulk payments

Request

Security
Api access(Required scopes:
services.banking
api
)
Path
paymentProductstring(PaymentProduct)required

The payment product type.

Enum ValueDescription
credit-transfer

Represents a payment made using the credit transfer method.

credit-transfer

direct-debit

Represents a payment method where funds are withdrawn directly from a bank account using direct debit.

direct-debit

Example: credit-transfer
Query
createdFromstring

Only payments created after this date will be fetched.

createdTostring

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

updatedFromstring

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

updatedTostring

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 updatedFrom if specified.

statusstring(TransactionStatus)

Filter payments by transaction status.

Enum ValueDescription
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: status=accc
accountIdstring

Resource identifier of the account to get payments for.

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(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
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

OK

Bodyapplication/json
paymentsArray of objects(PaymentLinksBulkPaymentResponse)
_linksobject(Links)

Pagination links for navigating between pages of results.

Response
application/json
{
  "payments": [
    { … }
  ],
  "_links": {
    "next": { … },
    "previous": { … }
  }
}

Get bulk payment information

Request

Security
Api access(Required scopes:
services.banking
api
)
Path
paymentProductstring(PaymentProduct)required

The payment product type.

Enum ValueDescription
credit-transfer

Represents a payment made using the credit transfer method.

credit-transfer

direct-debit

Represents a payment method where funds are withdrawn directly from a bank account using direct debit.

direct-debit

Example: credit-transfer
paymentIdstringrequired

Resource identifier of the bulk payment initiation.

Example: p1b52718ebabcd14affa29261a32d864557
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(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
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

OK

Bodyapplication/json
paymentIdstring

Resource identifier of the payment initiation.

Example: "p1pbb64b18233714bf38204314e3faa03bc"
transactionStatusstring(TransactionStatus)
Enum ValueDescription
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.

tppMessageArray of objects(TppMessage)

Messages from the ASPSP to the TPP on operational issues.

requestedExecutionDatenull or string(date)

The requested execution date of the payment.

debtorAccountobject(AccountReference)

Account reference

debtorNamenull or string

Debtor name.

Example: "Max Mustermann"
debtorAddressobject(Address)

Postal address.

createdAtnull or string(date-time)

Timestamp when the payment was created.

updatedAtnull or string(date-time)

Timestamp when the payment was last updated.

_linksobject(PagedPaymentInitiationLinks)

Links related to a paged payment initiation response.

batchBookingPreferredboolean

If set to true, the payment service provider should attempt to book all transactions in a single batch.

paymentsArray of objects(PaymentLineResponseDto)

The individual payment lines within the bulk payment.

Response
application/json
{
  "paymentId": "p1pbb64b18233714bf38204314e3faa03bc",
  "transactionStatus": "accc",
  "tppMessage": [
    { … }
  ],
  "requestedExecutionDate": null,
  "debtorAccount": {
    "iban": "FR7612345987650123456789014",
    "bban": "BARC12345612345678",
    "other": { … },
    "currency": "EUR",
    "pan": "5409050000000000",
    "maskedPan": "123456xxxxxx1234",
    "msisdn": "+491701234567"
  },
  "debtorName": "Max Mustermann",
  "debtorAddress": {
    "streetName": "Storgata",
    "buildingNumber": "56",
    "postCode": "0182",
    "townName": "Oslo",
    "country": "NO"
  },
  "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
paymentProductstring(PaymentProduct)required

The payment product type.

Enum ValueDescription
credit-transfer

Represents a payment made using the credit transfer method.

credit-transfer

direct-debit

Represents a payment method where funds are withdrawn directly from a bank account using direct debit.

direct-debit

Example: credit-transfer
paymentIdstringrequired

Resource identifier of the payment initiation.

Example: p1pbb64b18233714bf38204314e3faa03bc
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(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
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

OK

Bodyapplication/json
paymentIdstring

Resource identifier of the payment initiation.

Example: "p1pbb64b18233714bf38204314e3faa03bc"
transactionStatusstring(TransactionStatus)
Enum ValueDescription
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.

tppMessageArray of objects(TppMessage)

Messages from the ASPSP to the TPP on operational issues.

_linksobject(PaymentInitiationLinks)

Links related to a payment initiation, including authorisation links.

Response
application/json
{
  "paymentId": "p1pbb64b18233714bf38204314e3faa03bc",
  "transactionStatus": "accc",
  "tppMessage": [
    { … }
  ],
  "_links": {
    "self": { … },
    "status": { … },
    "startAuthorization": { … },
    "scaRedirect": { … }
  }
}

Start authorisation

Request

The PSU will be redirected to complete Strong Customer Authentication (SCA).

Security
Api access(Required scopes:
services.banking
api
)
Path
paymentProductstring(PaymentProduct)required

The payment product type.

Enum ValueDescription
credit-transfer

Represents a payment made using the credit transfer method.

credit-transfer

direct-debit

Represents a payment method where funds are withdrawn directly from a bank account using direct debit.

direct-debit

Example: credit-transfer
paymentIdstringrequired

Resource identifier of the payment initiation.

Example: p1pbb64b18233714bf38204314e3faa03bc
Headers
TPP-Redirect-URIstring(uri)

The URI to redirect the PSU to after authorisation.

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(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
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
Bodyapplication/json

Authentication method selection.

authenticationMethodIdnull or string

Identification used for later authentication method selection.

authenticationMethodAcrValuesnull or string

Acr values used for later authentication method selection.

application/json
{
  "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(PaymentAuthorizationLinks)
Response
application/json
{
  "scaStatus": "started",
  "authorizationId": "auth9000",
  "_links": {
    "scaRedirect": { … },
    "scaOauth": { … },
    "confirmation": { … },
    "self": { … }
  }
}

Update authorisation

Request

Called after the PSU has completed the redirect SCA flow.

Security
User access(Required scopes:
services.banking
)
Path
paymentProductstring(PaymentProduct)required

The payment product type.

Enum ValueDescription
credit-transfer

Represents a payment made using the credit transfer method.

credit-transfer

direct-debit

Represents a payment method where funds are withdrawn directly from a bank account using direct debit.

direct-debit

Example: credit-transfer
paymentIdstringrequired

Resource identifier of the payment initiation.

Example: p1pbb64b18233714bf38204314e3faa03bc
authorizationIdstringrequired

Resource identifier of the authorisation sub-resource.

Example: auth9000
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(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
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

OK

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(PaymentAuthorizationLinks)
Response
application/json
{
  "scaStatus": "started",
  "authorizationId": "auth9000",
  "_links": {
    "scaRedirect": { … },
    "scaOauth": { … },
    "confirmation": { … },
    "self": { … }
  }
}

Get payment information

Request

Security
Api access(Required scopes:
services.banking
api
)
Path
paymentProductstring(PaymentProduct)required

The payment product type.

Enum ValueDescription
credit-transfer

Represents a payment made using the credit transfer method.

credit-transfer

direct-debit

Represents a payment method where funds are withdrawn directly from a bank account using direct debit.

direct-debit

Example: credit-transfer
paymentIdstringrequired

Resource identifier of the payment initiation.

Example: p1pbb64b18233714bf38204314e3faa03bc
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(BankingChannel)

The banking channel.

Enum"unspecified""openBanking""psd2"
Example: unspecified
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

OK

Bodyapplication/json
paymentIdstring

Resource identifier of the payment initiation.

Example: "p1pbb64b18233714bf38204314e3faa03bc"
transactionStatusstring(TransactionStatus)
Enum ValueDescription
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.

tppMessageArray of objects(TppMessage)

Messages from the ASPSP to the TPP on operational issues.

requestedExecutionDatenull or string(date)

The requested execution date of the payment.

debtorAccountobject(AccountReference)

Account reference

debtorNamenull or string

Debtor name.

Example: "Max Mustermann"
debtorAddressobject(Address)

Postal address.

createdAtnull or string(date-time)

Timestamp when the payment was created.

updatedAtnull or string(date-time)

Timestamp when the payment was last updated.

_linksobject(PaymentInitiationLinks)

Links related to a payment initiation, including authorisation links.

endToEndIdentificationnull or string<= 35 characters

End to end identification

instructedAmountobject(Money)required

Amount with currency

currencynull or string

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

Example: "NOK"
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"
creditorAccountobject(AccountNumbers)required
ibannull or string[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

IBAN of the account

Example: "FR7612345987650123456789014"
bbannull or string[a-zA-Z0-9]{1,30}

BBAN of the account - ISO 20022

Example: "BARC12345612345678"
otherobject(GenericAccountDto)

Generic account reference.

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"
creditorAgentClearingSystemobject(ClearingSystemDto)

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"
creditorAddressobject(Address)

Postal address.

remittanceInformationUnstructurednull or string<= 140 characters

Unstructured remittance information

Example: "message"
remittanceInformationStructuredobject(RemittanceInformation)

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.

regulatoryReportingAmountobject(Money)

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"
instructionPrioritystring(InstructionPriorityCode)

Indictator of the urgency or order of importance that the payment is requested processed.

Enum ValueDescription
normal

Standard payment with normal priority (D+1).

high

Standard payment with high priority (D+0).

urgent

Urgent payment (instant payment).

Response
application/json
{
  "paymentId": "p1pbb64b18233714bf38204314e3faa03bc",
  "transactionStatus": "accc",
  "tppMessage": [
    { … }
  ],
  "requestedExecutionDate": null,
  "debtorAccount": {
    "iban": "FR7612345987650123456789014",
    "bban": "BARC12345612345678",
    "other": { … },
    "currency": "EUR",
    "pan": "5409050000000000",
    "maskedPan": "123456xxxxxx1234",
    "msisdn": "+491701234567"
  },
  "debtorName": "Max Mustermann",
  "debtorAddress": {
    "streetName": "Storgata",
    "buildingNumber": "56",
    "postCode": "0182",
    "townName": "Oslo",
    "country": "NO"
  },
  "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": "Storgata",
    "buildingNumber": "56",
    "postCode": "0182",
    "townName": "Oslo",
    "country": "NO"
  },
  "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

A signing basket groups multiple payments for authorisation with a single SCA operation. The basket can contain both bulk payments and individual payment lines, each with different authorisation requirements. Payments are exported to bank as soon as their authorisation requirements are fulfilled, even if other payments in the basket are still pending.

Operations