Airwallex setup guide

Agents read payments, invoices and accounts. Anything that moves money is tier 4: a person always approves it.

Ways to connect

Company admins connect apps, on the Integrations page in Everdeck: open Airwallex, choose one of the ways below, follow its steps and fill in its fields. Everdeck checks what you enter before it saves anything, and asks you to confirm it’s you (your second factor) before you type any secret. How connecting works.

Scoped API key (client ID and API key)

API key.

1. Sign in to the Airwallex web app as an Owner, Admin or Developer and open Settings > Developer > API keys.
2. Click New scoped API key and name it Everdeck. Under Account-level permissions pick the account it may use and give it: Read on Balances, Financial Transactions, Beneficiaries and Conversion (this covers FX rates); Write on Transfers (payouts), Payment Acceptance (payment intents and refunds) and Payment Links. Leave everything else off.
3. Copy the Client ID and the API key into the form. Airwallex shows the key only once.
4. If the key covers more than one account, enter the account id the agents should use.
5. You don't need to add a webhook: live updates from Airwallex (starting work when a payout is paid or fails, a deposit settles or a payment succeeds) aren't available yet, so leave the webhook secret empty.

Field	What to enter
Airwallex environment	Choice: Production, Sandbox.
Client ID	Text. Where to find it.
API key	A secret: Everdeck saves it encrypted and never shows it again.
Account ID (only if the key covers several accounts) (optional)	Text. For example acct_....
Webhook secret (optional, not used yet)	A secret: Everdeck saves it encrypted and never shows it again. Live updates from Airwallex aren't available yet; leave this empty.

Disconnecting deletes the credentials Everdeck saved, but Everdeck can't revoke them: the key, token or password itself keeps working at Airwallex until you delete or rotate it there.

What agents can do

An agent uses an action only when its charter grants it, on the agent’s Tools tab, where you choose whether each one runs by itself (Auto), asks first or never runs. Each action has a risk tier: tier 3 actions, which customers or the public see, ask first unless you choose otherwise, and tier 4 actions (money, deleting things, access) always need a person. How tools and tiers work.

Actions marked Reads outside content return things people outside your company may have written. Agents treat what they read as information, never as instructions, and their riskier actions later in the same session need approval.

• Get balancesTier 0 · ReadReads outside contentairwallex_get_balances

  Get available, pending, reserved and total balances in every currency the account holds.

• List account transactionsTier 0 · ReadReads outside contentairwallex_list_financial_transactions

  List the transactions that changed the balance (deposits, payouts, conversions, card payments, fees, refunds) with amount, fee, net, type, source id and status (PENDING or SETTLED). Pages start at 0.

• Get an FX rateTier 0 · ReadReads outside contentairwallex_get_fx_rate

  Get the current indicative rate to sell one currency and buy another for an amount (give buy_amount or sell_amount, not both). Useful before a payout in another currency.

• List beneficiariesTier 0 · ReadReads outside contentairwallex_list_beneficiaries

  List saved payees (beneficiaries) with name, entity type, bank country and currency and the transfer methods they accept. Payouts go to a beneficiary_id from here.

• List payoutsTier 0 · ReadReads outside contentairwallex_list_transfers

  List payouts (transfers) with status, amounts, fees, beneficiary and dates. Filter by status, currency, beneficiary or creation time (from and to at most 30 days apart; without dates only the last 30 days are listed). Page with page = page_after from the previous result.

• Check a payout before sendingTier 0 · ReadReads outside contentairwallex_validate_transfer

  Check a payout request without creating it. Returns OK, or the fields that are missing or invalid for this beneficiary, currency and route (Airwallex's required fields vary by route).

• Send a payoutTier 4 · Money or irreversibleReads outside contentairwallex_create_transfer

  Pay a saved beneficiary from the account balance, converting from source_currency when it differs. Money leaves the account (or the payout enters Airwallex's own approval flow if the account requires approvals). Run validate_transfer first.

• List card paymentsTier 0 · ReadReads outside contentairwallex_list_payment_intents

  List online payments (payment intents) with amount, currency, status (SUCCEEDED, REQUIRES_PAYMENT_METHOD, CANCELLED and so on), your order id and creation time. Pages start at 0.

• Refund a card paymentTier 4 · Money or irreversibleReads outside contentairwallex_create_refund

  Refund all or part of a captured payment intent (amount in major units, for example 25.50; omit for the rest of what was captured). The shopper gets the money back on their card or method.

• Create a payment linkTier 3 · ExternalReads outside contentairwallex_create_payment_link

  Create a hosted checkout link for a fixed amount (single use unless reusable). The returned url can be shared with a customer; nothing is sent until send_payment_link or your own email.

• Email a payment linkTier 4 · Money or irreversibleReads outside contentairwallex_send_payment_link

  Email a payment link to a shopper from Airwallex, asking them to pay.

Testing, problems and disconnecting

Everdeck checks the connection when you save it. On the connection’s page in Integrations, Test checks it again at any time.

If Airwallex later refuses the connection, for example because a key was deleted or a sign-in expired, the connection shows Needs attention on the Integrations page and the people who manage connections are told. Agents can’t use it until a company admin fixes it with Edit.

To stop agents using Airwallex, open the connection and select Disconnect. Agents stop using it at once and its saved credentials are deleted. What else happens depends on how it was connected: each way above says.