Factor Managed Accounts

A factor is a third-party partner who purchases Airwallex user’s accounts receivable (invoices) at a discount. The factor provides immediate cash to the Airwallex user’s business, then collects payment on the invoices directly from the customers.

A factor managed account, owned by the factor, refers to the legally binding agreement between the Airwallex user and the factor that outlines the terms and conditions under which the Airwallex user sells accounts receivable to the factor and the factor collects payments. For more information, see [Invoice Factoring].

Endpoints

POST /partner-api/v1/factoring/factor_managed_accounts/create
POST /partner-api/v1/factoring/factor_managed_accounts/{factorManagedAccountId}/activate
POST /partner-api/v1/factoring/factor_managed_accounts/{factorManagedAccountId}/close
GET /partner-api/v1/factoring/factor_managed_accounts/{factorManagedAccountId}

Create a factor managed account

POST /partner-api/v1/factoring/factor_managed_accounts/create

Copy for LLMView as Markdown

Create a factor managed account object to connect the factor and the user.

Request body

account_idrequiredstring

The account id of the user.

metadatarequiredobject

The metadata of the factor managed account in factor service.

request_idrequiredstring

A unique request identifier specified by you for idempotency. Up to 50 characters.

Response body - 200 OK

account_idstring

The Airwallex account unique identifier of the user.

consent_urlstring

The URL of the Airwallex web page where the customer consent is collected.

created_atstring

The time when this factor managed account was created.

idstring

The unique identifier of the factor managed account.

statusstring

The status of the factor managed account. One of the following:

INACTIVE: The factor managed account is initialized and requires the user to accept the factor managed account.
ACCEPTED: The factor managed account is accepted and requires the factor to activate the factor managed account.
ACTIVE: The factor managed account is activated and the factor can create payment on the factor managed account.
CLOSED: The factor managed account is closed. No further payment could be made on this factor managed account.

updated_atstring

The time when this factor managed account was last updated.

POST /partner-api/v1/factoring/factor_managed_accounts/create

$curl --request POST \
>  --url 'https://api-demo.airwallex.com/partner-api/v1/factoring/factor_managed_accounts/create' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json' \
>  --data '{
>  "account_id": "acct_ca6530db68a9",
>  "metadata": {
>    "reference_number": "1129289"
>  },
>  "request_id": "e26fe780-ac29-4130-b650-edb1cc1bd4a4"
>}'

Response (200 OK)

1{
2  "account_id": "acct_246530db2424",
3  "consent_url": "https://www.airwallex.com/app/login-auth?application=oauth-factoring&client_id=appid_CGvntybHx8RyNSE7vf2h&factoring_id=e1f3c6e3-ba66-4400-83ec-e81553647806&redirect_uri=",
4  "created_at": "<date-time>",
5  "id": "3290f2ef-6c55-4bed-90a6-2161748f0335",
6  "status": "ACTIVE",
7  "updated_at": "<date-time>"
8}

Was this section helpful?

Activate a factor managed account

POST /partner-api/v1/factoring/factor_managed_accounts/{factorManagedAccountId}/activate

Copy for LLMView as Markdown

Activates a factor-managed account. On success, the account’s status will be returned as ACTIVE.

Parameters

factorManagedAccountIdrequiredstring

The unique identifier of the factor managed account object.

Response body - 200 OK

account_idstring

The Airwallex account unique identifier of the user.

consent_urlstring

The URL of the Airwallex web page where the customer consent is collected.

created_atstring

The time when this factor managed account was created.

idstring

The unique identifier of the factor managed account.

statusstring

The status of the factor managed account. One of the following:

INACTIVE: The factor managed account is initialized and requires the user to accept the factor managed account.
ACCEPTED: The factor managed account is accepted and requires the factor to activate the factor managed account.
ACTIVE: The factor managed account is activated and the factor can create payment on the factor managed account.
CLOSED: The factor managed account is closed. No further payment could be made on this factor managed account.

updated_atstring

The time when this factor managed account was last updated.

POST /partner-api/v1/factoring/factor_managed_accounts/{factorManagedAccountId}/activate

$curl --request POST \
>  --url 'https://api-demo.airwallex.com/partner-api/v1/factoring/factor_managed_accounts/factorManagedAccountId/activate' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json'

