Airwallex Developer

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Unique identifier for the card to activate

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the draft Invoice to add line items to

Line items to add. Each needs either price_id (existing Price, pri_*) or inline price (product_id prd_* plus pricing_model and unit_amount/flat_amount). Use inline price when the user specifies a product and ad-hoc amount; do not put product IDs in price_id. Optional quantity, discounts, metadata.

Unique request ID specified by the merchant

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Transfer methods, e.g. ['SWIFT'], ['LOCAL'], or ['SWIFT', 'LOCAL']. Must be specified to ensure accurate banking details are captured and validated.

Additional beneficiary information for compliance

Beneficiary address

Bank account details. Use get_beneficiary_schema for required fields per country/currency/method.

Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds

Company name of the beneficiary (required when entity_type is COMPANY)

Beneficiary date of birth

Digital wallet details (required when beneficiary_type is DIGITAL_WALLET)

When true, validates the payload without creating the beneficiary. Returns validation errors if invalid, or OK if it passes.

Entity type of the beneficiary

First name of the beneficiary (required when entity_type is PERSONAL)

Last name of the beneficiary (required when entity_type is PERSONAL)

Internal nickname for this beneficiary

The payer entity type for transfers to this beneficiary. Required for compliance. Defaults to COMPANY.

Whether the beneficiary can be exempted from SCA when applicable

Reason for the transfer instruction being made to this beneficiary

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

How to calculate the discount amount when applied. FLAT: fixed amount off. PERCENTAGE: percentage off

Determines how long the coupon's discount remains active. ONCE: applies only to the first charge of a subscription or one-off invoice. CUSTOM: applies for a specified number of billing cycles (set via duration). INDEFINITELY: applies to all future charges until removed

Name of the coupon

Unique request ID specified by the merchant

Fixed amount to deduct when discount_model is FLAT (in major currency units, e.g. 10.00 for ten dollars)

The currency of amount_off when discount_model is FLAT, in 3-letter ISO-4217 format (e.g. USD, EUR, GBP)

Description of the coupon providing business context

Number of billing cycles the discount is applied for. Required when duration_type is CUSTOM

Time after which the coupon can no longer be redeemed, in ISO8601 format

A set of string key-value pairs to attach to this coupon for storing additional information

Percentage between 0 and 100 to deduct when discount_model is PERCENTAGE

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Unique request ID specified by the merchant

Customer address with country_code (required, 2-letter ISO 3166-1 alpha-2), city, state, street, postcode

Type of the billing customer: BUSINESS or INDIVIDUAL.

Default currency for billing this customer in 3-letter ISO-4217 format (e.g. USD, EUR, GBP)

ID of the default legal entity to use when billing this customer

Additional description about the billing customer

Email address of the billing customer. OMIT this field unless explicitly provided by the user. NEVER fabricate or use a placeholder email address.

A set of string key-value pairs to attach to this billing customer for storing additional information

Name of the billing customer

Internal nickname for the billing customer

Phone number of the billing customer. OMIT this field unless explicitly provided by the user. NEVER fabricate or use a placeholder phone number.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the Billing Customer who will be charged

Currency of the invoice in 3-letter ISO-4217 format (e.g. USD, EUR, GBP)

Unique request ID specified by the merchant

How payment is collected. AUTO_CHARGE requires payment_source_id. CHARGE_ON_CHECKOUT uses a hosted payment page. OUT_OF_BAND for external payment

Number of days from invoice finalization until payment is due. Mutually exclusive with due_at

Tax percent between 0 and 100 applied to each line item's price. Tax is exclusive. Defaults to 0

Invoice-level discounts. Currently only one element supported

Due date for this invoice in ISO8601 format. Mutually exclusive with days_until_due

ID of the legal entity to use as billing entity. Required if you have more than 1 entity in your organisation

ID of the linked payment account to collect payment

Custom message to share with the customer, shown as memo or invoice note

A set of string key-value pairs to attach to this invoice for storing additional information

