api
transaction

Changed on

Get transaction's public info

get/api/public/transactions/{id}

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/public/transactions/{id}
  • Auth: none declared

Path parameters

idstring required

The ID of the transaction

Query parameters

secretstring required

The secret token of the transaction

Response

OK

tidstring required

The ID of the transaction

secretstring required

The secret token of the transaction

subscriptionIdstring

The ID of the subscription of the transaction

realPricenumber float required

The calculated real price of the transaction

currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK'

An ISO 4217 3-character code of the currency

vouchersstring[]

An array of voucher codes applied to this transaction

emailstring email

The email of the user of the transaction

status'NEW' | 'RESERVED-BY-SYSTEM' | 'ABORTED' | 'COMPLETE' | 'CANCELED' required

The status of the transaction.

companystring

The company name of the user of the transaction

namestring

The name of the user of the transaction

prenamestring

The firstname of the user of the transaction

lastnamestring

The lastname of the user of the transaction

streetstring

The street of the user of the transaction

line2string

The additional address field of the user of the transaction.

postalstring

The postal of the user of the transaction

citystring

The city of the user of the transaction

statestring

The state of the user of the transaction

countrystring

The country of the user of the transaction

createdAtstring date-time

An ISO timestamp indicating when the transaction was created

eventIdstring required

The ID of the event containing this transaction

paymentStatus'AWAITING' | 'PENDING' | 'RECEIVED' | 'REFUND' | 'CANCELED' | 'FAILED' | 'DISPUTE' | 'CHARGEBACK' | 'POS-RECEIVED' | 'POS-CANCELED' | 'LOCAL-PENDING' | 'LOCAL-AWAITING' | 'LOCAL-RECEIVED' | 'EXTERNAL'

The payment status of the transaction.

outerChargenumber float

The outer charge of the transaction

paymentMethod'paypal' | 'stripe' | 'local' | 'external' | 'vivenu-payments'

The payment method of the transaction.

preferredLanguage'de' | 'de-CH' | 'en' | 'en-GB' | 'en-AU' | 'fr' | 'es' | 'es-MX' | 'is' | 'it' | 'ru' | 'pt' | 'tr' | 'nb' | 'nl' | 'pl' | 'sv' | 'sl' | 'da' | 'cs' | 'lv' | 'he' | 'ar' | 'th' | 'ko' | 'ja' | 'zh-TW'

The preferred language of the transaction. It is determined automatically

extraFieldsobject

The extra fields of the transaction

underShopstring

The under shop of the transaction

paymentInfoMethodstring

The method of the payment

couponsstring[]

An array of coupon codes applied

Changes

  • 4ef1e0466eb3Revision changes
    • breaking

      added subschema #1 subschema #2 to the /// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /// response property oneOf list for the response status

  • bafd26ef1fbeRevision changes
    • warning

      added the new MWK enum value to the response property for the response status