Skip to content
API Reference/
/
Get payment instruction

Fondo Partner API (2.0.0)

Overview

This API is intended for registered partners in agreement with Fondo.

The API is subject to change.

Download OpenAPI description
api_3.0.3.json
api_3.0.3.yaml
Overview
E-mail
tech@fondo.se
License
Proprietary
Languages
Servers
Mock server
https://docs.fondo.se/_mock/openapi/api_3.0.3
Production
https://api.fondo.se
Sandbox
https://api.sandbox.fondo.se

Authorization

Obtain and manage access tokens via OAuth 2.0 Client Credentials. Send grant_type=client_credentials with your client_id and client_secret. Use the returned access_token in Authorization: Bearer <token>. Tokens are short-lived—reuse during validity and renew on expiry.

Operations

Accounts

Accounts hold investor positions, balances, and cash movements under a client. Endpoints let you list accounts, fetch details, and close accounts. Responses include status, owner info, currency, linked bank accounts, positions, and timestamps.

Operations

Agreements

Retrieve account agreements and generate PDF documents for account-related contracts.

Operations

AllocationPlan

Allocation plans

Operations

Clients

A client is your legal entity (B2B) or grouping for end-investor accounts. Use these endpoints to list, create, read, and update clients, manage bank accounts and service types, and fetch client-specific resources (instruments, custodians).

Operations

Custodians

Fetch custodians linked to a client—useful for transfer instructions and operational routing. Returns identifiers and names for display and validation.

Operations

Journeys (Hosted Flows)

Journeys are secure, hosted web flows for customer interactions: account opening (e-sign), KYC/KYB questionnaires, fund transfers, and allocation plan setup. Create a Journey via API, redirect customers to the time-limited URL, and poll/callback for results.

Operations

Instruments

The instrument universe consists of mutual funds available for a given client or globally. Retrieve instrument metadata: identifiers (e.g., ISIN), currency, latest price, KIID links, tradability flags, unit decimals, minimums, and cost/fee breakdowns.

Operations

Payment Instructions

Payment instructions (e.g., autogiro) batch one or more payments to accounts. Create instructions, then track the payments under each instruction (amounts, status, and references).

Operations

Create payment instruction

Request

Creates a new payment instruction of the specified type (for example autogiro) for the client identified by client_id. Provide an array of payments with details such as amount, destination account, and a unique clientRef. The response returns the instruction id, the list of created payments, a bankTransferRef if available, and the initial status (for example new) so you can track subsequent processing and settlements.

Security
oAuth
Path
client_idstring(UUID)^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...read-onlyrequired

The ID of requested client.

Example: 49ad7378-121c-4a53-9894-dfd14a7b4877
Bodyapplication/json

Create instruction of payments

typeany

The type of payment

Value"autogiro"
paymentsArray of objects

Array of payment instructions

curl -i -X POST \
  https://docs.fondo.se/_mock/openapi/api_3.0.3/v2/partner/client/49ad7378-121c-4a53-9894-dfd14a7b4877/instruction/payment \
  -H 'Authorization: Bearer <YOUR_Token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "autogiro",
    "payments": [
      {
        "amount": 110,
        "clientRef": "instruction_id_29384"
      }
    ]
  }'

Responses

Instruction of payments

Bodyapplication/json
idstring(UUID)^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...read-only

UUID (Universally Unique Identifier)

Example: "49ad7378-121c-4a53-9894-dfd14a7b4877"
typestring

The type of instruction

Example: "autogiro"
instructionsArray of objects

Array of payment instructions

bankTransferRefstring or null

The text to use in a bank transfer. Not applicable for autogiro

Example: "REF-12345"
statusnew (string) or executing (string) or processed (string) or error (string) or canceled (string)

instruction status

One of:

instruction created

string(new)
Value"new"
Response
application/json
{
  "id": "string",
  "type": "autogiro",
  "instructions": [
    { … }
  ],
  "bankTransferRef": "REF-12345",
  "status": "new"
}

Get payments by instruction

Request

Returns the list of individual payments linked to an instruction identified by instruction_id under the given client_id. Each payment record includes its id, destination account, amount, optional clientRef, current status (such as new or completed), and any explanatory reason or reasonCode. Use this endpoint to monitor execution and settlement of all payments created within a given payment instruction.

Security
oAuth
Path
client_idstring(UUID)^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...read-onlyrequired