Payment display options including payment_method_types for display order on the digital invoice page

ID of the Payment Source to pay for the invoice. Required if collection_method is AUTO_CHARGE

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Type of aggregation to perform on each event's properties value. SUM: sum event values. MAX: maximum event value. LAST: value of the last event. COUNT: count events. UNIQUE: count unique events

The name of the Usage Event to record for. Corresponds with the event_name field on Usage Events

Meter name

Unique request ID specified by the merchant

The name of the property within the event to aggregate. Events are ignored during aggregation if they are missing this property or if its value is invalid

Meter description, used for internal classification and identification

A set of string key-value pairs to attach to this meter for storing additional information

Brief rationale for why this tool is being called.

Currency of the price in 3-letter ISO-4217 format (e.g. USD, EUR, GBP)

ID of the Product this price is associated with

Unique request ID specified by the merchant

Whether the price is available for new purchases. Defaults to true

When the price should be billed. IN_ADVANCE: at the start of the billing cycle. IN_ARREARS: at the end. Defaults to IN_ADVANCE

Price description, used for internal classification and identification

Fixed amount to be charged. Required when pricing_model is FLAT

A set of string key-value pairs to attach to this price for storing additional information

ID of the Meter object specifying how to calculate usage for this price

true if quantity is dynamically determined during the billing cycle via usage events. false if quantity is set when creating a subscription

How to calculate the total billing amount. PER_UNIT: fixed price per unit. FLAT: fixed price. VOLUME: unit price based on total quantity tier. GRADUATED: unit price changes as quantity increases. Defaults to PER_UNIT

Recurring billing configuration with period and period_unit (DAY/WEEK/MONTH/YEAR). Omit for one-off prices

Quantity-based pricing tiers. Required when pricing_model is VOLUME or GRADUATED. Last tier must have no upper_bound

Amount charged per product unit. Required when pricing_model is PER_UNIT

Brief rationale for why this tool is being called.

Product name

Unique request ID specified by the merchant

Whether the product is available for new purchases. Defaults to true

Product description, used for internal classification and identification

A set of string key-value pairs to attach to this product for storing additional information

Product unit (e.g. 'license', 'seat', 'gb')

Brief rationale for why this tool is being called.

ID of the Billing Customer who subscribes to this subscription

How payment is collected. AUTO_CHARGE: charge a saved Payment Source. CHARGE_ON_CHECKOUT: invoice for manual payment. OUT_OF_BAND: payments handled externally

List of subscription items with price_id (required), quantity, discounts, metadata

Unique request ID specified by the merchant

A future timestamp in the first billing cycle as the reference point to align future billing dates

Currency of the subscription in 3-letter ISO-4217 format

Number of days from invoice finalization until payment is due. Defaults to 0

Invoice template settings for generated invoices

Tax percent between 0 and 100 applied to generated invoices. Tax is exclusive. Defaults to 0

Subscription-level discounts. Currently only one element supported

Subscription duration with period and period_unit (DAY/WEEK/MONTH/YEAR)

Time when the subscription is scheduled to end in ISO8601 format. Only applicable when duration is empty

ID of the legal entity to use as billing entity. Required if you have more than 1 entity

ID of the linked payment account to collect payment. Required if collection_method is CHARGE_ON_CHECKOUT and you have more than 1 payment account

A set of string key-value pairs to attach to this subscription for storing additional information

Payment display options including payment_method_types

ID of the Payment Source to charge each billing period. Required if collection_method is AUTO_CHARGE

Time when the subscription starts or is scheduled to start. Defaults to start immediately

End time of the trial period in ISO8601 format

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Authorization controls including transaction limits, allowed currencies, merchant categories, and transaction count.

The ID of the cardholder to associate this card with.

Full legal name of user requesting the new card.

Form of the card: PHYSICAL or VIRTUAL.

Determines whether the card is assigned to a singular individual or to the business with multiple authorized cardholders. Only personalized cards can be created as physical and added to digital wallet providers.

Card program details including purpose, type, and sub-type.

