API docs by Redocly

OP Corporate Transaction Filter API (1.0.2)

Download OpenAPI specification:Download

Support: corp-payment-APIs@op.fi


OP Corporate Transaction Filter returns either debit or credit transactions for one account based on the given search parameters and endpoint used.

Authentication

Authentication for OP Corporate Transaction Filter API is based on practices from OpenID Connect (OIDC) 1.0 and OAuth 2.0.

Security Considerations

It is extremely important that the Client ID, Client Secret and MTLS certificate private key are not exposed at any point. Together they represent the identity of the client and thereby the corporation. In the possession of an attacker they could be used to make fraudulent API calls potentially causing considerable damage.

Sandbox

To test the API in the sandbox environment, please send an email at corp-payment-APIs@op.fi. You will be granted a user ID and password to access OP API Admin in the sandbox environment.

Production access

You can get production access for this API on OP API Admin in production. To use these APIs in production you should replace host in the API examples below with https://api.corporate-api.op.fi/

Change log

V1.0.2 (04/2024)

Changed

  • Changed sandbox and production URLs for APIs and OP API Admin

V1.0.1 (01/2024)

Added

  • Code examples added on both endpoints.

Changed

  • Servers updated
  • Removed section Usage example

V1.0 (02/2020)

Initial version

Debit transactions

Returns debit transactions from one account based on search parameters

The parameters accountIban, startDate and endDate are mandatory. Time range is limited between 0–30 days and response to maximum of 10 transactions. You should give additional search parameters to filter transactions. These parameters are described below. If the query resulted in more than 10 transactions, the number of transactions that were left out is returned in the skipped field. Please adjust the filter parameters accordingly so that the result list corresponds with your needs.

header Parameters
Authorization
required
string
Example: Bearer 6c18c234b1b18b1d97c7043e2e41135c293d0da9

Bearer JWT token - You can get JWT token by calling
POST /corporate-oidc/v1/token

X-Request-ID
string
Example: 1afb1874-5bd5-4c5a-9dbb-21a66ab23a85

Unique identifier for request. Used for debugging purposes

Request Body schema: application/json

Search Parameters

accountIban
required
string

IBAN for the account where the debit transactions are being searched

endDate
required
string

End date for transaction query (ISO8601 format)

startDate
required
string

Start date for transaction query ( ISO8601 Format )

type
string

Indicates type of the transaction (always DEBIT)

amount
string

Payment amount. Overrides minAmount and maxAmount.

message
string

Payment message. The search parameter can be a substring of a message.

maxAmount
string

Returns transactions below maxAmount

minAmount
string

Returns transactions above minAmount

reference
string

Structured payment reference

endToEndId
string

Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

creditorName
string

Recipient name

creditorAccount
string

Recipient account IBAN

Responses

Request samples

Content type
application/json
{
  • "type": "DEBIT",
  • "amount": "14.00",
  • "endDate": "2020-01-15T15:53:00.000Z",
  • "message": "MONEY FOR NOTHING",
  • "maxAmount": "20.00",
  • "minAmount": "5.00",
  • "reference": "00000000026819569389",
  • "startDate": "2008-09-15T15:53:00.000Z",
  • "endToEndId": "544652-end2end",
  • "accountIban": "FI7450009420999999",
  • "creditorName": "MRS. ANOTHER PERSON",
  • "creditorAccount": "FI7450009420999999"
}

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "skipped": 0
}

Credit transactions

Returns credit transactions from one account based on search parameters

The parameters accountIban, startDate and endDate are mandatory. Time range is limited between 0–30 days and response to maximum of 10 transactions. You should give additional search parameters to filter transactions. These parameters are described below. If the query resulted in more than 10 transactions, the number of transactions that were left out is returned in the skipped field. Please adjust the filter parameters accordingly so that the result list corresponds with your needs.

header Parameters
Authorization
required
string
Example: Bearer 6c18c234b1b18b1d97c7043e2e41135c293d0da9

Bearer JWT token - You can get JWT token by calling
POST /corporate-oidc/v1/token

X-Request-ID
string
Example: 1afb1874-5bd5-4c5a-9dbb-21a66ab23a85

Unique identifier for request. Used for debugging purposes

Request Body schema: application/json

Search Parameters

accountIban
required
string

IBAN for the account where the credit transactions are being searched

endDate
required
string

End date for transaction query ( ISO8601 Format )

startDate
required
string

Start date for transaction query ( ISO8601 Format )

amount
string

Payment amount. Overrides minAmount and maxAmount.

message
string

Payment message. The search parameter can be a substring of a message.

maxAmount
string

Returns transactions below maxAmount

minAmount
string

Returns transactions above minAmount

reference
string

Structured payment reference

debtorName
string

Payer name

endToEndId
string

Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

Responses

Request samples

Content type
application/json
{
  • "amount": "14.00",
  • "endDate": "2020-01-15T15:53:00.000Z",
  • "message": "MONEY FOR NOTHING",
  • "maxAmount": "20.00",
  • "minAmount": "5.00",
  • "reference": "00000000026819569389",
  • "startDate": "2008-09-15T15:53:00.000Z",
  • "debtorName": "MR. PERSON",
  • "endToEndId": "544652-end2end",
  • "accountIban": "FI7450009420999999"
}

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "skipped": 0
}