Skip to main content

Bill Pay Account Verify

Use this endpoint to verify that a customer account exists for a given biller before attempting bill pay.

Endpoint​

GET /bill-pay/account/verify?version=2024-10-01

Production:

https://api.paywise.co/bill-pay/account/verify

Sandbox:

https://sandbox-api.paywise.co/bill-pay/account/verify

Required query parameters​

  • version=2024-10-01
  • biller_mobile_number=<BILLER_MOBILE_NUMBER>
  • either:
    • lookup_type=<id|account_number|email|phone_number|first_name|last_name> and lookup_value=<value>
    • or account_ref=<value> as shorthand for lookup_type=account_number

biller_mobile_number is the canonical biller identifier for this verify contract. It should match the biller mobile number configured in PayWise core and in the PayWise biller registry.

Required headers​

  • PW-subscription-key
  • PW-origin-country
  • PW-request-date
  • PW-ip-address

Example​

curl -G "https://sandbox-api.paywise.co/bill-pay/account/verify" \
  --data-urlencode "version=2024-10-01" \
  --data-urlencode "biller_mobile_number=18680001234" \
  --data-urlencode "lookup_type=account_number" \
  --data-urlencode "lookup_value=IF-TEST-0001" \
  -H "PW-subscription-key: <your-subscription-key>" \
  -H "PW-origin-country: TT" \
  -H "PW-request-date: 2026-04-11 00:00:00" \
  -H "PW-ip-address: <your-public-ip>"

Response behavior​

  • 200 with data.valid=true|false for a normal single-result lookup
  • 409 if the lookup is ambiguous
  • 400 for invalid input
  • 429 if the lookup rate limit is exceeded

Notes​

  • Pass a single lookup at a time.
  • first_name and last_name are higher-risk lookup types because they may return ambiguity.
  • During migration, some internal environments may still accept legacy biller_code, but external callers should use biller_mobile_number.