A unique request ID specified by the client. Requests with the same request_id will be ignored, allowing safe retries.

Set to true to activate a physical card on creation, enabling use while being delivered. Virtual cards are always activated upon creation.

The IDs of additional cardholders to associate this card with.

Alert settings for the card (e.g. low remaining transaction limit).

Scheme for issuance. Default VISA.

Client data stored against the card record in Airwallex.

Delivery preferences for physical cards. Use to request EXPRESS delivery or override the destination mobile number.

Unique identifier linking a card to its designated funding source. If not provided, the default funding source is the account's wallet.

Key-value pairs attached to the Card. Up to 20 keys, key names up to 20 chars, values up to 150 chars.

A nickname for the card.

Notes stored against the card request for client reference.

Postal address for physical card delivery. If omitted, the cardholder's registered address is used.

Purpose for card's usage when card issueTo is ORGANISATION. Default value is BUSINESS_EXPENSES.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Email address of the cardholder. OMIT this field unless explicitly provided by the user. NEVER fabricate or use a placeholder email address.

Type of cardholder: INDIVIDUAL or DELEGATE

Required for INDIVIDUAL type. Contains name, date_of_birth, address, and express_consent_obtained (set to 'yes'). Use only values explicitly provided by the user. NEVER fabricate or use placeholder name, date of birth, or address data.

Mobile number of the cardholder. OMIT unless explicitly provided by the user. NEVER fabricate or use a placeholder phone number.

Postal address for physical card delivery. Use only values explicitly provided by the user. NEVER fabricate or use a placeholder address.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

The title of the payment link that is displayed in the payment checkout page.

The payment amount. Required for Fixed pricing only.

Optional fields to collect from the shopper at checkout (billing/shipping address, phone, reference, message).

The payment currency in 3-letter ISO-4217 format (e.g. USD). Required for Fixed pricing only.

Customer who is paying for this PaymentLink. Only applicable when `reusable=false`. Required if you want the payer to see payment methods saved in previous checkouts.

The default currency from `supported_currencies`. The shopper can change it during checkout. For Flexible pricing only.

Additional description text that appears under the title in the payment checkout page.

Payment link expiry timestamp in ISO 8601 format.

A set of key-value pairs to attach to the PaymentLink for storing additional information.

A reference only visible to the merchant.

Whether the payment link can be used multiple times.

Email address to send the created payment link to. Triggers a separate /notify_shopper API call after the link is created. Since this parameter is optional, OMIT it when it is not explicitly supplied by the user. NEVER mock or use a placeholder email address.

List of currencies (3-letter ISO-4217) the shopper may choose from. For Flexible pricing only.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the draft Invoice whose line items are being deleted

IDs of the Invoice Line Items to delete

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the draft Invoice to finalize

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Type of account to query. Supported values: cash, yield, credit. Returns all account types if not specified.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

3-letter ISO-4217 currency code of the beneficiary's account

2-letter ISO 3166-2 country code of the beneficiary's bank

Type of the beneficiary: BANK_ACCOUNT or DIGITAL_WALLET

Entity type of the beneficiary. Some countries require different fields for companies vs individuals.

Local clearing system for local transfers. Available for US USD, AU AUD, HK HKD/USD/CNY, SG SGD. If not specified, a default will be selected.

Service provider of the beneficiary's digital wallet (required when type is DIGITAL_WALLET)

Transfer method: LOCAL or SWIFT

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

The currency to buy (3-letter ISO code)

The currency to sell (3-letter ISO code)

Amount to buy. Cannot be set together with sell_amount

Amount to sell. Cannot be set together with buy_amount

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Type of account to query. Supported values: cash, yield, credit

Transaction currency in 3-letter ISO-4217 format

Start date (inclusive) of the balance activity range in ISO8601 format. Defaults to 7 days before to_post_at. Max range: to_post_at - from_post_at <= 7 days

Pagination cursor bookmark. Pass page_after for the next page or page_before for the previous page. Pass page=0 to override the 7-day default for null date ranges and search the full Wallet balance records

