host

Get payment transaction info

Changed on

Returns all information about payment transaction.

get/api/v2/host/payment-transactions/{paymentTransactionId}

Request

  • Base URL
    https://api.momence.com
  • Auth
    OAuth 2
    Authorization code/api/v2/auth/authorize
    Password
    Token URL/api/v2/auth/token

Path parameters

paymentTransactionIdnumber required

Response

idinteger required
hostIdinteger required
paymentStatus'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete' required
currencystring required
priceExcludingVatInCurrencystring required
paidInCurrencystring required
vatAmountInCurrencystring required
paymentProcessorFeeCoveredByCustomerInCurrencystring required
paymentProcessorFeeCoveredByHostInCurrencystring required
platformFeeCoveredByCustomerInCurrencystring required
platformFeeCoveredByHostInCurrencystring required
paidInMoneyCreditsstring required
paidInEventCreditsstring required
paymentSource'host-schedule-plugin' | 'checkout-pages' | 'mobile-app' | 'pos' | 'host-dashboard' | 'member-dashboard' | 'classpass' | 'gympass' | 'free-appointment-autopay' | 'joining-already-paid-appointment' | 'auto-book-session-with-membership' | 'auto-book-appointment-with-membership' | 'auto-renew-package-membership' | 'transfer-membership' | 'scheduled-job-renew-membership' | 'scheduled-job-payment-plan' | 'scheduled-job-auto-enroll-into-membership-sessions' | 'scheduled-job-campaign-sequence-action' | 'scheduled-job-process-unpaid-transaction' | 'scheduled-job-create-session-new-two' | 'scheduled-job-pay-for-membership' | 'scheduled-job-retry-failed-membership-charge' | 'scheduled-job-appointment-customer-confirmation-cleanup' | 'appointment-customer-confirmation-link' | 'kiosk' | 'import' | 'legacy-bookings-migration' | 'auto-attendance-penalty' | 'auto-book-from-waitlist' | 'auto-book-from-spotfiller' | 'referral-reward' | 'referral-gift' | 'move-to-other-session-booking' | 'switch-session-booking-bought-membership' | 'event-credit-refund' | 'api-v2' | 'scheduled-job-charge-tuition-installments' | 'urban-sports-club' | 'my-clubs' | 'checkouts-v2' | 'openai-support-agent' | 'stripe-dispute' required
purchaseType'membership' | 'session' | 'product' | 'video' | 'course' | 'gift-card' | 'custom-gift-card' | 'monthly-subscription' | 'pos-cart' | 'checkout-cart' | 'custom-member-payment-plan-installment' | 'money-credit' | 'event-credit' | 'auto-attendance-penalty' | 'auto-attendance-penalty-retry-fee' | 'stripe-refund' | 'refund' | 'tips' | 'tuition-installment' | 'tuition-registration-fee' | 'membership-freeze-fee' | 'membership-cancellation-fee' | 'membership-renewal-retry-fee' | 'membership-transfer-fee' | 'membership-joining-fee' | 'appointment-attendee' | 'appointment-addon' | 'appointment-deposit' | 'appointment-new-attendee-new-reservation' | 'appointment-new-attendee-existing-reservation' | 'appointment-new-attendee-deposit-new-reservation' | 'open-area-visit' | 'appointment' | 'new-appointment' | 'reward-points' | 'imported-sale' required
createdAtstring required

Example response

{
  "payingMember": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phoneNumber": "1234567890",
    "pictureUrl": "https://example.com/picture.jpg"
  },
  "sales": [
    {
      "id": 1,
      "saleDate": "2021-01-01T00:00:00Z",
      "items": [
        {
          "id": 1,
          "saleItemId": 1,
          "itemType": "membership",
          "itemName": "Monthly Membership for Johns",
          "descriptiveItemName": "Monthly Membership for Johns",
          "payingMember": {
            "id": 1,
            "firstName": "John",
            "lastName": "Doe"
          },
          "targetMember": {
            "id": 1,
            "firstName": "John",
            "lastName": "Doe"
          },
          "session": {
            "id": 1,
            "name": "Monday Morning Yoga",
            "startsAt": "2021-01-01T00:00:00Z",
            "endsAt": "2021-01-01T01:00:00Z"
          },
          "appointment": {
            "id": 3,
            "name": "Stretching with John"
          },
          "product": {
            "id": 3,
            "name": "T-Shirt"
          },
          "productVariant": {
            "id": 3,
            "name": "M"
          },
          "openArea": {
            "id": 3,
            "name": "Gym A"
          },
          "quantity": 1,
          "unitPriceExcludingTaxInCurrency": "9.99",
          "unitTaxAmountInCurrency": "0.43"
        }
      ],
      "paymentTransaction": {
        "items": [
          {
            "paymentMethodType": "custom",
            "paymentMethodName": "Custom payment method",
            "amountInCurrencyWithoutTax": "9.99",
            "taxAmountInCurrency": "9.99"
          }
        ]
      }
    }
  ]
}

Changes