Accounts

HTTP Method

Route

Authorization Level

Required Permission(s)

GET

accounts

End user or Merchant token (IP whitelist)

(none) Any accounts that have been assigned to the user's role(s).

GET

accounts/paged

End user or Merchant token (IP whitelist)

(none) Any accounts that have been assigned to the user's role(s).

GET

accounts/export

End user token

(none) Any accounts that have been assigned to the user's role(s).

GET

accounts/{accountID}

End user or Merchant token (IP whitelist)

(none) Account must have been assigned to the user's role(s).

PUT

accounts/{id}

End user or Merchant token

AccountPermissions.CanUpdateAccount

GET

accounts/{accountID}/transactions

End user or Merchant token (IP whitelist)

AccountPermissions.CanViewTransactions

GET

accounts/{accountID}/transactions/export

End user token

AccountPermissions.CanViewTransactions

GET

accounts/{accountID}/transactions/{id}

End user or Merchant token (IP whitelist)

AccountPermissions.CanViewTransactions

GET

accounts/{accountID}/payouts

End user or Merchant token (IP whitelist)

AccountPermissions.CanViewPayouts

GET

accounts/{accountID}/payouts/failed

End user or Merchant token (IP whitelist)

AccountPermissions.CanViewPayouts

POST

accounts

Merchant token

MerchantPermissions.CanCreateAccounts

PUT

accounts/{accountID}/topup/{amount}

End user token

(none)

DELETE

accounts/archive/{id}

End user or Merchant token

MerchantPermissions.CanArchiveAccounts

PUT

accounts/unarchive/{id}

End user or Merchant token

MerchantPermissions.CanArchiveAccounts

POST

accounts/{accountID}/statements

End user token

AccountPermissions.CanExportData

GET

accounts/{accountID}/statements/{id}

End user token

AccountPermissions.CanExportData

GET

accounts/statements

End user token

Any accounts that have been assigned to the user's role(s).

DELETE

accounts/statements

End user token

(none)

POST

accounts/{accountID}/virtual

End user or Merchant token

MerchantPermissions.CanCreateAccounts

GET

accounts/{accountID}/virtual

End user or Merchant token (IP whitelist)

Account must have been assigned to the user's role(s).

PUT

accounts/{accountID}/virtual/{virtualAccountID}

End user or Merchant token

AccountPermissions.CanUpdateAccount