OP Corporate International Payment Tracking API (1.0.2)

Download OpenAPI specification:Download

OP Corporate International Payment Tracking API provides OP corporate customers up-to-date access to the moves of outgoing international payments.
Currently the API is in development phase, and we welcome any feedback based on the API documentation. The comments and questions may be sent to corp-payment-APIs@op.fi.

Authentication

Authentication in OP Corporate Banking APIs is based on practices from OpenID Connect (OIDC) 1.0 and OAuth 2.0.

Security Considerations

It is extremely important that the clientId, clientSecret and client 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 for endpoint Outbound international payment details
Section Usage example removed
Servers information added

V1.0 (06/2023)

Initial version

Outbound international payment details

header Parameters

authorization required	string Example: Bearer 6c18c234b1b18b1d97c7043e2e41135c293d0da9 Bearer JWT token
x-request-id required	string <uuid> Unique identifier for a specific request. Used for debugging purposes.

Request Body schema: application/json

Outbound payments details request

account required	string^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ Creditor account number
archiveId required	string [ 16 .. 20 ] characters Payment archive ID (filing code). The archive ID should have 16, 18 or 20 characters, and 12th character from the right should be the number 5.

Responses

Request samples

Content type

application/json

{"account": "FI4550009420888888",
"archiveId": "20190524593156999999"
}

Response samples

200
400
403
404
500

Content type

application/json; charset=UTF-8

Example

Returns payment events related to a serial transaction

{"completionTime": "2020-08-30T17:00:00.000Z",
"initiationTime": "2020-08-30T09:00:00.000Z",
"lastUpdateTime": "2020-08-30T17:00:00.000Z",
"steps": [{"chargeAmount": [{"currency": "USD",
"amount": "10"
}
],
"chargeBearer": "CRED",
"fromBic": "BANABEBBXXX",
"instructedAmount": {"currency": "USD",
"amount": "1000"
},
"isReturnPayment": false,
"lastUpdateTime": "2020-08-30T09:30:01.000Z",
"receivedTime": "2020-08-30T09:30:01.000Z",
"senderAcknowledgementReceiptTime": "2020-08-30T09:30:00.000Z",
"status": "INPROCESS",
"toBic": "BANBUS33XXX"
},
{"chargeAmount": [{"currency": "USD",
"amount": "10"
},
{"currency": "USD",
"amount": "20"
}
],
"chargeBearer": "CRED",
"confirmedAmount": {"currency": "USD",
"amount": "970"
},
"fromBic": "BANBUS33XXX",
"isReturnPayment": false,
"lastUpdateTime": "2020-08-30T10:00:00.000Z",
"senderAcknowledgementReceiptTime": "2020-08-30T10:00:00.000Z",
"status": "INPROCESS",
"toBic": "TRCKCHZZXXX"
},
{"chargeAmount": [{"currency": "USD",
"amount": "10"
},
{"currency": "USD",
"amount": "20"
},
{"currency": "USD",
"amount": "30"
}
],
"chargeBearer": "CRED",
"fromBic": "BANCUS33XXX",
"instructedAmount": {"currency": "USD",
"amount": "1000"
},
"isReturnPayment": false,
"lastUpdateTime": "2020-08-30T10:30:01.000Z",
"receivedTime": "2020-08-30T10:30:01.000Z",
"senderAcknowledgementReceiptTime": "2020-08-30T10:30:00.000Z",
"status": "COMPLETED",
"toBic": "BANDJPJTXXX"
},
{"chargeAmount": [{"currency": "USD",
"amount": "10"
},
{"currency": "USD",
"amount": "20"
},
{"currency": "USD",
"amount": "30"
},
{"currency": "USD",
"amount": "40"
}
],
"chargeBearer": "CRED",
"confirmedAmount": {"currency": "USD",
"amount": "900"
},
"fromBic": "BANDJPJTXXX",
"fundsAvailableTime": "2020-08-30T17:00:00.000Z",
"isReturnPayment": false,
"lastUpdateTime": "2020-08-30T17:00:00.000Z",
"senderAcknowledgementReceiptTime": "2020-08-30T17:00:00.000Z",
"status": "COMPLETED",
"toBic": "TRCKCHZZXXX"
}
],
"status": "COMPLETED",
"uetr": "97ed4827-7b6f-4491-a06f-b548d5a7512d"
}