Skip to main content
POST
Create a payment

Authorizations

Authorization
string
header
required

API key from the Payoes dashboard (pk_test_... or pk_live_...)

Body

application/json
pricing_currency
string
required

Fiat currency code for the charge amount (for example USD or IDR).

Example:

"USD"

pricing_amount
string
required

Charge amount in the pricing currency.

Example:

"25.00"

settlement_asset
object

Optional. Defaults to the organization settlement asset.

allowed_assets
object[]

Optional. Defaults to all enabled organization assets.

Minimum array length: 1
description
string | null
Maximum string length: 500
metadata
object | null
expires_in_minutes
integer

Minutes until the payment expires (default 60)

Required range: 5 <= x <= 10080
customer_id
string | null

Customer public ID to link before checkout

Response

Payment created

id
string
required
Example:

"pay_nLU2gUDk-v3tdyd6"

object
enum<string>
required
Available options:
payment_intent
amount
string
required
Example:

"2.0000000"

settlement_asset
object
required
allowed_assets
object[]
required
status
enum<string>
required
Available options:
pending,
completed,
failed,
expired
checkout_url
string<uri>
required
created_at
string<date-time>
required
paid_asset
object | null

Asset the customer actually paid with (set after checkout)

description
string | null
metadata
object | null
source_type
enum<string>
Available options:
direct,
checkout_session,
payment_link,
invoice
customer_id
string | null
payer_address
string | null
tx_hash
string | null
confirmed_at
string<date-time> | null
expires_at
string<date-time> | null