API docs by Redocly

Logeecom - Airwallex Integration Middleware API (1.1.0)

Download OpenAPI specification:Download

API for managing the connection and transaction synchronization between Airwallex and ERP systems.

Connect to Logeecom Middleware

A user is redirected to this endpoint, upon clicking the connect button in the Airwallex app.

This endpoint accepts a base62-encoded connectParams payload passed as a query parameter as well as an HMAC-generated signature that verifies the authenticity and integrity of the request. The signature is calculated using the HMAC algorithm with a shared secret key and the connectParams. Signature is base62 encoded.

The connectParams object that should be encrypted has the following structure:

  • wallets: List of wallet objects (array).
  • connectionId: UUID (string) - The unique ID of the client. This is used to track the client and ensure it is not duplicated. Unique for reach request.
  • timestamp: Epoch time (number) - The timestamp of the request.

The connectParams JSON should be base62 encoded before sending.

Upon successful connection, the client will be redirected: https://airwallex_base_url/app/integrations/home/logeecom/connect?connectResult={connectResult}&signature={signature}

path Parameters
platform
required
string (accountingPlatform)
Enum: "EXACT_ONLINE" "PRIORITY" "MYOB" "SAP_B1"

The platform to which the user will integrate

query Parameters
signature
required
string

The signature used to validate the request

required
object (connectParams)

The Base62 encoded connect parameters (e.g., wallets, requestId, etc.).

Responses

Retrieve connection information (tokens)

Authentication is done using the signature in the X-AWX-Signature header. Signature is calculated using the HMAC algorithm based on the string {platform}:{id}:{timestamp}. Signature is base62 encoded.

path Parameters
platform
required
string (accountingPlatform)
Enum: "EXACT_ONLINE" "PRIORITY" "MYOB" "SAP_B1"

The platform to retrieve the connection information for.

id
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

Connection ID

query Parameters
timestamp
required
string <unix-time>
header Parameters
X-AWX-Signature
required
string

Responses

Response samples

Content type
application/json
{
  • "authType": "OAuth2",
  • "oauth2Credentials": {
    },
  • "basicAuthCredentials": {
    }
}

Disconnect from Logeecom Middleware

Authentication is done using the signature in the X-AWX-Signature header. Signature is calculated using the HMAC algorithm based on the string {platform}:{id}:{timestamp}. Signature is base62 encoded.

path Parameters
platform
required
string (accountingPlatform)
Enum: "EXACT_ONLINE" "PRIORITY" "MYOB" "SAP_B1"

The platform to disconnect from.

id
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

Connection ID

query Parameters
timestamp
required
string <unix-time>
header Parameters
X-AWX-Signature
required
string

Responses

Push transactions for the connected currencies and wallets to a specific platform.

This endpoint is used to push transactions for the connected currencies and wallets to a specific platform. Platform is one of the values from the AccountingPlatform schema.

Authentication is done using the signature in the X-AWX-Signature header. Signature is calculated using the HMAC algorithm based on the string {platform}:{id}:{walletId}:{currency}:{timestamp}. Signature is base62 encoded.

path Parameters
platform
required
string (accountingPlatform)
Enum: "EXACT_ONLINE" "PRIORITY" "MYOB" "SAP_B1"

The platform to push the transactions to.

id
required
string <uuid>

The connection ID.

query Parameters
timestamp
required
string <unix-time>
header Parameters
X-AWX-Signature
required
string
Request Body schema: application/json
required
walletId
string <uuid>
currency
string
Array of objects (transactionDto)

The transactions to create. MAX 10 transactions per request.

Responses

Request samples

Content type
application/json
{
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "currency": "string",
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "result": [
    ]
}