Create payment request

post

https://api.advancehq.com/v1/payments/payment-request

Creates a new payment request

Body Params

Request body for creating a standalone payment request (not tied to a plan).

allowed_payment_methods

array of objects | null

Allowed Payment Methods

Allowed:

amount

required

Requested payment amount in dollars

details

string | null

Description shown to the customer on the payment page

insured_id

string | null

Links this request to an existing insured record. Enables filtering by insured via GET /v1/payments/payment-requests?insured_id=...

payment_expiration

date-time

When the payment link expires. Defaults to 30 days from creation.

recipient_email

string | null

Email address of the intended payer. Used to send the payment link if send_email_to_recipient is true.

send_email_to_recipient

boolean

Defaults to false

Whether to send payment link email to the recipient

user_metadata

object | null

Custom key-value data you want to attach to this request. Returned as-is in responses.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response