Jump to Content
Guides
API Reference
Changelog
Discussions
Guides
API Reference
Create Your Account
API Reference
Guides
API Reference
Create Your Account
API Reference
Update checkout
Search
All
Pages
Start typing to search…
JUMP TO
UNIPaaS Platform API
Authentication
/authorize
post
Vendor
/vendors
post
/vendors
get
/vendors/{vendorId}
get
/vendors/{vendorId}/authorizations
get
/vendors/{vendorId}/settings/descriptor
patch
/vendors/{vendorId}/public-settings
get
/vendors/{vendorId}/public-settings/fees
get
/vendors/{vendorId}/marketing-configuration/{templateName}
get
/vendors/{vendorId}/marketing-data
get
/vendors/{vendorId}/communication-email
patch
/vendors/{vendorId}/ewallets
post
/vendors/{vendorId}/ewallets
get
/vendors/{vendorId}/ewallets/transactions
get
/vendors/{vendorId}/ewallets/{ewalletId}/transactions
get
/vendors/{vendorId}/payouts
get
/vendors/{vendorId}/payouts
post
/vendors/{vendorId}/payouts/configuration
get
/vendors/{vendorId}/payouts/configuration
del
/vendors/{vendorId}/payouts/configuration
post
/vendors/{vendorId}/payouts/{payoutId}/commit
post
/vendors/{vendorId}/payouts/{payoutId}/cancel
post
/vendors/{vendorId}/payouts/{payoutId}/drillthrough
get
/vendors/{vendorId}/payout-options
get
/vendors/{vendorId}/payment-options/available
get
/vendors/{vendorId}/payment-options
get
/vendors/{vendorId}/payment-methods/available
get
/vendors/{vendorId}/links
get
/vendors/{vendorId}/links
post
/vendors/{vendorId}/links/{linkId}
del
/vendors/{vendorId}/settings/logo
post
/vendors/{vendorId}/settings/logo
get
/vendors/{vendorId}/settings/logo
del
/vendors/{vendorId}/open-banking/link
post
/vendors/{vendorId}/open-banking/details
get
/vendors/open-banking/exchange
post
/vendors/{vendorId}/notifications
get
/vendors/{vendorId}/notifications/read
post
/vendors/{vendorId}/notifications/settings
get
/vendors/{vendorId}/notifications/settings
post
/vendors/{vendorId}/notifications/templates
get
/vendors/{vendorId}/invoices
get
/vendors/{vendorId}/invoices
post
/vendors/{vendorId}/invoices/{invoicesId}
get
/vendors/{vendorId}/invoices/{invoicesId}
patch
/vendors/reference/{vendorReference}/invoices
post
/vendors/reference/{vendorReference}/invoices/{invoicesId}
patch
/vendors/{vendorId}/mandates
post
/vendors/{vendorId}/mandates
get
/vendors/{vendorId}/mandates/{mandateId}/send
post
/vendors/{vendorId}/consumers/{consumerId}/mandates/{mandateId}/commit
post
/vendors/{vendorId}/mandates/{mandateId}/cancel
post
/vendors/{vendorId}/consumers/{consumerId}/mandates
get
/vendors/{vendorId}/consumers/{consumerId}/mandates/pdf
get
/vendors/{vendorId}/consumers/reference/{consumerReference}/mandates
get
eWallet
/ewallets
post
/ewallets
get
/ewallets/{ewalletId}
get
/ewallets/{ewalletId}/transactions
get
Payment Option
/payment-options
get
Payout
/payouts
get
/payouts
post
/payouts/{payoutId}/commit
post
/payouts/{payoutId}/cancel
post
/payouts/configuration
get
/payouts/configuration
del
/payouts/configuration
post
/payouts/{payoutId}
get
/payouts/{payoutId}/drillthrough
get
Onboarding
/vendors/{vendorId}/onboarding/file
post
/vendors/{vendorId}/onboarding
get
/vendors/{vendorId}/onboarding
post
/vendors/{vendorId}/overview
get
/vendors/{vendorId}/onboarding/require
post
Recurring
/pay-ins/plans
post
/pay-ins/plans
get
/pay-ins/plans/{planId}
get
/pay-ins/plans/{planId}
patch
/pay-ins/plans/{planId}
del
/pay-ins/plans/{planId}/subscriptions
get
/pay-ins/plans/{planId}/subscriptions
post
/pay-ins/plans/{planId}/subscriptions/{subscriptionId}
get
/pay-ins/plans/{planId}/subscriptions/{subscriptionId}
patch
PayIn
/pay-ins/checkout
post
Update checkout
patch
Expire checkout
post
/pay-ins/checkout/{checkoutId}
get
/pay-ins/banks
get
/pay-ins/token
post
/pay-ins
post
/pay-ins/{authorizationId}
get
/pay-ins/{authorizationId}/capture
post
/pay-ins/{authorizationId}/void
post
/pay-ins/{authorizationId}/refund
post
/pay-ins/{authorizationId}/activate
post
/pay-ins/{authorizationId}/reschedule
post
Payout Option
/payout-options
get
Webhook
/webhooks
get
/webhooks
post
/webhooks/{webhookId}
get
/webhooks/{webhookId}
patch
/webhooks/{webhookId}
del
Configuration
/configuration/public-configurations
get
Link
/links/{linkId}
get
/links/{linkId}/tokens
get
/links/{linkId}/tokens/login
get
/links/{linkId}/send
post
Reports
/reports/volume
get
/reports/revenue
get
/reports/revenue/vendors
get
/reports/balance
get
/reports/vendors-funnel
get
Transfer
/transfers
get
/transfers
post
/transfers/{transferId}/commit
post
/transfers/{transferId}/cancel
post
/transfers/{transferId}
get
Payments
/vendors/{vendorId}/embedded/payouts
get
/vendors/{vendorId}/payments
get
Consumers
/consumers/{consumerId}/payment-options/{paymentOptionId}
del
/consumers
post
Processors
/processors/{processorId}/webhooks
get
/processors/{processorId}/webhooks
post
AI
/ai/payment-methods-recommendation/vendor/{vendorId}/customer/{customerReference}
get
Chargebacks
/vendors/{vendorId}/chargebacks
get
Campaigns
/campaigns/vendors
get
/campaigns/vendors
post
/campaigns/vendors/delete
post
QR Code
/qr-code/generate
get
Update checkout
patch
https://sandbox.unipaas.com/platform/pay-ins/checkout/
{signedLinkId}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
URL
Base URL
https://sandbox.unipaas.com/platform
/pay-ins/checkout/{signedLinkId}
Response
Click
Try It!
to start a request and see the response here!