v2023-09-01
Search...
/
API Status
Partner Portal
Home
Guides
API Explorer
GitHub
Support
Home
Guides
API Explorer
GitHub
Support
API Concepts
Overview
Environments and URLs
Authentication
API versioning
Rate limiting
HTTP headers
Pagination, sorting, and filtering
General
Access tokens
Partner settings
Webhook subscriptions
Webhook deliveries
Events
Common
Entities
Entity bank accounts
Entity persons
Entity VAT IDs
Roles
Entity users
Counterparts
Counterpart addresses
Counterpart bank accounts
Counterpart contacts
Counterpart VAT IDs
Payment records
Projects
Tags
Accounts payable
Approval policies
Approval requests
Comments
Payable line items
Payables
Purchase orders
Accounts receivable
Measure units
Overdue reminders
Payment reminders
Payment terms
Products
Receivables
Recurrences
VAT rates
Payments
Batch payments
Entity bank account verifications
Entity onboarding data
Onboarding documents
Onboarding links
Onboarding requirements
Payment intents
Payment links
POST
Create a payment link
GET
Get payment link by ID
POST
Expire a payment link
Payment methods
Accounting integration
Accounting connections
Accounting data pull
Accounting synchronized records
Accounting tax rates
Ledger accounts
Utilities
Audit logs
Data export
Data export - extra data
Files
Mail templates
Mailbox domains
Mailboxes
PDF templates
Text templates
API Status
Partner Portal
Payments
Payment links
Get payment link by ID
GET
https://api.sandbox.monite.com/v1
/
payment_links
/
:payment_link_id
Path parameters
payment_link_id
string
Required
Headers
Auth
Authorization
string
Required
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-version
string
Required
x-monite-entity-id
string
Required
The ID of the entity that owns the requested resource.
Response
This endpoint returns an object.
id
string
amount
integer
currency
enum
Show 136 enum values
expires_at
datetime
payment_intent_id
string
payment_methods
list of strings
payment_page_url
string
recipient
object
Show 4 properties
status
string
invoice
object
Optional
Show 3 properties
payer
object
Optional
Show 3 properties
payment_intent
object
Optional
Show 7 properties
payment_reference
string
Optional
return_url
string
Optional
Errors
422
Unprocessable Entity
500
Internal Server Error
Expire a payment link
Up Next