@simpleapps-com/augur-api 2026.10.31 → 2026.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +84 -33
- package/SKILL.md +25 -24
- package/dist/client.d.ts +334 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/core/base-client.d.ts +179 -0
- package/dist/core/base-client.d.ts.map +1 -0
- package/dist/core/call-rules.d.ts +73 -0
- package/dist/core/call-rules.d.ts.map +1 -0
- package/dist/core/call.d.ts +48 -0
- package/dist/core/call.d.ts.map +1 -0
- package/dist/core/client.d.ts +112 -0
- package/dist/core/client.d.ts.map +1 -0
- package/dist/core/common-schemas.d.ts +522 -0
- package/dist/core/common-schemas.d.ts.map +1 -0
- package/dist/core/config.d.ts +72 -0
- package/dist/core/config.d.ts.map +1 -0
- package/dist/core/encoded-segment.d.ts +23 -0
- package/dist/core/encoded-segment.d.ts.map +1 -0
- package/dist/core/errors.d.ts +91 -0
- package/dist/core/errors.d.ts.map +1 -0
- package/dist/core/http-rules.d.ts +64 -0
- package/dist/core/http-rules.d.ts.map +1 -0
- package/dist/core/path-validation.d.ts +28 -0
- package/dist/core/path-validation.d.ts.map +1 -0
- package/dist/core/proxy-rules.d.ts +21 -0
- package/dist/core/proxy-rules.d.ts.map +1 -0
- package/dist/core/registry-rules.d.ts +15 -0
- package/dist/core/registry-rules.d.ts.map +1 -0
- package/dist/core/registry-tables.d.ts +3 -0
- package/dist/core/registry-tables.d.ts.map +1 -0
- package/dist/core/registry.d.ts +54 -0
- package/dist/core/registry.d.ts.map +1 -0
- package/dist/core/response-rules.d.ts +19 -0
- package/dist/core/response-rules.d.ts.map +1 -0
- package/dist/core/schemas.d.ts +70 -0
- package/dist/core/schemas.d.ts.map +1 -0
- package/dist/core/service-proxy.d.ts +81 -0
- package/dist/core/service-proxy.d.ts.map +1 -0
- package/dist/core/site-id-check.d.ts +6 -0
- package/dist/core/site-id-check.d.ts.map +1 -0
- package/dist/core/site-id.d.ts +15 -0
- package/dist/core/site-id.d.ts.map +1 -0
- package/dist/index.d.ts +71 -236
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +19875 -18513
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +19874 -18513
- package/dist/index.mjs.map +1 -1
- package/dist/services/agr-info/client.d.ts +71 -0
- package/dist/services/agr-info/client.d.ts.map +1 -0
- package/dist/services/agr-info/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-info/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-info/generated/schemas.d.ts +297 -0
- package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-info/generated/types.d.ts +1093 -0
- package/dist/services/agr-info/generated/types.d.ts.map +1 -0
- package/dist/services/agr-info/index.d.ts +2 -0
- package/dist/services/agr-info/index.d.ts.map +1 -0
- package/dist/services/agr-int/client.d.ts +100 -0
- package/dist/services/agr-int/client.d.ts.map +1 -0
- package/dist/services/agr-int/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-int/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-int/generated/schemas.d.ts +595 -0
- package/dist/services/agr-int/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-int/generated/types.d.ts +1984 -0
- package/dist/services/agr-int/generated/types.d.ts.map +1 -0
- package/dist/services/agr-int/index.d.ts +2 -0
- package/dist/services/agr-int/index.d.ts.map +1 -0
- package/dist/services/agr-site/client.d.ts +112 -0
- package/dist/services/agr-site/client.d.ts.map +1 -0
- package/dist/services/agr-site/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-site/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-site/generated/schemas.d.ts +537 -0
- package/dist/services/agr-site/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-site/generated/types.d.ts +1732 -0
- package/dist/services/agr-site/generated/types.d.ts.map +1 -0
- package/dist/services/agr-site/index.d.ts +2 -0
- package/dist/services/agr-site/index.d.ts.map +1 -0
- package/dist/services/agr-work/client.d.ts +23 -0
- package/dist/services/agr-work/client.d.ts.map +1 -0
- package/dist/services/agr-work/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-work/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-work/generated/schemas.d.ts +21 -0
- package/dist/services/agr-work/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-work/generated/types.d.ts +19 -0
- package/dist/services/agr-work/generated/types.d.ts.map +1 -0
- package/dist/services/agr-work/index.d.ts +2 -0
- package/dist/services/agr-work/index.d.ts.map +1 -0
- package/dist/services/avalara/client.d.ts +33 -0
- package/dist/services/avalara/client.d.ts.map +1 -0
- package/dist/services/avalara/generated/endpoints.d.ts +41 -0
- package/dist/services/avalara/generated/endpoints.d.ts.map +1 -0
- package/dist/services/avalara/generated/schemas.d.ts +22 -0
- package/dist/services/avalara/generated/schemas.d.ts.map +1 -0
- package/dist/services/avalara/generated/types.d.ts +103 -0
- package/dist/services/avalara/generated/types.d.ts.map +1 -0
- package/dist/services/avalara/index.d.ts +2 -0
- package/dist/services/avalara/index.d.ts.map +1 -0
- package/dist/services/basecamp2/client.d.ts +92 -0
- package/dist/services/basecamp2/client.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts +42 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/schemas.d.ts +845 -0
- package/dist/services/basecamp2/generated/schemas.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/types.d.ts +1587 -0
- package/dist/services/basecamp2/generated/types.d.ts.map +1 -0
- package/dist/services/basecamp2/index.d.ts +2 -0
- package/dist/services/basecamp2/index.d.ts.map +1 -0
- package/dist/services/brand-folder/client.d.ts +37 -0
- package/dist/services/brand-folder/client.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts +41 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/schemas.d.ts +81 -0
- package/dist/services/brand-folder/generated/schemas.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/types.d.ts +195 -0
- package/dist/services/brand-folder/generated/types.d.ts.map +1 -0
- package/dist/services/brand-folder/index.d.ts +2 -0
- package/dist/services/brand-folder/index.d.ts.map +1 -0
- package/dist/services/commerce/client.d.ts +57 -0
- package/dist/services/commerce/client.d.ts.map +1 -0
- package/dist/services/commerce/generated/endpoints.d.ts +42 -0
- package/dist/services/commerce/generated/endpoints.d.ts.map +1 -0
- package/dist/services/commerce/generated/schemas.d.ts +319 -0
- package/dist/services/commerce/generated/schemas.d.ts.map +1 -0
- package/dist/services/commerce/generated/types.d.ts +1134 -0
- package/dist/services/commerce/generated/types.d.ts.map +1 -0
- package/dist/services/commerce/index.d.ts +2 -0
- package/dist/services/commerce/index.d.ts.map +1 -0
- package/dist/services/customers/client.d.ts +162 -0
- package/dist/services/customers/client.d.ts.map +1 -0
- package/dist/services/customers/generated/endpoints.d.ts +42 -0
- package/dist/services/customers/generated/endpoints.d.ts.map +1 -0
- package/dist/services/customers/generated/schemas.d.ts +1970 -0
- package/dist/services/customers/generated/schemas.d.ts.map +1 -0
- package/dist/services/customers/generated/types.d.ts +3849 -0
- package/dist/services/customers/generated/types.d.ts.map +1 -0
- package/dist/services/customers/index.d.ts +2 -0
- package/dist/services/customers/index.d.ts.map +1 -0
- package/dist/services/goog-mc/client.d.ts +44 -0
- package/dist/services/goog-mc/client.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts +42 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/schemas.d.ts +175 -0
- package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/types.d.ts +361 -0
- package/dist/services/goog-mc/generated/types.d.ts.map +1 -0
- package/dist/services/goog-mc/index.d.ts +2 -0
- package/dist/services/goog-mc/index.d.ts.map +1 -0
- package/dist/services/gregorovich/client.d.ts +34 -0
- package/dist/services/gregorovich/client.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts +42 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/schemas.d.ts +35 -0
- package/dist/services/gregorovich/generated/schemas.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/types.d.ts +70 -0
- package/dist/services/gregorovich/generated/types.d.ts.map +1 -0
- package/dist/services/gregorovich/index.d.ts +2 -0
- package/dist/services/gregorovich/index.d.ts.map +1 -0
- package/dist/services/items/client.d.ts +453 -0
- package/dist/services/items/client.d.ts.map +1 -0
- package/dist/services/items/generated/endpoints.d.ts +42 -0
- package/dist/services/items/generated/endpoints.d.ts.map +1 -0
- package/dist/services/items/generated/schemas.d.ts +4636 -0
- package/dist/services/items/generated/schemas.d.ts.map +1 -0
- package/dist/services/items/generated/types.d.ts +10513 -0
- package/dist/services/items/generated/types.d.ts.map +1 -0
- package/dist/services/items/index.d.ts +2 -0
- package/dist/services/items/index.d.ts.map +1 -0
- package/dist/services/joomla/client.d.ts +74 -0
- package/dist/services/joomla/client.d.ts.map +1 -0
- package/dist/services/joomla/generated/endpoints.d.ts +41 -0
- package/dist/services/joomla/generated/endpoints.d.ts.map +1 -0
- package/dist/services/joomla/generated/schemas.d.ts +546 -0
- package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
- package/dist/services/joomla/generated/types.d.ts +1489 -0
- package/dist/services/joomla/generated/types.d.ts.map +1 -0
- package/dist/services/joomla/index.d.ts +2 -0
- package/dist/services/joomla/index.d.ts.map +1 -0
- package/dist/services/legacy/client.d.ts +75 -0
- package/dist/services/legacy/client.d.ts.map +1 -0
- package/dist/services/legacy/generated/endpoints.d.ts +41 -0
- package/dist/services/legacy/generated/endpoints.d.ts.map +1 -0
- package/dist/services/legacy/generated/schemas.d.ts +567 -0
- package/dist/services/legacy/generated/schemas.d.ts.map +1 -0
- package/dist/services/legacy/generated/types.d.ts +1454 -0
- package/dist/services/legacy/generated/types.d.ts.map +1 -0
- package/dist/services/legacy/index.d.ts +2 -0
- package/dist/services/legacy/index.d.ts.map +1 -0
- package/dist/services/logistics/client.d.ts +64 -0
- package/dist/services/logistics/client.d.ts.map +1 -0
- package/dist/services/logistics/generated/endpoints.d.ts +41 -0
- package/dist/services/logistics/generated/endpoints.d.ts.map +1 -0
- package/dist/services/logistics/generated/schemas.d.ts +375 -0
- package/dist/services/logistics/generated/schemas.d.ts.map +1 -0
- package/dist/services/logistics/generated/types.d.ts +925 -0
- package/dist/services/logistics/generated/types.d.ts.map +1 -0
- package/dist/services/logistics/index.d.ts +2 -0
- package/dist/services/logistics/index.d.ts.map +1 -0
- package/dist/services/markets/client.d.ts +47 -0
- package/dist/services/markets/client.d.ts.map +1 -0
- package/dist/services/markets/generated/endpoints.d.ts +41 -0
- package/dist/services/markets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/markets/generated/schemas.d.ts +180 -0
- package/dist/services/markets/generated/schemas.d.ts.map +1 -0
- package/dist/services/markets/generated/types.d.ts +405 -0
- package/dist/services/markets/generated/types.d.ts.map +1 -0
- package/dist/services/markets/index.d.ts +2 -0
- package/dist/services/markets/index.d.ts.map +1 -0
- package/dist/services/notifications/client.d.ts +58 -0
- package/dist/services/notifications/client.d.ts.map +1 -0
- package/dist/services/notifications/generated/endpoints.d.ts +41 -0
- package/dist/services/notifications/generated/endpoints.d.ts.map +1 -0
- package/dist/services/notifications/generated/schemas.d.ts +247 -0
- package/dist/services/notifications/generated/schemas.d.ts.map +1 -0
- package/dist/services/notifications/generated/types.d.ts +666 -0
- package/dist/services/notifications/generated/types.d.ts.map +1 -0
- package/dist/services/notifications/index.d.ts +2 -0
- package/dist/services/notifications/index.d.ts.map +1 -0
- package/dist/services/open-search/client.d.ts +69 -0
- package/dist/services/open-search/client.d.ts.map +1 -0
- package/dist/services/open-search/generated/endpoints.d.ts +42 -0
- package/dist/services/open-search/generated/endpoints.d.ts.map +1 -0
- package/dist/services/open-search/generated/schemas.d.ts +363 -0
- package/dist/services/open-search/generated/schemas.d.ts.map +1 -0
- package/dist/services/open-search/generated/types.d.ts +983 -0
- package/dist/services/open-search/generated/types.d.ts.map +1 -0
- package/dist/services/open-search/index.d.ts +2 -0
- package/dist/services/open-search/index.d.ts.map +1 -0
- package/dist/services/orders/client.d.ts +180 -0
- package/dist/services/orders/client.d.ts.map +1 -0
- package/dist/services/orders/generated/endpoints.d.ts +42 -0
- package/dist/services/orders/generated/endpoints.d.ts.map +1 -0
- package/dist/services/orders/generated/schemas.d.ts +2479 -0
- package/dist/services/orders/generated/schemas.d.ts.map +1 -0
- package/dist/services/orders/generated/types.d.ts +4717 -0
- package/dist/services/orders/generated/types.d.ts.map +1 -0
- package/dist/services/orders/index.d.ts +2 -0
- package/dist/services/orders/index.d.ts.map +1 -0
- package/dist/services/p21-apis/client.d.ts +59 -0
- package/dist/services/p21-apis/client.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/schemas.d.ts +46 -0
- package/dist/services/p21-apis/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/types.d.ts +246 -0
- package/dist/services/p21-apis/generated/types.d.ts.map +1 -0
- package/dist/services/p21-apis/index.d.ts +2 -0
- package/dist/services/p21-apis/index.d.ts.map +1 -0
- package/dist/services/p21-core/client.d.ts +131 -0
- package/dist/services/p21-core/client.d.ts.map +1 -0
- package/dist/services/p21-core/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-core/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-core/generated/schemas.d.ts +1478 -0
- package/dist/services/p21-core/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-core/generated/types.d.ts +2718 -0
- package/dist/services/p21-core/generated/types.d.ts.map +1 -0
- package/dist/services/p21-core/index.d.ts +2 -0
- package/dist/services/p21-core/index.d.ts.map +1 -0
- package/dist/services/p21-pim/client.d.ts +75 -0
- package/dist/services/p21-pim/client.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/schemas.d.ts +383 -0
- package/dist/services/p21-pim/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/types.d.ts +933 -0
- package/dist/services/p21-pim/generated/types.d.ts.map +1 -0
- package/dist/services/p21-pim/index.d.ts +2 -0
- package/dist/services/p21-pim/index.d.ts.map +1 -0
- package/dist/services/p21-sism/client.d.ts +432 -0
- package/dist/services/p21-sism/client.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/schemas.d.ts +2844 -0
- package/dist/services/p21-sism/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/types.d.ts +6977 -0
- package/dist/services/p21-sism/generated/types.d.ts.map +1 -0
- package/dist/services/p21-sism/index.d.ts +37 -0
- package/dist/services/p21-sism/index.d.ts.map +1 -0
- package/dist/services/payments/client.d.ts +77 -0
- package/dist/services/payments/client.d.ts.map +1 -0
- package/dist/services/payments/generated/endpoints.d.ts +42 -0
- package/dist/services/payments/generated/endpoints.d.ts.map +1 -0
- package/dist/services/payments/generated/schemas.d.ts +1015 -0
- package/dist/services/payments/generated/schemas.d.ts.map +1 -0
- package/dist/services/payments/generated/types.d.ts +1432 -0
- package/dist/services/payments/generated/types.d.ts.map +1 -0
- package/dist/services/payments/index.d.ts +2 -0
- package/dist/services/payments/index.d.ts.map +1 -0
- package/dist/services/pricing/client.d.ts +216 -0
- package/dist/services/pricing/client.d.ts.map +1 -0
- package/dist/services/pricing/generated/endpoints.d.ts +42 -0
- package/dist/services/pricing/generated/endpoints.d.ts.map +1 -0
- package/dist/services/pricing/generated/schemas.d.ts +2048 -0
- package/dist/services/pricing/generated/schemas.d.ts.map +1 -0
- package/dist/services/pricing/generated/types.d.ts +4257 -0
- package/dist/services/pricing/generated/types.d.ts.map +1 -0
- package/dist/services/pricing/index.d.ts +2 -0
- package/dist/services/pricing/index.d.ts.map +1 -0
- package/dist/services/shipping/client.d.ts +33 -0
- package/dist/services/shipping/client.d.ts.map +1 -0
- package/dist/services/shipping/generated/endpoints.d.ts +41 -0
- package/dist/services/shipping/generated/endpoints.d.ts.map +1 -0
- package/dist/services/shipping/generated/schemas.d.ts +29 -0
- package/dist/services/shipping/generated/schemas.d.ts.map +1 -0
- package/dist/services/shipping/generated/types.d.ts +116 -0
- package/dist/services/shipping/generated/types.d.ts.map +1 -0
- package/dist/services/shipping/index.d.ts +2 -0
- package/dist/services/shipping/index.d.ts.map +1 -0
- package/dist/services/smarty-streets/client.d.ts +33 -0
- package/dist/services/smarty-streets/client.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts +41 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts +72 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/types.d.ts +145 -0
- package/dist/services/smarty-streets/generated/types.d.ts.map +1 -0
- package/dist/services/smarty-streets/index.d.ts +2 -0
- package/dist/services/smarty-streets/index.d.ts.map +1 -0
- package/dist/services/ups/client.d.ts +32 -0
- package/dist/services/ups/client.d.ts.map +1 -0
- package/dist/services/ups/generated/endpoints.d.ts +40 -0
- package/dist/services/ups/generated/endpoints.d.ts.map +1 -0
- package/dist/services/ups/generated/schemas.d.ts +51 -0
- package/dist/services/ups/generated/schemas.d.ts.map +1 -0
- package/dist/services/ups/generated/types.d.ts +98 -0
- package/dist/services/ups/generated/types.d.ts.map +1 -0
- package/dist/services/ups/index.d.ts +2 -0
- package/dist/services/ups/index.d.ts.map +1 -0
- package/dist/services/vendors/client.d.ts +38 -0
- package/dist/services/vendors/client.d.ts.map +1 -0
- package/dist/services/vendors/generated/endpoints.d.ts +41 -0
- package/dist/services/vendors/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vendors/generated/schemas.d.ts +350 -0
- package/dist/services/vendors/generated/schemas.d.ts.map +1 -0
- package/dist/services/vendors/generated/types.d.ts +470 -0
- package/dist/services/vendors/generated/types.d.ts.map +1 -0
- package/dist/services/vendors/index.d.ts +2 -0
- package/dist/services/vendors/index.d.ts.map +1 -0
- package/dist/services/vmi/client.d.ts +129 -0
- package/dist/services/vmi/client.d.ts.map +1 -0
- package/dist/services/vmi/generated/endpoints.d.ts +41 -0
- package/dist/services/vmi/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vmi/generated/schemas.d.ts +723 -0
- package/dist/services/vmi/generated/schemas.d.ts.map +1 -0
- package/dist/services/vmi/generated/types.d.ts +2620 -0
- package/dist/services/vmi/generated/types.d.ts.map +1 -0
- package/dist/services/vmi/index.d.ts +2 -0
- package/dist/services/vmi/index.d.ts.map +1 -0
- package/dist/testing.d.ts +9 -13
- package/dist/testing.d.ts.map +1 -0
- package/dist/testing.js +7 -17
- package/dist/testing.js.map +1 -1
- package/dist/testing.mjs +7 -17
- package/dist/testing.mjs.map +1 -1
- package/dist/utils/cross-site-auth.d.ts +88 -0
- package/dist/utils/cross-site-auth.d.ts.map +1 -0
- package/package.json +34 -47
- package/dist/client-TPJa269Y.d.mts +0 -58610
- package/dist/client-TPJa269Y.d.ts +0 -58610
- package/dist/index.d.mts +0 -236
- package/dist/testing.d.mts +0 -83
|
@@ -0,0 +1,1432 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated types for the payments service.
|
|
3
|
+
* Unified payment processing gateway supporting Moneris, PayTrace, and Element card transactions
|
|
4
|
+
* and PayPal orders
|
|
5
|
+
*
|
|
6
|
+
* Public specs (the source of truth for every shape below):
|
|
7
|
+
* https://payments.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
|
|
8
|
+
* params and query params, each with type and required flag. Grep it for a path; for a GET
|
|
9
|
+
* that line is all you need. Bodies are not in it.
|
|
10
|
+
* https://payments.augur-api.com/openapi.json: the full contract: request and response bodies
|
|
11
|
+
* field by field, descriptions, formats and documented errors.
|
|
12
|
+
* https://payments.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
|
|
13
|
+
* services.
|
|
14
|
+
*
|
|
15
|
+
* Source: shared/specs/payments.json
|
|
16
|
+
*
|
|
17
|
+
* DO NOT EDIT — regenerate with: pnpm -C tools/augur-api-generator generate ts
|
|
18
|
+
*/
|
|
19
|
+
import type { EdgeCacheParams } from "../../../core/common-schemas";
|
|
20
|
+
import type { BaseResponse } from "../../../core/schemas";
|
|
21
|
+
/** Params for GET /moneris/pre-auth */
|
|
22
|
+
export interface MonerisPreAuthListParams extends EdgeCacheParams {
|
|
23
|
+
/** Amount of the transaction */
|
|
24
|
+
amount: number;
|
|
25
|
+
/** credit card number */
|
|
26
|
+
ccNumber: string;
|
|
27
|
+
/** expiration date of the credit card(YYMM) */
|
|
28
|
+
expDate: string;
|
|
29
|
+
/** Order ID for the transaction */
|
|
30
|
+
orderId: string;
|
|
31
|
+
/** Test mode for the transaction(Default: false) */
|
|
32
|
+
testMode?: boolean;
|
|
33
|
+
}
|
|
34
|
+
/** Params for GET /moneris/pre-auth-complete */
|
|
35
|
+
export interface MonerisPreAuthCompleteListParams extends EdgeCacheParams {
|
|
36
|
+
/** Amount of the transaction */
|
|
37
|
+
amount: number;
|
|
38
|
+
/** Order ID for the transaction */
|
|
39
|
+
orderId: string;
|
|
40
|
+
/** API mode for the transaction(Default: true) */
|
|
41
|
+
testMode?: boolean;
|
|
42
|
+
/** Transaction number */
|
|
43
|
+
txnNumber: string;
|
|
44
|
+
}
|
|
45
|
+
/** Params for GET /paypal/order-return */
|
|
46
|
+
export interface PaypalOrderReturnListParams extends EdgeCacheParams {
|
|
47
|
+
/**
|
|
48
|
+
* siteId, passed in the query because PayPal redirects the browser here via a GET and cannot send
|
|
49
|
+
* the x-site-id header
|
|
50
|
+
*/
|
|
51
|
+
siteId: string;
|
|
52
|
+
/**
|
|
53
|
+
* "true" or "1" uses the PayPal sandbox; any other value or none uses live; must match the mode
|
|
54
|
+
* the order was created in
|
|
55
|
+
*/
|
|
56
|
+
testMode?: string;
|
|
57
|
+
/** PayPal order ID (PayPal appends token to the return URL) */
|
|
58
|
+
token: string;
|
|
59
|
+
}
|
|
60
|
+
/** Params for GET /paypal/order/details */
|
|
61
|
+
export interface PaypalOrderDetailsListParams extends EdgeCacheParams {
|
|
62
|
+
/** PayPal order ID */
|
|
63
|
+
orderId: string;
|
|
64
|
+
/** "true" or "1" uses the PayPal sandbox; any other value or none uses live */
|
|
65
|
+
testMode?: string;
|
|
66
|
+
}
|
|
67
|
+
/** Params for GET /paypal/refund */
|
|
68
|
+
export interface PaypalRefundListParams extends EdgeCacheParams {
|
|
69
|
+
/** PayPal refund ID */
|
|
70
|
+
refundId: string;
|
|
71
|
+
/** "true" or "1" uses the PayPal sandbox; any other value or none uses live */
|
|
72
|
+
testMode?: string;
|
|
73
|
+
}
|
|
74
|
+
/** Params for POST /paypal/webhook */
|
|
75
|
+
export interface PaypalWebhookCreateParams {
|
|
76
|
+
/**
|
|
77
|
+
* siteId, passed in the query because PayPal posts server-to-server and cannot send the x-site-id
|
|
78
|
+
* header
|
|
79
|
+
*/
|
|
80
|
+
siteId: string;
|
|
81
|
+
/**
|
|
82
|
+
* "true" or "1" uses the PayPal sandbox; any other value or none uses live; must match the
|
|
83
|
+
* webhook environment registered with PayPal
|
|
84
|
+
*/
|
|
85
|
+
testMode?: string;
|
|
86
|
+
}
|
|
87
|
+
/** Params for GET /unified/account-query */
|
|
88
|
+
export interface UnifiedAccountQueryListParams extends EdgeCacheParams {
|
|
89
|
+
/** Customer ID for the transaction */
|
|
90
|
+
customerId: string;
|
|
91
|
+
/** API mode for the transaction(Default: live|dev) */
|
|
92
|
+
mode?: string;
|
|
93
|
+
/** Element TransactionSetupID returned by /api/unified/transaction-setup */
|
|
94
|
+
transactionSetupId: string;
|
|
95
|
+
}
|
|
96
|
+
/** Params for GET /unified/billing-update */
|
|
97
|
+
export interface UnifiedBillingUpdateListParams extends EdgeCacheParams {
|
|
98
|
+
/** Billing street address line 1 */
|
|
99
|
+
address1: string;
|
|
100
|
+
/** Billing street address line 2 */
|
|
101
|
+
address2?: string;
|
|
102
|
+
/** Billing city */
|
|
103
|
+
city: string;
|
|
104
|
+
/** Customer ID for the transaction */
|
|
105
|
+
customerId?: string;
|
|
106
|
+
/** API mode for the transaction(Default: live|dev) */
|
|
107
|
+
mode?: string;
|
|
108
|
+
/** Billing state code */
|
|
109
|
+
state: string;
|
|
110
|
+
/** Element TransactionSetupID returned by /api/unified/transaction-setup */
|
|
111
|
+
transactionSetupId: string;
|
|
112
|
+
/** Billing ZIP code */
|
|
113
|
+
zip: string;
|
|
114
|
+
}
|
|
115
|
+
/** Params for GET /unified/card-info */
|
|
116
|
+
export interface UnifiedCardInfoListParams extends EdgeCacheParams {
|
|
117
|
+
/** Customer ID for the transaction */
|
|
118
|
+
customerId?: string;
|
|
119
|
+
/** API mode for the transaction(Default: live|dev) */
|
|
120
|
+
mode?: string;
|
|
121
|
+
/** Element TransactionSetupID returned by /api/unified/transaction-setup */
|
|
122
|
+
transactionSetupId: string;
|
|
123
|
+
}
|
|
124
|
+
/** Params for GET /unified/surcharge */
|
|
125
|
+
export interface UnifiedSurchargeListParams extends EdgeCacheParams {
|
|
126
|
+
/** Transaction amount the surcharge is calculated on */
|
|
127
|
+
amount: string;
|
|
128
|
+
/** Country code of the transaction */
|
|
129
|
+
country: string;
|
|
130
|
+
/** Customer ID for the transaction */
|
|
131
|
+
customerId: string;
|
|
132
|
+
/** State code the order ships from */
|
|
133
|
+
fromState: string;
|
|
134
|
+
/** API mode for the transaction(Default: live|dev) */
|
|
135
|
+
mode?: string;
|
|
136
|
+
/** Element PaymentAccountID (card token) the surcharge applies to */
|
|
137
|
+
paymentAccountId: string;
|
|
138
|
+
/** State code the order ships to */
|
|
139
|
+
toState: string;
|
|
140
|
+
}
|
|
141
|
+
/** Params for GET /unified/transaction-response */
|
|
142
|
+
export interface UnifiedTransactionResponseListParams extends EdgeCacheParams {
|
|
143
|
+
/**
|
|
144
|
+
* siteId, passed in the query because Element redirects the browser here via a GET and cannot
|
|
145
|
+
* send the x-site-id header
|
|
146
|
+
*/
|
|
147
|
+
siteId?: string;
|
|
148
|
+
}
|
|
149
|
+
/** Params for GET /unified/transaction-setup */
|
|
150
|
+
export interface UnifiedTransactionSetupListParams extends EdgeCacheParams {
|
|
151
|
+
/** Customer ID for the transaction */
|
|
152
|
+
customerId: string;
|
|
153
|
+
/** API mode for the transaction(dev or live) */
|
|
154
|
+
mode?: string;
|
|
155
|
+
}
|
|
156
|
+
/** Params for GET /unified/validate */
|
|
157
|
+
export interface UnifiedValidateListParams extends EdgeCacheParams {
|
|
158
|
+
/** Customer ID for the transaction */
|
|
159
|
+
customerId: string;
|
|
160
|
+
/** API mode for the transaction(Default: live|dev) */
|
|
161
|
+
mode?: string;
|
|
162
|
+
/** Element TransactionSetupID returned by /api/unified/transaction-setup */
|
|
163
|
+
transactionSetupId: string;
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Create payment account token
|
|
167
|
+
* Response data for POST /element/payment — MINIMUM fields, extras pass through
|
|
168
|
+
*
|
|
169
|
+
* Returned by: api.payments.element.payment.create(data)
|
|
170
|
+
*/
|
|
171
|
+
export interface ElementPaymentCreateData {
|
|
172
|
+
/** Always "element" */
|
|
173
|
+
processor: string;
|
|
174
|
+
/**
|
|
175
|
+
* Element PaymentAccountCreate fields (ExpressResponseCode "0" means tokenized, PaymentAccountID
|
|
176
|
+
* is the token); [] when Element could not be reached ([] when empty)
|
|
177
|
+
*/
|
|
178
|
+
cardData: Record<string, unknown> | [];
|
|
179
|
+
/**
|
|
180
|
+
* Address verification block; AvsVerdict is always present (match, partial, no_match,
|
|
181
|
+
* unavailable) ([] when empty)
|
|
182
|
+
*/
|
|
183
|
+
avs: Record<string, unknown> | [];
|
|
184
|
+
[key: string]: unknown;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* Shape of `card` (MINIMUM fields; reused wherever the same shape appears)
|
|
188
|
+
* Card to tokenize
|
|
189
|
+
*
|
|
190
|
+
* Field `card` of ElementPaymentCreateBody
|
|
191
|
+
*/
|
|
192
|
+
export interface ElementPaymentCreateBodyCard {
|
|
193
|
+
/** Card number */
|
|
194
|
+
ccNumber?: string | null;
|
|
195
|
+
/** Card security code */
|
|
196
|
+
cvv?: string | null;
|
|
197
|
+
/** Expiration month */
|
|
198
|
+
expMonth?: string | null;
|
|
199
|
+
/** Expiration year */
|
|
200
|
+
expYear?: string | null;
|
|
201
|
+
[key: string]: unknown;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* Shape of `billing` (MINIMUM fields; reused wherever the same shape appears)
|
|
205
|
+
* Billing address; address1 and postalCode feed the AVS check
|
|
206
|
+
*
|
|
207
|
+
* Field `billing` of ElementPaymentCreateBodyAddress
|
|
208
|
+
* Field `shipping` of ElementPaymentCreateBodyAddress
|
|
209
|
+
*/
|
|
210
|
+
export interface ElementPaymentCreateBodyAddressBilling {
|
|
211
|
+
/** First name; sent only together with lastName */
|
|
212
|
+
firstName?: string | null;
|
|
213
|
+
/** Last name; sent only together with firstName */
|
|
214
|
+
lastName?: string | null;
|
|
215
|
+
/** Street address line 1 */
|
|
216
|
+
address1?: string | null;
|
|
217
|
+
/** Street address line 2 */
|
|
218
|
+
address2?: string | null;
|
|
219
|
+
/** City */
|
|
220
|
+
city?: string | null;
|
|
221
|
+
/** State or province code */
|
|
222
|
+
state?: string | null;
|
|
223
|
+
/** Postal or ZIP code */
|
|
224
|
+
postalCode?: string | null;
|
|
225
|
+
/** Email address */
|
|
226
|
+
email?: string | null;
|
|
227
|
+
/** Phone number */
|
|
228
|
+
phone?: string | null;
|
|
229
|
+
[key: string]: unknown;
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* Shape of `address` (MINIMUM fields; reused wherever the same shape appears)
|
|
233
|
+
* Billing and shipping addresses; shipping picks the processor, billing feeds AVS
|
|
234
|
+
*
|
|
235
|
+
* Field `address` of ElementPaymentCreateBody
|
|
236
|
+
*/
|
|
237
|
+
export interface ElementPaymentCreateBodyAddress {
|
|
238
|
+
/** Billing address; address1 and postalCode feed the AVS check */
|
|
239
|
+
billing?: ElementPaymentCreateBodyAddressBilling | null;
|
|
240
|
+
/** Shipping address; state and postalCode pick the site's Element processor */
|
|
241
|
+
shipping?: ElementPaymentCreateBodyAddressBilling | null;
|
|
242
|
+
[key: string]: unknown;
|
|
243
|
+
}
|
|
244
|
+
/**
|
|
245
|
+
* Create payment account token
|
|
246
|
+
* Request body for POST /element/payment — MINIMUM fields, extras pass through
|
|
247
|
+
*
|
|
248
|
+
* Request body of: api.payments.element.payment.create(data)
|
|
249
|
+
*/
|
|
250
|
+
export interface ElementPaymentCreateBody {
|
|
251
|
+
/** Card to tokenize */
|
|
252
|
+
card?: ElementPaymentCreateBodyCard | null;
|
|
253
|
+
/** Billing and shipping addresses; shipping picks the processor, billing feeds AVS */
|
|
254
|
+
address?: ElementPaymentCreateBodyAddress | null;
|
|
255
|
+
[key: string]: unknown;
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* Pre-authorizes a transaction.
|
|
259
|
+
* Response data for GET /moneris/pre-auth — MINIMUM fields, extras pass through
|
|
260
|
+
*
|
|
261
|
+
* Returned by: api.payments.moneris.preAuth.list(params)
|
|
262
|
+
* Returned by: api.payments.moneris.preAuthComplete.list(params)
|
|
263
|
+
*/
|
|
264
|
+
export interface MonerisPreAuthListData {
|
|
265
|
+
/** Card type code */
|
|
266
|
+
cardType: string;
|
|
267
|
+
/** Transaction amount */
|
|
268
|
+
transAmount: string;
|
|
269
|
+
/** Moneris transaction number; pass it to pre-auth-complete */
|
|
270
|
+
txnNumber: string;
|
|
271
|
+
/** Receipt id (the order id sent) */
|
|
272
|
+
receiptId: string;
|
|
273
|
+
/** Transaction type code */
|
|
274
|
+
transType: string;
|
|
275
|
+
/** Moneris reference number */
|
|
276
|
+
referenceNum: string;
|
|
277
|
+
/** Moneris response code */
|
|
278
|
+
responseCode: string;
|
|
279
|
+
/** Moneris response message */
|
|
280
|
+
message: string;
|
|
281
|
+
/** Issuer authorization code */
|
|
282
|
+
authCode: string;
|
|
283
|
+
/** Moneris completion flag */
|
|
284
|
+
complete: string;
|
|
285
|
+
/** Transaction date */
|
|
286
|
+
transDate: string;
|
|
287
|
+
/** Transaction time */
|
|
288
|
+
transTime: string;
|
|
289
|
+
[key: string]: unknown;
|
|
290
|
+
}
|
|
291
|
+
/**
|
|
292
|
+
* Completes a pre-authorization transaction.
|
|
293
|
+
* Response data for GET /moneris/pre-auth-complete — MINIMUM fields, extras pass through
|
|
294
|
+
*
|
|
295
|
+
* Returned by: api.payments.moneris.preAuthComplete.list(params)
|
|
296
|
+
*/
|
|
297
|
+
export type MonerisPreAuthCompleteListData = MonerisPreAuthListData;
|
|
298
|
+
/**
|
|
299
|
+
* Shape of `amount` (MINIMUM fields; reused wherever the same shape appears)
|
|
300
|
+
* Captured amount
|
|
301
|
+
*
|
|
302
|
+
* Field `amount` of PaypalAuthorizationCaptureCreateDataOption1
|
|
303
|
+
* Field `amount` of PaypalAuthorizationVoidCreateDataOption1
|
|
304
|
+
* Field `amount` of PaypalCaptureRefundCreateDataOption1
|
|
305
|
+
* Field `amount` of PaypalOrderCreateDataOption1PurchaseUnitsItem
|
|
306
|
+
*/
|
|
307
|
+
export interface PaypalAuthorizationCaptureCreateDataOption1Amount {
|
|
308
|
+
/** ISO-4217 currency code */
|
|
309
|
+
currencyCode: string;
|
|
310
|
+
/** Amount as a decimal string, e.g. "10.00" */
|
|
311
|
+
value: string;
|
|
312
|
+
/**
|
|
313
|
+
* Order amount breakdown (item total, shipping, tax, discount), when PayPal sends one ([] when
|
|
314
|
+
* empty)
|
|
315
|
+
*/
|
|
316
|
+
breakdown?: Record<string, unknown> | [] | null;
|
|
317
|
+
[key: string]: unknown;
|
|
318
|
+
}
|
|
319
|
+
/**
|
|
320
|
+
* Shape of `links` (MINIMUM fields; reused wherever the same shape appears)
|
|
321
|
+
* Related actions (refund, self, up)
|
|
322
|
+
*
|
|
323
|
+
* Field `links` of PaypalAuthorizationCaptureCreateDataOption1
|
|
324
|
+
* Field `links` of PaypalAuthorizationVoidCreateDataOption1
|
|
325
|
+
* Field `links` of PaypalCaptureRefundCreateDataOption1
|
|
326
|
+
* Field `links` of PaypalOrderCreateDataOption1
|
|
327
|
+
*/
|
|
328
|
+
export interface PaypalAuthorizationCaptureCreateDataOption1LinksItem {
|
|
329
|
+
/** Link URL */
|
|
330
|
+
href: string;
|
|
331
|
+
/** Link relation, e.g. approve, payer-action, self */
|
|
332
|
+
rel: string;
|
|
333
|
+
/** HTTP method for the link */
|
|
334
|
+
method?: string | null;
|
|
335
|
+
[key: string]: unknown;
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* Shape of data nested in PaypalAuthorizationCaptureCreateData (MINIMUM fields; reused wherever the
|
|
339
|
+
* same shape appears)
|
|
340
|
+
*
|
|
341
|
+
* Nested in PaypalAuthorizationCaptureCreateData
|
|
342
|
+
* Field `captures` of PaypalOrderCreateDataOption1PurchaseUnitsItemPayments
|
|
343
|
+
*/
|
|
344
|
+
export interface PaypalAuthorizationCaptureCreateDataOption1 {
|
|
345
|
+
/** Capture ID; pass it to refund */
|
|
346
|
+
id: string;
|
|
347
|
+
/** COMPLETED, DECLINED, PARTIALLY_REFUNDED, PENDING, REFUNDED or FAILED */
|
|
348
|
+
status?: string | null;
|
|
349
|
+
/** Reason the capture is in its status ([] when empty) */
|
|
350
|
+
statusDetails?: Record<string, unknown> | [] | null;
|
|
351
|
+
/** Captured amount */
|
|
352
|
+
amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
|
|
353
|
+
/** Invoice identifier */
|
|
354
|
+
invoiceId?: string | null;
|
|
355
|
+
/** Merchant custom ID sent with the order */
|
|
356
|
+
customId?: string | null;
|
|
357
|
+
/** Card network transaction reference ([] when empty) */
|
|
358
|
+
networkTransactionReference?: Record<string, unknown> | [] | null;
|
|
359
|
+
/** Seller protection eligibility ([] when empty) */
|
|
360
|
+
sellerProtection?: Record<string, unknown> | [] | null;
|
|
361
|
+
/** true when no further capture is possible on the authorization */
|
|
362
|
+
finalCapture?: boolean | null;
|
|
363
|
+
/** Gross, PayPal fee and net amounts ([] when empty) */
|
|
364
|
+
sellerReceivableBreakdown?: Record<string, unknown> | [] | null;
|
|
365
|
+
/** INSTANT or DELAYED */
|
|
366
|
+
disbursementMode?: string | null;
|
|
367
|
+
/** Related actions (refund, self, up) */
|
|
368
|
+
links?: PaypalAuthorizationCaptureCreateDataOption1LinksItem[] | null;
|
|
369
|
+
/** Card processor response codes ([] when empty) */
|
|
370
|
+
processorResponse?: Record<string, unknown> | [] | null;
|
|
371
|
+
/** When the capture was created (ISO 8601) */
|
|
372
|
+
createTime?: string | null;
|
|
373
|
+
/** When the capture was last updated (ISO 8601) */
|
|
374
|
+
updateTime?: string | null;
|
|
375
|
+
/** Related order and transaction identifiers ([] when empty) */
|
|
376
|
+
supplementaryData?: Record<string, unknown> | [] | null;
|
|
377
|
+
/** Merchant receiving the payment ([] when empty) */
|
|
378
|
+
payee?: Record<string, unknown> | [] | null;
|
|
379
|
+
[key: string]: unknown;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* Shape of `details` (MINIMUM fields; reused wherever the same shape appears)
|
|
383
|
+
* PayPal error issues; empty when PayPal sent none
|
|
384
|
+
*
|
|
385
|
+
* Field `details` of PaypalAuthorizationCaptureCreateDataOption2
|
|
386
|
+
*/
|
|
387
|
+
export interface PaypalAuthorizationCaptureCreateDataOption2DetailsItem {
|
|
388
|
+
/** PayPal issue code, e.g. ORDER_NOT_APPROVED */
|
|
389
|
+
issue?: string | null;
|
|
390
|
+
/** Issue description */
|
|
391
|
+
description?: string | null;
|
|
392
|
+
/** Request field the issue is about */
|
|
393
|
+
field?: string | null;
|
|
394
|
+
/** Value of that field */
|
|
395
|
+
value?: string | null;
|
|
396
|
+
/** Where the field was: body, path or query */
|
|
397
|
+
location?: string | null;
|
|
398
|
+
[key: string]: unknown;
|
|
399
|
+
}
|
|
400
|
+
/**
|
|
401
|
+
* Shape of data nested in PaypalAuthorizationCaptureCreateData (MINIMUM fields; reused wherever the
|
|
402
|
+
* same shape appears)
|
|
403
|
+
*
|
|
404
|
+
* Nested in PaypalAuthorizationCaptureCreateData
|
|
405
|
+
* Nested in PaypalAuthorizationVoidCreateData
|
|
406
|
+
* Nested in PaypalCaptureRefundCreateData
|
|
407
|
+
* Nested in PaypalOrderCreateData
|
|
408
|
+
* Nested in PaypalOrderReturnListData
|
|
409
|
+
* Nested in PaypalOrderAuthorizeCreateData
|
|
410
|
+
* Nested in PaypalOrderCaptureCreateData
|
|
411
|
+
* Nested in PaypalOrderDetailsListData
|
|
412
|
+
* Nested in PaypalRefundListData
|
|
413
|
+
*/
|
|
414
|
+
export interface PaypalAuthorizationCaptureCreateDataOption2 {
|
|
415
|
+
/** true when PayPal accepted the request with an empty body */
|
|
416
|
+
success: boolean;
|
|
417
|
+
/** Failure message (PayPal's message, or why the call failed) */
|
|
418
|
+
statusMessage?: string | null;
|
|
419
|
+
/** PayPal error name, e.g. UNPROCESSABLE_ENTITY; UNKNOWN when PayPal sent none */
|
|
420
|
+
name?: string | null;
|
|
421
|
+
/** PayPal error issues; empty when PayPal sent none */
|
|
422
|
+
details?: PaypalAuthorizationCaptureCreateDataOption2DetailsItem[] | null;
|
|
423
|
+
/** PayPal debug ID to quote to PayPal support */
|
|
424
|
+
debugId?: string | null;
|
|
425
|
+
/** Raw PayPal response body when it was not JSON */
|
|
426
|
+
responseBody?: string | null;
|
|
427
|
+
/** PayPal's HTTP status code; absent when PayPal could not be reached */
|
|
428
|
+
statusCode?: number | null;
|
|
429
|
+
[key: string]: unknown;
|
|
430
|
+
}
|
|
431
|
+
/**
|
|
432
|
+
* Capture funds from a PayPal authorization.
|
|
433
|
+
* Response data for POST /paypal/authorization/capture — MINIMUM fields, extras pass through
|
|
434
|
+
*
|
|
435
|
+
* Returned by: api.payments.paypal.authorization.capture.create(data)
|
|
436
|
+
*/
|
|
437
|
+
export type PaypalAuthorizationCaptureCreateData = PaypalAuthorizationCaptureCreateDataOption1 | PaypalAuthorizationCaptureCreateDataOption2;
|
|
438
|
+
/**
|
|
439
|
+
* Capture funds from a PayPal authorization.
|
|
440
|
+
* Request body for POST /paypal/authorization/capture — MINIMUM fields, extras pass through
|
|
441
|
+
*
|
|
442
|
+
* Request body of: api.payments.paypal.authorization.capture.create(data)
|
|
443
|
+
*/
|
|
444
|
+
export interface PaypalAuthorizationCaptureCreateBody {
|
|
445
|
+
/** PayPal authorization ID to capture */
|
|
446
|
+
authorizationId: string | null;
|
|
447
|
+
/** Amount to capture; defaults to the full authorization */
|
|
448
|
+
amount?: number | null;
|
|
449
|
+
/** Invoice identifier */
|
|
450
|
+
invoiceId?: string | null;
|
|
451
|
+
/** true (or the string "true" or "1") marks this the final capture for the authorization */
|
|
452
|
+
finalCapture?: boolean | null;
|
|
453
|
+
/** true (or the string "true" or "1") uses the PayPal sandbox; default live */
|
|
454
|
+
testMode?: boolean | null;
|
|
455
|
+
[key: string]: unknown;
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
* Shape of data nested in PaypalAuthorizationVoidCreateData (MINIMUM fields; reused wherever the
|
|
459
|
+
* same shape appears)
|
|
460
|
+
*
|
|
461
|
+
* Nested in PaypalAuthorizationVoidCreateData
|
|
462
|
+
* Field `authorizations` of PaypalOrderCreateDataOption1PurchaseUnitsItemPayments
|
|
463
|
+
*/
|
|
464
|
+
export interface PaypalAuthorizationVoidCreateDataOption1 {
|
|
465
|
+
/** Authorization ID; pass it to capture or void */
|
|
466
|
+
id: string;
|
|
467
|
+
/** CREATED, CAPTURED, DENIED, PARTIALLY_CAPTURED, VOIDED or PENDING */
|
|
468
|
+
status?: string | null;
|
|
469
|
+
/** Reason the authorization is in its status ([] when empty) */
|
|
470
|
+
statusDetails?: Record<string, unknown> | [] | null;
|
|
471
|
+
/** Authorized amount */
|
|
472
|
+
amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
|
|
473
|
+
/** Invoice identifier sent with the order */
|
|
474
|
+
invoiceId?: string | null;
|
|
475
|
+
/** Merchant custom ID sent with the order */
|
|
476
|
+
customId?: string | null;
|
|
477
|
+
/** Card network transaction reference ([] when empty) */
|
|
478
|
+
networkTransactionReference?: Record<string, unknown> | [] | null;
|
|
479
|
+
/** Seller protection eligibility ([] when empty) */
|
|
480
|
+
sellerProtection?: Record<string, unknown> | [] | null;
|
|
481
|
+
/** When the authorization expires (ISO 8601) */
|
|
482
|
+
expirationTime?: string | null;
|
|
483
|
+
/** Related actions (capture, void, reauthorize, self, up) */
|
|
484
|
+
links?: PaypalAuthorizationCaptureCreateDataOption1LinksItem[] | null;
|
|
485
|
+
/** When the authorization was created (ISO 8601) */
|
|
486
|
+
createTime?: string | null;
|
|
487
|
+
/** When the authorization was last updated (ISO 8601) */
|
|
488
|
+
updateTime?: string | null;
|
|
489
|
+
/** Card processor response codes ([] when empty) */
|
|
490
|
+
processorResponse?: Record<string, unknown> | [] | null;
|
|
491
|
+
/** Related order and transaction identifiers ([] when empty) */
|
|
492
|
+
supplementaryData?: Record<string, unknown> | [] | null;
|
|
493
|
+
/** Merchant receiving the payment ([] when empty) */
|
|
494
|
+
payee?: Record<string, unknown> | [] | null;
|
|
495
|
+
[key: string]: unknown;
|
|
496
|
+
}
|
|
497
|
+
/**
|
|
498
|
+
* Void a PayPal authorization.
|
|
499
|
+
* Response data for POST /paypal/authorization/void — MINIMUM fields, extras pass through
|
|
500
|
+
*
|
|
501
|
+
* Returned by: api.payments.paypal.authorization.void.create(data)
|
|
502
|
+
*/
|
|
503
|
+
export type PaypalAuthorizationVoidCreateData = PaypalAuthorizationVoidCreateDataOption1 | PaypalAuthorizationCaptureCreateDataOption2;
|
|
504
|
+
/**
|
|
505
|
+
* Void a PayPal authorization.
|
|
506
|
+
* Request body for POST /paypal/authorization/void — MINIMUM fields, extras pass through
|
|
507
|
+
*
|
|
508
|
+
* Request body of: api.payments.paypal.authorization.void.create(data)
|
|
509
|
+
*/
|
|
510
|
+
export interface PaypalAuthorizationVoidCreateBody {
|
|
511
|
+
/** PayPal authorization ID to void */
|
|
512
|
+
authorizationId: string | null;
|
|
513
|
+
/** true (or the string "true" or "1") uses the PayPal sandbox; default live */
|
|
514
|
+
testMode?: boolean | null;
|
|
515
|
+
[key: string]: unknown;
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* Shape of data nested in PaypalCaptureRefundCreateData (MINIMUM fields; reused wherever the same
|
|
519
|
+
* shape appears)
|
|
520
|
+
*
|
|
521
|
+
* Nested in PaypalCaptureRefundCreateData
|
|
522
|
+
* Field `refunds` of PaypalOrderCreateDataOption1PurchaseUnitsItemPayments
|
|
523
|
+
* Nested in PaypalRefundListData
|
|
524
|
+
*/
|
|
525
|
+
export interface PaypalCaptureRefundCreateDataOption1 {
|
|
526
|
+
/** Refund ID */
|
|
527
|
+
id: string;
|
|
528
|
+
/** CANCELLED, FAILED, PENDING or COMPLETED */
|
|
529
|
+
status?: string | null;
|
|
530
|
+
/** Reason the refund is in its status ([] when empty) */
|
|
531
|
+
statusDetails?: Record<string, unknown> | [] | null;
|
|
532
|
+
/** Refunded amount */
|
|
533
|
+
amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
|
|
534
|
+
/** Invoice identifier */
|
|
535
|
+
invoiceId?: string | null;
|
|
536
|
+
/** Merchant custom ID */
|
|
537
|
+
customId?: string | null;
|
|
538
|
+
/** Card network acquirer reference number */
|
|
539
|
+
acquirerReferenceNumber?: string | null;
|
|
540
|
+
/** Note shown to the payer on the refund */
|
|
541
|
+
noteToPayer?: string | null;
|
|
542
|
+
/** Gross, PayPal fee and net amounts of the refund ([] when empty) */
|
|
543
|
+
sellerPayableBreakdown?: Record<string, unknown> | [] | null;
|
|
544
|
+
/** Merchant that issued the refund ([] when empty) */
|
|
545
|
+
payer?: Record<string, unknown> | [] | null;
|
|
546
|
+
/** Related actions (self, up) */
|
|
547
|
+
links?: PaypalAuthorizationCaptureCreateDataOption1LinksItem[] | null;
|
|
548
|
+
/** When the refund was created (ISO 8601) */
|
|
549
|
+
createTime?: string | null;
|
|
550
|
+
/** When the refund was last updated (ISO 8601) */
|
|
551
|
+
updateTime?: string | null;
|
|
552
|
+
[key: string]: unknown;
|
|
553
|
+
}
|
|
554
|
+
/**
|
|
555
|
+
* Refund a captured PayPal payment.
|
|
556
|
+
* Response data for POST /paypal/capture/refund — MINIMUM fields, extras pass through
|
|
557
|
+
*
|
|
558
|
+
* Returned by: api.payments.paypal.capture.refund.create(data)
|
|
559
|
+
*/
|
|
560
|
+
export type PaypalCaptureRefundCreateData = PaypalCaptureRefundCreateDataOption1 | PaypalAuthorizationCaptureCreateDataOption2;
|
|
561
|
+
/**
|
|
562
|
+
* Refund a captured PayPal payment.
|
|
563
|
+
* Request body for POST /paypal/capture/refund — MINIMUM fields, extras pass through
|
|
564
|
+
*
|
|
565
|
+
* Request body of: api.payments.paypal.capture.refund.create(data)
|
|
566
|
+
*/
|
|
567
|
+
export interface PaypalCaptureRefundCreateBody {
|
|
568
|
+
/** PayPal capture ID to refund */
|
|
569
|
+
captureId: string | null;
|
|
570
|
+
/** Amount to refund; defaults to the full capture */
|
|
571
|
+
amount?: number | null;
|
|
572
|
+
/** Invoice identifier */
|
|
573
|
+
invoiceId?: string | null;
|
|
574
|
+
/** Note shown to the payer on the refund */
|
|
575
|
+
noteToPayer?: string | null;
|
|
576
|
+
/** true (or the string "true" or "1") uses the PayPal sandbox; default live */
|
|
577
|
+
testMode?: boolean | null;
|
|
578
|
+
[key: string]: unknown;
|
|
579
|
+
}
|
|
580
|
+
/**
|
|
581
|
+
* Shape of `payments` (MINIMUM fields; reused wherever the same shape appears)
|
|
582
|
+
* Authorizations, captures and refunds made against the unit
|
|
583
|
+
*
|
|
584
|
+
* Field `payments` of PaypalOrderCreateDataOption1PurchaseUnitsItem
|
|
585
|
+
*/
|
|
586
|
+
export interface PaypalOrderCreateDataOption1PurchaseUnitsItemPayments {
|
|
587
|
+
/** Authorizations; the ID is what capture and void take */
|
|
588
|
+
authorizations?: PaypalAuthorizationVoidCreateDataOption1[] | null;
|
|
589
|
+
/** Captures; the ID is what refund takes */
|
|
590
|
+
captures?: PaypalAuthorizationCaptureCreateDataOption1[] | null;
|
|
591
|
+
/** Refunds */
|
|
592
|
+
refunds?: PaypalCaptureRefundCreateDataOption1[] | null;
|
|
593
|
+
[key: string]: unknown;
|
|
594
|
+
}
|
|
595
|
+
/**
|
|
596
|
+
* Shape of `purchaseUnits` (MINIMUM fields; reused wherever the same shape appears)
|
|
597
|
+
* Purchase units, with the payments made against each
|
|
598
|
+
*
|
|
599
|
+
* Field `purchaseUnits` of PaypalOrderCreateDataOption1
|
|
600
|
+
*/
|
|
601
|
+
export interface PaypalOrderCreateDataOption1PurchaseUnitsItem {
|
|
602
|
+
/** Purchase unit reference ID */
|
|
603
|
+
referenceId?: string | null;
|
|
604
|
+
/** Purchase unit amount */
|
|
605
|
+
amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
|
|
606
|
+
/** Merchant receiving the payment ([] when empty) */
|
|
607
|
+
payee?: Record<string, unknown> | [] | null;
|
|
608
|
+
/** Platform fees and disbursement instructions ([] when empty) */
|
|
609
|
+
paymentInstruction?: Record<string, unknown> | [] | null;
|
|
610
|
+
/** Purchase description */
|
|
611
|
+
description?: string | null;
|
|
612
|
+
/** Merchant custom ID */
|
|
613
|
+
customId?: string | null;
|
|
614
|
+
/** Invoice identifier sent at order creation */
|
|
615
|
+
invoiceId?: string | null;
|
|
616
|
+
/** Statement descriptor shown to the payer */
|
|
617
|
+
softDescriptor?: string | null;
|
|
618
|
+
/** Shipping name, address and options ([] when empty) */
|
|
619
|
+
shipping?: Record<string, unknown> | [] | null;
|
|
620
|
+
/** Card and level 2/3 data ([] when empty) */
|
|
621
|
+
supplementaryData?: Record<string, unknown> | [] | null;
|
|
622
|
+
/** Authorizations, captures and refunds made against the unit */
|
|
623
|
+
payments?: PaypalOrderCreateDataOption1PurchaseUnitsItemPayments | null;
|
|
624
|
+
[key: string]: unknown;
|
|
625
|
+
}
|
|
626
|
+
/**
|
|
627
|
+
* Shape of `name` (MINIMUM fields; reused wherever the same shape appears)
|
|
628
|
+
* Payer name
|
|
629
|
+
*
|
|
630
|
+
* Field `name` of PaypalOrderCreateDataOption1Payer
|
|
631
|
+
*/
|
|
632
|
+
export interface PaypalOrderCreateDataOption1PayerName {
|
|
633
|
+
/** Given (first) name */
|
|
634
|
+
givenName?: string | null;
|
|
635
|
+
/** Surname (last name) */
|
|
636
|
+
surname?: string | null;
|
|
637
|
+
[key: string]: unknown;
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* Shape of `address` (MINIMUM fields; reused wherever the same shape appears)
|
|
641
|
+
* Payer address
|
|
642
|
+
*
|
|
643
|
+
* Field `address` of PaypalOrderCreateDataOption1Payer
|
|
644
|
+
*/
|
|
645
|
+
export interface PaypalOrderCreateDataOption1PayerAddress {
|
|
646
|
+
/** First address line */
|
|
647
|
+
addressLine1?: string | null;
|
|
648
|
+
/** Second address line */
|
|
649
|
+
addressLine2?: string | null;
|
|
650
|
+
/** City or locality */
|
|
651
|
+
adminArea2?: string | null;
|
|
652
|
+
/** State, province or region */
|
|
653
|
+
adminArea1?: string | null;
|
|
654
|
+
/** Postal code */
|
|
655
|
+
postalCode?: string | null;
|
|
656
|
+
/** ISO 3166-1 alpha-2 country code */
|
|
657
|
+
countryCode?: string | null;
|
|
658
|
+
[key: string]: unknown;
|
|
659
|
+
}
|
|
660
|
+
/**
|
|
661
|
+
* Shape of `payer` (MINIMUM fields; reused wherever the same shape appears)
|
|
662
|
+
* Buyer who approved the order
|
|
663
|
+
*
|
|
664
|
+
* Field `payer` of PaypalOrderCreateDataOption1
|
|
665
|
+
*/
|
|
666
|
+
export interface PaypalOrderCreateDataOption1Payer {
|
|
667
|
+
/** Payer name */
|
|
668
|
+
name?: PaypalOrderCreateDataOption1PayerName | null;
|
|
669
|
+
/** Payer email address */
|
|
670
|
+
emailAddress?: string | null;
|
|
671
|
+
/** PayPal payer ID (the PayerID PayPal appends to the return URL) */
|
|
672
|
+
payerId?: string | null;
|
|
673
|
+
/** Payer phone ([] when empty) */
|
|
674
|
+
phone?: Record<string, unknown> | [] | null;
|
|
675
|
+
/** Payer birth date (YYYY-MM-DD) */
|
|
676
|
+
birthDate?: string | null;
|
|
677
|
+
/** Payer tax ID ([] when empty) */
|
|
678
|
+
taxInfo?: Record<string, unknown> | [] | null;
|
|
679
|
+
/** Payer address */
|
|
680
|
+
address?: PaypalOrderCreateDataOption1PayerAddress | null;
|
|
681
|
+
[key: string]: unknown;
|
|
682
|
+
}
|
|
683
|
+
/**
|
|
684
|
+
* Shape of data nested in PaypalOrderCreateData (MINIMUM fields; reused wherever the same shape
|
|
685
|
+
* appears)
|
|
686
|
+
*
|
|
687
|
+
* Nested in PaypalOrderCreateData
|
|
688
|
+
* Nested in PaypalOrderReturnListData
|
|
689
|
+
* Nested in PaypalOrderAuthorizeCreateData
|
|
690
|
+
* Nested in PaypalOrderCaptureCreateData
|
|
691
|
+
* Nested in PaypalOrderDetailsListData
|
|
692
|
+
*/
|
|
693
|
+
export interface PaypalOrderCreateDataOption1 {
|
|
694
|
+
/** PayPal order ID; the buyer approves it, then it is authorized or captured */
|
|
695
|
+
id: string;
|
|
696
|
+
/** CAPTURE or AUTHORIZE */
|
|
697
|
+
intent?: string | null;
|
|
698
|
+
/** CREATED, SAVED, APPROVED, VOIDED, COMPLETED or PAYER_ACTION_REQUIRED */
|
|
699
|
+
status?: string | null;
|
|
700
|
+
/** Funding source the buyer used (paypal, card, venmo...) ([] when empty) */
|
|
701
|
+
paymentSource?: Record<string, unknown> | [] | null;
|
|
702
|
+
/** Purchase units, with the payments made against each */
|
|
703
|
+
purchaseUnits?: PaypalOrderCreateDataOption1PurchaseUnitsItem[] | null;
|
|
704
|
+
/** Buyer who approved the order */
|
|
705
|
+
payer?: PaypalOrderCreateDataOption1Payer | null;
|
|
706
|
+
/** When the order was created (ISO 8601) */
|
|
707
|
+
createTime?: string | null;
|
|
708
|
+
/** When the order was last updated (ISO 8601) */
|
|
709
|
+
updateTime?: string | null;
|
|
710
|
+
/** Related actions; rel approve or payer-action is the URL the buyer approves at */
|
|
711
|
+
links?: PaypalAuthorizationCaptureCreateDataOption1LinksItem[] | null;
|
|
712
|
+
/** Order processing instruction */
|
|
713
|
+
processingInstruction?: string | null;
|
|
714
|
+
[key: string]: unknown;
|
|
715
|
+
}
|
|
716
|
+
/**
|
|
717
|
+
* Create a PayPal order.
|
|
718
|
+
* Response data for POST /paypal/order — MINIMUM fields, extras pass through
|
|
719
|
+
*
|
|
720
|
+
* Returned by: api.payments.paypal.order.create(data)
|
|
721
|
+
*/
|
|
722
|
+
export type PaypalOrderCreateData = PaypalOrderCreateDataOption1 | PaypalAuthorizationCaptureCreateDataOption2;
|
|
723
|
+
/**
|
|
724
|
+
* Create a PayPal order.
|
|
725
|
+
* Request body for POST /paypal/order — MINIMUM fields, extras pass through
|
|
726
|
+
*
|
|
727
|
+
* Request body of: api.payments.paypal.order.create(data)
|
|
728
|
+
*/
|
|
729
|
+
export interface PaypalOrderCreateBody {
|
|
730
|
+
/** Order amount in dollars */
|
|
731
|
+
amount: number | null;
|
|
732
|
+
/** Order intent: CAPTURE or AUTHORIZE */
|
|
733
|
+
intent: string | null;
|
|
734
|
+
/** ISO-4217 currency code; default USD */
|
|
735
|
+
currencyCode?: string | null;
|
|
736
|
+
/** Invoice identifier */
|
|
737
|
+
invoiceId?: string | null;
|
|
738
|
+
/** URL PayPal redirects the buyer to after approval */
|
|
739
|
+
returnUrl?: string | null;
|
|
740
|
+
/** URL PayPal redirects the buyer to on cancel */
|
|
741
|
+
cancelUrl?: string | null;
|
|
742
|
+
/** true (or the string "true" or "1") uses the PayPal sandbox; default live */
|
|
743
|
+
testMode?: boolean | null;
|
|
744
|
+
[key: string]: unknown;
|
|
745
|
+
}
|
|
746
|
+
/**
|
|
747
|
+
* Handle the PayPal approval redirect.
|
|
748
|
+
* Response data for GET /paypal/order-return — MINIMUM fields, extras pass through
|
|
749
|
+
*
|
|
750
|
+
* Returned by: api.payments.paypal.orderReturn.list(params)
|
|
751
|
+
*/
|
|
752
|
+
export type PaypalOrderReturnListData = PaypalOrderCreateDataOption1 | PaypalAuthorizationCaptureCreateDataOption2;
|
|
753
|
+
/**
|
|
754
|
+
* Authorize an approved PayPal order.
|
|
755
|
+
* Response data for POST /paypal/order/authorize — MINIMUM fields, extras pass through
|
|
756
|
+
*
|
|
757
|
+
* Returned by: api.payments.paypal.order.authorize.create(data)
|
|
758
|
+
*/
|
|
759
|
+
export type PaypalOrderAuthorizeCreateData = PaypalOrderCreateDataOption1 | PaypalAuthorizationCaptureCreateDataOption2;
|
|
760
|
+
/**
|
|
761
|
+
* Authorize an approved PayPal order.
|
|
762
|
+
* Request body for POST /paypal/order/authorize — MINIMUM fields, extras pass through
|
|
763
|
+
*
|
|
764
|
+
* Request body of: api.payments.paypal.order.authorize.create(data)
|
|
765
|
+
* Request body of: api.payments.paypal.order.capture.create(data)
|
|
766
|
+
*/
|
|
767
|
+
export interface PaypalOrderAuthorizeCreateBody {
|
|
768
|
+
/** PayPal order ID */
|
|
769
|
+
orderId: string | null;
|
|
770
|
+
/** true (or the string "true" or "1") uses the PayPal sandbox; default live */
|
|
771
|
+
testMode?: boolean | null;
|
|
772
|
+
[key: string]: unknown;
|
|
773
|
+
}
|
|
774
|
+
/**
|
|
775
|
+
* Capture payment for an approved PayPal order.
|
|
776
|
+
* Response data for POST /paypal/order/capture — MINIMUM fields, extras pass through
|
|
777
|
+
*
|
|
778
|
+
* Returned by: api.payments.paypal.order.capture.create(data)
|
|
779
|
+
*/
|
|
780
|
+
export type PaypalOrderCaptureCreateData = PaypalOrderCreateDataOption1 | PaypalAuthorizationCaptureCreateDataOption2;
|
|
781
|
+
/**
|
|
782
|
+
* Capture payment for an approved PayPal order.
|
|
783
|
+
* Request body for POST /paypal/order/capture — MINIMUM fields, extras pass through
|
|
784
|
+
*
|
|
785
|
+
* Request body of: api.payments.paypal.order.capture.create(data)
|
|
786
|
+
*/
|
|
787
|
+
export type PaypalOrderCaptureCreateBody = PaypalOrderAuthorizeCreateBody;
|
|
788
|
+
/**
|
|
789
|
+
* Get a PayPal order by ID.
|
|
790
|
+
* Response data for GET /paypal/order/details — MINIMUM fields, extras pass through
|
|
791
|
+
*
|
|
792
|
+
* Returned by: api.payments.paypal.order.details.list(params)
|
|
793
|
+
*/
|
|
794
|
+
export type PaypalOrderDetailsListData = PaypalOrderCreateDataOption1 | PaypalAuthorizationCaptureCreateDataOption2;
|
|
795
|
+
/**
|
|
796
|
+
* Get a PayPal refund by ID.
|
|
797
|
+
* Response data for GET /paypal/refund — MINIMUM fields, extras pass through
|
|
798
|
+
*
|
|
799
|
+
* Returned by: api.payments.paypal.refund.list(params)
|
|
800
|
+
*/
|
|
801
|
+
export type PaypalRefundListData = PaypalCaptureRefundCreateDataOption1 | PaypalAuthorizationCaptureCreateDataOption2;
|
|
802
|
+
/**
|
|
803
|
+
* Receive a PayPal webhook event.
|
|
804
|
+
* Response data for POST /paypal/webhook — MINIMUM fields, extras pass through
|
|
805
|
+
*
|
|
806
|
+
* Returned by: api.payments.paypal.webhook.create(data, params)
|
|
807
|
+
*/
|
|
808
|
+
export interface PaypalWebhookCreateData {
|
|
809
|
+
/** Always true; a failed verification responds 400 instead */
|
|
810
|
+
verified: boolean;
|
|
811
|
+
[key: string]: unknown;
|
|
812
|
+
}
|
|
813
|
+
/**
|
|
814
|
+
* Receive a PayPal webhook event.
|
|
815
|
+
* Request body for POST /paypal/webhook — MINIMUM fields, extras pass through
|
|
816
|
+
*
|
|
817
|
+
* Request body of: api.payments.paypal.webhook.create(data, params)
|
|
818
|
+
*/
|
|
819
|
+
export interface PaypalWebhookCreateBody {
|
|
820
|
+
/** Webhook event ID */
|
|
821
|
+
id?: string | null;
|
|
822
|
+
/** Event version */
|
|
823
|
+
eventVersion?: string | null;
|
|
824
|
+
/** When the event was created (ISO 8601) */
|
|
825
|
+
createTime?: string | null;
|
|
826
|
+
/** Type of the resource the event is about, e.g. capture or checkout-order */
|
|
827
|
+
resourceType?: string | null;
|
|
828
|
+
/** Version of the resource */
|
|
829
|
+
resourceVersion?: string | null;
|
|
830
|
+
/** Event type, e.g. PAYMENT.CAPTURE.COMPLETED */
|
|
831
|
+
eventType?: string | null;
|
|
832
|
+
/** Human-readable event summary */
|
|
833
|
+
summary?: string | null;
|
|
834
|
+
/** The PayPal resource the event is about, as PayPal sent it ([] when empty) */
|
|
835
|
+
resource?: Record<string, unknown> | [] | null;
|
|
836
|
+
[key: string]: unknown;
|
|
837
|
+
}
|
|
838
|
+
/**
|
|
839
|
+
* Shape of `creditCard` (MINIMUM fields; reused wherever the same shape appears)
|
|
840
|
+
* Card to authorize
|
|
841
|
+
*
|
|
842
|
+
* Field `creditCard` of PaytraceAuthorizationCreateBody
|
|
843
|
+
*/
|
|
844
|
+
export interface PaytraceAuthorizationCreateBodyCreditCard {
|
|
845
|
+
/** Card number */
|
|
846
|
+
number: string | null;
|
|
847
|
+
/** Expiration month */
|
|
848
|
+
expirationMonth: string | null;
|
|
849
|
+
/** Expiration year */
|
|
850
|
+
expirationYear: string | null;
|
|
851
|
+
[key: string]: unknown;
|
|
852
|
+
}
|
|
853
|
+
/**
|
|
854
|
+
* Shape of `billingAddress` (MINIMUM fields; reused wherever the same shape appears)
|
|
855
|
+
* Billing address sent with the authorization
|
|
856
|
+
*
|
|
857
|
+
* Field `billingAddress` of PaytraceAuthorizationCreateBody
|
|
858
|
+
*/
|
|
859
|
+
export interface PaytraceAuthorizationCreateBodyBillingAddress {
|
|
860
|
+
/** Cardholder name */
|
|
861
|
+
name?: string | null;
|
|
862
|
+
/** Street address */
|
|
863
|
+
streetAddress?: string | null;
|
|
864
|
+
/** City */
|
|
865
|
+
city?: string | null;
|
|
866
|
+
/** State code */
|
|
867
|
+
state?: string | null;
|
|
868
|
+
/** ZIP code */
|
|
869
|
+
zip?: string | null;
|
|
870
|
+
[key: string]: unknown;
|
|
871
|
+
}
|
|
872
|
+
/**
|
|
873
|
+
* Authorize a credit card transaction.
|
|
874
|
+
* Request body for POST /paytrace/authorization — MINIMUM fields, extras pass through
|
|
875
|
+
*
|
|
876
|
+
* Request body of: api.payments.paytrace.authorization.create(data)
|
|
877
|
+
*/
|
|
878
|
+
export interface PaytraceAuthorizationCreateBody {
|
|
879
|
+
/** Dollar amount to authorize */
|
|
880
|
+
amount: number | null;
|
|
881
|
+
/** Card to authorize */
|
|
882
|
+
creditCard: PaytraceAuthorizationCreateBodyCreditCard | null;
|
|
883
|
+
/** Card security code (3-4 digits) */
|
|
884
|
+
csc?: string | null;
|
|
885
|
+
/** Billing address sent with the authorization */
|
|
886
|
+
billingAddress?: PaytraceAuthorizationCreateBodyBillingAddress | null;
|
|
887
|
+
/** Invoice identifier */
|
|
888
|
+
invoiceId?: string | null;
|
|
889
|
+
/** true (or the string "true" or "1") uses the PayTrace sandbox; default live */
|
|
890
|
+
testMode?: boolean | null;
|
|
891
|
+
[key: string]: unknown;
|
|
892
|
+
}
|
|
893
|
+
/**
|
|
894
|
+
* Estimate sales tax through Avalara.
|
|
895
|
+
* Response data for POST /rates — MINIMUM fields, extras pass through
|
|
896
|
+
*
|
|
897
|
+
* Returned by: api.payments.rates.create(data)
|
|
898
|
+
*/
|
|
899
|
+
export type RatesCreateData = number;
|
|
900
|
+
/**
|
|
901
|
+
* Shape of `address` (MINIMUM fields; reused wherever the same shape appears)
|
|
902
|
+
* Ship-to address
|
|
903
|
+
*
|
|
904
|
+
* Field `address` of RatesCreateBody
|
|
905
|
+
*/
|
|
906
|
+
export interface RatesCreateBodyAddress {
|
|
907
|
+
/** Ship-to street address line 1 */
|
|
908
|
+
line1: string | null;
|
|
909
|
+
/** Ship-to street address line 2 (empty string when unused) */
|
|
910
|
+
line2: string | null;
|
|
911
|
+
/** Ship-to street address line 3 (empty string when unused) */
|
|
912
|
+
line3: string | null;
|
|
913
|
+
/** Ship-to city */
|
|
914
|
+
city: string | null;
|
|
915
|
+
/** Ship-to state or province code, e.g. TX */
|
|
916
|
+
region: string | null;
|
|
917
|
+
/** Ship-to postal code */
|
|
918
|
+
postalCode: string | null;
|
|
919
|
+
/** Ship-to ISO country code, e.g. US */
|
|
920
|
+
countryCode: string | null;
|
|
921
|
+
[key: string]: unknown;
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
* Shape of `items` (MINIMUM fields; reused wherever the same shape appears)
|
|
925
|
+
* Order lines to tax
|
|
926
|
+
*
|
|
927
|
+
* Field `items` of RatesCreateBody
|
|
928
|
+
*/
|
|
929
|
+
export interface RatesCreateBodyItemsItem {
|
|
930
|
+
/** Extended line total (unit price x quantity) sent to AvaTax */
|
|
931
|
+
amount: number | null;
|
|
932
|
+
/** Quantity ordered */
|
|
933
|
+
quantity: number | null;
|
|
934
|
+
/** Item identifier */
|
|
935
|
+
itemCode: string | null;
|
|
936
|
+
/** AvaTax tax code (empty string for the default) */
|
|
937
|
+
taxCode: string | null;
|
|
938
|
+
/** Accepted but ignored; tax is calculated from amount */
|
|
939
|
+
unitPrice?: number | null;
|
|
940
|
+
[key: string]: unknown;
|
|
941
|
+
}
|
|
942
|
+
/**
|
|
943
|
+
* Estimate sales tax through Avalara.
|
|
944
|
+
* Request body for POST /rates — MINIMUM fields, extras pass through
|
|
945
|
+
*
|
|
946
|
+
* Request body of: api.payments.rates.create(data)
|
|
947
|
+
*/
|
|
948
|
+
export interface RatesCreateBody {
|
|
949
|
+
/** Ship-to address */
|
|
950
|
+
address: RatesCreateBodyAddress | null;
|
|
951
|
+
/** Order lines to tax */
|
|
952
|
+
items: RatesCreateBodyItemsItem[];
|
|
953
|
+
[key: string]: unknown;
|
|
954
|
+
}
|
|
955
|
+
/**
|
|
956
|
+
* Update billing information with transaction setup id
|
|
957
|
+
* Response data for GET /unified/billing-update — MINIMUM fields, extras pass through
|
|
958
|
+
*
|
|
959
|
+
* Returned by: api.payments.unified.billingUpdate.list(params)
|
|
960
|
+
*/
|
|
961
|
+
export type UnifiedBillingUpdateListData = boolean;
|
|
962
|
+
/**
|
|
963
|
+
* Create a transaction with customer and account information
|
|
964
|
+
* Response data for GET /unified/transaction-setup — MINIMUM fields, extras pass through
|
|
965
|
+
*
|
|
966
|
+
* Returned by: api.payments.unified.transactionSetup.list(params)
|
|
967
|
+
*/
|
|
968
|
+
export interface UnifiedTransactionSetupListData {
|
|
969
|
+
/** Element hosted-payment page URL for the mode */
|
|
970
|
+
uiEndpoint: string;
|
|
971
|
+
/** Element TransactionSetupID to load in the hosted page; null when Element did not create one */
|
|
972
|
+
transactionSetupId: string | null;
|
|
973
|
+
[key: string]: unknown;
|
|
974
|
+
}
|
|
975
|
+
/**
|
|
976
|
+
* Validate a transaction with customer and account information
|
|
977
|
+
* Response data for GET /unified/validate — MINIMUM fields, extras pass through
|
|
978
|
+
*
|
|
979
|
+
* Returned by: api.payments.unified.validate.list(params)
|
|
980
|
+
*/
|
|
981
|
+
export type UnifiedValidateListData = boolean;
|
|
982
|
+
export interface PaymentsClientSpec {
|
|
983
|
+
element: {
|
|
984
|
+
payment: {
|
|
985
|
+
/**
|
|
986
|
+
* Create payment account token
|
|
987
|
+
* Call: api.payments.element.payment.create(data)
|
|
988
|
+
*
|
|
989
|
+
* Create payment account token from card data
|
|
990
|
+
*
|
|
991
|
+
* Request body: Card and address to tokenize through Element; a missing card or address is
|
|
992
|
+
* sent to Element as empty
|
|
993
|
+
* Response data: Element tokenization result and AVS verdict; see
|
|
994
|
+
* packages/payments/src/Helpers/Element-Error-Responses.md
|
|
995
|
+
*
|
|
996
|
+
* Errors:
|
|
997
|
+
* 400: Invalid request body. Or Card and address are required. Or The card or address data
|
|
998
|
+
* could not be built from the body.
|
|
999
|
+
*
|
|
1000
|
+
* POST https://payments.augur-api.com/element/payment
|
|
1001
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1element~1payment/post
|
|
1002
|
+
*
|
|
1003
|
+
* @param data ElementPaymentCreateBody (request body)
|
|
1004
|
+
* @returns BaseResponse whose `data` is ElementPaymentCreateData
|
|
1005
|
+
*/
|
|
1006
|
+
create: (data: ElementPaymentCreateBody) => Promise<BaseResponse<ElementPaymentCreateData>>;
|
|
1007
|
+
};
|
|
1008
|
+
};
|
|
1009
|
+
moneris: {
|
|
1010
|
+
preAuth: {
|
|
1011
|
+
/**
|
|
1012
|
+
* Pre-authorizes a transaction.
|
|
1013
|
+
* Call: api.payments.moneris.preAuth.list(params)
|
|
1014
|
+
*
|
|
1015
|
+
* Response data: Moneris receipt for a pre-authorization or its completion; a field Moneris
|
|
1016
|
+
* did not return is ""
|
|
1017
|
+
*
|
|
1018
|
+
* GET https://payments.augur-api.com/moneris/pre-auth
|
|
1019
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1moneris~1pre-auth/get
|
|
1020
|
+
*
|
|
1021
|
+
* @param params MonerisPreAuthListParams (query string)
|
|
1022
|
+
* @returns BaseResponse whose `data` is MonerisPreAuthListData
|
|
1023
|
+
*/
|
|
1024
|
+
list: (params?: MonerisPreAuthListParams) => Promise<BaseResponse<MonerisPreAuthListData>>;
|
|
1025
|
+
};
|
|
1026
|
+
preAuthComplete: {
|
|
1027
|
+
/**
|
|
1028
|
+
* Completes a pre-authorization transaction.
|
|
1029
|
+
* Call: api.payments.moneris.preAuthComplete.list(params)
|
|
1030
|
+
*
|
|
1031
|
+
* Response data: Moneris receipt for a pre-authorization or its completion; a field Moneris
|
|
1032
|
+
* did not return is ""
|
|
1033
|
+
*
|
|
1034
|
+
* GET https://payments.augur-api.com/moneris/pre-auth-complete
|
|
1035
|
+
* Contract:
|
|
1036
|
+
* https://payments.augur-api.com/openapi.json#/paths/~1moneris~1pre-auth-complete/get
|
|
1037
|
+
*
|
|
1038
|
+
* @param params MonerisPreAuthCompleteListParams (query string)
|
|
1039
|
+
* @returns BaseResponse whose `data` is MonerisPreAuthCompleteListData
|
|
1040
|
+
*/
|
|
1041
|
+
list: (params?: MonerisPreAuthCompleteListParams) => Promise<BaseResponse<MonerisPreAuthCompleteListData>>;
|
|
1042
|
+
};
|
|
1043
|
+
};
|
|
1044
|
+
paypal: {
|
|
1045
|
+
authorization: {
|
|
1046
|
+
capture: {
|
|
1047
|
+
/**
|
|
1048
|
+
* Capture funds from a PayPal authorization.
|
|
1049
|
+
* Call: api.payments.paypal.authorization.capture.create(data)
|
|
1050
|
+
*
|
|
1051
|
+
* Request body: Capture funds from a PayPal authorization, in USD
|
|
1052
|
+
*
|
|
1053
|
+
* Errors:
|
|
1054
|
+
* 400: Invalid request body. Or Missing required field: authorizationId.
|
|
1055
|
+
* 502: PayPal could not issue an access token: credentials are not configured for the
|
|
1056
|
+
* site, or the PayPal OAuth call failed.
|
|
1057
|
+
*
|
|
1058
|
+
* POST https://payments.augur-api.com/paypal/authorization/capture
|
|
1059
|
+
* Contract:
|
|
1060
|
+
* https://payments.augur-api.com/openapi.json#/paths/~1paypal~1authorization~1capture/post
|
|
1061
|
+
*
|
|
1062
|
+
* @param data PaypalAuthorizationCaptureCreateBody (request body)
|
|
1063
|
+
* @returns BaseResponse whose `data` is PaypalAuthorizationCaptureCreateData
|
|
1064
|
+
*/
|
|
1065
|
+
create: (data: PaypalAuthorizationCaptureCreateBody) => Promise<BaseResponse<PaypalAuthorizationCaptureCreateData>>;
|
|
1066
|
+
};
|
|
1067
|
+
void: {
|
|
1068
|
+
/**
|
|
1069
|
+
* Void a PayPal authorization.
|
|
1070
|
+
* Call: api.payments.paypal.authorization.void.create(data)
|
|
1071
|
+
*
|
|
1072
|
+
* Void (cancel) a PayPal authorization.
|
|
1073
|
+
*
|
|
1074
|
+
* Request body: Void (cancel) a PayPal authorization
|
|
1075
|
+
*
|
|
1076
|
+
* Errors:
|
|
1077
|
+
* 400: Invalid request body. Or Missing required field: authorizationId.
|
|
1078
|
+
* 502: PayPal could not issue an access token: credentials are not configured for the
|
|
1079
|
+
* site, or the PayPal OAuth call failed.
|
|
1080
|
+
*
|
|
1081
|
+
* POST https://payments.augur-api.com/paypal/authorization/void
|
|
1082
|
+
* Contract:
|
|
1083
|
+
* https://payments.augur-api.com/openapi.json#/paths/~1paypal~1authorization~1void/post
|
|
1084
|
+
*
|
|
1085
|
+
* @param data PaypalAuthorizationVoidCreateBody (request body)
|
|
1086
|
+
* @returns BaseResponse whose `data` is PaypalAuthorizationVoidCreateData
|
|
1087
|
+
*/
|
|
1088
|
+
create: (data: PaypalAuthorizationVoidCreateBody) => Promise<BaseResponse<PaypalAuthorizationVoidCreateData>>;
|
|
1089
|
+
};
|
|
1090
|
+
};
|
|
1091
|
+
capture: {
|
|
1092
|
+
refund: {
|
|
1093
|
+
/**
|
|
1094
|
+
* Refund a captured PayPal payment.
|
|
1095
|
+
* Call: api.payments.paypal.capture.refund.create(data)
|
|
1096
|
+
*
|
|
1097
|
+
* Request body: Refund a captured PayPal payment, in USD
|
|
1098
|
+
*
|
|
1099
|
+
* Errors:
|
|
1100
|
+
* 400: Invalid request body. Or Missing required field: captureId.
|
|
1101
|
+
* 502: PayPal could not issue an access token: credentials are not configured for the
|
|
1102
|
+
* site, or the PayPal OAuth call failed.
|
|
1103
|
+
*
|
|
1104
|
+
* POST https://payments.augur-api.com/paypal/capture/refund
|
|
1105
|
+
* Contract:
|
|
1106
|
+
* https://payments.augur-api.com/openapi.json#/paths/~1paypal~1capture~1refund/post
|
|
1107
|
+
*
|
|
1108
|
+
* @param data PaypalCaptureRefundCreateBody (request body)
|
|
1109
|
+
* @returns BaseResponse whose `data` is PaypalCaptureRefundCreateData
|
|
1110
|
+
*/
|
|
1111
|
+
create: (data: PaypalCaptureRefundCreateBody) => Promise<BaseResponse<PaypalCaptureRefundCreateData>>;
|
|
1112
|
+
};
|
|
1113
|
+
};
|
|
1114
|
+
order: {
|
|
1115
|
+
/**
|
|
1116
|
+
* Create a PayPal order.
|
|
1117
|
+
* Call: api.payments.paypal.order.create(data)
|
|
1118
|
+
*
|
|
1119
|
+
* Create a PayPal order with intent CAPTURE or AUTHORIZE.
|
|
1120
|
+
*
|
|
1121
|
+
* Request body: Create a PayPal order
|
|
1122
|
+
*
|
|
1123
|
+
* Errors:
|
|
1124
|
+
* 400: Invalid request body. Or Missing required field: amount. Or Missing required field:
|
|
1125
|
+
* intent.
|
|
1126
|
+
* 502: PayPal could not issue an access token: credentials are not configured for the site,
|
|
1127
|
+
* or the PayPal OAuth call failed.
|
|
1128
|
+
*
|
|
1129
|
+
* POST https://payments.augur-api.com/paypal/order
|
|
1130
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1paypal~1order/post
|
|
1131
|
+
*
|
|
1132
|
+
* @param data PaypalOrderCreateBody (request body)
|
|
1133
|
+
* @returns BaseResponse whose `data` is PaypalOrderCreateData
|
|
1134
|
+
*/
|
|
1135
|
+
create: (data: PaypalOrderCreateBody) => Promise<BaseResponse<PaypalOrderCreateData>>;
|
|
1136
|
+
authorize: {
|
|
1137
|
+
/**
|
|
1138
|
+
* Authorize an approved PayPal order.
|
|
1139
|
+
* Call: api.payments.paypal.order.authorize.create(data)
|
|
1140
|
+
*
|
|
1141
|
+
* Authorize an approved PayPal order, creating an authorization.
|
|
1142
|
+
*
|
|
1143
|
+
* Request body: Authorize or capture an approved PayPal order
|
|
1144
|
+
*
|
|
1145
|
+
* Errors:
|
|
1146
|
+
* 400: Invalid request body. Or Missing required field: orderId.
|
|
1147
|
+
* 502: PayPal could not issue an access token: credentials are not configured for the
|
|
1148
|
+
* site, or the PayPal OAuth call failed.
|
|
1149
|
+
*
|
|
1150
|
+
* POST https://payments.augur-api.com/paypal/order/authorize
|
|
1151
|
+
* Contract:
|
|
1152
|
+
* https://payments.augur-api.com/openapi.json#/paths/~1paypal~1order~1authorize/post
|
|
1153
|
+
*
|
|
1154
|
+
* @param data PaypalOrderAuthorizeCreateBody (request body)
|
|
1155
|
+
* @returns BaseResponse whose `data` is PaypalOrderAuthorizeCreateData
|
|
1156
|
+
*/
|
|
1157
|
+
create: (data: PaypalOrderAuthorizeCreateBody) => Promise<BaseResponse<PaypalOrderAuthorizeCreateData>>;
|
|
1158
|
+
};
|
|
1159
|
+
capture: {
|
|
1160
|
+
/**
|
|
1161
|
+
* Capture payment for an approved PayPal order.
|
|
1162
|
+
* Call: api.payments.paypal.order.capture.create(data)
|
|
1163
|
+
*
|
|
1164
|
+
* Request body: Authorize or capture an approved PayPal order
|
|
1165
|
+
*
|
|
1166
|
+
* Errors:
|
|
1167
|
+
* 400: Invalid request body. Or Missing required field: orderId.
|
|
1168
|
+
* 502: PayPal could not issue an access token: credentials are not configured for the
|
|
1169
|
+
* site, or the PayPal OAuth call failed.
|
|
1170
|
+
*
|
|
1171
|
+
* POST https://payments.augur-api.com/paypal/order/capture
|
|
1172
|
+
* Contract:
|
|
1173
|
+
* https://payments.augur-api.com/openapi.json#/paths/~1paypal~1order~1capture/post
|
|
1174
|
+
*
|
|
1175
|
+
* @param data PaypalOrderCaptureCreateBody (request body)
|
|
1176
|
+
* @returns BaseResponse whose `data` is PaypalOrderCaptureCreateData
|
|
1177
|
+
*/
|
|
1178
|
+
create: (data: PaypalOrderCaptureCreateBody) => Promise<BaseResponse<PaypalOrderCaptureCreateData>>;
|
|
1179
|
+
};
|
|
1180
|
+
details: {
|
|
1181
|
+
/**
|
|
1182
|
+
* Get a PayPal order by ID.
|
|
1183
|
+
* Call: api.payments.paypal.order.details.list(params)
|
|
1184
|
+
*
|
|
1185
|
+
* Retrieve details for a PayPal order by ID.
|
|
1186
|
+
*
|
|
1187
|
+
* Errors:
|
|
1188
|
+
* 400: Missing required parameter: orderId.
|
|
1189
|
+
* 502: PayPal could not issue an access token: credentials are not configured for the
|
|
1190
|
+
* site, or the PayPal OAuth call failed.
|
|
1191
|
+
*
|
|
1192
|
+
* GET https://payments.augur-api.com/paypal/order/details
|
|
1193
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1paypal~1order~1details/get
|
|
1194
|
+
*
|
|
1195
|
+
* @param params PaypalOrderDetailsListParams (query string)
|
|
1196
|
+
* @returns BaseResponse whose `data` is PaypalOrderDetailsListData
|
|
1197
|
+
*/
|
|
1198
|
+
list: (params?: PaypalOrderDetailsListParams) => Promise<BaseResponse<PaypalOrderDetailsListData>>;
|
|
1199
|
+
};
|
|
1200
|
+
};
|
|
1201
|
+
orderReturn: {
|
|
1202
|
+
/**
|
|
1203
|
+
* Handle the PayPal approval redirect.
|
|
1204
|
+
* Call: api.payments.paypal.orderReturn.list(params)
|
|
1205
|
+
*
|
|
1206
|
+
* Handle the PayPal approval redirect and auto-authorize the order.
|
|
1207
|
+
*
|
|
1208
|
+
* Auth: bearer token; spec scopes: none listed (most endpoints list `public`)
|
|
1209
|
+
*
|
|
1210
|
+
* Errors:
|
|
1211
|
+
* 400: Missing required query parameter: site_id and token are required.
|
|
1212
|
+
* 502: PayPal could not issue an access token: credentials are not configured for the site,
|
|
1213
|
+
* or the PayPal OAuth call failed.
|
|
1214
|
+
*
|
|
1215
|
+
* GET https://payments.augur-api.com/paypal/order-return
|
|
1216
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1paypal~1order-return/get
|
|
1217
|
+
*
|
|
1218
|
+
* @param params PaypalOrderReturnListParams (query string)
|
|
1219
|
+
* @returns BaseResponse whose `data` is PaypalOrderReturnListData
|
|
1220
|
+
*/
|
|
1221
|
+
list: (params?: PaypalOrderReturnListParams) => Promise<BaseResponse<PaypalOrderReturnListData>>;
|
|
1222
|
+
};
|
|
1223
|
+
refund: {
|
|
1224
|
+
/**
|
|
1225
|
+
* Get a PayPal refund by ID.
|
|
1226
|
+
* Call: api.payments.paypal.refund.list(params)
|
|
1227
|
+
*
|
|
1228
|
+
* Retrieve details for a PayPal refund by ID.
|
|
1229
|
+
*
|
|
1230
|
+
* Errors:
|
|
1231
|
+
* 400: Missing required parameter: refundId.
|
|
1232
|
+
* 502: PayPal could not issue an access token: credentials are not configured for the site,
|
|
1233
|
+
* or the PayPal OAuth call failed.
|
|
1234
|
+
*
|
|
1235
|
+
* GET https://payments.augur-api.com/paypal/refund
|
|
1236
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1paypal~1refund/get
|
|
1237
|
+
*
|
|
1238
|
+
* @param params PaypalRefundListParams (query string)
|
|
1239
|
+
* @returns BaseResponse whose `data` is PaypalRefundListData
|
|
1240
|
+
*/
|
|
1241
|
+
list: (params?: PaypalRefundListParams) => Promise<BaseResponse<PaypalRefundListData>>;
|
|
1242
|
+
};
|
|
1243
|
+
webhook: {
|
|
1244
|
+
/**
|
|
1245
|
+
* Receive a PayPal webhook event.
|
|
1246
|
+
* Call: api.payments.paypal.webhook.create(data, params)
|
|
1247
|
+
*
|
|
1248
|
+
* Process an inbound PayPal webhook event notification.
|
|
1249
|
+
*
|
|
1250
|
+
* Request body: PayPal webhook event envelope, as PayPal posts it (snake_case keys); verified
|
|
1251
|
+
* against PayPal as sent
|
|
1252
|
+
* Response data: Acknowledgement of a PayPal webhook whose signature PayPal verified
|
|
1253
|
+
*
|
|
1254
|
+
* Auth: bearer token; spec scopes: none listed (most endpoints list `public`)
|
|
1255
|
+
*
|
|
1256
|
+
* Errors:
|
|
1257
|
+
* 400: Missing required query parameter: site_id. Or Webhook signature verification failed.
|
|
1258
|
+
* 502: PayPal could not issue an access token: credentials are not configured for the site,
|
|
1259
|
+
* or the PayPal OAuth call failed.
|
|
1260
|
+
*
|
|
1261
|
+
* POST https://payments.augur-api.com/paypal/webhook
|
|
1262
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1paypal~1webhook/post
|
|
1263
|
+
*
|
|
1264
|
+
* @param data PaypalWebhookCreateBody (request body)
|
|
1265
|
+
* @param params PaypalWebhookCreateParams (query string)
|
|
1266
|
+
* @returns BaseResponse whose `data` is PaypalWebhookCreateData
|
|
1267
|
+
*/
|
|
1268
|
+
create: (data: PaypalWebhookCreateBody, params?: PaypalWebhookCreateParams) => Promise<BaseResponse<PaypalWebhookCreateData>>;
|
|
1269
|
+
};
|
|
1270
|
+
};
|
|
1271
|
+
paytrace: {
|
|
1272
|
+
authorization: {
|
|
1273
|
+
/**
|
|
1274
|
+
* Authorize a credit card transaction.
|
|
1275
|
+
* Call: api.payments.paytrace.authorization.create(data)
|
|
1276
|
+
*
|
|
1277
|
+
* Authorize a credit card transaction (pre-auth).
|
|
1278
|
+
*
|
|
1279
|
+
* Request body: Keyed PayTrace card authorization (pre-auth)
|
|
1280
|
+
*
|
|
1281
|
+
* Errors:
|
|
1282
|
+
* 400: Invalid request body. Or Missing required field: amount. Or Missing required field:
|
|
1283
|
+
* creditCard. Or Invalid credit_card format. Or Missing required creditCard fields
|
|
1284
|
+
* (number, expirationMonth, expirationYear).
|
|
1285
|
+
*
|
|
1286
|
+
* POST https://payments.augur-api.com/paytrace/authorization
|
|
1287
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1paytrace~1authorization/post
|
|
1288
|
+
*
|
|
1289
|
+
* @param data PaytraceAuthorizationCreateBody (request body)
|
|
1290
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
1291
|
+
*/
|
|
1292
|
+
create: (data: PaytraceAuthorizationCreateBody) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
1293
|
+
};
|
|
1294
|
+
};
|
|
1295
|
+
rates: {
|
|
1296
|
+
/**
|
|
1297
|
+
* Estimate sales tax through Avalara.
|
|
1298
|
+
* Call: api.payments.rates.create(data)
|
|
1299
|
+
*
|
|
1300
|
+
* Estimate sales tax for a ship-to address and order lines through Avalara AvaTax.
|
|
1301
|
+
*
|
|
1302
|
+
* Request body: Tax estimate request: ship-to address plus order lines; snake_case keys are
|
|
1303
|
+
* still accepted
|
|
1304
|
+
* Response data: Estimated total sales tax for the request
|
|
1305
|
+
*
|
|
1306
|
+
* Errors:
|
|
1307
|
+
* 400: The body is missing or not a JSON object, or the site has no avalara config.
|
|
1308
|
+
*
|
|
1309
|
+
* POST https://payments.augur-api.com/rates
|
|
1310
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1rates/post
|
|
1311
|
+
*
|
|
1312
|
+
* @param data RatesCreateBody (request body)
|
|
1313
|
+
* @returns BaseResponse whose `data` is RatesCreateData
|
|
1314
|
+
*/
|
|
1315
|
+
create: (data: RatesCreateBody) => Promise<BaseResponse<RatesCreateData>>;
|
|
1316
|
+
};
|
|
1317
|
+
unified: {
|
|
1318
|
+
accountQuery: {
|
|
1319
|
+
/**
|
|
1320
|
+
* Get account query with transaction setup id
|
|
1321
|
+
* Call: api.payments.unified.accountQuery.list(params)
|
|
1322
|
+
*
|
|
1323
|
+
* Errors:
|
|
1324
|
+
* 429: More than 10 retrieval calls for this transactionSetupId within one minute.
|
|
1325
|
+
* validate, account-query and card-info share the counter.
|
|
1326
|
+
*
|
|
1327
|
+
* GET https://payments.augur-api.com/unified/account-query
|
|
1328
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1unified~1account-query/get
|
|
1329
|
+
*
|
|
1330
|
+
* @param params UnifiedAccountQueryListParams (query string)
|
|
1331
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
1332
|
+
*/
|
|
1333
|
+
list: (params?: UnifiedAccountQueryListParams) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
1334
|
+
};
|
|
1335
|
+
billingUpdate: {
|
|
1336
|
+
/**
|
|
1337
|
+
* Update billing information with transaction setup id
|
|
1338
|
+
* Call: api.payments.unified.billingUpdate.list(params)
|
|
1339
|
+
*
|
|
1340
|
+
* GET https://payments.augur-api.com/unified/billing-update
|
|
1341
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1unified~1billing-update/get
|
|
1342
|
+
*
|
|
1343
|
+
* @param params UnifiedBillingUpdateListParams (query string)
|
|
1344
|
+
* @returns BaseResponse whose `data` is UnifiedBillingUpdateListData
|
|
1345
|
+
*/
|
|
1346
|
+
list: (params?: UnifiedBillingUpdateListParams) => Promise<BaseResponse<UnifiedBillingUpdateListData>>;
|
|
1347
|
+
};
|
|
1348
|
+
cardInfo: {
|
|
1349
|
+
/**
|
|
1350
|
+
* Get card information with transaction setup id
|
|
1351
|
+
* Call: api.payments.unified.cardInfo.list(params)
|
|
1352
|
+
*
|
|
1353
|
+
* Errors:
|
|
1354
|
+
* 429: More than 10 retrieval calls for this transactionSetupId within one minute.
|
|
1355
|
+
* validate, account-query and card-info share the counter.
|
|
1356
|
+
*
|
|
1357
|
+
* GET https://payments.augur-api.com/unified/card-info
|
|
1358
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1unified~1card-info/get
|
|
1359
|
+
*
|
|
1360
|
+
* @param params UnifiedCardInfoListParams (query string)
|
|
1361
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
1362
|
+
*/
|
|
1363
|
+
list: (params?: UnifiedCardInfoListParams) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
1364
|
+
};
|
|
1365
|
+
surcharge: {
|
|
1366
|
+
/**
|
|
1367
|
+
* Get surcharge with payment account id
|
|
1368
|
+
* Call: api.payments.unified.surcharge.list(params)
|
|
1369
|
+
*
|
|
1370
|
+
* GET https://payments.augur-api.com/unified/surcharge
|
|
1371
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1unified~1surcharge/get
|
|
1372
|
+
*
|
|
1373
|
+
* @param params UnifiedSurchargeListParams (query string)
|
|
1374
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
1375
|
+
*/
|
|
1376
|
+
list: (params?: UnifiedSurchargeListParams) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
1377
|
+
};
|
|
1378
|
+
transactionResponse: {
|
|
1379
|
+
/**
|
|
1380
|
+
* Capture Unified hosted-payment response
|
|
1381
|
+
* Call: api.payments.unified.transactionResponse.list(params)
|
|
1382
|
+
*
|
|
1383
|
+
* Capture the Unified hosted-payment ReturnURL response and persist it by transaction setup
|
|
1384
|
+
* id
|
|
1385
|
+
*
|
|
1386
|
+
* Auth: bearer token; spec scopes: none listed (most endpoints list `public`)
|
|
1387
|
+
*
|
|
1388
|
+
* GET https://payments.augur-api.com/unified/transaction-response
|
|
1389
|
+
* Contract:
|
|
1390
|
+
* https://payments.augur-api.com/openapi.json#/paths/~1unified~1transaction-response/get
|
|
1391
|
+
*
|
|
1392
|
+
* @param params UnifiedTransactionResponseListParams (query string)
|
|
1393
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
1394
|
+
*/
|
|
1395
|
+
list: (params?: UnifiedTransactionResponseListParams) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
1396
|
+
};
|
|
1397
|
+
transactionSetup: {
|
|
1398
|
+
/**
|
|
1399
|
+
* Create a transaction with customer and account information
|
|
1400
|
+
* Call: api.payments.unified.transactionSetup.list(params)
|
|
1401
|
+
*
|
|
1402
|
+
* Response data: Hosted-payment page location and the transaction setup it is bound to
|
|
1403
|
+
*
|
|
1404
|
+
* GET https://payments.augur-api.com/unified/transaction-setup
|
|
1405
|
+
* Contract:
|
|
1406
|
+
* https://payments.augur-api.com/openapi.json#/paths/~1unified~1transaction-setup/get
|
|
1407
|
+
*
|
|
1408
|
+
* @param params UnifiedTransactionSetupListParams (query string)
|
|
1409
|
+
* @returns BaseResponse whose `data` is UnifiedTransactionSetupListData
|
|
1410
|
+
*/
|
|
1411
|
+
list: (params?: UnifiedTransactionSetupListParams) => Promise<BaseResponse<UnifiedTransactionSetupListData>>;
|
|
1412
|
+
};
|
|
1413
|
+
validate: {
|
|
1414
|
+
/**
|
|
1415
|
+
* Validate a transaction with customer and account information
|
|
1416
|
+
* Call: api.payments.unified.validate.list(params)
|
|
1417
|
+
*
|
|
1418
|
+
* Errors:
|
|
1419
|
+
* 429: More than 10 retrieval calls for this transactionSetupId within one minute.
|
|
1420
|
+
* validate, account-query and card-info share the counter.
|
|
1421
|
+
*
|
|
1422
|
+
* GET https://payments.augur-api.com/unified/validate
|
|
1423
|
+
* Contract: https://payments.augur-api.com/openapi.json#/paths/~1unified~1validate/get
|
|
1424
|
+
*
|
|
1425
|
+
* @param params UnifiedValidateListParams (query string)
|
|
1426
|
+
* @returns BaseResponse whose `data` is UnifiedValidateListData
|
|
1427
|
+
*/
|
|
1428
|
+
list: (params?: UnifiedValidateListParams) => Promise<BaseResponse<UnifiedValidateListData>>;
|
|
1429
|
+
};
|
|
1430
|
+
};
|
|
1431
|
+
}
|
|
1432
|
+
//# sourceMappingURL=types.d.ts.map
|