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 Payment Link API

Create, read, and delete shareable payment links.

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

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

This API exposes 3 operations across 2 paths, and defines 6 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.

3 operations 2 paths 6 schemas 1 DELETE1 GET1 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 Payment Link 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 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Link 3

Create, read, and delete shareable payment links.

POST
/v1/payment-links
Create a payment link
createPaymentLink body → 201401
GET
/v1/payment-links/{order_id}
Get payment link details
getPaymentLink 1 param → 200401404
DELETE
/v1/payment-links/{order_id}
Delete a payment link
deletePaymentLink 1 param → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PaymentLinkRequest (6 properties), CustomerDetails (4 properties), ItemDetail (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

PaymentLinkRequest
object
6 properties 1 required
ItemDetail
object
4 properties
PaymentLink
object
2 properties
TransactionDetails
object
2 properties 2 required
Error
object
3 properties
CustomerDetails
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

midtrans-payment-link-api-openapi.yml Raw ↑

Other APIs Midtrans publishes across the network.

Midtrans Card Tokenization API
Midtrans Core API API
Midtrans GoPay Tokenization API
Midtrans Iris Disbursement API
Midtrans Snap API
Midtrans Subscription API
Where this information came from

This is an independent, third-party profile of Midtrans Payment Link 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.