Documents

Payins

SentBiz Payins allow businesses to receive KRW via local bank transfers into their wallet using Virtual Accounts (VAs). These VAs support both third-party collections and internal funding, enabling real-time posting, automation, and seamless integration with payout workflows.


Payin Flow

Step 1: Assign a Virtual Account

  • The business (client) requests a KRW virtual account via API.

Step 2: Share Account Details

  • The client shares the virtual account details with:
    • Their own finance team (for wallet funding), or
    • End-customers (for collections on behalf of merchants)

Step 3: Local Bank Transfer

  • The payer (e.g. Korean buyer or the client itself) sends KRW to the virtual account using a local bank transfer.

Step 4: Real-time Posting

  • Once funds are received:
  • The amount is posted to the client’s wallet in real-time
  • A webhook notification is triggered (if configured)

Step 5: Use the Funds

  • The client can use the received funds for:
  • Cross-currency FX conversion
  • Payouts to overseas recipients via SentBiz APIs
  • Internal reconciliation or settlement

API Summary

Virtual Account Management

MethodEndpointDescription
POST/v3/virtual-accountsCreate a new virtual account.
– Deposit validity depends on contract.
– Requires user creation.
GET/v2/virtual-accountsRetrieve a list of issued virtual accounts.
GET/v2/virtual-accounts/{virtual_account_id}Retrieve details of a specific virtual account.
PUT/v2/virtual-accounts/{virtual_account_id}Update account info before deposit.
– Static accounts cannot be modified.
DELETE/v2/virtual-accounts/{virtual_account_id}Cancel a virtual account before deposit.
POST/v2/virtual-accounts/searchSearch virtual accounts using filters.

Deposit Transactions

MethodEndpointDescription
GET/v2/virtual-accounts/{virtual_account_id} /transactionsList deposit transactions for the account.
POST/v2/virtual-accounts/{virtual_account_id} /transactions/searchSearch transactions using filters.
GET/v2/virtual-accounts/{virtual_account_id}/transactions /{transaction_id}Get details of a specific transaction.
POST/v2/virtual-accounts/{virtual_account_id} /depositSimulate a deposit (sandbox only).
– Not available in production.
GET/v2/virtual-accounts/{virtual_account_id}/transactions /{transaction_id}/receiptDownload deposit receipt as PDF.

Supporting Documents

MethodAPI EndpointDescription
POST/v2/virtual-accounts/{virtual_account_id}/transactions/{transaction_id}/documentsUpload a supporting document for a transaction.
GET/v2/virtual-accounts/{virtual_account_id}/transactions/{transaction_id}/documents/{supporting_document_id}Download a specific supporting document.

Webhook: Virtual Account Deposit Completed

SentBiz notifies the client upon successful deposit via webhook.

  • Setup Requirements:
    • Share Webhook URL and key with SentBiz.
    • Complete firewall whitelist.
  • Retry Policy:
    • Retries if result ≠ SUCCESS.
    • 12 retries at 10-minute intervals.

Client Response Format

{
 "transaction_id": "abc123",
 "result": "SUCCESS"
}

Duplicate Handling:

  • If a webhook with the same transaction_id is received again, skip processing and return SUCCESS.