> ## Documentation Index
> Fetch the complete documentation index at: https://integration.wpay.com.au/llms.txt
> Use this file to discover all available pages before exploring further.

# List payment links

This endpoint requires the `payment-links.read` scope.


## OpenAPI

````yaml openapi.speakeasy.json GET /payment-links
openapi: 3.0.0
info:
  title: Gr4vy API
  version: 1.1.0-beta
  contact:
    name: Gr4vy Support
    email: code@gr4vy.com
    url: https://gr4vy.com
  termsOfService: https://gr4vy.com
  license:
    name: MIT
    url: https://raw.githubusercontent.com/gr4vy/gr4vy-openapi/main/LICENSE
  description: |-
    Welcome to the Gr4vy API reference documentation.
    Our API is still very much a work in product and subject to change.
servers:
  - url: https://api.sandbox.{id}.gr4vy.app
    x-speakeasy-server-id: sandbox
    variables:
      id:
        default: example
        description: The subdomain for your Gr4vy instance.
  - url: https://api.{id}.gr4vy.app
    x-speakeasy-server-id: production
    variables:
      id:
        default: example
        description: The subdomain for your Gr4vy instance.
security:
  - bearerAuth: []
tags:
  - name: Account Updater
    description: >-
      An Account Updater is a service provided by credit card issuers

      (such as banks and financial institutions) to merchants who accept

      recurring payments from customers. Its primary purpose is to help

      merchants maintain accurate and up-to-date payment information for

      their customers' credit or debit card accounts.


      In Gr4vy, the Account Updater service is provided in an on-demand

      and asynchronous fashion:


      1. A merchant requests an update for a set of stored cards.

      2. A request is submitted to a third-party service.

      3. When results are ready, new card details are stored and left in
      standby.

      4. Card details are updated when it gets determined that the original card
         is no longer valid (e.g. has expired).
  - name: Anti-Fraud Services
    description: >-
      In Gr4vy, an anti-fraud service represents a configured anti-fraud service

      provider (`Sift`, `CyberSource`, etc). This third-party services will be

      used to screen transactions to determine the risk and prevents chargebacks

      and fraudulent transactions.


      The anti-fraud services API can be used to:


      * Provide Gr4vy with the API credentials for an anti-fraud service
      provider.

      * Set a display name for a anti-fraud provider.

      * Map anti-fraud service decisions to Gr4vy internal decisions.
    x-internal: true
  - name: Anti Fraud Service Definitions
    description: >-
      Anti fraud service definitions describe the fields required for a anti
      fraud

      service to be configured.
  - name: API Key Pairs
    description: >-
      In Gr4vy, an API key pair is used to sign and validate JSON Web Tokens
      (JWT).

      JWTs are used as a HTTP `bearer` token to authenticate to the API. For
      more

      information please visit our [in-depth
      authentication](/guides/authentication)

      guide.
    x-internal: true
  - name: API Logs
    description: >-
      API Logs provide an historic of 4XX and 5XX errors that happened in the
      API

      in the last 24 hours with a 250 result limit.
    x-internal: true
  - name: Apple Pay Certificates
    description: >-
      Apple Pay payment processing certificates are used by Apple to encrypt
      Apple

      Pay tokens. You must register and upload an Apple Pay payment processing

      certificate if you wish to use Apple Pay with Gr4vy's mobile SDKs.


      The Apple Pay certificates API can be used to:


      * Start a new Apple Pay certificate registration, providing you with a

      Certificate Signing Request (CSR).

      * Update the Apple Pay certificate record with the certificate received
      from

      Apple after creating a new payment processing certificate on your Apple

      Developer console and uploading a CSR.

      * List all Apple Pay certificates.
    x-internal: true
  - name: Audit Logs
    description: >-
      Audit Logs provide an historic record of changes made to your Gr4vy
      instance.
  - name: Buyers
    description: >-
      In Gr4vy, a buyer represents your customer, the shopper who's performing

      a checkout and making a purchase.


      A buyer can be used by you to:


      * Display a human readable name (`display_name`) for a buyer in the Gr4vy

      admin panel

      * Associate multiple stored payment methods with a single user

      * Initialize **Gr4vy Embed** with the buyer ID, automatically displaying
      the
        buyer's previously stored payment methods, allowing for faster checkout.
  - name: Card Details
    description: Endpoints to retrieve details of a card by utilising a BIN lookup table.
    x-internal: true
  - name: Card Scheme Definitions
    description: Card Scheme definitions provide display information to a card scheme.
  - name: Connections
    description: |-
      Endpoints to retrieve details of configured connections such as payment
      services, digital wallets, and anti-fraud services.
    x-internal: true
  - name: Connection Definitions
    description: |-
      Endpoints to retrieve details of various connections such as payment
      services, digital wallets, and anti-fraud services.
    x-internal: true
  - name: Checkout Sessions
    description: |-
      A Checkout Session represents the session of a user as they progress
      through an online checkout.
  - name: Digital Wallets
    description: |-
      In Gr4vy, a digital wallet represents a way for a buyer to pay using
      card details already stored on their device via a digital wallet service
      such as Apple Pay or Google Pay. The buyer will not have to fill in their
      card details on checkout.

      The digital wallets API can be used to:

      * Register with a digital wallet provider.
      * List digital wallets currently registered.
  - name: Gift Cards
    description: >-
      In Gr4vy, a gift card represents a stored value card that can be used to
      pay for

      a transaction.
  - name: Gift Card Services
    description: >-
      In Gr4vy, a gift card service represents a configured provider for
      processing

      gift cards.
  - name: Gift Card Service Definitions
    description: |-
      Gift card service definitions describe the fields required for a gift
      card service to be configured.
  - name: Health Dashboard
    description: Endpoints to retrieve the data used for the Health Dashboard.
    x-internal: true
  - name: Merchant Accounts
    description: |-
      In Gr4vy, a merchant account represents an individual merchant in an
      instance. Each instance has one or more merchant accounts, and each
      merchant account has its own connections, Flow rules, transactions, and
      more.
  - name: Metrics Explorer
    description: Endpoints to retrieve the data used for the Metrics Explorer.
    x-internal: true
  - name: Payment Methods
    description: |-
      In Gr4vy, a payment method represents a way in which a payment can be
      processed, for example a card, a PayPal account, or a bank account.

      The payment method API can be used to:

      * List all the available payment methods
      * Filter the available payment method for a buyer in a specific currency
      and country.
      * Store (also known as vault) a payment method for a buyer.
      * Fetch all previously stored payment methods for a buyer.
  - name: Payment Method Definitions
    description: >-
      Payment Method definitions provide display information to a payment
      method.
  - name: Payment Options
    description: |-
      In Gr4vy, a payment option represents a list of methods (card, PayPal,
      etc) that are available for a given locale.

      The payment options API can be used to:

      * Determine what types of payments can be processed in a specific locale.
      * Display a list options to a buyer to choose from.
  - name: Payment Service Definitions
    description: |-
      Payment service definitions describe the fields required for a payment
      service to be configured.
  - name: Payment Services
    description: |-
      In Gr4vy, a payment service represents a configured payment provider
      (Stripe, PayPal, Adyen, etc) for a specific payment type (card, bitcoin,
      etc)

      The payment services API can be used to:

      * Provide Gr4vy with the payment credentials for a payment provider.
      * Set a display name for a payment provider.
  - name: Payouts
    description: |-
      Payouts allow a merchant to send money from one of their own accounts to a
      third party.
  - name: Payment Links
    description: >-
      In Gr4vy, payment links allow a merchant to generate a link, send it to a

      customer via email, SMS, etc, and then have the customer pay without the
      need

      for the merchant hosting their own checkout.
  - name: Vault Forward Definitions
    description: >-
      Vault Forward definitions describe a third party service that has been
      vetted

      to receive requests containing PCI data.
  - name: Vault Forward Configurations
    description: |-
      A Vault Forward Configuration represents a third party service that is
      currently enabled to send requests containing PCI data.
  - name: Vault Forward
    description: |-
      Vault Forwarding is a way to perform requests where, provided a template,
      Gr4vy will evaluate it to inject PCI data and forward it to third party
      services that have been vetted to receive such data.
  - name: Reports
    description: |-
      In Gr4vy, a report represents the configuration details to extract or
      dump a set of data into a downloadable CSV file. The data extracted
      by a report is configured via the reports API where you can specify:

      * Which fields should be in the dataset.
      * How the dataset should be sorted.
      * How the dataset should be filtered.

      Once a report is created, it may be executed on a one-off or recurring
      basis. One-off reports are executed only once shortly after the report
      is created, while recurring reports are executed periodically based on
      its configured frequency, e.g. weekly or monthly.

      During a report execution, the data is extracted and loaded into
      a CSV file according to the report's configuration. The resulting file
      may then be downloaded.

      The reports API can be used to:

      * Create and configure new reports.
      * List all reports.
      * View the configuration details of a report.
      * List a report's executions.
      * Reconfigure an existing report.
      * Generate a temporary URL to download the result of a report execution
      in CSV format.
  - name: Sessions
    description: |-
      The sessions APIs are used to facilitate user authentication for the Gr4vy
      dashboard.
    x-internal: true
  - name: Transactions
    description: >-
      In Gr4vy, a transaction represents a payment in any state, either before
      it

      is authorized, once it is captured, or after it has been refunded.


      The transactions API can be used to:


      - Authorize, capture, and store cards.

      - Authorize, capture, and store alternative payment methods like PayPal.

      - Refund, void, and otherwise cancel existing transactions.
  - name: Users
    description: |-
      In Gr4vy, a user represents an employee of the merchant with access to the
      dashboard.
    x-internal: true
  - name: Webhooks
    description: |-
      Endpoints related to webhooks to integrate Gr4vy with payment services
      webhooks functionality.
    x-internal: true
  - name: Flow
    description: >-
      In Gr4vy, a rule can be created that triggers actions anywhere in the
      payment flow.
    x-internal: true
  - name: Roles
    description: >-
      In Gr4vy, users can be granted access to specific types of resources and
      permissions

      to perform certain actions by being assigned one or more roles.
  - name: Tokens
    description: Endpoints related to the Gr4vy tokenization service.
  - name: Webhook subscriptions
    description: >-
      Endpoints related to the management of subscriptions for endpoints to
      receive webhooks.
