Skip to content

ADOPAY Developer Platform

Main Navigation

Overview
Common
Merchant API
Partner API
Webhooks

English
简体中文

English
简体中文

Appearance

Sidebar Navigation

1. Overview

Overview
Introduction
Integration Models
API Environment
API Endpoint
Quick Start

2. Common

Authentication
Request Signing
Response Format
Response Status
Error Codes
Idempotency
Date & Time
Amount & Currency
Webhook Specification

3. Merchant API

Account
- Get Balance
Collection
- Create Payment / QR Code
  Query Payment by Order SN
  Query Payment by E2E ID
  Decode PIX QR Code
  Payment Webhook
Refund
- Create Refund
  Query Refund Detail
  Refund Webhook
Payout
- Create PIX Out
  Query PIX Out
  Query PIX Out Proof
  PIX Out Webhook
Exchange
- Get Exchange Price
  Create Exchange Cashout
  Query Exchange Status
  Exchange Webhook
PIX Services
- List PIX Keys
  Consult PIX Key
  List MED
Schemas
- GetTokenRequest
  AuthRequest
  RefreshRequest
  AuthTokens
  AuthTokenRefresh
  QuoteRequest
  QuoteResponse
  CreatePixChargeRequest
  PixChargeResponse
  BaseMerchantTransaction
  MerchantPayInTransaction
  MerchantPayOutTransaction
  MerchantConversionTransaction
  MerchantTransaction
  PixKeyType
  PixWithdrawalRequest
  PixWithdrawalResponse
  Reason
  StatusChangeEvent
  MerchantNotification_StatusChangeEvent
  MerchantBalance
  Envelope
  ErrorEnvelope
  LegacyGoogleAuthEnvelope
  ErrorCodes
  ActiveState
  OperatorItem
  RbacRoleItem
  RbacPermissionItem
  RbacPermissionTreeNode
  AuthRoleItem
  AuthMenuNode
  PageMeta
  AuthMeData
  LoginSubmitData
  BootstrapData
  LoginPrepareData

4. Partner API

Partner Account
Merchant Onboarding
Merchant Management
Transaction API
Collection
Refund
Payout
Settlement API
MED API
Report API

5. Webhook Events

Payment Event
Refund Event
Payout Event
Merchant Status Event
Settlement Event

6. Appendix

Order Status
Merchant Status
Refund Status
Payout Status
Error Code List
Currency
Glossary

On this page

Currency

PIX Collection / Payout commonly use BRL. Exchange pairs follow Exchange API definitions.

Last updated:

Pager

PreviousError Code List