v1

latestOpenAPI 3.0.12026-07-247756110.6 KB

Payment Links

Get payment link

Get a payment link by UUID

get/payment_links/{uuid}

Path parameters

uuidstring required

UUID of the payment link

Query parameters

publish_status'published' | 'draft'

Filter payment link by publish status

Response

Successful response

Example response

{
  "data": {
    "trip": {
      "uuid": "12345678",
      "title": "Amazing London Adventure",
      "trip_id": "TRIP20",
      "url": "https://example.com/trips/123456",
      "defaultImageUrl": "https://example.com/trip-123.jpg",
      "start_date": "2026-05-07",
      "end_date": "2026-05-14",
      "currency": "USD",
      "participant_fees": "all"
    },
    "pricing": {
      "price": 800,
      "payment_plan": {
        "deposit": 654,
        "installments": [
          {
            "type": "installment",
            "total": 5000,
            "previous_payment": 5000,
            "paid": true,
            "date": "2021-06-25T00:00:00.000Z"
          }
        ]
      }
    }
  }
}