Skip to main content
POST
finance.payment-addresses.find

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
phone
string
required

Indian mobile number, ten digits without a country prefix.

Required string length: 1 - 10
Pattern: ^[6-9][0-9]{9}$
limit
integer
default:100

Maximum returned addresses, 1 to 100; excess addresses are indicated.

Required range: 1 <= x <= 100

Response

The result

results
object[]
required

Payment addresses linked to the requested mobile number.

Maximum array length: 100
truncated
boolean
required

Whether the service found more addresses than returned.