Skip to main content
POST
Process duty payment for a collection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
paymentMethodId
string
required

Stripe payment method ID from Stripe Elements

Example:

"pm_1234567890"

email
string
required

Customer email for receipt

Example:

"customer@example.com"

name
string

Customer name for receipt

idempotencyKey
string

Idempotency key to prevent duplicate payments

Response

messages
object[]
required
success
boolean
required

Whether the payment was successful

status
string
required

Payment status

Example:

"succeeded"

amount
number
required

Amount paid in cents

currency
string
required

Currency of payment

paymentIntentId
string

Stripe payment intent ID

alreadyPaid
boolean

Whether the collection was already paid

error
string

Error message if payment failed

clientSecret
string

Stripe client secret for 3D Secure authentication

requiresAction
boolean

Whether payment requires additional action (3D Secure)