Sign in

v1

latestOpenAPI 3.0.12026-07-247756110.6 KB
Transactions

Get transaction

Get a transaction

get/transactions/{uuid}

Path parameters

uuidstring required

The unique global ID of the transaction

Response

Get a transaction

uuidstring

The unique global ID of the transaction

user_idinteger

The unique ID of the user who initiated the transaction

organizer_idinteger

The unique ID of the organizer who's balance is affected

vendor_idinteger

The unique ID of the vendor who's balance is affected

amountinteger

The amount paid excluding all fees

customer_facing_amountinteger

Total gross amount paid through WeTravel - cc or bank payments

refunded_amountinteger

Amount refunded to the participant through WeTravel - cc or bank payments

disputed_amountinteger

Amount disputed to the participant through WeTravel - cc or bank payments

net_amountinteger

The final amount received by an organizer after deducting all the fees

currencystring

Currency of the transaction

transfer_idstring

The unique ID of the transaction based on type

bank_namestring

Bank's name

brandstring

Card brand name

last4string

Last 4 digits of cc or bank account

beneficiary_namestring

Beneficiary name of Top Up, Adjustment, Card Transfer, Conversion, Payout/Wire or Supplier Transfers

beneficiary_emailstring

Beneficiary email of Top Up, Payout/Wire, Conversion, or Supplier Transfers

payout_account_typestring

Payout account type

statusstring

Transaction status

notestring

Note of the transaction (Purpose of payment of Wire and Supplier Transfers)

descriptionstring

Description of the transaction

payment_methodstring

Payment method

payment_idstring

The unique ID of the payment

order_idstring

The unique ID of the order (booking)

rebooked_from_order_idstring

The unique ID of the order (booking) which this order was rebooked from

discount_codestring

discount_code

typestring

Transaction type

parent_uuidstring

The unique global ID of the parent transaction

wetravel_feeinteger

Wetravel fee

organizer_card_feeinteger

Card fee paid by the organizer

customer_card_feeinteger

Card fee paid by the customer (buyer)

organizer_payout_feeinteger

Payout fee paid by the organizer

created_atstring date-time

Time at which the transaction was initiated in ISO 8601 format

updated_atstring date-time

Time at which the transaction was updated in ISO 8601 format

running_balanceinteger

Running balance

referencestring

Reference filled in by the user who initiated the transaction

Example response

{
  "uuid": "py-19e4e192-db9e-401f-8e91-ebeee7826190",
  "user_id": 2,
  "organizer_id": 1,
  "amount": 100000,
  "customer_facing_amount": 102987,
  "net_amount": 98970,
  "currency": "USD",
  "bank_name": "STRIPE TEST BANK",
  "brand": "Visa",
  "status": "processed",
  "note": "Payout to my vendor",
  "description": "John Doe for San Francisco Trip!",
  "payment_method": "ach",
  "trip": {
    "title": "Epic Trip"
  },
  "rebooked_from_trip": {
    "title": "Epic Trip"
  },
  "participants": [
    {
      "email": "max.smith@wetravel.com",
      "first_name": "Max",
      "last_name": "Smith"
    }
  ],
  "packages": [
    {
      "name": "Sea Package",
      "price": 100000,
      "deposit": 2000,
      "participants": [
        {
          "email": "max.smith@wetravel.com",
          "first_name": "Max",
          "last_name": "Smith"
        }
      ]
    }
  ],
  "buyer": {
    "email": "john+doe@wetravel.com",
    "first_name": "John",
    "last_name": "Doe"
  },
  "type": "Payment",
  "wetravel_fee": 1030,
  "created_at": "2022-05-02T11:51:35.000Z",
  "updated_at": "2022-05-02T11:51:45.000Z",
  "running_balance": 19970,
  "reference": "Sample-Reference-1234"
}