Skip to main content
POST
Authorize payment (publishable)

Authorizations

Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Path Parameters

id
string
required

Resource identifier.

Body

application/json

Body for POST /payments/{id}/authorize/.

source
integer
required

Source ID to authorize this payment against.

Response

Payment authorized.

amount
number
required
currency
string
required

ISO currency code.

date
string<date>
required
description
string
required
Maximum string length: 256
id
integer
read-only
invoice
string | null

Invoice ID this payment applies to.

subscription
string | null

Subscription ID when generated by a subscription cycle.

customer
string | null
balance
number
read-only

Remaining balance to charge against this payment.

payment_date
string<date-time> | null

Effective date the payment was completed.

source
integer | null

Primary source ID. (Legacy single source link.)

sources
integer[]

All source IDs linked to this payment (multi-source support).

status
enum<string>
default:requires_payment_method
Available options:
cancelled,
failed,
incomplete,
processing,
requires_payment_method,
succeeded
failed_reason
string | null
read-only

Reason code when status=failed.

return_url
string<uri> | null

URL the payer is sent back to after a redirect-flow checkout.

enable_checkout
boolean
default:true

Whether the publishable checkout /pay/ is reachable for this payment.

metadata
object
test_mode
boolean
read-only
created
string<date-time>
read-only
updated
string<date-time>
read-only