Response (200 OK)

1{
2  "account_id": "acct_246530db2424",
3  "consent_url": "https://www.airwallex.com/app/login-auth?application=oauth-factoring&client_id=appid_CGvntybHx8RyNSE7vf2h&factoring_id=e1f3c6e3-ba66-4400-83ec-e81553647806&redirect_uri=",
4  "created_at": "<date-time>",
5  "id": "3290f2ef-6c55-4bed-90a6-2161748f0335",
6  "status": "ACTIVE",
7  "updated_at": "<date-time>"
8}

Was this section helpful?

Close a factor managed account

POST /partner-api/v1/factoring/factor_managed_accounts/{factorManagedAccountId}/close

Copy for LLMView as Markdown

Closes a factor-managed account. On success, the account’s status will be returned as CLOSED.

Parameters

factorManagedAccountIdrequiredstring

The unique identifier of the factor managed account object.

Response body - 200 OK

account_idstring

The Airwallex account unique identifier of the user.

consent_urlstring

The URL of the Airwallex web page where the customer consent is collected.

created_atstring

The time when this factor managed account was created.

idstring

The unique identifier of the factor managed account.

statusstring

The status of the factor managed account. One of the following:

INACTIVE: The factor managed account is initialized and requires the user to accept the factor managed account.
ACCEPTED: The factor managed account is accepted and requires the factor to activate the factor managed account.
ACTIVE: The factor managed account is activated and the factor can create payment on the factor managed account.
CLOSED: The factor managed account is closed. No further payment could be made on this factor managed account.

updated_atstring

The time when this factor managed account was last updated.

POST /partner-api/v1/factoring/factor_managed_accounts/{factorManagedAccountId}/close

$curl --request POST \
>  --url 'https://api-demo.airwallex.com/partner-api/v1/factoring/factor_managed_accounts/factorManagedAccountId/close' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json'

Response (200 OK)

1{
2  "account_id": "acct_246530db2424",
3  "consent_url": "https://www.airwallex.com/app/login-auth?application=oauth-factoring&client_id=appid_CGvntybHx8RyNSE7vf2h&factoring_id=e1f3c6e3-ba66-4400-83ec-e81553647806&redirect_uri=",
4  "created_at": "<date-time>",
5  "id": "3290f2ef-6c55-4bed-90a6-2161748f0335",
6  "status": "ACTIVE",
7  "updated_at": "<date-time>"
8}

Was this section helpful?

Get factor managed account by ID

GET /partner-api/v1/factoring/factor_managed_accounts/{factorManagedAccountId}

Copy for LLMView as Markdown

Retrieve details of a factor managed account using its unique identifier.

Parameters

factorManagedAccountIdrequiredstring

The factor managed account unique identifier.

Response body - 200 OK

account_idstring

The Airwallex account unique identifier of the user.

consent_urlstring

The URL of the Airwallex web page where the customer consent is collected.

created_atstring

The time when this factor managed account was created.

idstring

The unique identifier of the factor managed account.

statusstring

The status of the factor managed account. One of the following:

INACTIVE: The factor managed account is initialized and requires the user to accept the factor managed account.
ACCEPTED: The factor managed account is accepted and requires the factor to activate the factor managed account.
ACTIVE: The factor managed account is activated and the factor can create payment on the factor managed account.
CLOSED: The factor managed account is closed. No further payment could be made on this factor managed account.

updated_atstring

The time when this factor managed account was last updated.

GET /partner-api/v1/factoring/factor_managed_accounts/{factorManagedAccountId}

$curl --request GET \
>  --url 'https://api-demo.airwallex.com/partner-api/v1/factoring/factor_managed_accounts/factorManagedAccountId' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json'

Response (200 OK)

1{
2  "account_id": "acct_246530db2424",
3  "consent_url": "https://www.airwallex.com/app/login-auth?application=oauth-factoring&client_id=appid_CGvntybHx8RyNSE7vf2h&factoring_id=e1f3c6e3-ba66-4400-83ec-e81553647806&redirect_uri=",
4  "created_at": "<date-time>",
5  "id": "3290f2ef-6c55-4bed-90a6-2161748f0335",
6  "status": "ACTIVE",
7  "updated_at": "<date-time>"
8}

Was this section helpful?