Skip to main content
POST
/
api
/
v3
/
integrator
Create an integrator
curl --request POST \
  --url https://sandbox-api.kotanipay.io/api/v3/integrator \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization": "A&B Company",
  "product_name": "MY APP NAME",
  "first_name": "John",
  "last_name": "Doe",
  "email": "ab@gmail.com",
  "phone": "+xxx xxx xxx xxx",
  "country_code": "US or USA",
  "webhook_url": "https://example.com/kotani/webhooks",
  "webhook_secret": "whsec_xxx",
  "webhook_events": [
    "transaction.deposit.status.updated",
    "payment.confirmed"
  ]
}
'
{
  "success": true,
  "message": "The record has been successfully created.",
  "data": {
    "organization": "A&B Company",
    "first_name": "John",
    "last_name": "Doe",
    "email": "ab@gmail.com",
    "phone": "+xxx xxx xxx xxx",
    "id": "xxxxxxxxxxxxxxxxxxxxxxxx",
    "webhook_url": "https://example.com/kotani/webhooks",
    "webhook_events": [
      "transaction.deposit.status.updated",
      "payment.confirmed"
    ]
  }
}
Create a new integrator account to start using the Kotani Pay API platform.

Body

application/json
​
organization
string
required

organization

Example:

"A&B Company"

​
product_name
string
required

product name

Example:

"MY APP NAME"

​
first_name
string
required

first_name

Example:

"John"

​
last_name
string
required

last_name

Example:

"Doe"

​
email
string
required

email

Example:

"ab@gmail.com"

​
phone
string
required

phone

Example:

"+xxx xxx xxx xxx"

​
country_code
string
required

Country code (accepts ISO-2 or ISO-3, auto-converts to ISO-2)

Example:

"US or USA"

​
webhook_url
string

Default webhook callback URL

Example:

"https://example.com/kotani/webhooks"

​
webhook_secret
string

Shared secret used to sign webhook payloads

Example:

"whsec_xxx"

​
webhook_events
enum<string>[]

Webhook events this integrator is subscribed to

Available options:
transaction.status.updated,
transaction.deposit.status.updated,
transaction.withdrawal.status.updated,
transaction.onramp.status.updated,
transaction.offramp.status.updated,
payment.confirmed,
kyc.status.changed,
refund.lightning.invoice_needed,
refund.completed,
refund.failed,
settlement.approved,
settlement.rejected,
settlement.processed,
settlement.cancelled,
settlement.paused,
settlement.batch.approved,
settlement.batch.rejected,
settlement.batch.processed,
settlement.batch.partial,
settlement.batch.cancelled,
system.event
Example:
[
  "transaction.deposit.status.updated",
  "payment.confirmed"
]

Response

​
success
boolean
Example:

true

​
message
string
Example:

"The record has been successfully created."

​
data
object