checkout
  1. Payee
checkout
  • Core
    • Get application configuration values.
      GET
  • Fund Request
    • Public Incoming fund request details by referral code.
      GET
    • Decline by public referral code.
      POST
    • Pay for fund-request as public (by requesteeUuid). Only Apple/Google allowed.
      POST
    • Verify hosted card payment for a requestee by transaction id.
      POST
    • Create a ktti fund request.
      POST
    • Public fund request details by referral code. V3.
      GET
    • Create.
      POST
    • Incoming detail for a requestee.
      GET
    • List incoming fund requests (addressed to the current user).
      GET
    • List outgoing fund requests (created by the current user).
      GET
    • Incoming detail for a requestee.
      GET
    • Link Token - fund-request detail by referral token.
      POST
    • Cancel one or many requestees by owner.
      POST
    • List history of one.
      GET
    • Detail.
      GET
    • Delete Fund Request.
      DELETE
    • Update.
      PATCH
    • Outgoing detail.
      GET
    • Reminder.
      POST
    • Pay for fund-request.
      POST
    • Decline by user.
      POST
  • Fund Ktti
    • Public Ktti details for funding.
      GET
    • Create a fund request and return the payment link (iframe URL).
      POST
  • Reminder
    • Snooze reminder for fund request requestee - public.
    • List reminder tones.
    • View reminder setting for fund request.
    • Toggle auto reminder for fund request.
    • Send reminder for fund request.
    • View reminder setting for requestee.
    • Toggle auto reminder for requestee.
    • Send reminder for requestee.
    • List reminder logs for requestee.
    • Snooze reminder for fund request requestee.
  • Ktti
    • PUBLIC - Read a single ktti using payment referral code.
    • Get all ktties or some ktties based on filters.
    • Creates a new ktti.
    • Refresh the group_referral_code for a specific ktti.
    • Get personal Ktti for the current user.
    • Update a ktti.
    • Read a single ktti.
    • Initiate a ktti closure.
    • Disburse remaining ktti funds to members before final closure.
    • Permanently close the ktti with 0 total and available balance.
    • Cancel the ktti closure and re-activate the ktti.
    • List moments for a ktti.
    • Create a new moment for a ktti.
    • Update a moment for a ktti.
    • TopUp ktti using Wallet.
    • Creates a new ktti.
    • Update a ktti.
  • Circle
    • List the circle of user.
  • Payee
    • Handle the incoming request to create a new payee.
      POST
    • List all payees for the current user.
      GET
    • Edit a payee's recipient name.
      PATCH
    • Delete a payee by ID.
      DELETE
  • Billing
    • View billing plan for a KTTI.
    • Return billing history for a specific KTTI.
  • KttiMembership
    • Join Ktti with referral code.
    • Create ktti member invite with referral code.
    • Get the ktti membership invite link.
    • List all members of ktti.
    • Join Ktt by direct invitation.
    • Reject direct invitation for a Ktti.
    • Leave the kitti.
    • Update membership for an individual in a ktti.
    • Remove a member from a ktti.
    • Request admin access for a specific ktti.
  • BankingProvider
    • Get Shaype account details for a specific Ktti.
  • Card
    • Get card details for a specific Ktti.
    • Get card details for a specific Ktti (v3).
  • GroupChat
    • Send a chat to the group ktti.
  • Cards
    • change card address while ordering physical card.
  • ExpenseSplit
    • Retrieve total deposited and spent amount for each member in a ktti.
    • Update split proportions for members of a KTTI.
    • Get split proportions for members of a KTTI.
    • Update assignee for a deposit transaction.
    • View split details for a transaction (expenses, refunds, and deposits).
    • Update split details for a non-deposit transaction (expenses and refunds).
  • Transaction
    • Return a list of unassigned deposits.
    • View the details of a specific transaction.
    • View transaction with additional info.
    • Update transaction with additional info.
    • All Transactions V3.
    • /api/v3/ktties/{kttiId}/unassigned-deposits
    • Ktti Transactions V3.
    • All Transactions V4.
    • Ktti Transactions V4.
    • All Transactions V5.
    • View Transaction Detail V5.
    • Ktti Transactions V5.
  • Receipt
    • Retrieve receipt details and line items for a transaction.
    • Update a line item.
    • Delete a receipt and its associated line items.
    • Upload a transaction receipt.
  • Off Platform
    • Create off platform transaction.
    • Update off platform transaction.
    • Delete off platform transaction.
    • Create off platform fund request.
  • Kyc
    • Get KYC details for the current authenticated user.
    • Save user details.
    • Confirm user details.
    • Start upload documents.
    • Finish upload documents.
    • Get KYC details for the current authenticated user.
  • Registration
    • Register user.
    • Set user password to finish registration.
    • Send email code.
    • Resend email code.
    • Verify email.
    • Set user preferred name.
    • Set user password to finish registration.
  • User
    • Update user password.
    • Request for a user reset password.
    • Get current user information.
    • Get current user information.
  • Authentication
    • Login user using email & password.
    • Login user using social.
    • Login user using idp token.
    • Refresh user token.
    • Logout user.
    • Logout user with device id.
  • Settings
    • Change user password.
    • Update user details.
    • Send phone number code.
    • Resend phone number code.
    • Verify phone number.
  • Device
    • Save fcm token for user device.
    • Save app details for user device.
  • Guest
    • Add guest user.
    • Update guest user.
  • Notifications
    • Get app inbox notifications for the current user.
    • Get notification information for the current user.
    • Get notification preferences for the current user.
    • Update notification preferences for the current user.
    • Delete notification.
  • Action
    • Execute action.
  • Analytics
    • Webhook to update marketing preferences.
  • create a signed url used for uploading a certain type of images.
    POST
  • Schemas
    • MoneySchema
    • GenericError
    • AddressSchema
    • ValidationError
    • MakeApplePaymentRequestSchema
    • FundRequestDetailBaseSchema
    • KttiFundRequestResource
    • FundKttiSchema
    • MakeGooglePaymentRequestSchema
    • FundRequestSchema
    • FundRequestOutgoingDetailSchema
    • TransactionFundRequestResource
    • FundRequestIncomingDetailSchema
    • FundRequestV2Schema
    • MakeInternalPaymentRequestSchema
    • CreateKttiV3
    • UpdateKtti
    • Ktti
    • TopUpKttiUsingAppleTokenRequestSchema
    • UpdateKttiV3
    • CreateKtti
    • KttiMoment
    • TopUpKttiUsingGoogleTokenRequestSchema
    • KttiV2
    • PersonalKtti
    • EmbeddedKttiMember
    • SaveDeviceFcmTokenRequest
    • SaveDeviceAppDetailsRequest
    • Password
    • RequestResetPasswordRequest
    • UpdateUserDetailsResponse
    • ChangePasswordRequest
    • UpdateUserDetailsRequest
    • CurrentUser
    • PhoneResponse
    • PhoneRequest
    • UpdatePasswordRequest
    • RegisterUserRequest
    • SetPasswordRequest
    • CurrentUserV3
    • UserPublicItem
    • SocialLoginUserRequest
    • LoginUserResponse
    • RefreshTokenRequest
    • LoginUserRequest
    • RefreshTokenResponse
    • UserItem
    • UpdatePhysicalCardAddress
    • CardSchema
    • CardV3Schema
    • TransactionListItemV4
    • TransactionKtti
    • TransactionAddress
    • TransactionItem
    • TransactionListItemV5
    • DirectDebitTransaction
    • InterBankTransferOutTransaction
    • KttiToKttiTransferTransaction
    • AtmWithdrawalTransaction
    • OffPlatformTransactionType
    • FundRequestTransaction
    • CardTransaction
    • KttiBillingTransaction
    • InterBankTransferInTransaction
    • GeneralCreditTransaction
    • intent
    • AccountSchema
    • ActionItem
    • ActionGroup
    • NotificationChannel
    • SystemNotification
    • TransactionNotification
    • GeneralNotification
    • NotificationListItem
    • Payee
    • TaxDetails
    • Address
    • NameDob
    • ReminderTone
    • ReminderLog
    • OffPlatformTransaction
  1. Payee

Handle the incoming request to create a new payee.

POST
/api/v2/payees

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/json

Examples

Responses

🟢201
application/json
Payee created successfully
Body

🟠400
🟠401
🟠422
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v2/payees' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "bsb_acc",
    "account_name": "string",
    "account_nickname": "string",
    "bsb": "string",
    "account_number": "string",
    "payid": "string"
}'
Response Response Example
201 - Example 1
{
    "data": {
        "uuid": "string",
        "account_name": "string",
        "account_nickname": "string",
        "type": "bsb_acc",
        "bsb": "string",
        "account_number": "string",
        "target_ktti_uuid": "string",
        "target_user_uuid": "string"
    }
}
Modified at 2026-02-18 00:33:01
Previous
List the circle of user.
Next
List all payees for the current user.
Built with