Docs + scrub: neutral example account number, CBE reference formats, webhooks, quota
- The example account number in the README and in the source docblock was a REAL account number. Replaced with an obviously fake one (1000123456789). The same scrub had already been applied to sdks/ in qbirr-saas; this repo had drifted from it. - Document that CBE accepts the full receipt link, the "v2-" token and the bare token as the SAME payment. qbirr reduces them to one identity, so a receipt cannot be verified twice by presenting it differently. Case is ignored for that check. - Document the webhook contract: `verification.created` fires for BOTH outcomes so always read data.verified; data.client_ref echoes the tag your own upload sent (null if you did not send one); a 4xx response is final and is NOT retried, while 5xx / timeouts are retried with exponential backoff. - Document that only verified lookups count against the monthly quota. - sdk-node: the committed dist/ comment blocks were updated to match src. The change is inside comments only — no executable code differs.
This commit is contained in:
Vendored
+2
-2
@@ -8,7 +8,7 @@
|
||||
* ref: 'FT23001234ABC',
|
||||
* amount: 500,
|
||||
* receiverName: 'YOUR NAME',
|
||||
* receiverAccount: '1000017692643',
|
||||
* receiverAccount: '1000123456789',
|
||||
* });
|
||||
* console.log(r.verified, r.payer);
|
||||
*
|
||||
@@ -84,7 +84,7 @@ export class Qbirr {
|
||||
* provider: 'cbe',
|
||||
* amount: 999,
|
||||
* receiverName: 'YOUR NAME',
|
||||
* receiverAccount: '1000017692643',
|
||||
* receiverAccount: '1000123456789',
|
||||
* file: buf,
|
||||
* filename: 'receipt.pdf',
|
||||
* contentType: 'application/pdf',
|
||||
|
||||
Vendored
+2
-2
@@ -8,7 +8,7 @@
|
||||
* ref: 'FT23001234ABC',
|
||||
* amount: 500,
|
||||
* receiverName: 'YOUR NAME',
|
||||
* receiverAccount: '1000017692643',
|
||||
* receiverAccount: '1000123456789',
|
||||
* });
|
||||
* console.log(r.verified, r.payer);
|
||||
*
|
||||
@@ -120,7 +120,7 @@ export declare class Qbirr {
|
||||
* provider: 'cbe',
|
||||
* amount: 999,
|
||||
* receiverName: 'YOUR NAME',
|
||||
* receiverAccount: '1000017692643',
|
||||
* receiverAccount: '1000123456789',
|
||||
* file: buf,
|
||||
* filename: 'receipt.pdf',
|
||||
* contentType: 'application/pdf',
|
||||
|
||||
Vendored
+2
-2
@@ -8,7 +8,7 @@
|
||||
* ref: 'FT23001234ABC',
|
||||
* amount: 500,
|
||||
* receiverName: 'YOUR NAME',
|
||||
* receiverAccount: '1000017692643',
|
||||
* receiverAccount: '1000123456789',
|
||||
* });
|
||||
* console.log(r.verified, r.payer);
|
||||
*
|
||||
@@ -84,7 +84,7 @@ export class Qbirr {
|
||||
* provider: 'cbe',
|
||||
* amount: 999,
|
||||
* receiverName: 'YOUR NAME',
|
||||
* receiverAccount: '1000017692643',
|
||||
* receiverAccount: '1000123456789',
|
||||
* file: buf,
|
||||
* filename: 'receipt.pdf',
|
||||
* contentType: 'application/pdf',
|
||||
|
||||
Reference in New Issue
Block a user