The ID of requested client.

Example: 49ad7378-121c-4a53-9894-dfd14a7b4877
instruction_idstring(UUID)^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...read-onlyrequired

The ID of requested instruction.

Example: 49ad7378-121c-4a53-9894-dfd14a7b4877
curl -i -X GET \
  https://docs.fondo.se/_mock/openapi/api_3.0.3/v2/partner/client/49ad7378-121c-4a53-9894-dfd14a7b4877/instruction/49ad7378-121c-4a53-9894-dfd14a7b4877/payment \
  -H 'Authorization: Bearer <YOUR_Token_HERE>'

Responses

Array of payments

Bodyapplication/jsonArray [
idstring(UUID)^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...read-only

UUID (Universally Unique Identifier)

Example: "49ad7378-121c-4a53-9894-dfd14a7b4877"
sortedIdstring

Sortable ID for ordering payments chronologically

accountstring(UUID)^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

UUID (Universally Unique Identifier)

Example: "49ad7378-121c-4a53-9894-dfd14a7b4877"
amountnumber

Payment amount

clientRefstring(client reference)

Client applied ref

Example: "my_order_123"
statusnew (string) or pending (string) or complete (string) or failed (string) or settled (string) or canceled (string) or refunded (string)

Payment status

One of:

Payment created

string(new)
Value"new"
reasonstring or null

Reason of failure

reasonCodestring or null

Bankgiro error code

]
Response
application/json
[
  {
    "id": "string",
    "sortedId": "string",
    "account": "string",
    "amount": 0,
    "clientRef": "my_order_123",
    "status": "new",
    "reason": "string",
    "reasonCode": "string"
  }
]

Get payment instruction

Request

Returns the full payment instruction identified by instruction_id under the given client_id. The response includes the instruction id, a list of scheduled payments (each with amount, target account, and optional clientRef), any bankTransferRef provided by the payment system, and the current status (such as new, processing, or completed). Use this endpoint to track the overall lifecycle and settlement state of a particular payment instruction.

Security
oAuth
Path
client_idstring(UUID)^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...read-onlyrequired

The ID of requested client.

Example: 49ad7378-121c-4a53-9894-dfd14a7b4877
instruction_idstring(UUID)^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...read-onlyrequired

The ID of requested instruction.

Example: 49ad7378-121c-4a53-9894-dfd14a7b4877
curl -i -X GET \
  https://docs.fondo.se/_mock/openapi/api_3.0.3/v2/partner/client/49ad7378-121c-4a53-9894-dfd14a7b4877/instruction/49ad7378-121c-4a53-9894-dfd14a7b4877 \
  -H 'Authorization: Bearer <YOUR_Token_HERE>'

Responses

Instruction of payments

Bodyapplication/json
idstring(UUID)^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...read-only

UUID (Universally Unique Identifier)

Example: "49ad7378-121c-4a53-9894-dfd14a7b4877"
typestring

The type of instruction

Example: "autogiro"
instructionsArray of objects

Array of payment instructions

bankTransferRefstring or null

The text to use in a bank transfer. Not applicable for autogiro

Example: "REF-12345"
statusnew (string) or executing (string) or processed (string) or error (string) or canceled (string)

instruction status

One of:

instruction created

string(new)
Value"new"
Response
application/json
{
  "id": "string",
  "type": "autogiro",
  "instructions": [
    { … }
  ],
  "bankTransferRef": "REF-12345",
  "status": "new"
}

Orders

Fund orders (subscription/redemption) drive the trading lifecycle. Create, read, list, and cancel orders; track status from received → sent → confirmed → settled. Orders reference accounts and instruments, and map to cash/fund transactions on settlement.

Operations

Transactions

Transactions record movements of money and units.

  • Cash transactions (CT): deposits, withdrawals, cash legs of fund orders (with settlement dates).
  • Fund transactions (FT): unit movements from subscriptions/redemptions (trade & settlement dates). Use these endpoints to reconcile ledgers and statements.
Operations

Subscriptions (WebSocket & Webhooks)

Receive real-time updates from Fondo without polling.

  • WebSocket: open a persistent stream for .create, .update, .delete, and heartbeat events.
  • Webhooks: register a callback URL to get signed POSTs with current/previous payloads. Include replay/retry handling in your consumers.
Operations

System

API Service functions

Operations
© 2026 Fondo Solutions. All rights reserved.