Midtrans

Midtrans GoPay Tokenization API

Bind and read a customer's GoPay account.

Documentation GitHub OpenAPI

Operations 2

POST /v2/pay/account Create (link) a GoPay pay account #

GET /v2/pay/account/{account_id} Get a GoPay pay account #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/midtrans-gopay-tokenization-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Midtrans Payment GoPay Tokenization API
  description: A representative OpenAPI description of the Midtrans payment platform, an Indonesian payment gateway (part of the GoTo Group).
  version: '1.0'
  contact:
    name: Midtrans
    url: https://midtrans.com
  license:
    name: Proprietary
    url: https://midtrans.com
servers:
- url: https://api.midtrans.com
  description: Core API / Payment Link / Subscription - Production
- url: https://api.sandbox.midtrans.com
  description: Core API / Payment Link / Subscription - Sandbox
security:
- serverKeyAuth: []
tags:
- name: GoPay Tokenization
  description: Bind and read a customer's GoPay account.
paths:
  /v2/pay/account:
    post:
      operationId: createPayAccount
      tags:
      - GoPay Tokenization
      summary: Create (link) a GoPay pay account
      description: Links a customer's GoPay account by phone number and returns activation actions plus an `account_id`. The account status progresses through PENDING, ENABLED, EXPIRED, and DISABLED.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayAccountRequest'
      responses:
        '201':
          description: The linked pay account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayAccount'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v2/pay/account/{account_id}:
    parameters:
    - name: account_id
      in: path
      required: true
      description: The linked pay account identifier.
      schema:
        type: string
    get:
      operationId: getPayAccount
      tags:
      - GoPay Tokenization
      summary: Get a GoPay pay account
      description: Retrieves a linked GoPay account's status and available payment tokens.
      responses:
        '200':
          description: The pay account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayAccount'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    PayAccountRequest:
      type: object
      required:
      - payment_type
      properties:
        payment_type:
          type: string
          enum:
          - gopay
        gopay_partner:
          type: object
          properties:
            phone_number:
              type: string
            country_code:
              type: string
            redirect_url:
              type: string
              format: uri
    PayAccount:
      type: object
      properties:
        status_code:
          type: string
        payment_type:
          type: string
        account_id:
          type: string
        account_status:
          type: string
          enum:
          - PENDING
          - ENABLED
          - EXPIRED
          - DISABLED
        actions:
          type: array
          items:
            $ref: '#/components/schemas/Action'
        metadata:
          type: object
          additionalProperties: true
    Action:
      type: object
      properties:
        name:
          type: string
        method:
          type: string
        url:
          type: string
          format: uri
    Error:
      type: object
      properties:
        status_code:
          type: string
        status_message:
          type: string
        id:
          type: string
  securitySchemes:
    serverKeyAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic authentication. Your Server Key is the username and the password is empty, so the header is `Authorization: Basic base64(SERVER_KEY:)`. Iris disbursement uses the same HTTP Basic scheme but with its own creator / approver API key.'