Skip to content

PaymentChannelConfig ​

Beta

Salaxy API v04 is in beta: it may change, and it is not used in production yet. Build on v03, the current version.

The payment channel config of the current company: its own values that a payment channel needs to pay for it, such as the ID the provider gave the company and the account the provider debits. At most one per channel, in the company settings (payments.channelConfigs[]) like settings/dimensions, and never inherited through a service model. A config of a channel that is no longer available to the company, for example after a partner's authorization is removed, can only be read or deleted. Every call acts for the account of the token; partners use the impersonation token. Every write is a version in the settings' history with the user and the account. The ETag is the config's own, so a change elsewhere in the settings does not change it; when the settings keep changing during a write, it answers 409 concurrent-change after three attempts. If-Match makes a write fail with 412 when the config changed since the caller's read or is missing; If-None-Match: * makes a PUT create-only. Errors are problem details (RFC 9457, application/problem+json): a client branches on type; title and detail follow Accept-Language (fi or en, Finnish by default); a 422 has the messages per field in errors. An unexpected error is 500 internal-error.

Salaxy API v04 (beta), Finland only. 4 operations. Interactive version: REST API reference. Machine-readable: OpenAPI document.

The reference wins

These pages are generated from the OpenAPI document. If a guide and this reference disagree about a field, follow the reference. Error responses are not in the document — see Errors.

GET /v04/api/settings/payment-channels/nordea/config ​

The company's payment channel config of a channel, with its version in the ETag header.

Response: NordeaPaymentChannelConfig

Try it: interactive reference

PUT /v04/api/settings/payment-channels/nordea/config ​

Creates the company's payment channel config of a channel, or replaces it. Idempotent: a retry is safe. The IBAN is stored without spaces; a missing BIC is filled from the IBAN. data takes only the keys the channel declares; Nordea CA Lite requires agreementId. Returns 201 with a Location header the first time, then 200; the new version is in the ETag header.

ParameterInTypeRequiredDescription
If-Matchheaderstring
If-None-Matchheaderstring

Request body: NordeaPaymentChannelConfig (required)

Response: NordeaPaymentChannelConfig

Try it: interactive reference

PATCH /v04/api/settings/payment-channels/nordea/config ​

Changes named fields of the company's payment channel config of a channel with a JSON Merge Patch (RFC 7396), sent as application/merge-patch+json: a field with a value is set, a field with null is cleared, a missing field is unchanged, and debitAccount and data merge field by field. A patch that changes the IBAN without a BIC refills the BIC from the new IBAN. The patched config is validated like a PUT; the new version is in the ETag header. Every response has Accept-Patch: application/merge-patch+json.

ParameterInTypeRequiredDescription
If-Matchheaderstring

Request body: NordeaPaymentChannelConfigPatch (required)

Response: NordeaPaymentChannelConfig

Try it: interactive reference

DELETE /v04/api/settings/payment-channels/nordea/config ​

Removes the company's payment channel config of a channel.

ParameterInTypeRequiredDescription
If-Matchheaderstring

Response: No Content

Try it: interactive reference

Every page is also available as Markdown: add .md to its URL — a folder page such as white-label/ is white-label/index.md. Index for LLMs: llms.txt. Questions: Support.