Page number to retrieve. Range 0 to 10000

Number of records per page. Between 10 and 2000. Defaults to 100

Client-supplied request_id for the transaction

End date (exclusive) of the balance activity range in ISO8601 format. Defaults to today if neither this field nor from_post_at are specified. Max range: to_post_at - from_post_at <= 7 days (prefer a T00:00:00Z end over T23:59:59Z)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by bank account number of beneficiary

Filter by company name of beneficiary

Filter by entity type

Start of created_at date range in ISO-8601 format (inclusive)

Filter by name of beneficiary

Filter by nickname of beneficiary

Page number, starts from 0

Number of results per page. Defaults to 100. Minimum 10.

Filter by SCA exemptible beneficiaries

End of created_at date range in ISO-8601 format (inclusive)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by active status. true if the coupon is available to be applied, false otherwise

Filter by discount model. FLAT: fixed amount off. PERCENTAGE: percentage off

Filter by duration type. ONCE: first charge only. CUSTOM: specified number of billing cycles. INDEFINITELY: all future charges

Start time of created_at in ISO8601 format (inclusive)

Start time of expires_at in ISO8601 format (inclusive)

Pagination cursor bookmark. Pass the page_after or page_before value from a previous response to retrieve the next or previous page of results

Number of results per page. Defaults to 20

End time of created_at in ISO8601 format (exclusive)

End time of expires_at in ISO8601 format (exclusive)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter billing customers by email address. OMIT this field unless explicitly provided by the user. NEVER fabricate or use a placeholder email address.

Optional start time of created_at in ISO8601 format (inclusive)

Pagination cursor bookmark. Pass the page_after or page_before value from a previous response to retrieve the next or previous page of results

Number of billing customers per page. Defaults to 20

Optional end time of created_at in ISO8601 format (exclusive)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the Invoice object that the Invoice Line Items belong to

Pagination cursor bookmark. Pass the page_after or page_before value from a previous response to retrieve the next or previous page of results

Number of invoice line items per page. Defaults to 20

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by Billing Customer ID

Start time of created_at in ISO8601 format (inclusive)

Pagination cursor bookmark. Pass the page_after or page_before value from a previous response to retrieve the next or previous page of results

Number of invoices per page. Defaults to 20

Filter by payment status of the invoice

Filter by invoice status

Filter by Subscription ID that generated the invoice

End time of created_at in ISO8601 format (exclusive)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by aggregation type. SUM: sum event values. MAX: maximum event value. LAST: value of the last event. COUNT: count events. UNIQUE: count unique events

Filter by the property within the event used for aggregation

Filter by archived status. true if the meter is archived, false otherwise

Filter by the name of the Usage Event the meter records. Corresponds with the event_name field on Usage Events

Start time of created_at in ISO8601 format (inclusive)

Pagination cursor bookmark. Pass the page_after or page_before value from a previous response to retrieve the next or previous page of results

Number of results per page. Defaults to 20

End time of created_at in ISO8601 format (exclusive)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by the ID of the Billing Customer that the Payment Source belongs to

Filter by the corresponding Payment Source ID on the payment provider's side. For Airwallex, this is the Payment Method ID

Start time of created_at in ISO8601 format (inclusive)

Filter by the ID of the linked payment account this Payment Source is created with. Found in the Airwallex web app under Settings > Account details > Account ID

Pagination cursor bookmark. Pass the page_after or page_before value from a previous response to retrieve the next or previous page of results

Number of Payment Sources per page. Defaults to 20

End time of created_at in ISO8601 format (exclusive)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by active status. true if the price is available for new purchases, false otherwise

Filter by currency in 3-letter ISO-4217 format (e.g. USD, EUR, GBP)

Pagination cursor bookmark. Pass the page_after or page_before value from a previous response to retrieve the next or previous page of results

Number of prices per page. Defaults to 20

Filter by Product ID

Filter by the number of period units between subscription billing cycles

