Skip to content

Commit c410803

Browse files
committed
docs: refresh API table with new params and renamed handlers
Replace stale callbackScheme/handleCallback names with the v1.0 naming (completeScheme + handleCompleteRedirect), add callbackUrl, orderId, and transactionType rows.
1 parent 23419df commit c410803

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,17 @@ Accept an NFC payment. Returns a Promise.
102102
| `customerName` | `string` | No | Customer name |
103103
| `customerEmail` | `string` | No | Customer email |
104104
| `customerPhone` | `string` | No | Customer phone |
105-
| `callbackScheme` | `string` | iOS | Your app's registered URL scheme |
105+
| `callbackUrl` | `string` | No | HTTPS endpoint for the signed webhook. Trusted channel — use for fulfillment. Must be `https://`, max 2048 chars. |
106+
| `orderId` | `string` | No | Merchant order reference. Surfaced in the webhook callback for reconciliation. Max 2048 chars. If omitted, the SDK generates one. |
107+
| `transactionType` | `string` | No | Optional: `'SALE'` (default), `'AUTH'`, `'REFUND'`, `'CAPTURE'`, `'CANCEL'`, `'PAYOUT'`, `'VERIF'`. Server-validated. |
108+
| `completeScheme` | `string` | iOS | Your app's registered URL scheme. MONEI Pay opens `<completeScheme>://payment-result` on completion. |
106109
| `mode` | `string` | No | Android: `'direct'` (default) or `'via-monei-pay'` |
107110

108111
Returns `PaymentResult`. Throws on failure.
109112

110-
### `handleCallback(url)`
113+
### `handleCompleteRedirect(url)`
111114

112-
Handle incoming callback URL from MONEI Pay (iOS only). Wire into your Linking handler.
115+
Handle the post-payment redirect URL from MONEI Pay (iOS only). Wire into your `Linking` handler.
113116

114117
### `cancelPendingPayment()`
115118

0 commit comments

Comments
 (0)