Account Capability

The Account Capability resource represents capabilities you can enable or query on your Airwallex account like accepting card payments or making fund transfers.

Endpoints

GET /api/v1/account_capabilities/{id}
POST /api/v1/account_capabilities/{id}/enable
GET /api/v1/account_capabilities/funding_limits

Retrieve an Account Capability

GET /api/v1/account_capabilities/{id}

Copy for LLMView as Markdown

Get the status of a capability by providing the capability unique identifier.

Path parameters

idrequiredstring

The unique identifier.

Response body - 200 OK

commentstring

Additional details about the status of this capability.

detailsobject

Details of this capability.

details.reason_codesarray

Specific codes that indicate the reason a capability is disabled. For more information on the codes related to payment method capabilities, refer to this pageDocs.

entity_typestring

The type of entity of your declarant, one of INDIVIDUAL, BUSINESS.

idstring

A unique identifier of the requested capability.

statusstring

The status of this capability, one of ENABLED, DISABLED, PENDING.

updated_atstring

Last time this capability has been updated.

Errors

Error status	Description
400	[`"capability_not_supported"` ]
401	Possible errors: `credentials_invalid`, `credentials_expired`
429	Too many requests
500	Service unavailable

GET /api/v1/account_capabilities/{id}

$curl --request GET \
>  --url 'https://api.sandbox.airwallex.com/api/v1/account_capabilities/account_capability_id' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json'

Response (200 OK)

1{
2  "comment": "<string>",
3  "details": {
4    "reason_codes": []
5  },
6  "entity_type": "INDIVIDUAL",
7  "id": "transfer_cny_local",
8  "status": "ENABLED",
9  "updated_at": "2023-04-01T11:25:39+0000"
10}

Was this section helpful?

Enable an Account Capability

POST /api/v1/account_capabilities/{id}/enable

Copy for LLMView as Markdown

Submit a request to enable a specific capability for your Airwallex account.

Path parameters

idrequiredstring

A unique identifier of the requested capability, transfer_cny_local for transfer CNY local, or one of payments_mastercard, payments_klarna, payments_jcb, payments_amex, payments_giropay, payments_googlepay, payments_applepay, payments_wechat, payments_unionpay, payments_visa, payments_ideal, payments_bancontact, payments_sofort, payments_bacs_direct_debit, payments_airwallex_pay, payments_alipaycn, payments_alipayhk, payments_blik, payments_boost, payments_dana, payments_diners, payments_discover, payments_doku_ewallet, payments_dragonpay, payments_duit_now, payments_eps, payments_fps, payments_gcash, payments_grabpay_my, payments_grabpay_sg, payments_kakaopay, payments_konbini, payments_korean_local_card, payments_mybank, payments_naver_pay, payments_online_banking_kr, payments_online_banking_ph, payments_online_banking_th, payments_p24, payments_pay_now, payments_payco, payments_payeasy, payments_paysafecard, payments_paysafecash, payments_prompt_pay, payments_rabbit_line_pay, payments_sam_kiosk, payments_samsung_pay, payments_seven_eleven_my, payments_seven_eleven_tw, payments_shopee_pay, payments_skrill, payments_tesco_lotus, payments_tng, payments_truemoney, payments_trustly, payments_ach_direct_debit, payments_alfamart, payments_atome, payments_axs_kiosk, payments_bank_transfer_id, payments_bank_transfer_kr, payments_bitpay, payments_eft_direct_debit, payments_enets, payments_esun, payments_family_mart, payments_fpx, payments_go_pay, payments_hi_life, payments_indomaret, payments_jenius_pay, payments_linkaja, payments_maxima, payments_multibanco, payments_narvesen, payments_online_banking_ee, payments_online_banking_lt, payments_online_banking_lv, payments_ovo, payments_paybybankapp, payments_paypal, payments_paypost, payments_paysera, payments_payu, payments_perlas_terminals, payments_permata_atm, payments_satispay, payments_sepa_direct_debit, payments_upi, payments_zip, payments_line_pay, payments_paypay, payments_payeasy_atm, payments_toss_pay, payments_spei, payments_venmo, payments_afterpay, payments_payto, payments_birdpay, payments_twint, payments_bank_transfer, payments_cash_app_pay, payments_lumi, payments_pix, payments_seven_eleven_jp, payments_payme, payments_jkopay, payments_shopee_pay_id, payments_shopee_pay_sg, payments_shopee_pay_th, payments_shopee_pay_ph, payments_shopee_pay_vn, payments_shopee_pay_my, payments_spaylater_id, payments_spaylater_my, payments_spaylater_sg, payments_spaylater_th, payments_spaylater_ph, payments_spaylater_vn, payments_bc, payments_hana, payments_hyundai, payments_kb, payments_lotte, payments_nh, payments_samsung, payments_shinhan, payments_woori, payments_laybuy, payments_tabby, payments_octopus, payments_wero, payments_airi, payments_affirm, payments_bizum, payments_swish, payments_cartes_bancaires, payments_mbway for payment methods.

