Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Your PayBridgeNP API key. Obtain one from the dashboard under Settings → API Keys. Prefix: sk_test_ for testing, sk_live_ for production.

Body

application/json
name
string
required
Example:

"Aarav Sharma"

email
string<email> | null
Example:

"aarav@example.com"

phone
string | null
Maximum string length: 20
Example:

"9801234567"

externalCustomerId
string | null

Your internal customer ID (for cross-referencing).

Example:

"user_abc123"

metadata
object | null

Response

Customer created.

id
string
Example:

"bcu_01j9x2k3m4n5p6q7r8s9t0u1v2"

object
enum<string>

String representing the object's type.

Available options:
customer
name
string
Example:

"Aarav Sharma"

email
string<email> | null
Example:

"aarav@example.com"

phone
string | null
Example:

"9801234567"

external_customer_id
string | null

Your internal customer ID for cross-referencing.

credit_balance
integer

Account credit balance in paisa, applied to future invoices.

Example:

0

metadata
object | null

Arbitrary key-value pairs you attached.

livemode
boolean

true when created with a live key, false for sandbox.