Payment APIs

Payment APIs

Master Merchant APIs

MasterMerchant APIs

Refund APIs

Refund APIs
- Create Refundpost
- Fetch Refunds Listget

Payout_APIs

Payout APIs

Subscription APIs

Plan APIs
Subscription APIs

Recon APIs

Recon APIs

Payment APIs

Payment APIs

Master Merchant APIs

MasterMerchant APIs

Refund APIs

Refund APIs
- Create Refundpost
- Fetch Refunds Listget

Payout_APIs

Payout APIs

Subscription APIs

Plan APIs
Subscription APIs

Recon APIs

Recon APIs

Fetch All Sub-merchants Paginated

post https://api.portone.cloud/api/master-merchant/{mkey}/merchants/paginated

URL Expired

The URL for this request expired after 30 days.

Path Params

mkey

string

required

Body Params

page

string

required

The page number of the data to be fetched.

pagesize

string

required

The page size of the data to be fetched.

string

required

The to Date to fetch the sub-merchant.

from

string

required

The from Date to fetch the sub-merchant.

filters

object

required

The filters to apply to the sub-merchant, check examples.

environment

string

required

The environment of the transaction is either live OR sandbox

Headers

X-Portone-Client-Key

string

Authorization

string

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token in this guide

Responses

Response body

object

content

object

The object containing the fetch Invited sub merchant API response data.

uuid

string

The unique identifier of the invited SubMerchant.

name

string

The name of the invited SubMerchant.

email_address

string

The email_address of the invited SubMerchant.

merchant_status

string

The status of the invited SubMerchant.

key

string

The PortOne key of the invited SubMerchant.

master_merchant_access

boolean

The boolean flag indicating whether master_merchant_access can access sub_merchant.

use_master_merchant_creds

boolean

The boolean flag indicating whether sub-merchant can use the Master Merchant credentials.

is_login_allowed

boolean

The boolean flag indicating whether sub-merchant can login to PortOne admin console.

is_invite_merchant

boolean

The boolean flag indicating whether the merchant was invited.

kyc_link

string

The URL of the dedicated KYC page for the sub-merchant.

kyc_status

string

The KYC status of the merchant.

send_kyc_link_email

boolean

The boolean flag indicating whether sub-merchant was sent email containing the KYC details.

message

string

The description of the API request execution result

status_code

string

The status_code for API request execution result

status_reason

string

The status_reason for API request execution result

Response body

object

message

string

The description of the API request execution result

status_code

string

The status_code for transaction of transaction creation

status_reason

string

The status_reason for transaction of transaction creation

Response body

object

message

string

The description of the API request execution result

status_code

string

The status_code for transaction of transaction creation

status_reason

string

The status_reason for transaction of transaction creation

Updated over 1 year ago

Fetch All Sub-merchants

Update Sub-merchant Status

Did this page help you?

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.portone.cloud/api/master-merchant/mkey/merchants/paginated \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "environment": "live"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Fetch All Sub-merchants

Update Sub-merchant Status

Did this page help you?

Payment APIs
Payment APIs
Fetch Merchant Transactionspost
Update Transaction Detailsput
Capture Transactionpost
Update Transaction Statusput
Fetch PSP Credentialsget
Update PSP Credentialsput
Add PSP Credentialspost
Fetch Payment Link Status using Merchant Link Ref (New)get
Fetch Payment Link Status using PortOne Link Refget
Fetch Payment Link Status using Mch Link Ref (Deprecated)get
Get Transaction Detailspost
Get Transaction Statusget
Fetch All Webhook Endpointsget
Add Webhook Endpointpost
Update Payment Link Statusput
Create Payment Linkpost
Initiate Paymentpost
Generate signature hashpost
Create JWT Tokenpost

Master Merchant APIs
MasterMerchant APIs
Fetch All Payment Links Paginatedpost
Export Sub-merchants Transactionspost
Fetch Sub-merchants Transactionspost
Update Payment Method Statuspost
Update Sub-merchant Statusput
Fetch All Sub-merchants Paginatedpost
Fetch All Sub-merchantsget
Fetch Invited Sub-merchantsget
Add Sub-merchantpost

Refund APIs
Refund APIs
Fetch Refunds Listget
Create Refundpost

Payout_APIs
Payout APIs
Approve Resend OTPpost
Verify Resend OTPpost
Download Virtual Account Statementget
Verify Payout Transactionspost
Fetch Beneficiaries Listget
Create A Beneficiarypost
Approve Payout Txnspost
Generate OTP - Approvepost
Generate OTP - Verifypost
Cancel Payout Txnput
Fetch Payout Txn Statusget
Fetch Virtual Account Statementpost
Verify Beneficiary Accountpost
Fetch Virtual Accounts Listget
Create Payoutpost
Fetch Virtual Account Balanceget
Fetch Payouts Listpost

Subscription APIs
Plan APIs
Get Planget
Cancel Planput
Create Planpost
Subscription APIs
Cancel Subscriptionput
Get Subscription Link Transaction Detailsget
Get Subscriptionget
Trigger Next Deductionput
Create Ondemand Deductionpost
Create Subscriptionpost

Recon APIs
Recon APIs
Get Data Sourcesget
Create Reconpost
Upload Filepost
Export Dashboard Source Recordspost
Get Dashboard Recordspost
Get Dashboard Summarypost

Payment APIs
Payment APIs
Fetch Merchant Transactionspost
Update Transaction Detailsput
Capture Transactionpost
Update Transaction Statusput
Fetch PSP Credentialsget
Update PSP Credentialsput
Add PSP Credentialspost
Fetch Payment Link Status using Merchant Link Ref (New)get
Fetch Payment Link Status using PortOne Link Refget
Fetch Payment Link Status using Mch Link Ref (Deprecated)get
Get Transaction Detailspost
Get Transaction Statusget
Fetch All Webhook Endpointsget
Add Webhook Endpointpost
Update Payment Link Statusput
Create Payment Linkpost
Initiate Paymentpost
Generate signature hashpost
Create JWT Tokenpost

Master Merchant APIs
MasterMerchant APIs
Fetch All Payment Links Paginatedpost
Export Sub-merchants Transactionspost
Fetch Sub-merchants Transactionspost
Update Payment Method Statuspost
Update Sub-merchant Statusput
Fetch All Sub-merchants Paginatedpost
Fetch All Sub-merchantsget
Fetch Invited Sub-merchantsget
Add Sub-merchantpost

Refund APIs
Refund APIs
Fetch Refunds Listget
Create Refundpost

Payout_APIs
Payout APIs
Approve Resend OTPpost
Verify Resend OTPpost
Download Virtual Account Statementget
Verify Payout Transactionspost
Fetch Beneficiaries Listget
Create A Beneficiarypost
Approve Payout Txnspost
Generate OTP - Approvepost
Generate OTP - Verifypost
Cancel Payout Txnput
Fetch Payout Txn Statusget
Fetch Virtual Account Statementpost
Verify Beneficiary Accountpost
Fetch Virtual Accounts Listget
Create Payoutpost
Fetch Virtual Account Balanceget
Fetch Payouts Listpost

Subscription APIs
Plan APIs
Get Planget
Cancel Planput
Create Planpost
Subscription APIs
Cancel Subscriptionput
Get Subscription Link Transaction Detailsget
Get Subscriptionget
Trigger Next Deductionput
Create Ondemand Deductionpost
Create Subscriptionpost

Recon APIs
Recon APIs
Get Data Sourcesget
Create Reconpost
Upload Filepost
Export Dashboard Source Recordspost
Get Dashboard Recordspost
Get Dashboard Summarypost

200Successful response

400Failure response

401Failure response