Skip to content

Payee and Payment

Overview

This document describes how to integrate payee management and payment features. Through these APIs, you can manage payee information and execute payment operations.

Before making a payment, you must first create a payee. The payee is the recipient in the payment process, and you are the payer in the payment process.

Business Process

Payee Management

Payee Status

Description of image

Create Payee

  • Create Payee: This API creates new payee information.
  • The system returns a payee ID payee_id and status, which is required when initiating a payment.
  • The request_id in the request parameters is used for tracking the business process.

Modify Payee

  • Modify Payee: This API modifies payee information when it has been rejected.
  • The request_id in the request parameters must match the request_id from payee creation.

Query Payee Status

  • Query Payee Status: This API queries the review status of a payee.
  • The request_id in the request parameters must match the request_id from payee creation.

Listen for Payee Creation Results

  • Payee Creation Result (Notification): webhook for receiving asynchronous notifications.
  • Listen for callback notifications of type PAYEE
  • The request_id in the notification content is the request_id from payee creation

Payment Process

Payment Status

Description of image

Initiate Payment

  • Payment: This API initiates a payment application, calculates fees, and returns exchange rate information if currency conversion is needed.
  • The payee ID beneficiary_id in the request parameters is the successfully created payee ID payee_id from the payee process
  • The request_id in the request parameters is used for tracking the business process

Query Payment Result

  • Query Payment Status: This API retrieves payment result information.
  • The request_id in the request parameters is the request_id from payment initiation

Listen for Payment Result Notifications

  • Payment Result Notification: webhook for receiving asynchronous notifications.
  • Listen for callback notifications of type PAYMENT
  • The request_id in the notification content is the request_id from payment initiation

Notes

  • Amount Notes
    • All amounts use the minimum currency unit
    • For example: 100.50 USD should be submitted as 10050
  • Payment Operations
    • Before making a payment, ensure the payee status is NORMAL