OP Corporate Transaction Info API (1.0.2)
Download OpenAPI specification:Download
OP Corporate Transaction Info API provides OP's corporate customers
with more information about transactions on their account for reconciliation
purposes. The API returns the payer name and payer address for credit
transactions on the corporate account when the payment has been originated
from an OP account.
Authentication in OP Corporate Transaction Info API is based on practices from OpenID Connect (OIDC) 1.0 and OAuth 2.0.
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.
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.
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/
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
Changed
- Usage example section removed
- Servers updated
V1.0 (12/2021)
Initial version
Payer details
Returns name and address of the payer
header Parameters
authorization required | string Example: Bearer 6c18c234b1b18b1d97c7043e2e41135c293d0da9 Bearer JWT token |
X-Request-ID | string Example: 1afb1874-5bd5-4c5a-9dbb-21a66ab23a85 Unique identifier for a specific request. Used for debugging purposes |
Request Body schema: application/json; charset=UTF-8required
Details of the transaction to be queried.
accountIban required | string IBAN account which has received the original payment. |
archiveId required | string [ 16 .. 20 ] characters Accepted format for the archive id is a string of 16, 18 or 20 characters. |
Responses
Request samples
- Payload
- CLI
- C#
- Java
- Node.js
- PHP
- Python
- CURL
{- "archiveId": "20190524593156999999",
- "accountIban": "FI4550009420888888"
}
Response samples
- 200
- 400
- 403
- 404
- 500
{- "archiveId": "20190524593156999999",
- "amount": "10.00",
- "debtorName": "Debbie Debtor",
- "debtorAddress": {
- "streetAddress": "Hallituskatu 22",
- "postalCode": "90100",
- "city": "Oulu",
- "country": "FI"
}
}