Skip to main content
POST
Perform a one-click purchase

Path Parameters

org_id
string
required

Organization ID

Body

application/json
external_id
string
required

Your unique identifier for the user

Maximum string length: 256
pp_ident
string
required

Unique identifier of the price point

Maximum string length: 256
Pattern: ^[-A-Za-z_0-9]{1,256}$
client_metadata
Client Metadata · object

Custom metadata from your client application

initiation_type
enum<string> | null

How to send the payment: cit (customer-initiated) or mit (merchant-initiated). Leave it out to use the organization or funnel setting. Without the ff-secret-key header, this field can only make the setting stricter: mit is applied, cit is ignored where the setting is mit.

Available options:
cit,
mit
cit_card_networks
enum<string>[] | null

Card brands allowed to go as CIT. Leave it out to use the organization or funnel setting. Without the ff-secret-key header, this list can only narrow the brands in the setting.

Available options:
AMEX,
CARTES_BANCAIRES,
DINERS_CLUB,
DISCOVER,
EFTPOS,
ELO,
JCB,
MAESTRO,
MASTERCARD,
MIR,
UNIONPAY,
VISA
idempotency_key
string | null

Unique key per purchase attempt. Reuse it on every retry of that attempt so the customer is charged only once.

Required string length: 1 - 128

Response

200 - application/json

Payment status and details

action_required_token
string
required
checkout_status
enum<string>
required
Available options:
processing,
succeeded,
failed,
cancelled
failed_message_for_user
string
required
order_id
string<uuid> | null
required
decline_code
string | null
decline_code_source
enum<string> | null
Available options:
fakeintegration,
primer,
stripe
idempotent_replay
boolean
default:false

True when this response replays an earlier one-click request made with the same idempotency key, rather than a new charge.