> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve payment > Retrieves the details of an existing payment. Required permissions: - `payment:basic:read` - `plan:basic:read` - `access_pass:basic:read` - `member:email:read` - `member:basic:read` - `member:phone:read` - `promo_code:basic:read` - `payment:dispute:read` - `payment:resolution_center_case:read` ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/whopsdk/openapi.documented.yml get /payments/{id} openapi: 3.1.0 info: title: Whop API description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ version: 1.0.0 servers: - url: https://api.whop.com/api/v1 description: Production Whop API security: [] tags: - name: Products description: Products - name: Plans description: Plans - name: Payments description: Payments - name: Refunds description: Refunds - name: Disputes description: Disputes - name: Dispute alerts description: Dispute alerts - name: Resolution center cases description: Resolution center cases - name: Checkout configurations description: Checkout configurations - name: Setup intents description: Setup intents - name: Payment methods description: Payment methods - name: Invoices description: Invoices - name: Promo codes description: Promo codes - name: Card transactions description: Card transactions - name: Ledger accounts description: Ledger accounts - name: Transfers description: Transfers - name: Withdrawals description: Withdrawals - name: Payout methods description: Payout methods - name: Verifications description: Verifications - name: Payout accounts description: Payout accounts - name: Topups description: Topups - name: Users description: Users - name: Companies description: Companies - name: Authorized users description: Authorized users - name: Fee markups description: Fee markups - name: Members description: Members - name: Memberships description: Memberships - name: Leads description: Leads - name: Entries description: Entries - name: Shipments description: Shipments - name: Reviews description: Reviews - name: Company token transactions description: Company token transactions - name: Affiliates description: Affiliates - name: Experiences description: Experiences - name: Forums description: Forums - name: Forum posts description: Forum posts - name: Chat channels description: Chat channels - name: Support channels description: Support channels - name: Messages description: Messages - name: Reactions description: Reactions - name: Dm members description: Dm members - name: Dm channels description: Dm channels - name: Notifications description: Notifications - name: Courses description: Courses - name: Course chapters description: Course chapters - name: Course lessons description: Course lessons - name: Course students description: Course students - name: Course lesson interactions description: Course lesson interactions - name: Apps description: Apps - name: Webhooks description: Webhooks - name: App builds description: App builds - name: Access tokens description: Access tokens - name: Account links description: Account links - name: Files description: Files - name: Ai chats description: Ai chats - name: Bounties description: Bounties - name: Stats description: Stats - name: Ad campaigns description: Ad campaigns - name: Ad groups description: Ad groups - name: Ads description: Ads - name: Conversions description: Conversions paths: /payments/{id}: get: tags: - Payments summary: Retrieve payment description: |- Retrieves the details of an existing payment. Required permissions: - `payment:basic:read` - `plan:basic:read` - `access_pass:basic:read` - `member:email:read` - `member:basic:read` - `member:phone:read` - `promo_code:basic:read` - `payment:dispute:read` - `payment:resolution_center_case:read` operationId: retrievePayment parameters: - name: id in: path required: true description: The unique identifier of the payment. schema: type: string example: pay_xxxxxxxxxxxxxx responses: '200': description: A successful response content: application/json: schema: $ref: '#/components/schemas/Payment' '400': description: Bad request content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: invalid_request_error code: parameter_missing message: 'Missing required parameter: amount.' param: amount '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: unauthorized message: Invalid or missing API key '403': description: Forbidden content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: forbidden message: You do not have permission to access this resource '404': description: Not found content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: not_found message: Resource not found '422': description: Verification required content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: null '500': description: Internal server error content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: internal_server_error message: An unexpected error occurred security: - bearerAuth: - payment:basic:read - plan:basic:read - access_pass:basic:read - member:email:read - member:basic:read - member:phone:read - promo_code:basic:read - payment:dispute:read - payment:resolution_center_case:read x-codeSamples: - lang: JavaScript source: >- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const payment = await client.payments.retrieve('pay_xxxxxxxxxxxxxx'); console.log(payment.id); - lang: Python source: |- import os from whop_sdk import Whop client = Whop( api_key=os.environ.get("WHOP_API_KEY"), # This is the default and can be omitted ) payment = client.payments.retrieve( "pay_xxxxxxxxxxxxxx", ) print(payment.id) - lang: Ruby source: |- require "whop_sdk" whop = WhopSDK::Client.new(api_key: "My API Key") payment = whop.payments.retrieve("pay_xxxxxxxxxxxxxx") puts(payment) components: schemas: Payment: type: object properties: id: type: string description: The unique identifier for the payment. example: pay_xxxxxxxxxxxxxx status: oneOf: - $ref: '#/components/schemas/ReceiptStatus' - type: 'null' description: >- The current lifecycle state of this payment (e.g., 'draft', 'open', 'paid', 'void'). substatus: $ref: '#/components/schemas/FriendlyReceiptStatus' description: The friendly status of the payment. refundable: type: boolean description: >- True only for payments that are `paid`, have not been fully refunded, and were processed by a payment processor that allows refunds. retryable: type: boolean description: >- True when the payment status is `open` and its membership is in one of the retry-eligible states (`active`, `trialing`, `completed`, or `past_due`); otherwise false. Used to decide if Whop can attempt the charge again. voidable: type: boolean description: >- True when the payment is tied to a membership in `past_due`, the payment status is `open`, and the processor allows voiding payments; otherwise false. created_at: type: string format: date-time description: The datetime the payment was created. example: '2023-12-01T05:00:00.401Z' updated_at: type: string format: date-time description: The datetime the payment was last updated. example: '2023-12-01T05:00:00.401Z' paid_at: type: - string - 'null' format: date-time description: >- The time at which this payment was successfully collected. Null if the payment has not yet succeeded. As a Unix timestamp. example: '2023-12-01T05:00:00.401Z' last_payment_attempt: type: - string - 'null' format: date-time description: The time of the last payment attempt. example: '2023-12-01T05:00:00.401Z' next_payment_attempt: type: - string - 'null' format: date-time description: The time of the next schedule payment retry. example: '2023-12-01T05:00:00.401Z' dispute_alerted_at: type: - string - 'null' format: date-time description: When an alert came in that this transaction will be disputed example: '2023-12-01T05:00:00.401Z' refunded_at: type: - string - 'null' format: date-time description: When the payment was refunded (if applicable). example: '2023-12-01T05:00:00.401Z' plan: type: - object - 'null' properties: id: type: string description: The unique identifier for the plan. example: plan_xxxxxxxxxxxxx internal_notes: type: - string - 'null' description: A personal description or notes section for the business. required: - id - internal_notes description: The plan attached to this payment. product: type: - object - 'null' properties: id: type: string description: The unique identifier for the product. example: prod_xxxxxxxxxxxxx title: type: string description: >- The display name of the product shown to customers on the product page and in search results. example: Pickaxe Analytics route: type: string description: >- The URL slug used in the product's public link (e.g., 'my-product' in whop.com/company/my-product). example: pickaxe-analytics required: - id - title - route description: The product this payment was made for user: type: - object - 'null' properties: id: type: string description: The unique identifier for the user. example: user_xxxxxxxxxxxxx name: type: - string - 'null' description: The user's display name shown on their public profile. example: John Doe username: type: string description: The user's unique username shown on their public profile. example: johndoe42 email: type: - string - 'null' description: >- The user's email address. Requires the member:email:read permission to access. Null if not authorized. example: john.doe@example.com required: - id - name - username - email description: The user that made this payment. membership: type: - object - 'null' properties: id: type: string description: The unique identifier for the membership. example: mem_xxxxxxxxxxxxxx status: $ref: '#/components/schemas/MembershipStatus' description: The state of the membership. required: - id - status description: The membership attached to this payment. member: type: - object - 'null' properties: id: type: string description: The unique identifier for the company member. phone: type: - string - 'null' description: The phone number for the member, if available. required: - id - phone description: The member attached to this payment. payment_method: type: - object - 'null' properties: id: type: string description: The unique identifier for the payment token. example: payt_xxxxxxxxxxxxx created_at: type: string format: date-time description: The datetime the payment token was created. example: '2023-12-01T05:00:00.401Z' payment_method_type: $ref: '#/components/schemas/PaymentMethodTypes' description: The payment method type of the payment method card: type: - object - 'null' properties: brand: oneOf: - $ref: '#/components/schemas/CardBrands' - type: 'null' description: >- The card network (e.g., visa, mastercard, amex). Null if the brand could not be determined. last4: type: - string - 'null' description: >- The last four digits of the card number. Null if not available. example: '4242' exp_month: type: - integer - 'null' description: >- The two-digit expiration month of the card (1-12). Null if not available. example: 42 exp_year: type: - integer - 'null' description: >- The two-digit expiration year of the card (e.g., 27 for 2027). Null if not available. example: 42 required: - brand - last4 - exp_month - exp_year description: >- The card data associated with the payment method, if its a debit or credit card. required: - id - created_at - payment_method_type - card description: >- The tokenized payment method reference used for this payment. Null if no token was used. company: type: - object - 'null' properties: id: type: string description: The unique identifier for the company. example: biz_xxxxxxxxxxxxxx title: type: string description: The written name of the company. route: type: string description: The slug/route of the company on the Whop site. required: - id - title - route description: The company for the payment. promo_code: type: - object - 'null' properties: id: type: string description: The unique identifier for the promo code. example: promo_xxxxxxxxxxxx code: type: - string - 'null' description: The specific code used to apply the promo at checkout. amount_off: type: number description: >- The discount amount. Interpretation depends on promo_type: if 'percentage', this is the percentage (e.g., 20 means 20% off); if 'flat_amount', this is dollars off (e.g., 10.00 means $10.00 off). example: 6.9 base_currency: $ref: '#/components/schemas/Currencies' description: The monetary currency of the promo code. promo_type: $ref: '#/components/schemas/PromoTypes' description: The type (% or flat amount) of the promo. number_of_intervals: type: - integer - 'null' description: The number of months the promo is applied for. example: 42 required: - id - code - amount_off - base_currency - promo_type - number_of_intervals description: The promo code used for this payment. currency: oneOf: - $ref: '#/components/schemas/Currencies' - type: 'null' description: >- The three-letter ISO currency code for this payment (e.g., 'usd', 'eur'). settlement_currency: type: string description: >- The currency in which the creator receives payouts and fees are charged (e.g., 'usd', 'eur'). For multi-currency payments this differs from the payment currency. total: type: - number - 'null' description: The total to show to the creator (excluding buyer fees). example: 6.9 subtotal: type: - number - 'null' description: The subtotal to show to the creator (excluding buyer fees). example: 6.9 usd_total: type: - number - 'null' description: The total in USD to show to the creator (excluding buyer fees). example: 6.9 refunded_amount: type: - number - 'null' description: The payment refund amount(if applicable). example: 6.9 auto_refunded: type: boolean description: Whether this payment was auto refunded or not amount_after_fees: type: number description: How much the payment is for after fees example: 6.9 application_fee: type: - object - 'null' properties: id: type: string description: The unique identifier for the application fee. example: apfee_xxxxxxxxxxxx amount: type: number description: The application fee amount. example: 6.9 amount_captured: type: number description: The amount of the application fee that has been captured. example: 6.9 amount_refunded: type: number description: The amount of the application fee that has been refunded. example: 6.9 currency: $ref: '#/components/schemas/Currencies' description: The currency of the application fee. created_at: type: string format: date-time description: The datetime the application fee was created. example: '2023-12-01T05:00:00.401Z' required: - id - amount - amount_captured - amount_refunded - currency - created_at description: The application fee charged on this payment. card_brand: oneOf: - $ref: '#/components/schemas/CardBrands' - type: 'null' description: >- Card network reported by the processor (e.g., 'visa', 'mastercard', 'amex'). Present only when the payment method type is 'card'. card_last4: type: - string - 'null' description: >- The last four digits of the card used to make this payment. Null if the payment was not made with a card. example: '4242' billing_address: type: - object - 'null' properties: name: type: - string - 'null' description: The name of the customer. line1: type: - string - 'null' description: The line 1 of the address. line2: type: - string - 'null' description: The line 2 of the address. city: type: - string - 'null' description: The city of the address. state: type: - string - 'null' description: The state of the address. postal_code: type: - string - 'null' description: The postal code of the address. country: type: - string - 'null' description: The country of the address. required: - name - line1 - line2 - city - state - postal_code - country description: The address of the user who made the payment. payment_method_type: oneOf: - $ref: '#/components/schemas/PaymentMethodTypes' - type: 'null' description: >- The type of payment instrument used for this payment (e.g., card, Cash App, iDEAL, Klarna, crypto). Null when the processor does not supply a type. billing_reason: oneOf: - $ref: '#/components/schemas/BillingReasons' - type: 'null' description: >- The machine-readable reason this charge was created, such as initial subscription purchase, renewal cycle, or one-time payment. payments_failed: type: - integer - 'null' description: The number of failed payment attempts for the payment. example: 42 tax_amount: type: - number - 'null' description: The calculated amount of the sales/VAT tax (if applicable). example: 6.9 tax_behavior: oneOf: - $ref: '#/components/schemas/ReceiptTaxBehaviors' - type: 'null' description: >- The type of tax inclusivity applied to the payment, for determining whether the tax is included in the final price, or paid on top. failure_message: type: - string - 'null' description: If the payment failed, the reason for the failure. metadata: type: - object - 'null' additionalProperties: true description: >- The custom metadata stored on this payment. This will be copied over to the checkout configuration for which this payment was made checkout_configuration_id: type: - string - 'null' description: >- The ID of the checkout session/configuration that produced this payment, if any. Use this to map payments back to the checkout configuration that created them. settlement_amount: type: number description: >- The payment amount in the creator's settlement currency (what the creator priced in). Equal to final_amount for single-currency payments. example: 6.9 settlement_exchange_rate: type: - number - 'null' description: >- The locked exchange rate used to convert from the buyer's payment currency to the creator's settlement currency. Null for single-currency payments. example: 6.9 tax_refunded_amount: type: - number - 'null' description: The amount of tax that has been refunded (if applicable). example: 6.9 financing_installments_count: type: - integer - 'null' description: >- The number of financing installments for the payment. Present if the payment is a financing payment (e.g. Splitit, Klarna, etc.). example: 42 financing_transactions: type: array items: type: object properties: id: type: string description: The unique identifier for the payment transaction. example: ptx_xxxxxxxxxxxxxx amount: type: number description: The amount of the payment transaction. example: 6.9 status: $ref: '#/components/schemas/PaymentTransactionStatuses' description: The status of the payment transaction. created_at: type: string format: date-time description: The date and time the payment transaction was created. example: '2023-12-01T05:00:00.401Z' transaction_type: $ref: '#/components/schemas/PaymentTransactionTypes' description: The type of the payment transaction. required: - id - amount - status - created_at - transaction_type description: A payment transaction. description: >- The financing transactions attached to this payment. Present if the payment is a financing payment (e.g. Splitit, Klarna, etc.). disputes: type: - array - 'null' items: type: object properties: id: type: string description: The unique identifier for the dispute. example: dspt_xxxxxxxxxxxxx amount: type: number description: >- The disputed amount in the specified currency, formatted as a decimal. example: 6.9 currency: $ref: '#/components/schemas/Currencies' description: The three-letter ISO currency code for the disputed amount. status: $ref: '#/components/schemas/DisputeStatuses' description: >- The current status of the dispute lifecycle, such as needs_response, under_review, won, or lost. editable: type: - boolean - 'null' description: >- Whether the dispute evidence can still be edited and submitted. Returns true only when the dispute status requires a response. needs_response_by: type: - string - 'null' format: date-time description: >- The deadline by which dispute evidence must be submitted. Null if no response deadline is set. example: '2023-12-01T05:00:00.401Z' reason: type: - string - 'null' description: A human-readable reason for the dispute. example: Product Not Received notes: type: - string - 'null' description: >- Additional freeform notes submitted by the company as part of the dispute evidence. example: Customer used the product for 3 months before disputing. required: - id - amount - currency - status - editable - needs_response_by - reason - notes description: >- A dispute is a chargeback or payment challenge filed against a company, including evidence and response status. description: >- The disputes attached to this payment. Null if the actor in context does not have the payment:dispute:read permission. resolutions: type: - array - 'null' items: type: object properties: id: type: string description: The unique identifier for the resolution. example: reso_xxxxxxxxxxxxx status: $ref: '#/components/schemas/ResolutionCenterCaseStatuses' description: >- The current status of the resolution case, indicating which party needs to respond or if the case is closed. due_date: type: - string - 'null' format: date-time description: >- The deadline by which the next response is required. Null if no deadline is currently active. As a Unix timestamp. example: '2023-12-01T05:00:00.401Z' issue: $ref: '#/components/schemas/ResolutionCenterCaseIssueTypes' description: The category of the dispute. customer_appealed: type: boolean description: >- Whether the customer has filed an appeal after the initial resolution decision. merchant_appealed: type: boolean description: >- Whether the merchant has filed an appeal after the initial resolution decision. customer_response_actions: type: array items: $ref: '#/components/schemas/ResolutionCenterCaseCustomerResponses' description: The list of actions currently available to the customer. merchant_response_actions: type: array items: $ref: '#/components/schemas/ResolutionCenterCaseMerchantResponses' description: The list of actions currently available to the merchant. platform_response_actions: type: array items: $ref: '#/components/schemas/ResolutionCenterCasePlatformResponses' description: >- The list of actions currently available to the Whop platform for moderating this resolution. required: - id - status - due_date - issue - customer_appealed - merchant_appealed - customer_response_actions - merchant_response_actions - platform_response_actions description: >- A resolution center case is a dispute or support case between a user and a company, tracking the issue, status, and outcome. description: >- The resolution center cases opened by the customer on this payment. Null if the actor in context does not have the payment:resolution_center_case:read permission. required: - id - status - substatus - refundable - retryable - voidable - created_at - updated_at - paid_at - last_payment_attempt - next_payment_attempt - dispute_alerted_at - refunded_at - plan - product - user - membership - member - payment_method - company - promo_code - currency - settlement_currency - total - subtotal - usd_total - refunded_amount - auto_refunded - amount_after_fees - application_fee - card_brand - card_last4 - billing_address - payment_method_type - billing_reason - payments_failed - tax_amount - tax_behavior - failure_message - metadata - checkout_configuration_id - settlement_amount - settlement_exchange_rate - tax_refunded_amount - financing_installments_count - financing_transactions - disputes - resolutions description: >- A payment represents a completed or attempted charge. Payments track the amount, status, currency, and payment method used. ReceiptStatus: type: string enum: - draft - open - paid - pending - uncollectible - unresolved - void description: The status of a receipt FriendlyReceiptStatus: type: string enum: - succeeded - pending - failed - past_due - canceled - price_too_low - uncollectible - refunded - auto_refunded - partially_refunded - dispute_warning - dispute_needs_response - dispute_warning_needs_response - resolution_needs_response - dispute_under_review - dispute_warning_under_review - resolution_under_review - dispute_won - dispute_warning_closed - resolution_won - dispute_lost - dispute_closed - resolution_lost - drafted - incomplete - unresolved - open_dispute - open_resolution description: >- The friendly status of a payment. This is a derived status that provides a human-readable summary of the payment state, combining the underlying status and substatus fields. MembershipStatus: type: string enum: - trialing - active - past_due - completed - canceled - expired - unresolved - drafted - canceling description: The status of a membership PaymentMethodTypes: type: string enum: - acss_debit - affirm - afterpay_clearpay - alipay - alma - amazon_pay - apple - apple_pay - au_bank_transfer - au_becs_debit - bacs_debit - bancolombia - bancontact - billie - bizum - blik - boleto - bre_b - ca_bank_transfer - capchase_pay - card - card_installments_three - card_installments_six - card_installments_twelve - cashapp - claritypay - coinbase - crypto - custom - customer_balance - demo_pay - efecty - eps - eu_bank_transfer - fpx - gb_bank_transfer - giropay - google_pay - gopay - grabpay - id_bank_transfer - ideal - interac - kakao_pay - klarna - klarna_pay_now - konbini - kr_card - kr_market - kriya - kueski - link - mb_way - m_pesa - mercado_pago - mobilepay - mondu - multibanco - naver_pay - nequi - netbanking - ng_bank - ng_bank_transfer - ng_card - ng_market - ng_ussd - ng_wallet - nz_bank_account - oxxo - p24 - pago_efectivo - pse - pay_by_bank - payco - paynow - paypal - paypay - payto - pix - platform_balance - promptpay - qris - rechnung - revolut_pay - samsung_pay - satispay - scalapay - sencillito - sepa_debit - sequra - servipag - sezzle - shop_pay - shopeepay - sofort - south_korea_market - spei - splitit - sunbit - swish - tamara - twint - upi - us_bank_account - us_bank_transfer - venmo - vipps - webpay - wechat_pay - yape - zip - coinflow - unknown description: The different types of payment methods that can be used. CardBrands: type: string enum: - mastercard - visa - amex - discover - unionpay - jcb - diners - link - troy - visadankort - visabancontact - china_union_pay - rupay - jcbrupay - elo - maestro - tarjeta_naranja - cirrus - nspk_mir - verve - ebt - private_label - local_brand - uatp - wexcard - uzcard - meeza - hrg_store_card - girocard - fuel_card - dankort - carnet - atm_card - china_union_payuzcard - codensa - cabal - hipercard - jcblankapay - cmi - unknown description: Possible card brands that a payment token can have Currencies: type: string enum: - usd - sgd - inr - aud - brl - cad - dkk - eur - nok - gbp - sek - chf - hkd - huf - jpy - mxn - myr - pln - czk - nzd - aed - eth - ape - cop - ron - thb - bgn - idr - dop - php - try - krw - twd - vnd - pkr - clp - uyu - ars - zar - dzd - tnd - mad - kes - kwd - jod - all - xcd - amd - bsd - bhd - bob - bam - khr - crc - xof - egp - etb - gmd - ghs - gtq - gyd - ils - jmd - mop - mga - mur - mdl - mnt - nad - ngn - mkd - omr - pyg - pen - qar - rwf - sar - rsd - lkr - tzs - ttd - uzs - rub - btc - cny - usdt - kzt description: The available currencies on the platform PromoTypes: type: string enum: - percentage - flat_amount description: The type of promo code used to discount a plan BillingReasons: type: string enum: - subscription_create - subscription_cycle - subscription_update - one_time - manual - subscription description: The reason why a specific payment was billed ReceiptTaxBehaviors: type: string enum: - exclusive - inclusive - unspecified - unable_to_collect description: >- The type of tax inclusivity applied to the receipt, for determining whether the tax is included in the final price, or paid on top. PaymentTransactionStatuses: type: string enum: - succeeded - declined - error - pending - created - expired - won - rejected - lost - prevented - canceled description: The different statuses a payment transaction can be in. PaymentTransactionTypes: type: string enum: - purchase - authorize - capture - refund - canceled - verify - chargeback - pre_chargeback - three_d_secure - fraud_screening - authorization - installment description: The different types of payment transactions. DisputeStatuses: type: string enum: - warning_needs_response - warning_under_review - warning_closed - needs_response - under_review - won - lost - closed - other description: The possible statuses of a dispute ResolutionCenterCaseStatuses: type: string enum: - merchant_response_needed - customer_response_needed - merchant_info_needed - customer_info_needed - under_platform_review - customer_won - merchant_won - customer_withdrew description: The statuses a resolution object can have ResolutionCenterCaseIssueTypes: type: string enum: - forgot_to_cancel - item_not_received - significantly_not_as_described - unauthorized_transaction - product_unacceptable description: The different types of issues a resolution can be ResolutionCenterCaseCustomerResponses: type: string enum: - respond - appeal - withdraw description: The types of responses a customer can make to a resolution. ResolutionCenterCaseMerchantResponses: type: string enum: - accept - deny - request_more_info - appeal - respond description: The types of responses a merchant can make to a resolution. ResolutionCenterCasePlatformResponses: type: string enum: - request_buyer_info - request_merchant_info - merchant_wins - platform_refund - merchant_refund description: The types of responses the platform can make to a resolution. securitySchemes: bearerAuth: type: http description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer bearerFormat: auth-scheme ````