Payouts Workflow: Pockyt User

Introduction

When the Pockyt User feature is enabled for a merchant, any payee registered through the /v3/payee/register endpoint will receive a registration email that grants them access to the Pockyt Payee Portal. This eliminates the need for the merchant to collect and submit sensitive documents or manually configure payout accounts on behalf of the payee. The key steps in this flow are:

1. Register Payee:
   The merchant registers a payee via Pockyt’s API. A customerNo is returned and the payee receives an email invitation to log in to the Pockyt Payee Portal.

2. Payee Completes KYC & Payout Configuration:
   The payee uses the portal link to submit identity verification details and configure payout accounts directly—without merchant involvement.

3. Initiate Payout:
   Once the payee is marked as ACTIVE and has at least one configured payout account, the merchant can execute payouts using the customerNo and selected accountToken.

API Workflow

Step-by-Step Breakdown of the Payout Workflow

📘

API References for Workflow Steps

• Step 1: Register Payee /v3/payee/register
• Step 3: Check Payee Status /v3/payee/retrieve
• Step 4: Query payee funding account /v3/payout-accounts
• Step 5: Execute Payout /v3/payouts/pay
• Step 6: Handle Webhook Notifications

Step-by-Step Workflow

Step 1: Register Payee

Action:
The merchant registers the payee in Pockyt’s system using: POST /v3/payee/register

Key Considerations:

• The API returns a customerNo, which is needed for all subsequent steps.
• Pockyt also sends the payee a registration email with a link to the Payee Portal.

---

Step 2: Complete Profile in Payee App

Action:
The payee opens the Payee Portal and completes their KYC profile.

Key Considerations:

• The payee must provide identity verification documents and select a payout method.
• Once completed, the account goes into compliance review.

---

Step 3: Query Payee Status

Action:
The merchant checks the payee's compliance status using: POST /v3/payee/retrieve

Key Considerations:

• A status of ACTIVE indicates the payee is eligible for payouts.
• A status of PENDING or DECLINED means further action is required.

---

Step 4: Query Payee Funding Accounts

Action:
The merchant retrieves the list of payout accounts using: POST /v3/payee/payout-accounts

Key Considerations:

• You may provide an accountToken to filter for a specific payout method.
• Ensure that the payee has a valid payout method configured before proceeding.

---

Step 5: Initiate Payout

Action:
Initiate a payout using: POST /v3/payouts/pay

Required Parameters:

• customerNo (from Step 1)
• accountToken (from Step 4)
• amount, currency, invoiceId, and ipnUrl

Key Considerations:

• The response includes a transactionNo and initial status (PROCESSING, etc.).
• This step confirms the request but does not guarantee fund delivery.

---

Step 6: Webhook Notification

Action:
Pockyt sends a webhook to the provided ipnUrl once the transaction is processed.

Key Considerations:

• The webhook contains the final transaction status: SUCCESS, FAILED, or PENDING.
• You must listen to and handle webhook events to confirm payout delivery.

---