Filter by billing frequency

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by active status. true if the product is available for new purchases, false otherwise

Pagination cursor bookmark. Pass the page_after or page_before value from a previous response to retrieve the next or previous page of results

Number of products per page. Defaults to 20

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the Subscription object that the Subscription Items belong to

Pagination cursor bookmark. Pass the page_after or page_before value from a previous response to retrieve the next or previous page of results

Number of subscription items per page. Defaults to 20

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the Invoice this Billing Transaction is associated with

Start date of created_at in ISO8601 format (inclusive)

Pagination cursor bookmark. Pass the page_after or page_before value from a previous response to retrieve the next or previous page

Number of Billing Transactions per page. Defaults to 20

End date of created_at in ISO8601 format (exclusive)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by cardholder status

Filter by cardholder email address

Page number, starts from 0

Number of results per page. Minimum 10 (the API rejects smaller values with BELOW_MIN_PAGE_SIZE).

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by current card status

Filter by cardholder ID

Filter cards created after this date in ISO-8601 format (inclusive)

Filter cards updated after this date in ISO-8601 format (inclusive)

Filter by exact card nickname

Page number, starts from 0

Number of results per page. Minimum 10 (the API rejects smaller values with BELOW_MIN_PAGE_SIZE).

Filter cards created before this date in ISO-8601 format (inclusive)

Filter cards updated before this date in ISO-8601 format (inclusive)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the conversion

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by currency bought (3-letter ISO-4217 code)

Start of created_at date range in ISO-8601 format (inclusive). If not specified with to_created_at, defaults to 31 days ago.

Page number, starts from 0

Number of results per page. Defaults to 100. Minimum 10.

Filter by client-supplied conversion request_id (idempotency key)

Filter by currency sold (3-letter ISO-4217 code)

Filter by conversion status

End of created_at date range in ISO-8601 format (inclusive). If not specified with from_created_at, defaults to 31 days after from_created_at.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the global account

The start date of created_at in ISO8601 format (inclusive). Max range: to_created_at - from_created_at <= 31 days

Page number, starts from 0

Number of results per page. Defaults to 100. Minimum 10.

The end date of created_at in ISO8601 format (inclusive). Max range: to_created_at - from_created_at <= 31 days (a full calendar month can exceed it)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Page number, starts from 0

Number of results per page. Defaults to 100. Minimum 10.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by billing currency (3-letter ISO 4217 code)

Filter by card ID. Only returns card transactions associated with this card.

Filter for items created after this date in ISO8601 format (inclusive)

Filter by lifecycle ID. Only returns card transactions belonging to this lifecycle.

Pagination cursor bookmark. Pass the page_after or page_before value from a previous response to retrieve the next or previous page.

Number of results per page. Maximum is 100.

Filter by card transaction status

Filter for items created before this date in ISO8601 format (inclusive)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by PaymentIntent currency in 3-letter ISO-4217 format (e.g. USD, EUR, GBP)

Start time of created_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. 'Z' or '-04:00').

Filter by merchant order ID (the order ID in the merchant's order system)

Page number starting from 0

Number of PaymentIntents to be listed per page. Defaults to the API default (10) when omitted. Documented maximum is 1000.

Filter by Payment Consent ID

Filter by PaymentIntent status. Common values include REQUIRES_PAYMENT_METHOD, REQUIRES_CUSTOMER_ACTION, REQUIRES_CAPTURE, PENDING_REVIEW, PENDING, SUCCEEDED, CANCELLED. Note: this list is not exhaustive; the API may return additional statuses.

End time of created_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. 'Z' or '-04:00').

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by active status (true or false).

Start time (inclusive) for a range query by created timestamp. Use ISO 8601 with the `Z` UTC suffix, e.g. `2026-01-01T00:00:00Z`. This endpoint rejects the numeric offset form (e.g. `+0000`).

Page number starting from 0.

Number of payment links per page. If omitted, the API uses its default.

Filter by whether the payment link is reusable.

Filter by payment link status.

