Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WeTravel Payment Links API

The Payment Links API from WeTravel — 3 operation(s) for payment links.

WeTravel Payment Links API is one of 17 APIs that WeTravel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Links. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 2.0.0.

Requests are made against 2 base URLs: https://api.wetravel.com/v2, https://api.demo.wetravel.to/v2.

6 operations 3 paths 6 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0.0
Base URL
https://api.wetravel.com/v2
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

WeTravel Payment Links API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as X-Api-Key (tokenAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Payment Links 6
POST
/payment_links
Create payment link
createPaymentLink 1 param body → 201400401
GET
/payment_links
List payment links
getPaymentLinks 3 params → 200401
DELETE
/payment_links/{uuid}
Delete payment link
deletePaymentLink 1 param → 204401404
GET
/payment_links/{uuid}
Get payment link
getPaymentLinkById 2 params → 200401404
PUT
/payment_links/{uuid}
Update payment link
updatePaymentLink 2 params body → 200400401404
POST
/payment_links/{uuid}/publish
Publish payment link
publishPaymentLink 1 param → 200400401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Pagination (6 properties), UpdatePaymentLink (2 properties), CreatePaymentLink (2 properties), PaymentLink (2 properties). Each schema is shown below with its type and property counts.

Installment
object
2 properties 2 required
ValidationError
object
1 property
PaymentLink
object
Payment Link model
2 properties
CreatePaymentLink
object
Create Payment Link request model
2 properties 2 required
UpdatePaymentLink
object
Update Payment Link request model
2 properties
Pagination
object
Pagination object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wetravel-payment-links-api-openapi.yml Raw ↑

Other APIs WeTravel publishes across the network.

WeTravel Access token API
WeTravel Add-ons API
WeTravel Discounts API
WeTravel Images API
WeTravel Included items API
WeTravel Leads API
WeTravel Not Included items API
WeTravel Orders API
WeTravel Packages API
WeTravel Paragraphs API
WeTravel Participant Information API
WeTravel Payment Plans API