Airwallex Integration Guide

Welcome to Payvy's Airwallex Integration Guide! This documentation will help you seamlessly integrate Airwallex's API with Payvy to manage your accounts payable and receivable processes efficiently and securely. Follow the steps below to get started.

Getting Started

To begin using Airwallex with Payvy, follow these simple steps:

1. Log into Your Airwallex Account

   • Navigate to Airwallex's website and log in to your account.
   • If you don't have an account, sign up here.

2. Generate an API Token

   • Go to the Account Settings page in your Airwallex dashboard.
   • Click on API Keys and then Create API Key.
   • Create a name for your API key, such as "Payvy Integration".
   • Choose the appropriate Scopes to limit the API key's permissions based on your integration needs.
   • Click Generate API Key and securely store your API token. Important: You won't be able to view it again after closing the dialog.

3. Set Up the API Key in Payvy

   • In your Payvy application's settings, navigate to the API Integration section.
   • Enter the Airwallex API token you generated.
   • Note: Ensure that your API token is stored securely. Do not expose it in public repositories or client-side code.

Securing Your API Token

After generating your Airwallex API token, it's crucial to secure it to prevent unauthorized access:

• Store Securely: Save your API token in a secure location. Do not expose it in source control or unsecured environments.
• Treat Like a Password: API tokens can access your Airwallex account just like a real user. Handle them with the same level of security as passwords.
• Revoke if Compromised: If you suspect that your token has been leaked or stolen, immediately revoke it from your Airwallex dashboard and generate a new one.

Token Permission Tiers

Airwallex offers different levels of access through API tokens, each with specific permission levels:

1. Read Only

   • Permissions: Can fetch all available data on your Airwallex account.
   • Use Case: Ideal for applications that need to read data without making any changes.

2. Read and Write

   • Permissions: Can initiate transactions and manage recipients.
   • Use Case: Suitable for applications that need to both read and modify data.

3. Custom

   • Permissions: Limited to specific scopes as defined during token creation.
   • Use Case: Best for applications that require granular control over API access.

   Scopes allow you to specify the level of access an API token has. When creating a Custom token, select the fewest scopes needed to perform the required tasks.

   • Note: Scopes cannot be edited after creating a Custom token. If you need different scopes, create a new token with the necessary permissions.

Best Practices

• Use Least Privilege: Assign the minimal required scopes to your Airwallex API tokens to reduce potential security risks.
• Regularly Review Tokens: Periodically audit your Airwallex API tokens and their permissions to ensure they align with your current needs.
• Secure Storage: Store Airwallex API tokens in secure environments and avoid exposing them in client-side code or public repositories.
• Monitor Usage: Keep an eye on your Airwallex token usage and revoke any tokens that are no longer needed or show suspicious activity.

Conclusion

By following this Airwallex Integration Guide, you've successfully integrated Airwallex’s secure and efficient API with Payvy to manage your accounts payable and receivable processes. This setup ensures that your financial operations are streamlined, secure, and optimized for your business needs.

For further assistance or detailed troubleshooting, refer to our comprehensive documentation or contact our support team.

Happy transacting with Payvy!