End time (exclusive) for a range query by created timestamp. Use ISO 8601 with the `Z` UTC suffix, e.g. `2026-12-31T23:59:59Z`. This endpoint rejects the numeric offset form (e.g. `+0000`).

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by refund currency in 3-letter ISO-4217 format (e.g. USD).

Start time of created_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. 'Z' or '-04:00').

Page number starting from 0.

Number of refunds per page. Defaults to the API default (10) when omitted. Documented maximum is 1000.

Filter by the PaymentAttempt ID the refunds were created against.

Filter by the PaymentIntent ID the refunds were created against.

Filter by refund status.

End time of created_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. 'Z' or '-04:00').

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Level of detail. compact replaces line_items with line_items_count; full returns line_items.

Filter by bills created after this timestamp (inclusive) in ISO8601 format. Defaults to last 30 days from to_created_at.

Filter by legal entity ID

Pagination cursor bookmark from a previous response

Number of results per page. 1-100; defaults to 100 when unset. Lower it to bound response size.

Filter by purchase order ID

Filter by bill status

Filter by sync status with external accounting system

Filter by bills created before this timestamp (exclusive) in ISO8601 format. Defaults to now.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Level of detail. compact replaces approvers and line_items with counts; full returns both arrays.

Filter by expenses created after this timestamp (inclusive) in ISO8601 format. Defaults to last 30 days from to_created_at.

Filter by legal entity ID

Pagination cursor bookmark from a previous response

Number of results per page. 1-100; defaults to 100 when unset. Lower it to bound response size.

Filter by expense approval status

Filter by sync status with external accounting system