paths:
  /payment-links:
    get:
      tags:
        - Payment Links
      summary: List payment links
      description: Lists all payment links for an account. Sorted by last updated at.
      operationId: list-payment-links
      responses:
        '200':
          description: Returns a paginated list of payment links for an account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinks'
        '401':
          description: Returns an error if no valid authentication was provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401Unauthorized'
components:
  schemas:
    PaymentLinks:
      title: Payment Links
      type: object
      description: A list of payment links.
      x-tags:
        - PaymentLinks
      properties:
        items:
          type: array
          description: A list of payment links.
          items:
            $ref: '#/components/schemas/PaymentLink'
        limit:
          type: integer
          description: >-
            The limit applied to request. This represents the number of items
            that are at

            maximum returned by this request.
          format: int32
          minimum: 1
          maximum: 100
          example: 1
          default: 20
        next_cursor:
          type: string
          description: >-
            The cursor that represents the next page of results. Use the
            `cursor` query

            parameter to fetch this page of items.
          example: ZXhhbXBsZTE
          nullable: true
          minLength: 1
          maxLength: 1000
        previous_cursor:
          type: string
          description: >-
            The cursor that represents the next page of results. Use the
            `cursor` query

            parameter to fetch this page of items.
          example: null
          nullable: true
          minLength: 1
          maxLength: 1000
    Error401Unauthorized:
      title: Unauthorized Error
      type: object
      description: Unauthorized Error (HTTP 401).
      x-tags:
        - Errors
      properties:
        type:
          type: string
          description: '`error`.'
          enum:
            - error
          example: error
        code:
          type: string
          description: '`unauthorized`.'
          example: unauthorized
          enum:
            - unauthorized
        status:
          type: integer
          description: '`401`.'
          example: 401
          enum:
            - 401
        message:
          type: string
          description: No valid API authentication found.
          example: No valid API authentication found
          enum:
            - No valid API authentication found
        details:
          type: array
          description: >-
            A list of detail objects that further clarify the reason for the
            error.

            Not every error supports more detail.
          example: []
          items:
            $ref: '#/components/schemas/ErrorDetail'
    PaymentLink:
      title: Payment Link
      type: object
      x-tags:
        - PaymentLink
      properties:
        id:
          type: string
          format: uuid
          description: The ID of a payment link.
          example: 8d3fe99b-1422-42e6-bbb3-932d95ae5f79
        type:
          type: string
          description: The type of this resource. Is always `payment_link`.
          example: payment_link
          enum:
            - payment_link
        amount:
          description: >-
            The monetary amount for this payment link, in the smallest

            currency unit for the given currency, for example `1299` cents to
            create

            an authorization for `$12.99`.
          type: integer
          example: 1299
        currency:
          type: string
          example: USD
          description: A supported ISO-4217 currency code.
        created_at:
          type: string
          description: The date and time when this payment link was created.
          format: date-time
          example: '2022-01-01T12:00:00+00:00'
        updated_at:
          type: string
          description: The date and time when this payment link was created.
          format: date-time
          example: '2022-01-01T12:00:00+00:00'
        expires_at:
          type: string
          description: The date and time when this payment link expires.
          format: date-time
          example: '2022-01-01T12:00:00+00:00'
        status:
          type: string
          example: active
          enum:
            - active
            - completed
            - expired
            - processing
        external_identifier:
          type: string
          description: >-
            A value that can be used to match the payment link against your own
            records.
          example: payment-link-123
          nullable: true
          minLength: 1
          maxLength: 200
        statement_descriptor:
          type: object
          allOf:
            - $ref: '#/components/schemas/StatementDescriptor'
          nullable: true
        locale:
          type: string
          nullable: true
          description: The locale used to translate text within the payment link.
          example: en
          enum:
            - en
            - en-GB
            - es
            - pt
            - pt-BR
        merchant_name:
          type: string
          description: The name of the merchant to display on the payment link.
          example: Gr4vy
          maxLength: 100
          nullable: true
        merchant_url:
          type: string
          description: The URL of the merchant to display on the payment link.
          example: https://gr4vy.com
          nullable: true
        merchant_banner_url:
          type: string
          description: The URL of the merchant banner to display on the payment link.
          example: https://gr4vy.com/banner.png
          nullable: true
        merchant_color:
          type: string
          description: The color code of the merchant to display on the payment link.
          example: '#FF0000'
          nullable: true
        merchant_message:
          type: string
          description: The message to display on the payment link.
          example: Thank you for shopping with us!
          maxLength: 255
          nullable: true
        merchant_terms_and_conditions_url:
          type: string
          description: >-
            The URL of the merchant terms and conditions to display on the
            payment link.
          example: https://gr4vy.com/terms
          nullable: true
        merchant_favicon_url:
          type: string
          description: The URL of the merchant favicon icon.
          example: https://gr4vy.com/favicon.png
          nullable: true
        country:
          description: >
            The 2-letter ISO code of the country of the transaction.

            This is used to filter the payment services that is used to process
            the

            transaction.
          example: US
          type: string
          nullable: true
        intent:
          type: string
          description: The intent of the payment link.
          example: authorize
          enum:
            - authorize
            - capture
          nullable: true
        return_url:
          type: string
          description: The URL to redirect the buyer to after payment.
          example: https://gr4vy.com/return
          nullable: true
        cart_items:
          description: >-
            An array of cart items that represents the line items of a payment
            link.
          items:
            $ref: '#/components/schemas/CartItem'
          maxItems: 249
          type: array
        metadata:
          additionalProperties:
            type: string
          description: >-
            Any additional information about the payment link that you would
            like to

            store as key-value pairs. This data is passed to payment service

            providers that support it.
          example:
            key: value
          maxProperties: 20
          type: object
          nullable: true
        payment_source:
          type: string
          description: The source of the payment link. Defaults to `ecommerce`.
          nullable: true
          example: recurring
          enum:
            - ecommerce
            - moto
            - recurring
            - installment
            - card_on_file
        buyer:
          type: object
          allOf:
            - $ref: '#/components/schemas/Buyer--Snapshot'
          description: The buyer used for this transaction.
          nullable: true
        shipping_details:
          description: Shipping details for the payment link.
          allOf:
            - $ref: '#/components/schemas/ShippingDetail'
          type: object
          x-model-name: ShippingDetail
          nullable: true
    ErrorDetail:
      title: Error details
      description: Additional detail about the part of a request body that caused an issue.
      type: object
      x-tags:
        - Errors
      properties:
        location:
          type: string
          example: body
          description: The location where the error caused an issue.
          enum:
            - query
            - body
            - path
            - header
        type:
          type: string
          example: value_error.missing
          description: A unique identifier for the type of error that occurred.
        pointer:
          type: string
          example: /payment_method/number
          description: >-
            The exact item for which the validation did not succeed. This is a
            JSON

            pointer for request bodies, while for query, path, and header
            parameters

            it is the name of the parameter.
        message:
          type: string
          example: field required
          description: A human readable message for this error detail.
    StatementDescriptor:
      title: Statement descriptor
      type: object
      description: >-
        The statement descriptor is the text to be shown on the buyer's
        statements.


        The specific usage of these fields will depend on the capabilities of

        the underlying PSP and bank. As a typical example, 'name' and

        'description' could be concatenated using '* ' as a separator, and

        then the resulting descriptor would be truncated to 22 characters by

        the issuing bank.
      properties:
        name:
          type: string
          minLength: 5
          maxLength: 22
          description: |-
            Reflects your doing business as (DBA) name.

            Other validations:

            1. Contains only Latin characters.
            2. Contain at least one letter
            3. Does not contain any of the special characters `< > \ ' " *`
            4. Supports:
              1. Lower case: `a-z`
              2. Upper case: `A-Z`
              3. Numbers: `0-9`
              4. Spaces: ` `
              5. Special characters: `. , _ - ? + /`.
          example: GR4VY
          nullable: true
        description:
          type: string
          minLength: 5
          maxLength: 22
          example: Card payment
          description: |-
            A short description about the purchase.

            Other validations:
            1. Contains only Latin characters.
            2. Contain at least one letter
            3. Does not contain any of the special characters `< > \ ' " *`
            4. Supports:
              1. Lower case: `a-z`
              2. Upper case: `A-Z`
              3. Numbers: `0-9`
              4. Spaces: ` `
              5. Special characters: `. , _ - ? + /`.
          nullable: true
        city:
          type: string
          minLength: 1
          maxLength: 13
          description: |-
            The merchant's city to be displayed in a statement
            descriptor.
          example: London
          nullable: true
        country:
          description: >
            The 2-letter ISO country code of the merchant to be displayed in a
            statement

            descriptor.
          example: US
          nullable: true
          type: string
        phone_number:
          type: string
          pattern: ^\+[1-9]\d{1,14}$
          minLength: 5
          maxLength: 20
          description: >-
            The value in the phone number field of a customer's statement which

            should be formatted according to the

            [E164 number
            standard](https://www.twilio.com/docs/glossary/what-e164).
          example: '+1234567890'
          nullable: true
        url:
          type: string
          minLength: 1
          maxLength: 50
          description: |-
            The merchant's URL to be displayed in a statement
            descriptor.
          example: www.gr4vy.com
          nullable: true
    CartItem:
      title: Cart Item
      type: object
      description: >-
        A cart item that represents a single cart line item for a transaction.

        Note that some optional properties are required for certain payment

        service providers. If no value is set for these properties, we will use

        their default value.


        If the total due to be paid for the item is required by the payment
        service

        provider, generally referred to as the "total amount", the formula below

        will usually be used to calculate this amount:


        `(unit_amount * quantity) - discount_amount + tax_amount`


        It's highly recommended that the total amount to pay for all items

        should match the transaction's amount to reduce the risk of the

        transaction being declined by the payment service provider.
      required:
        - name
        - quantity
        - unit_amount
      properties:
        name:
          type: string
          description: |-
            The name of the cart item. The value you set for this property may
            be truncated if the maximum length accepted by a payment service
            provider is less than 255 characters.
          example: GoPro HERO9 Camcorder
          maxLength: 255
        quantity:
          type: integer
          description: |-
            The quantity of this item in the cart. This value cannot be negative
            or zero.
          example: 1
          minimum: 1
          maximum: 99999999
        unit_amount:
          type: integer
          description: |-
            The amount for an individual item represented as a monetary amount
            in the smallest currency unit for the given currency, for example
            `1299` USD cents represents `$12.99`.
            The amount sent through to the payment processor as unitary amount
            will be calculated to include the discount and tax values sent
            as part of this cart item.
          example: 37999
          minimum: 0
          maximum: 99999999
        discount_amount:
          type: integer
          description: >-
            The amount discounted for this item represented as a monetary amount

            in the smallest currency unit for the given currency, for example
            `1299`

            USD cents represents `$12.99`.


            Please note that this amount is for the total of the cart item and
            not

            for an individual item. For example, if the quantity is 5, this
            value

            should be the total discount amount for 5 of the cart item.


            You might see unexpected failed transactions if the
            `discount_amount` can

            not be equally divided by the `quantity` value. This is due to the
            fact

            that some payment services require this amount to be specified per
            unit.


            In this situation we recommend splitting this item into separate
            items,

            each with their own specific discount.
          example: 0
          minimum: 0
          maximum: 99999999
          nullable: true
          default: 0
        tax_amount:
          type: integer
          description: >-
            The tax amount for this item represented as a monetary amount

            in the smallest currency unit for the given currency, for example
            `1299`

            USD cents represents `$12.99`.


            Please not that this amount is for the total of the cart item and
            not

            for an individual item. For example, if the quantity is 5, this
            value

            should be the total tax amount for 5 of the cart item.


            You might see unexpected failed transactions if the `tax_amount` can

            not be equally divided by the `quantity` value. This is due to the
            fact

            that some payment services require this amount to be specified per
            unit.


            In this situation we recommend splitting this item into separate
            items,

            each with their own specific tax amount.
          example: 0
          minimum: 0
          maximum: 99999999
          nullable: true
          default: 0
        external_identifier:
          type: string
          example: item-789123
          description: >-
            An external identifier for the cart item. This can be set to any
            value and is not sent to the payment service.
          nullable: true
          maxLength: 200
        sku:
          type: string
          example: sku-789123
          description: The SKU for the item.
          nullable: true
          maxLength: 200
        product_url:
          type: string
          format: url
          example: https://example.com/items/gopro
          description: The product URL for the item.
          nullable: true
          maxLength: 2083
        image_url:
          type: string
          format: url
          example: https://example.com/images/items/gopro.png
          description: The URL for the image of the item.
          nullable: true
          maxLength: 2083
        categories:
          type: array
          description: |-
            A list of strings containing product categories for the item.
            Max length per item: 50.
          items:
            type: string
            maxLength: 50
          nullable: true
          maxItems: 100
        product_type:
          type: string
          description: The product type of the cart item.
          nullable: true
          example: physical
          enum:
            - physical
            - discount
            - shipping_fee
            - sales_tax
            - digital
            - gift_card
            - store_credit
            - surcharge
            - null
        seller_country:
          type: string
          description: >-
            The country code of the seller of the item. For some connectors, if
            this country code

            does not match the `country` then the transaction will be marked to
            Visa as a foreign

            seller transaction to meet Marketplace reporting requirements.
          example: US
          pattern: ^[A-Z]{2}$
          nullable: true
    Buyer--Snapshot:
      title: Buyer (Snapshot)
      type: object
      description: |-
        Snapshot of a buyer, as used when embedded inside other
        resources.
      x-tags:
        - Buyers
      properties:
        type:
          type: string
          description: The type of this resource. Is always `buyer`.
          example: buyer
          enum:
            - buyer
        id:
          type: string
          example: fe26475d-ec3e-4884-9553-f7356683f7f9
          description: The unique Gr4vy ID for this buyer.
          format: uuid
          nullable: true
        billing_details:
          allOf:
            - $ref: '#/components/schemas/BillingDetails'
          description: |-
            The billing details associated with the buyer, which include the
            address and tax ID.
          nullable: true
        display_name:
          description: >-
            A unique name for this buyer which is used in the Gr4vy admin panel
            to give a buyer a human readable name.
          example: John L.
          maxLength: 200
          minLength: 1
          nullable: true
          type: string
        external_identifier:
          description: >-
            An external identifier that can be used to match the buyer against
            your own records.
          example: user-789123
          maxLength: 200
          minLength: 1
          nullable: true
          type: string
        account_number:
          type: string
          minLength: 1
          maxLength: 255
          example: '1234567'
          description: The source account number to perform an account funding transaction.
          nullable: true
    ShippingDetail:
      title: Shipping detail
      type: object
      description: Shipping detail for a buyer.
      x-tags:
        - Buyers
      properties:
        type:
          type: string
          description: The type of this resource. Is always `shipping-details`.
          example: shipping-details
          enum:
            - shipping-details
        id:
          type: string
          format: uuid
          description: The unique ID for a buyer's shipping detail.
          example: 8724fd24-5489-4a5d-90fd-0604df7d3b83
        buyer_id:
          type: string
          format: uuid
          description: The unique ID for a buyer.
          example: 8724fd24-5489-4a5d-90fd-0604df7d3b83
        first_name:
          type: string
          minLength: 1
          maxLength: 255
          description: The first name(s) or given name of the buyer.
          example: John
          nullable: true
        last_name:
          type: string
          minLength: 1
          maxLength: 255
          example: Lunn
          description: The last name, or family name, of the buyer.
          nullable: true
        email_address:
          type: string
          minLength: 1
          maxLength: 320
          description: The email address of the buyer.
          example: john@example.com
          nullable: true
        phone_number:
          type: string
          pattern: ^\+[1-9]\d{1,14}$
          minLength: 1
          maxLength: 50
          description: >-
            The phone number of the buyer. This number is formatted according to
            the

            [E164 number
            standard](https://www.twilio.com/docs/glossary/what-e164).
          example: '+1234567890'
          nullable: true
        address:
          type: object
          description: The physical shipping address associated to this buyer.
          nullable: true
          allOf:
            - $ref: '#/components/schemas/Address'
    BillingDetails:
      title: Billing details
      type: object
      description: Billing details associated to a buyer.
      x-tags:
        - Buyers
      properties:
        type:
          type: string
          description: The type of this resource. Is always `billing-details`.
          example: billing-details
          enum:
            - billing-details
        first_name:
          type: string
          minLength: 1
          maxLength: 255
          description: The first name(s) or given name of the buyer.
          example: John
          nullable: true
        last_name:
          type: string
          minLength: 1
          maxLength: 255
          example: Lunn
          description: The last name, or family name, of the buyer.
          nullable: true
        email_address:
          type: string
          minLength: 1
          maxLength: 320
          description: The email address of the buyer.
          example: john@example.com
          nullable: true
        phone_number:
          type: string
          pattern: ^\+[1-9]\d{1,14}$
          minLength: 1
          maxLength: 50
          description: >-
            The phone number of the buyer. This number is formatted according to
            the

            [E164 number
            standard](https://www.twilio.com/docs/glossary/what-e164).
          example: '+1234567890'
          nullable: true
        address:
          description: The billing address of the buyer.
          nullable: true
          allOf:
            - $ref: '#/components/schemas/Address'
        tax_id:
          description: The tax information associated with the billing details.
          nullable: true
          allOf:
            - $ref: '#/components/schemas/TaxId'
    Address:
      title: Address
      type: object
      description: An address for the buyer.
      x-tags:
        - Buyers
      properties:
        city:
          type: string
          minLength: 1
          maxLength: 100
          description: The city for the address.
          example: London
          nullable: true
        country:
          type: string
          minLength: 2
          maxLength: 2
          description: The country for the address in ISO 3166 format.
          example: GB
          nullable: true
        postal_code:
          type: string
          minLength: 1
          maxLength: 50
          description: The postal code or zip code for the address.
          example: '789123'
          nullable: true
        state:
          type: string
          minLength: 1
          maxLength: 255
          description: The state, county, or province for the address.
          example: Greater London
          nullable: true
        state_code:
          type: string
          minLength: 4
          maxLength: 6
          description: |-
            The code of state, county, or province for the address in
            ISO 3166-2 format.
          example: GB-LND
          nullable: true
        house_number_or_name:
          type: string
          minLength: 1
          maxLength: 255
          description: |-
            The house number or name for the address. Not all payment
            services use this field but some do.
          example: '10'
          nullable: true
        line1:
          type: string
          minLength: 1
          maxLength: 255
          description: The first line of the address.
          example: 10 Oxford Street
          nullable: true
        line2:
          type: string
          minLength: 1
          maxLength: 255
          description: The second line of the address.
          example: New Oxford Court
          nullable: true
        organization:
          type: string
          minLength: 1
          maxLength: 255
          description: |-
            The optional name of the company or organisation to add
            to the address.
          example: Gr4vy
          nullable: true
    TaxId:
      title: Tax ID
      type: object
      description: The tax ID information associated to a buyer.
      x-tags:
        - Buyers
      required:
        - kind
        - value
      properties:
        value:
          type: string
          minLength: 1
          maxLength: 50
          description: The tax ID for the buyer.
          example: '12345678931'
        kind:
          type: string
          description: The kind of tax ID.
          example: gb.vat
          enum:
            - ae.trn
            - au.abn
            - ar.dni
            - ar.cuil
            - ar.cuit
            - br.cnpj
            - br.cpf
            - ca.bn
            - ca.gst_hst
            - ca.pst_bc
            - ca.pst_mb
            - ca.pst_sk
            - ca.qst
            - ch.vat
            - cl.tin
            - es.cif
            - eu.vat
            - gb.vat
            - hk.br
            - id.nik
            - id.npwp
            - in.gst
            - jp.cn
            - jp.rn
            - kr.brn
            - li.uid
            - mx.curp
            - my.frp
            - my.itn
            - my.nric
            - my.sst
            - no.vat
            - nz.gst
            - ph.tin
            - ru.inn
            - ru.kpp
            - sa.vat
            - sg.gst
            - sg.uen
            - th.id
            - th.vat
            - tw.vat
            - us.ein
            - za.vat
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````