API Reference

Generate Payment Link

post
https://api-sandbox.urbanpayx.com/api/v1/checkout/paylink

Create a payment link

Creates a new transaction record and returns a payment checkout URL. Requires a unique X-Idempotency-Key header to prevent duplicate payments. The user must exist and pass verification requirements before a payment link can be generated. The project's associated operating company must be in ACTIVATED status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
required

The amount of the transaction

string
required
length between 3 and 3

The currency of the transaction (EUR only for now)

The user id (individual customer). Mutually exclusive with business_customer_id.

The business customer id (KYB-verified company). Mutually exclusive with user_id.

string
required

The ID of the project associated with the transaction

string
required

The description of the transaction

Optional secondary remittance information sent to the payment provider

Optional contract request to bind to this payment transaction

Optional hard deadline after which the link will no longer mint new sessions

Optional HTTPS return URL the payer is redirected to after completing or canceling this payment. Falls back to the client's default callback URL when omitted.

boolean
Defaults to true

When true, UrbanPayX sends a payment-link invitation email to the payer after the link is created.

Headers
string
required
Responses

Updated 29 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 29 days ago