Scopes

WAPI Scopes

When requesting an access token via the Grant endpoint, you must specify which scopes your token should have access to. Scopes control which API endpoints and operations the token is authorized to perform.

Use the exact scope strings documented on this site.

Request multiple scopes by separating them with spaces:

wapi-transactions-retrieve wapi-transactions-get-fees wapi-accounts-retrieve

Parent scopes grant access to all child scopes in the same category.

Accounts Scopes

Scope	Description	Endpoint
`wapi-accounts-all`	All account operations	Accounts
`wapi-accounts-create`	Create a WiPay account under an approved MMA configuration	POST /accounts
`wapi-accounts-delete`	Delete or de-authorize a WiPay account linked to the MMA	DELETE /accounts/{account_number}
`wapi-accounts-retrieve`	Retrieve information on a WiPay account linked to the MMA	GET /accounts/{account_number}
`wapi-accounts-update`	Update information on a WiPay account created by the MMA	PATCH /accounts/{account_number}

User Scopes

Scope	Description	Endpoint
`wapi-user-all`	All user operations	User
`wapi-user-create`	Upload profile picture, create bank account	POST /user/picture, POST /user/banks/{type}
`wapi-user-delete`	Delete profile picture, delete bank account	DELETE /user/picture, DELETE /user/banks/{type}
`wapi-user-retrieve`	Retrieve user profile and bank accounts	GET /user, GET /user/banks
`wapi-user-update`	Update password, phone, profile picture, and bank accounts	PATCH /user/password, PATCH /user/phone, PATCH /user/picture, PATCH /user/banks/{type}

Transactions Scopes

Scope	Description	Endpoint
`wapi-transactions-all`	All transaction operations	Transactions
`wapi-transactions-get-fees`	Calculate transaction fees	GET /transactions/fees
`wapi-transactions-retrieve`	Retrieve transaction history, single-transaction records, and transaction metadata	GET /transactions, GET /transactions/meta
`wapi-transactions-refund-request`	Submit a refund request	POST /transactions/{transaction_id}/refund

Trusted Card Scopes

Scope	Description	Endpoint
`wapi-trusted-cards-all`	All trusted-card operations	Trusted Cards
`wapi-trusted-cards-charge-request`	Get a payment link to charge a verified trusted card	POST /trusted-cards/{uuid}/charge
`wapi-trusted-cards-create`	Start trusted-card enrollment	POST /trusted-cards
`wapi-trusted-cards-delete`	Delete a verified or unverified trusted card	DELETE /trusted-cards/{uuid}
`wapi-trusted-cards-retrieve`	Retrieve trusted-card details	GET /trusted-cards or /trusted-cards/{uuid}
`wapi-trusted-cards-verify`	Verify the micro-charge amount for a trusted card	POST /trusted-cards/{uuid}/verify

Withdrawal Scopes

Scope	Description	Endpoint
`wapi-withdrawals-all`	All withdrawal operations	Withdrawals
`wapi-withdrawals-create`	Create a withdrawal request	POST /withdrawals
`wapi-withdrawals-delete`	Delete a withdrawal request	DELETE /withdrawals/{transaction_id}
`wapi-withdrawals-retrieve`	Retrieve withdrawal history and single-withdrawal records	GET /withdrawals

Example

Request a token with multiple scopes to access both transaction retrieval and account creation:

curl -X POST https://ttsb.wipayfinancial.com/wapi/auth/tokens \
  -H "Accept: application/json" \
  -F "email=your@email.com" \
  -F "password=your_password" \
  -F "scopes=wapi-transactions-retrieve wapi-accounts-create"

To request an entire category, use the parent scope for that category:

curl -X POST https://ttsb.wipayfinancial.com/wapi/auth/tokens \
  -H "Accept: application/json" \
  -F "email=your@email.com" \
  -F "password=your_password" \
  -F "scopes=wapi-trusted-cards-all"