v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

Payins

Get payin authorization limits

Retrieves the current authorization level, per-window limits, and volume totals for an end-user participant on the authenticated platform. Optionally scoped to a specific merchant when merchant_participant_code is supplied (the authenticated platform must operate for that merchant).

get/pay/limits

Query parameters

participant_codestring required

End-user participant code (6-character alphanumeric).

merchant_participant_codestring

Optional merchant participant code. When supplied, the response also includes merchant_totals (volume totals aggregated against that merchant). The authenticated platform must operate for the merchant or the request is rejected.

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required

Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Platform and (optionally) merchant payin limits.

Example response

{
  "message": {
    "request_id": "test-request-id",
    "participant_code": "SHOPP1",
    "merchant_participant_code": "MERCH1",
    "merchant_classification": "NON-TRANSFERABLE-3",
    "current_level": 2,
    "current_limits": [
      {
        "limit": "1000.00",
        "spent": "250.00",
        "remaining": "750.00",
        "window": "daily"
      }
    ],
    "platform_totals": [
      {
        "window": "daily",
        "currency": "USD",
        "total_amount": "5000.00",
        "transaction_count": 12
      }
    ],
    "merchant_totals": [
      {
        "window": "daily",
        "currency": "USD",
        "total_amount": "5000.00",
        "transaction_count": 12
      }
    ]
  }
}