Request body

Returns an empty JSON object

Response body - 200 OK

commentstring

Additional details about the status of this capability.

detailsobject

Details of this capability.

details.reason_codesarray

Specific codes that indicate the reason a capability is disabled. For more information on the codes related to payment method capabilities, refer to this pageDocs.

entity_typestring

The type of entity of your declarant, one of INDIVIDUAL, BUSINESS.

idstring

A unique identifier of the requested capability.

statusstring

The status of this capability, one of ENABLED, DISABLED, PENDING.

updated_atstring

Last time this capability has been updated.

Errors

Error status	Description
400	[`"bad_request"` ,`"field_required"` `"invalid_person"` ]
401	Possible errors: `credentials_invalid`, `credentials_expired`
429	Too many requests
500	Service unavailable

POST /api/v1/account_capabilities/{id}/enable

$curl --request POST \
>  --url 'https://api.sandbox.airwallex.com/api/v1/account_capabilities/account_capability_id/enable' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json' \
>  --data '{
>  "enroll_sme_program": true,
>  "id": "payments_mastercard"
>}'

Response (200 OK)

1{
2  "comment": "string",
3  "details": {
4    "reason_codes": [
5      "string"
6    ]
7  },
8  "entity_type": "INDIVIDUAL",
9  "id": "payments_mastercard",
10  "status": "ENABLED",
11  "updated_at": "2023-04-01T11:25:39+0000"
12}

Was this section helpful?

List all Funding Limits

GET /api/v1/account_capabilities/funding_limits

Copy for LLMView as Markdown

Before initiating a Direct Debit from a Linked Account or as a Funding Source, you may wish to query the available funding limit or Faster Direct Debit limit.

Query parameters

ccystring

Specify the currency the limit will be displayed in. A single limit is applied for the entire customer, regardless of the display currency.

mandate_typestring

The settlement method or clearing system.

page_numinteger

Page number.

page_sizeinteger

Page size.

Response body - 200 OK

has_moreboolean

A flag which identifies whether there are more results.

itemsarray

Paged results.

items.availablenumber

The remaining limit.

items.currencystring

Currency of the limit, it's the applied one, or default as per your owning entity.

items.limitnumber

The upper limit.

items.statusstring

Current setting status.

ACTIVE

REQUESTED

items.typestring

Deposit type, possible values are DIRECT_DEBIT, FASTER_DIRECT_DEBIT.

DIRECT_DEBIT_DEPOSIT

FASTER_DIRECT_DEBIT_DEPOSIT

items.mandate_typestring

the settlement method or clearing system.

items.requested_limitnumber

The under evaluating limit.

items.updated_atstring

Last update time.

Errors

Error status	Description
401	Possible errors: `credentials_invalid`, `credentials_expired`
429	Too many requests
500	Service unavailable

GET /api/v1/account_capabilities/funding_limits

$curl --request GET \
>  --url 'https://api.sandbox.airwallex.com/api/v1/account_capabilities/funding_limits' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json'

Response (200 OK)

1{
2  "has_more": false,
3  "items": [
4    {
5      "currency": "USD",
6      "limit": 30000,
7      "mandate_type": "US_ACH_DEBIT",
8      "requested_limit": 100000,
9      "status": "ACTIVE",
10      "type": "DIRECT_DEBIT_DEPOSIT",
11      "updated_at": "2022-08-22T01:23:00+0000",
12      "available": 25000
13    }
14  ]
15}

Was this section helpful?