urbanpayx

Showing 25 of 31 from the live probe.

• Get Account Context

  Get your UrbanPayX account context: who you are, which environment this session targets, your role, and enabled capabilities. Call this first to orient yourself before other operations.

• List Projects

  List your projects. A project_id is required to create a payment link; frozen projects cannot take payments.

• Create Paylink

  Create a payment link a payer can open to pay you. Requires a project_id: call list_projects first if you do not have one. Returns the shareable payment_url. Set send_payer_email=true only if the payer should receive an email (requires user_id or business_customer_id with an email on file).

• Get Transaction

  Get one transaction's current status and payment link by id.

• List Transactions

  List transactions, newest first. status is one of: pending, processing, success, failed, expired, canceled. Dates are ISO 8601.

• Cancel Checkout Intent

  Cancel a pending payment intent so its payment link stops working. Only possible while the transaction has not been paid.

• Create Kyc User

  Register an individual (natural person) so you can verify or charge them later. Does not start identity verification and does not cost anything.

• Start Kyc Verification

  Start identity (KYC) verification for a person and get the verification link to share with them. Creates the user if they do not exist yet. NOTE: this is billable and, with send_email=true, emails a real person - confirm with the operator before calling. Returns verification_url.

• Get Kyc Status

  Check a person's KYC status (none, pending, approved, rejected, on_hold) and the latest verification link if one is still active.

• List Kyc Users

  List individuals and their KYC status. Filter by kyc_status (none, pending, approved, rejected, on_hold) or a keyword search over name/email. By default only active users are returned.

• Resubmit Kyc

  Ask an existing user to resubmit their KYC verification (e.g. after a rejection). NOTE: this starts a new verification, which is billable and may email the person - confirm with the operator before calling. Returns the new verification_url and which steps must be resubmitted.

• List Kyc Levels

  List the available KYC verification levels (their keys and display names). Use a level key as the level_name argument to start_kyc_verification.

• Create Kyb Business

  Register a business customer so you can verify or charge it later. Does not start verification and does not cost anything. country is an ISO 3166-1 alpha-2 code (e.g. ES).

• Start Kyb Verification

  Start business (KYB) verification and get the verification link. Creates the business if it does not exist yet. NOTE: this is billable and, with send_email=true, emails a real person - confirm with the operator before calling. Returns verification_url.

• Get Kyb Status

  Check a business's KYB status (none, pending, approved, rejected, on_hold) and the latest verification link if one is still active.

• List Kyb Businesses

  List business customers and their KYB status. Filter by kyb_status (none, pending, approved, rejected, on_hold) or a keyword search over company name. By default only active businesses are returned.

• Resubmit Kyb

  Ask an existing business to resubmit its KYB verification (e.g. after a rejection). NOTE: this starts a new verification, which is billable and may email a contact - confirm with the operator before calling. Returns the new verification_url and which steps must be resubmitted.

• List Kyb Levels

  List the available KYB verification levels (their keys and display names). Use a level key as the kyb_level argument to create_kyb_business.

• List Contract Templates

  List your contract templates. Only templates with status 'published' can be sent for signing. Each template lists its signer roles and the variables you can fill via send_contract.

• Send Contract

  Send a published contract template for signing. Each signer needs the template role plus either an existing user_id / business_customer_id, or name and email for an external signer. NOTE: this emails real people immediately - confirm the signer list with the operator before calling. Requires an owner or operations API key role.

• Get Contract Status

  Check a contract request: overall status, each participant's progress and signing link, and the completed document URL once finished.

• List Invoices

  List your monthly billing invoices, newest first. Filter by period (period_year + period_month) or status. Amounts are strings and include tax; grand_total is the total due, outstanding_total is what is unpaid.

• Get Invoice

  Get one billing invoice in full: totals, fee breakdown, line items, recorded payments, tax breakdown, and payment_link (the online link to pay this invoice, if unpaid).

• Search Global

  Search across your transactions, users, business customers, projects, contracts, and support tickets by keyword. Returns up to limit_per_type (max 20) matches per category, each with an id, title, and subtitle.

• List Workflows

  List your automation workflows. status is one of draft, published, archived. Only published workflows can be triggered.