Skip to main content
POST
payments.methods.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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
country
string
required

Buyer country code.

Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
amount
object
required

Purchase total used to assess eligible methods.

flow
enum<string>
default:one_time

Intended payment flow.

Available options:
one_time,
recurring,
save_with_payment,
save_without_payment
channel
object

Optional buyer browser, system and device.

customerKey
string

Your own buyer identifier; not an upstream account id.

Required string length: 1 - 36
Pattern: ^[A-Za-z0-9_-]+$
email
string

Optional buyer email used only for eligibility.

Required string length: 1 - 320
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
phone
object

Optional buyer phone used only for eligibility.

includeAccountDetails
boolean
default:false

Request whether the buyer has eligible wallet accounts.

includeSavedMethods
boolean
default:false

Request saved methods; a source may decline until saved-method support is available.

constraint
object

Optional eligibility filter.

Response

The result

results
object[]
required

Eligible payment methods; no buyer contacts or payment tokens are returned.