How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Midtrans Iris Disbursement API

Payouts, beneficiaries, balance, and account validation.

Midtrans Iris Disbursement API is one of 7 APIs that Midtrans publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Iris Disbursement. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 10 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.midtrans.com, https://api.sandbox.midtrans.com.

11 operations 10 paths 8 schemas 6 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.midtrans.com/snap/v1
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

Midtrans Iris Disbursement API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (serverKeyAuth). By default, every request must be authenticated.

  • serverKeyAuth — HTTP Basic authentication. Your Server Key is the username and the password is empty, so the header is Authorization: Basic base64(SERVERKEY:). Iris disburseme…

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 6 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Iris Disbursement 11

Payouts, beneficiaries, balance, and account validation.

GET
/iris/api/v1/ping
Ping Iris
irisPing → 200
GET
/iris/api/v1/beneficiaries
List beneficiaries
listBeneficiaries → 200401
POST
/iris/api/v1/beneficiaries
Create a beneficiary
createBeneficiary body → 201401
PATCH
/iris/api/v1/beneficiaries/{alias_name}
Update a beneficiary
updateBeneficiary 1 param body → 200401
POST
/iris/api/v1/payouts
Create payouts
createPayouts body → 201401
POST
/iris/api/v1/payouts/approve
Approve payouts
approvePayouts body → 202401
POST
/iris/api/v1/payouts/reject
Reject payouts
rejectPayouts body → 202401
GET
/iris/api/v1/payouts/{reference_no}
Get payout details
getPayoutDetails 1 param → 200401404
GET
/iris/api/v1/balance
Get account balance
getBalance → 200401
GET
/iris/api/v1/bank_accounts
List bank accounts
listBankAccounts → 200401
GET
/iris/api/v1/account_validation
Validate a bank account
validateBankAccount 2 params → 200401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Payout (6 properties), PayoutItem (6 properties), Beneficiary (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Payout
object
6 properties
Beneficiary
object
5 properties
PayoutRequest
object
1 property 1 required
PayoutResponse
object
1 property
PayoutItem
object
6 properties 4 required
PayoutRejection
object
2 properties 2 required
PayoutApproval
object
2 properties 1 required
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

midtrans-iris-disbursement-api-openapi.yml Raw ↑

Other APIs Midtrans publishes across the network.

Midtrans Card Tokenization API
Midtrans Core API API
Midtrans GoPay Tokenization API
Midtrans Payment Link API
Midtrans Snap API
Midtrans Subscription API
Where this information came from

This is an independent, third-party profile of Midtrans Iris Disbursement API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.