Console
Your key, its calls and your webhook.
Paste your API key to see its account, its rate and the calls it made; to set, rotate, test or remove the webhook your events go to; to list your events and send one again; to work your enrollment requests and look up what a payer asks; and to manage your account’s keys, your notice address, your webhook destinations and your SFTP file drop. The key stays on this page: it is never stored, never put in an address, and gone when you close the tab.
Webhooks
Set an https address in the console and every answer the 837P claims sandbox (POST /v1/sandbox/claims) makes, and every change to an enrollment request, is posted to it as an event, the moment it is made, signed with a secret only you and Payerworks hold. An event your server does not take is tried again, and every event is kept for 30 days, to list and to send again.
Each POST is signed under the Standard Webhooks specification, so any of its libraries checks it: webhook-id is the event’s id, webhook-timestamp the time it was signed in Unix seconds, and webhook-signature is v1, a comma and the signature in base64.
That signature is HMAC-SHA256 over the id, a period, the timestamp, a period and the raw body exactly as it arrived, keyed with your signing secret’s bytes: the part after whsec_, decoded from base64.
Each POST also carries the Payerworks-Signature header the first receivers were built on: t, the time it was signed in Unix seconds, and v1, HMAC-SHA256 keyed with your whole signing secret over the time, a period and the raw body, written in hex.
Check one of them before you trust the body: compute the same HMAC, compare the two in constant time, and refuse a time more than five minutes from your clock, so a captured event cannot be sent to you again.
The events, their signature and code to check it are on the Developers page.
Talk to us
What happens next
- 1
A person at Payerworks reads what you sent, usually within a business day.
- 2
One reply by email names the next step: our trading partner details, where each of your payers stands, or a key for the API.
- 3
Nothing follows unless you answer. There is no sequence behind this form.
Or write to hello@payerworks.com.