Partner API
This documentation covers how a partner of Dintero can use the API to manage their merchants.
Managing a merchant account
You will need to include the access token obtained through the authorization flow in described in [Getting API access to a merchant account] and use the access_token
as the Authorization header of your request.
[Merchant account API access]: /docs/partners/partners-merchant-api-access
Get the account details
Retrieve details about the merchant, this response also includes the optional applicant.signup_reference
that was used during the merchant onboarding.
Creating API clients and grants
Creating a new API client is a two step process where you first create an API client, and then delegate grants to the client
1. Create the API client
POST https://api.dintero.com/v1/accounts/{merchant_account_id}/auth/clients
Authorization: Bearer {access_token}
Content-Type: application/json
{
"name": "API client for e-commerce",
"description": "Created by partner",
"client_id": "ecom-123",
}
Response example
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "API client for e-commerce",
"description": "Created by partner",
"client_id": "ecom-123",
"client_secret": "JYCRP/x7iBGWA1fun0J9laH5sEg5cP9g/4QivhfGzm4",
...
}
2. Create client grants
Note that the client_id
in this request is the id
returned in the fist step.
POST https://api.dintero.com/v1/accounts/{merchant_account_id}/auth/client-grants
Authorization: Bearer {access_token}
Content-Type: application/json
{
"client_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"audience": "https://api.dintero.com/v1/accounts/{merchant_account_id}",
"scope": [
"checkout:admin"
],
"type": "client_credentials"
}
Managing payment profiles
- Create a new payment profile API reference
- List payment profiles API reference
- Update a payment profile API reference
Reports
A Dintero merchant can have two types of reports, Settlement Reports and scheduled custom Insight Reports.
Settlement reports
Settlement reports are created when the settlements are paid out by the payment processors eg, Dintero Payout, Vipps, Swedbank Pay, Bambora, Walley and Klarna. See our payouts guide our for when to expect a settlement after a transaction is captured.
Each item in the List settlements can contain multiple attachments, both the source files from the payment processor and the normalized Dintero settlement reports. You can be notified when a settlement is added by creating a webhook subscription with the settlement_add
event.
Insight reports
The insight reports are created from transaction data and they do not contain any settlement information, but they can be
useful for other purposes. Insight reports are created automatically at scheduled intervals eg. weekly
or monthly
.