Skip to content

Create Payee

Request

Create payee information

Headers
X-Merch-Idstring
Default:"M24061911365700670"
Example:M24061911365700670
Bodyapplication/json
request_idstring, [ 1 .. 32 ] charactersrequired

Request number, Unique within the requesting system

typestringrequired

Purpose (Required): PAYMENT-Collection, WITHDRAWAL-Withdrawal

beneficiaryobjectrequired

CollectionPeopleInformation

bank_accobjectrequired

BankAccountInformation

attachmentobject

OtherFileAttachment

curl -i -X POST \
  https://api.paykka.com/api/v2/merch/beneficiary/create \
  -H 'Content-Type: application/json' \
  -H 'X-Merch-Id: M24061911365700670'

Responses

OK

Headers
any
Body*/*
statusstringrequired

PayerReviewStatus PENDING-Pending Review NORMAL-Normal REJECTED-ReviewNot approved

Enum:"PENDING""NORMAL""REJECTED"
msgstring

Result description, not empty when Failed

payee_idstring, [ 0 .. 20 ] characters

Collection person id, only Return after CreateSuccessful and ReviewApproved; ApprovedSpecifyCollection person id can be used during Payment InitiatePayment

Response
{
  "msg": "string",
  "payee_id": "string",
  "status": "PENDING"
}