Filter by expenses created before this timestamp (exclusive) in ISO8601 format. Defaults to now.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by vendor external ID (the vendor's identifier in your system)

Filter by vendors created after this timestamp (inclusive) in ISO8601 format. Defaults to last 30 days from to_created_at.

Filter by legal entity ID

Pagination cursor bookmark from a previous response

Number of results per page. 1-100; defaults to 100 when unset. Lower it to bound response size.

Filter by vendor status

Filter by sync status with external accounting system

Filter by vendors created before this timestamp (exclusive) in ISO8601 format. Defaults to now.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Filter by batch transfer ID

Filter by beneficiary ID

Start of created_at date range in ISO-8601 format (inclusive). Defaults to 30 days before to_created_at. Max range: to_created_at - from_created_at <= 30 days.

Pagination cursor bookmark from a previous response. Pass page=0 on the first call to override the 30-day default.

Number of results per page. Defaults to the API default (2000) when omitted. Documented maximum is 2000.

Filter by transfer request_id

Filter by transfer short_reference_id

Filter by transfer status

End of created_at date range in ISO-8601 format (inclusive). Max range: to_created_at - from_created_at <= 30 days (a full calendar month can exceed it).

Filter by transfer currency (3-letter ISO-4217 code)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the finalized Invoice to mark as paid out-of-band

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

The ID of the billing customer to retrieve

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the Invoice object

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the Billing Transaction object

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Unique identifier for the card

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

The ID of the card to retrieve limits for

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

The ID of the spend bill to retrieve

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

The ID of the spend vendor to retrieve

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

The question to search the documentation with. Must be written in English; translate from the user's language before calling if needed.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

The type of feedback.

Detailed description of the issue or suggestion. Do NOT include any user PII (names, emails, account IDs, etc.).

How impactful is this issue? Defaults to medium if not specified.

Name of the tool this feedback is about, if applicable.

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the Coupon object to update

Whether the coupon is active and can be redeemed. Set to false to deactivate

Fixed amount to deduct when discount_model is FLAT (in major currency units). Cannot be updated once the coupon has been redeemed

The currency of amount_off when discount_model is FLAT, in 3-letter ISO-4217 format. Cannot be updated once the coupon has been redeemed

Description of the coupon providing business context

How to calculate the discount amount. FLAT: fixed amount off. PERCENTAGE: percentage off. Cannot be updated once the coupon has been redeemed

Number of billing cycles the discount is applied for. Used when duration_type is CUSTOM

How long the discount remains active. ONCE: first charge only. CUSTOM: a specified number of billing cycles (set via duration). INDEFINITELY: all future charges until removed. Cannot be updated once the coupon has been redeemed

Time after which the coupon can no longer be redeemed, in ISO8601 format

A set of string key-value pairs to attach to this coupon for storing additional information

Name of the coupon

Percentage between 0 and 100 to deduct when discount_model is PERCENTAGE. Cannot be updated once the coupon has been redeemed

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

The ID of the billing customer to update

Updated customer address with country_code (2-letter ISO 3166-1 alpha-2), city, state, street, postcode

Updated type of the billing customer

Updated default currency in 3-letter ISO-4217 format (e.g. USD, EUR, GBP)

Updated ID of the default legal entity to use when billing this customer

Updated description about the billing customer

Updated email address of the billing customer. OMIT this field unless explicitly provided by the user. NEVER fabricate or use a placeholder email address.

Updated key-value pairs to attach to this billing customer

Updated name of the billing customer

Updated internal nickname for the billing customer

Updated phone number of the billing customer. OMIT this field unless explicitly provided by the user. NEVER fabricate or use a placeholder phone number.

Brief rationale for why this tool is being called.

ID of the draft Invoice to update

ID of the Billing Customer who this invoice is to be issued to

How payment is collected. AUTO_CHARGE requires payment_source_id. CHARGE_ON_CHECKOUT uses a hosted payment page. OUT_OF_BAND for external payment

Currency of the invoice in 3-letter ISO-4217 format (e.g. USD, EUR, GBP)

Number of days from invoice finalization until payment is due. Mutually exclusive with due_at

Tax percent between 0 and 100 applied to each line item's price. Tax is exclusive

Invoice-level discounts. If provided, fully replaces existing discounts. Currently only one element supported

Due date for this invoice in ISO8601 format. Mutually exclusive with days_until_due

ID of the legal entity to use as billing entity

ID of the linked payment account to collect payment. Required if collection_method is CHARGE_ON_CHECKOUT when the invoice is finalized

Custom message to share with the customer, shown as memo or invoice note

A set of string key-value pairs to attach to this invoice for storing additional information

Payment display options including payment_method_types for display order on the digital invoice page

ID of the Payment Source to pay for the invoice. Required when collection_method is AUTO_CHARGE

Brief rationale for why this tool is being called.

ID of the draft Invoice whose line items are being updated

Line items to update. Each entry must include the line-item id and any subset of mutable fields (quantity, metadata, discounts)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the Meter object to update

Meter description, used for internal classification and identification

A set of string key-value pairs to attach to this meter for storing additional information

Meter name

Brief rationale for why this tool is being called.

Unique identifier for the card to update

The IDs of additional cardholders to associate this card with

Alert settings for the card

Authorization controls including transaction limits, allowed currencies, and merchant categories

New card status. Allowed values are INACTIVE, ACTIVE, CLOSED.

The ID of the cardholder to associate this card with

Key-value pairs attached to the Card. Up to 20 keys, key names up to 20 chars, values up to 150 chars

A nickname for the card

Purpose for the card's usage

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Unique identifier for the cardholder to update

Type of cardholder: INDIVIDUAL or DELEGATE

Individual cardholder details. If provided, all required child fields (name, date_of_birth, address, express_consent_obtained) must be valid.

Mobile number of the cardholder

Postal address for physical card delivery

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

Entity type of the beneficiary

Transfer method for the beneficiary

Bank account details to verify. Provide the combination required for the target country and transfer method (account_number + routing for LOCAL; IBAN or swift_code for SWIFT)

Brief, high-level rationale for why this tool is being called. Describe only the general reason for the call — not specific or identifying details such as the names of particular businesses, people, or places, or any personally identifiable information (PII). For example, say "to pay a supplier invoice" rather than "to pay Acme Corp's invoice".

ID of the finalized Invoice to void