Weav Docsv1

API reference / Channels

List channels

GET/v1/channels

Every channel and whether your account can use it now (allowed by Weav and switched on by you).

It also shows your payment limits. maintenance is always null for now. Creating a payment on a channel that is off returns 422 with code 4220101.

Headers

  • AuthorizationstringRequired
    Bearer plus your API key. See Authentication.

Responses

200 OK

All channels.

What data holds
  • payment_limitsarray of objects
    The smallest and largest payment you can create, per currency. Null means no limit.
    3 fields in payment_limits
    • currencystring
      ISO 4217. PHP today; more as they're enabled for your account.
      One of: PHP
    • min_amountnumber | null
    • max_amountnumber | null
  • channelsarray of objects
    5 fields in channels
    • channelstring
      The value you send when creating a payment.
      One of: QR_PH GCASH MAYA CARD PAY_AND_GO PALAWANPAY BAYAD
    • namestring
    • is_enabledboolean
      Whether new payments can use it (allowed by Weav and switched on by you).
    • appsarray of objects
      QR Ph only. The bank and e-wallet apps you can send as qr_ph_app. Empty for other channels.
      2 fields in apps
      • codestring
      • namestring
    • maintenanceobject | null
      Always null for now. Scheduled maintenance windows aren't shown here yet.

401 Unauthorized

Missing, malformed or unknown API key (code 4010000).

403 Forbidden

The key can't make this request (code 4030000): an address outside the key's IP allowlist, a live key before your live mode is on, or an account that isn't active. A live key sent from a browser is refused (code 4030001): keep live keys on your server.

GET

Try it: List channels

Test mode
Authorization
cURL

Uses $WEAV_API_KEY, never your key. Paste it into a terminal, or import it into Postman.

Response

Send the request to see Weav's answer here.

curl -X GET https://api.weavpayments.com/v1/channels \
    -H "Authorization: Bearer $WEAV_API_KEY"
{
    "code": "2000000",
    "success": true,
    "message": "OK",
    "data": {
        "payment_limits": [
            {
                "currency": "PHP",
                "min_amount": 0.01,
                "max_amount": 50000.0
            }
        ],
        "channels": [
            {
                "channel": "QR_PH",
                "name": "QR Ph",
                "is_enabled": true,
                "apps": [
                    {
                        "code": "BDO",
                        "name": "BDO Pay"
                    },
                    {
                        "code": "CHINABANK",
                        "name": "Chinabank"
                    },
                    {
                        "code": "GOTYME",
                        "name": "GoTyme"
                    },
                    {
                        "code": "LANDBANK",
                        "name": "LANDBANK"
                    },
                    {
                        "code": "METROBANK",
                        "name": "Metrobank"
                    },
                    {
                        "code": "PNB",
                        "name": "PNB"
                    },
                    {
                        "code": "RCBC",
                        "name": "RCBC"
                    },
                    {
                        "code": "ROBINSONS_BANK",
                        "name": "Robinsons Bank"
                    },
                    {
                        "code": "SECURITY_BANK",
                        "name": "Security Bank"
                    },
                    {
                        "code": "UNIONBANK",
                        "name": "UnionBank"
                    },
                    {
                        "code": "GRABPAY",
                        "name": "GrabPay"
                    },
                    {
                        "code": "SHOPEEPAY",
                        "name": "ShopeePay"
                    }
                ],
                "maintenance": null
            },
            {
                "channel": "GCASH",
                "name": "GCash",
                "is_enabled": true,
                "apps": [],
                "maintenance": null
            },
            {
                "channel": "MAYA",
                "name": "Pay with Maya",
                "is_enabled": true,
                "apps": [],
                "maintenance": null
            },
            {
                "channel": "CARD",
                "name": "Credit or debit card",
                "is_enabled": false,
                "apps": [],
                "maintenance": null
            },
            {
                "channel": "PAY_AND_GO",
                "name": "Pay & Go",
                "is_enabled": true,
                "apps": [],
                "maintenance": null
            },
            {
                "channel": "PALAWANPAY",
                "name": "PalawanPay",
                "is_enabled": true,
                "apps": [],
                "maintenance": null
            },
            {
                "channel": "BAYAD",
                "name": "Bayad",
                "is_enabled": true,
                "apps": [],
                "maintenance": null
            }
        ]
    }
}