@munchi_oy/core 2.21.0 → 2.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/api.d.ts +912 -1
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +1162 -1
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -15507,6 +15507,339 @@ export interface NexiConfigResponseDto {
|
|
|
15507
15507
|
*/
|
|
15508
15508
|
'hasPassword': boolean;
|
|
15509
15509
|
}
|
|
15510
|
+
/**
|
|
15511
|
+
*
|
|
15512
|
+
* @export
|
|
15513
|
+
* @interface NexiOnDeviceAnswerDto
|
|
15514
|
+
*/
|
|
15515
|
+
export interface NexiOnDeviceAnswerDto {
|
|
15516
|
+
/**
|
|
15517
|
+
*
|
|
15518
|
+
* @type {PoyntPaymentStatus}
|
|
15519
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15520
|
+
*/
|
|
15521
|
+
'status': PoyntPaymentStatus;
|
|
15522
|
+
/**
|
|
15523
|
+
* The reference the payment app was given, read back from the transaction\'s references: the session\'s sessionId. Required on a sale\'s or a refund\'s approval, which is refused when it is not the session\'s. A decline or a cancel may come without it, and then only ends the wait. Not read on a revert: Poynt\'s void carries the sale\'s references.
|
|
15524
|
+
* @type {string}
|
|
15525
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15526
|
+
*/
|
|
15527
|
+
'reference'?: string;
|
|
15528
|
+
/**
|
|
15529
|
+
* Poynt\'s `Transaction.id`. Required on an approval. On a sale or a refund it becomes the session\'s providerTransactionId, and one id settles one session only. On a revert it is the void\'s own transaction or the sale\'s, and it or parentId must be the sale\'s; it is kept in the stored answer only.
|
|
15530
|
+
* @type {string}
|
|
15531
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15532
|
+
*/
|
|
15533
|
+
'transactionId'?: string;
|
|
15534
|
+
/**
|
|
15535
|
+
* Poynt\'s `Transaction.parentId`: on a void, the sale\'s transaction id. Absent on a sale, and on a refund, which Poynt does not link to its sale (a non-referenced refund).
|
|
15536
|
+
* @type {string}
|
|
15537
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15538
|
+
*/
|
|
15539
|
+
'parentId'?: string;
|
|
15540
|
+
/**
|
|
15541
|
+
* Poynt\'s `Transaction.status`. A sale\'s approval must carry CAPTURED, a refund\'s REFUNDED, a revert\'s VOIDED; any other is kept for ops and the session is not settled.
|
|
15542
|
+
* @type {string}
|
|
15543
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15544
|
+
*/
|
|
15545
|
+
'transactionStatus'?: string;
|
|
15546
|
+
/**
|
|
15547
|
+
* Poynt\'s `Transaction.action` (SALE, REFUND). Kept in the stored answer, not checked.
|
|
15548
|
+
* @type {string}
|
|
15549
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15550
|
+
*/
|
|
15551
|
+
'transactionAction'?: string;
|
|
15552
|
+
/**
|
|
15553
|
+
* Poynt\'s `Transaction.partiallyApproved`. An approval for part of the amount is kept for ops and the session is not settled. Absent reads as false.
|
|
15554
|
+
* @type {boolean}
|
|
15555
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15556
|
+
*/
|
|
15557
|
+
'partiallyApproved'?: boolean;
|
|
15558
|
+
/**
|
|
15559
|
+
* How many of the Payment\'s transactions Poynt approved. Absent or 1 is the normal case; 2 or more is kept for ops and the session is not settled.
|
|
15560
|
+
* @type {number}
|
|
15561
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15562
|
+
*/
|
|
15563
|
+
'approvedTransactionCount'?: number;
|
|
15564
|
+
/**
|
|
15565
|
+
* The currency charged, ISO 4217 alpha code (`amounts.currency`). Required on a sale\'s or a refund\'s approval, and must be the session\'s.
|
|
15566
|
+
* @type {string}
|
|
15567
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15568
|
+
*/
|
|
15569
|
+
'currency'?: string;
|
|
15570
|
+
/**
|
|
15571
|
+
* What the card was charged or refunded, in cents (`amounts.transactionAmount`), tip included. Required on a sale\'s or a refund\'s approval: a sale\'s must be the session\'s amount plus its tip, a refund\'s the refund\'s amount. One that does not match is kept for ops and the session is not settled. Not checked on a revert, which gives back the whole sale.
|
|
15572
|
+
* @type {number}
|
|
15573
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15574
|
+
*/
|
|
15575
|
+
'transactionAmount'?: number;
|
|
15576
|
+
/**
|
|
15577
|
+
* The tip in `amounts.tipAmount`, in cents. Kept in the stored answer; the payment event\'s tip is the session\'s, since the payment app takes no tip of its own.
|
|
15578
|
+
* @type {number}
|
|
15579
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15580
|
+
*/
|
|
15581
|
+
'tipAmount'?: number;
|
|
15582
|
+
/**
|
|
15583
|
+
* The card brand, Poynt\'s `card.type`.
|
|
15584
|
+
* @type {string}
|
|
15585
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15586
|
+
*/
|
|
15587
|
+
'cardType'?: string;
|
|
15588
|
+
/**
|
|
15589
|
+
* The card\'s first six digits (`card.numberFirst6`); they tell a benefit card. Six digits exactly.
|
|
15590
|
+
* @type {string}
|
|
15591
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15592
|
+
*/
|
|
15593
|
+
'numberFirst6'?: string;
|
|
15594
|
+
/**
|
|
15595
|
+
* The card\'s last four digits (`card.numberLast4`). A refund whose card differs from the sale\'s is recorded and logged, never refused. Four digits exactly.
|
|
15596
|
+
* @type {string}
|
|
15597
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15598
|
+
*/
|
|
15599
|
+
'numberLast4'?: string;
|
|
15600
|
+
/**
|
|
15601
|
+
* The issuer\'s approval code (`processorResponse.approvalCode`; Poynt\'s top-level `approvalCode` is null on the N950). Optional: shown on the payment event, never required.
|
|
15602
|
+
* @type {string}
|
|
15603
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15604
|
+
*/
|
|
15605
|
+
'approvalCode'?: string;
|
|
15606
|
+
/**
|
|
15607
|
+
* The acquirer\'s retrieval reference number (`processorResponse.retrievalRefNum`).
|
|
15608
|
+
* @type {string}
|
|
15609
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15610
|
+
*/
|
|
15611
|
+
'retrievalRefNum'?: string;
|
|
15612
|
+
/**
|
|
15613
|
+
* `processorResponse.status`: Successful or Failure. Kept, not checked.
|
|
15614
|
+
* @type {string}
|
|
15615
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15616
|
+
*/
|
|
15617
|
+
'processorStatus'?: string;
|
|
15618
|
+
/**
|
|
15619
|
+
* `processorResponse.statusMessage`: why a transaction failed, in Poynt\'s words. Stored, trimmed, as the session\'s errorMessage when the session ends without money; a blank one (the N950 sends a single space when it has none) is replaced by the server\'s own words.
|
|
15620
|
+
* @type {string}
|
|
15621
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15622
|
+
*/
|
|
15623
|
+
'processorStatusMessage'?: string;
|
|
15624
|
+
/**
|
|
15625
|
+
* Nexi\'s own reference of the transaction (the `npay-reference-number` reference), as the Nexi portal shows it. Kept, not checked.
|
|
15626
|
+
* @type {string}
|
|
15627
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15628
|
+
*/
|
|
15629
|
+
'nexiReferenceNumber'?: string;
|
|
15630
|
+
/**
|
|
15631
|
+
* When Poynt created the transaction, ISO 8601, as the device\'s clock says. Kept in the stored answer only; the payment event\'s time is the server\'s.
|
|
15632
|
+
* @type {string}
|
|
15633
|
+
* @memberof NexiOnDeviceAnswerDto
|
|
15634
|
+
*/
|
|
15635
|
+
'createdAt'?: string;
|
|
15636
|
+
}
|
|
15637
|
+
/**
|
|
15638
|
+
*
|
|
15639
|
+
* @export
|
|
15640
|
+
* @interface NexiOnDeviceResultViewDto
|
|
15641
|
+
*/
|
|
15642
|
+
export interface NexiOnDeviceResultViewDto {
|
|
15643
|
+
/**
|
|
15644
|
+
* Opaque client token.
|
|
15645
|
+
* @type {string}
|
|
15646
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15647
|
+
*/
|
|
15648
|
+
'clientToken': string;
|
|
15649
|
+
/**
|
|
15650
|
+
* Internal session ID.
|
|
15651
|
+
* @type {string}
|
|
15652
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15653
|
+
*/
|
|
15654
|
+
'sessionId': string;
|
|
15655
|
+
/**
|
|
15656
|
+
* Viva transaction ID set after webhook completes.
|
|
15657
|
+
* @type {string}
|
|
15658
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15659
|
+
*/
|
|
15660
|
+
'providerTransactionId'?: string;
|
|
15661
|
+
/**
|
|
15662
|
+
*
|
|
15663
|
+
* @type {PaymentSessionStatus}
|
|
15664
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15665
|
+
*/
|
|
15666
|
+
'status': PaymentSessionStatus;
|
|
15667
|
+
/**
|
|
15668
|
+
* Amount in cents.
|
|
15669
|
+
* @type {number}
|
|
15670
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15671
|
+
*/
|
|
15672
|
+
'amount': number;
|
|
15673
|
+
/**
|
|
15674
|
+
* Currency.
|
|
15675
|
+
* @type {string}
|
|
15676
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15677
|
+
*/
|
|
15678
|
+
'currency': string;
|
|
15679
|
+
/**
|
|
15680
|
+
* Tip amount (cents).
|
|
15681
|
+
* @type {number}
|
|
15682
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15683
|
+
*/
|
|
15684
|
+
'tipAmount': number;
|
|
15685
|
+
/**
|
|
15686
|
+
* Surcharge amount (cents).
|
|
15687
|
+
* @type {number}
|
|
15688
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15689
|
+
*/
|
|
15690
|
+
'surchargeAmount': number;
|
|
15691
|
+
/**
|
|
15692
|
+
* Error code if failed.
|
|
15693
|
+
* @type {string}
|
|
15694
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15695
|
+
*/
|
|
15696
|
+
'errorCode'?: string;
|
|
15697
|
+
/**
|
|
15698
|
+
* Error message if failed.
|
|
15699
|
+
* @type {string}
|
|
15700
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15701
|
+
*/
|
|
15702
|
+
'errorMessage'?: string;
|
|
15703
|
+
/**
|
|
15704
|
+
* When the session was started (ISO 8601, UTC).
|
|
15705
|
+
* @type {string}
|
|
15706
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15707
|
+
*/
|
|
15708
|
+
'createdAt': string;
|
|
15709
|
+
/**
|
|
15710
|
+
* When the session last changed (ISO 8601, UTC).
|
|
15711
|
+
* @type {string}
|
|
15712
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15713
|
+
*/
|
|
15714
|
+
'updatedAt': string;
|
|
15715
|
+
/**
|
|
15716
|
+
* When the sale was written to the order and closed (ISO 8601, UTC); null while it is not.
|
|
15717
|
+
* @type {string}
|
|
15718
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15719
|
+
*/
|
|
15720
|
+
'closedAt'?: string;
|
|
15721
|
+
/**
|
|
15722
|
+
*
|
|
15723
|
+
* @type {NexiOnDeviceResultViewDtoTransaction}
|
|
15724
|
+
* @memberof NexiOnDeviceResultViewDto
|
|
15725
|
+
*/
|
|
15726
|
+
'transaction'?: NexiOnDeviceResultViewDtoTransaction;
|
|
15727
|
+
}
|
|
15728
|
+
/**
|
|
15729
|
+
* The payment event the order receives for this sale, built from the payment app\'s approval: the session\'s amount, the tip as a fee, the card\'s brand and masked number. Present while the session is a paid sale (SUCCESS or CLOSED), a repeated answer included; absent for a failure, a cancel, a refund or a revert.
|
|
15730
|
+
* @export
|
|
15731
|
+
* @interface NexiOnDeviceResultViewDtoTransaction
|
|
15732
|
+
*/
|
|
15733
|
+
export interface NexiOnDeviceResultViewDtoTransaction {
|
|
15734
|
+
/**
|
|
15735
|
+
* Id of this payment: the payment provider\'s transaction id for a card payment, or an id the till made
|
|
15736
|
+
* @type {string}
|
|
15737
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15738
|
+
*/
|
|
15739
|
+
'id': string;
|
|
15740
|
+
/**
|
|
15741
|
+
* The payment\'s reference: the provider\'s session or merchant reference for a card payment, or, on a reversal, the id of the payment it reverses; null when there is none
|
|
15742
|
+
* @type {string}
|
|
15743
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15744
|
+
*/
|
|
15745
|
+
'referenceId': string | null;
|
|
15746
|
+
/**
|
|
15747
|
+
*
|
|
15748
|
+
* @type {PaymentProvider}
|
|
15749
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15750
|
+
*/
|
|
15751
|
+
'provider': PaymentProvider;
|
|
15752
|
+
/**
|
|
15753
|
+
*
|
|
15754
|
+
* @type {PaymentMethod}
|
|
15755
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15756
|
+
*/
|
|
15757
|
+
'type': PaymentMethod;
|
|
15758
|
+
/**
|
|
15759
|
+
*
|
|
15760
|
+
* @type {PaymentOutcomeStatus}
|
|
15761
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15762
|
+
*/
|
|
15763
|
+
'paymentOutcomeStatus'?: PaymentOutcomeStatus;
|
|
15764
|
+
/**
|
|
15765
|
+
* Amount paid in cents
|
|
15766
|
+
* @type {number}
|
|
15767
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15768
|
+
*/
|
|
15769
|
+
'amount': number;
|
|
15770
|
+
/**
|
|
15771
|
+
* Difference from cash rounding in cents
|
|
15772
|
+
* @type {number}
|
|
15773
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15774
|
+
*/
|
|
15775
|
+
'roundingDifference': number;
|
|
15776
|
+
/**
|
|
15777
|
+
* Raw data from payment provider, as it sent it
|
|
15778
|
+
* @type {object}
|
|
15779
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15780
|
+
*/
|
|
15781
|
+
'rawData': object;
|
|
15782
|
+
/**
|
|
15783
|
+
* When the payment was taken
|
|
15784
|
+
* @type {string}
|
|
15785
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15786
|
+
*/
|
|
15787
|
+
'createdAt': string;
|
|
15788
|
+
/**
|
|
15789
|
+
*
|
|
15790
|
+
* @type {TransactionDtoCardDetail}
|
|
15791
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15792
|
+
*/
|
|
15793
|
+
'cardDetail': TransactionDtoCardDetail | null;
|
|
15794
|
+
/**
|
|
15795
|
+
* The monetary amount of the voucher value that was *not* used and *not* refunded to the customer (i.e., the overage). This is applicable only when a voucher is used and its value exceeds the order total.
|
|
15796
|
+
* @type {number}
|
|
15797
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15798
|
+
*/
|
|
15799
|
+
'voucherForfeitedAmount'?: number | null;
|
|
15800
|
+
/**
|
|
15801
|
+
* The specific line items this transaction paid for. If null or empty, it was a pooled payment against the total bill.
|
|
15802
|
+
* @type {Array<string>}
|
|
15803
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15804
|
+
*/
|
|
15805
|
+
'lineItemIds'?: Array<string> | null;
|
|
15806
|
+
/**
|
|
15807
|
+
* The specific split part this transaction paid for. If null, it was not a payment for a split part.
|
|
15808
|
+
* @type {string}
|
|
15809
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15810
|
+
*/
|
|
15811
|
+
'splitPartId'?: string | null;
|
|
15812
|
+
/**
|
|
15813
|
+
* Detailed settlement allocations for this transaction. Use this for accurate refund and reconciliation logic, especially when one line item is split across multiple payments.
|
|
15814
|
+
* @type {Array<TransactionItemAllocationDto>}
|
|
15815
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15816
|
+
*/
|
|
15817
|
+
'itemAllocations'?: Array<TransactionItemAllocationDto> | null;
|
|
15818
|
+
/**
|
|
15819
|
+
*
|
|
15820
|
+
* @type {TransactionDtoDevice}
|
|
15821
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15822
|
+
*/
|
|
15823
|
+
'device'?: TransactionDtoDevice | null;
|
|
15824
|
+
/**
|
|
15825
|
+
*
|
|
15826
|
+
* @type {TransactionDtoCapturedBy}
|
|
15827
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15828
|
+
*/
|
|
15829
|
+
'capturedBy'?: TransactionDtoCapturedBy | null;
|
|
15830
|
+
/**
|
|
15831
|
+
* Indicates whether this transaction was processed as a pre-authorization.
|
|
15832
|
+
* @type {string}
|
|
15833
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15834
|
+
*/
|
|
15835
|
+
'label': string | null;
|
|
15836
|
+
/**
|
|
15837
|
+
*
|
|
15838
|
+
* @type {TransactionDtoFees}
|
|
15839
|
+
* @memberof NexiOnDeviceResultViewDtoTransaction
|
|
15840
|
+
*/
|
|
15841
|
+
'fees'?: TransactionDtoFees | null;
|
|
15842
|
+
}
|
|
15510
15843
|
/**
|
|
15511
15844
|
*
|
|
15512
15845
|
* @export
|
|
@@ -18311,6 +18644,65 @@ export interface ParkPosOrderResponseDto {
|
|
|
18311
18644
|
*/
|
|
18312
18645
|
'heldLineItems': number;
|
|
18313
18646
|
}
|
|
18647
|
+
/**
|
|
18648
|
+
*
|
|
18649
|
+
* @export
|
|
18650
|
+
* @interface PartnerDto
|
|
18651
|
+
*/
|
|
18652
|
+
export interface PartnerDto {
|
|
18653
|
+
/**
|
|
18654
|
+
* The partner\'s id, which never changes: a provider row links to it, and an order keeps it with the partner\'s name and logo as they were when the order was saved
|
|
18655
|
+
* @type {string}
|
|
18656
|
+
* @memberof PartnerDto
|
|
18657
|
+
*/
|
|
18658
|
+
'id': string;
|
|
18659
|
+
/**
|
|
18660
|
+
* The partner\'s key, which never changes once created: orders keep it. A platform Munchi connected before the partner standard has its channel name as key (Wolt, WoltStorefront, UberEats, Foodora, Bolt, ResQ); a partner on the partner standard a slug: words of lowercase letters and digits joined by single -, starting with a letter, 2 to 41 characters, that names no Munchi channel
|
|
18661
|
+
* @type {string}
|
|
18662
|
+
* @memberof PartnerDto
|
|
18663
|
+
*/
|
|
18664
|
+
'key': string;
|
|
18665
|
+
/**
|
|
18666
|
+
* The partner\'s name as the apps show it
|
|
18667
|
+
* @type {string}
|
|
18668
|
+
* @memberof PartnerDto
|
|
18669
|
+
*/
|
|
18670
|
+
'name': string;
|
|
18671
|
+
/**
|
|
18672
|
+
* The partner\'s logo, an https address; null when it has none
|
|
18673
|
+
* @type {string}
|
|
18674
|
+
* @memberof PartnerDto
|
|
18675
|
+
*/
|
|
18676
|
+
'logoUrl': string | null;
|
|
18677
|
+
/**
|
|
18678
|
+
* Whether the partner is active
|
|
18679
|
+
* @type {boolean}
|
|
18680
|
+
* @memberof PartnerDto
|
|
18681
|
+
*/
|
|
18682
|
+
'isActive': boolean;
|
|
18683
|
+
/**
|
|
18684
|
+
* When the partner was added, ISO 8601 in UTC
|
|
18685
|
+
* @type {string}
|
|
18686
|
+
* @memberof PartnerDto
|
|
18687
|
+
*/
|
|
18688
|
+
'createdAt': string;
|
|
18689
|
+
/**
|
|
18690
|
+
* When the partner was last changed, ISO 8601 in UTC
|
|
18691
|
+
* @type {string}
|
|
18692
|
+
* @memberof PartnerDto
|
|
18693
|
+
*/
|
|
18694
|
+
'updatedAt': string;
|
|
18695
|
+
}
|
|
18696
|
+
/**
|
|
18697
|
+
*
|
|
18698
|
+
* @export
|
|
18699
|
+
* @enum {string}
|
|
18700
|
+
*/
|
|
18701
|
+
export declare const PartnerWrite: {
|
|
18702
|
+
readonly Created: "created";
|
|
18703
|
+
readonly Updated: "updated";
|
|
18704
|
+
};
|
|
18705
|
+
export type PartnerWrite = typeof PartnerWrite[keyof typeof PartnerWrite];
|
|
18314
18706
|
/**
|
|
18315
18707
|
*
|
|
18316
18708
|
* @export
|
|
@@ -23476,6 +23868,23 @@ export interface PosVivaMerchantDto {
|
|
|
23476
23868
|
*/
|
|
23477
23869
|
'merchantId': string | null;
|
|
23478
23870
|
}
|
|
23871
|
+
/**
|
|
23872
|
+
*
|
|
23873
|
+
* @export
|
|
23874
|
+
* @enum {string}
|
|
23875
|
+
*/
|
|
23876
|
+
export declare const PoyntPaymentStatus: {
|
|
23877
|
+
readonly Authorized: "AUTHORIZED";
|
|
23878
|
+
readonly Canceled: "CANCELED";
|
|
23879
|
+
readonly Completed: "COMPLETED";
|
|
23880
|
+
readonly Declined: "DECLINED";
|
|
23881
|
+
readonly Failed: "FAILED";
|
|
23882
|
+
readonly Hold: "HOLD";
|
|
23883
|
+
readonly ReadCardOnly: "READ_CARD_ONLY";
|
|
23884
|
+
readonly Refunded: "REFUNDED";
|
|
23885
|
+
readonly Voided: "VOIDED";
|
|
23886
|
+
};
|
|
23887
|
+
export type PoyntPaymentStatus = typeof PoyntPaymentStatus[keyof typeof PoyntPaymentStatus];
|
|
23479
23888
|
/**
|
|
23480
23889
|
*
|
|
23481
23890
|
* @export
|
|
@@ -26655,6 +27064,152 @@ export declare const RecordManualStatus: {
|
|
|
26655
27064
|
readonly Failed: "FAILED";
|
|
26656
27065
|
};
|
|
26657
27066
|
export type RecordManualStatus = typeof RecordManualStatus[keyof typeof RecordManualStatus];
|
|
27067
|
+
/**
|
|
27068
|
+
*
|
|
27069
|
+
* @export
|
|
27070
|
+
* @interface RecordNexiOnDeviceResultDto
|
|
27071
|
+
*/
|
|
27072
|
+
export interface RecordNexiOnDeviceResultDto {
|
|
27073
|
+
/**
|
|
27074
|
+
* The sessionId the start, refund or revert route answered. A sale\'s and a refund\'s is the reference the payment app was given; a revert\'s names the reversal the void settles.
|
|
27075
|
+
* @type {string}
|
|
27076
|
+
* @memberof RecordNexiOnDeviceResultDto
|
|
27077
|
+
*/
|
|
27078
|
+
'sessionId': string;
|
|
27079
|
+
/**
|
|
27080
|
+
*
|
|
27081
|
+
* @type {RecordNexiOnDeviceResultDtoAnswer}
|
|
27082
|
+
* @memberof RecordNexiOnDeviceResultDto
|
|
27083
|
+
*/
|
|
27084
|
+
'answer': RecordNexiOnDeviceResultDtoAnswer;
|
|
27085
|
+
}
|
|
27086
|
+
/**
|
|
27087
|
+
* The payment app\'s answer, flattened from Poynt\'s Payment by the app.
|
|
27088
|
+
* @export
|
|
27089
|
+
* @interface RecordNexiOnDeviceResultDtoAnswer
|
|
27090
|
+
*/
|
|
27091
|
+
export interface RecordNexiOnDeviceResultDtoAnswer {
|
|
27092
|
+
/**
|
|
27093
|
+
*
|
|
27094
|
+
* @type {PoyntPaymentStatus}
|
|
27095
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27096
|
+
*/
|
|
27097
|
+
'status': PoyntPaymentStatus;
|
|
27098
|
+
/**
|
|
27099
|
+
* The reference the payment app was given, read back from the transaction\'s references: the session\'s sessionId. Required on a sale\'s or a refund\'s approval, which is refused when it is not the session\'s. A decline or a cancel may come without it, and then only ends the wait. Not read on a revert: Poynt\'s void carries the sale\'s references.
|
|
27100
|
+
* @type {string}
|
|
27101
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27102
|
+
*/
|
|
27103
|
+
'reference'?: string;
|
|
27104
|
+
/**
|
|
27105
|
+
* Poynt\'s `Transaction.id`. Required on an approval. On a sale or a refund it becomes the session\'s providerTransactionId, and one id settles one session only. On a revert it is the void\'s own transaction or the sale\'s, and it or parentId must be the sale\'s; it is kept in the stored answer only.
|
|
27106
|
+
* @type {string}
|
|
27107
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27108
|
+
*/
|
|
27109
|
+
'transactionId'?: string;
|
|
27110
|
+
/**
|
|
27111
|
+
* Poynt\'s `Transaction.parentId`: on a void, the sale\'s transaction id. Absent on a sale, and on a refund, which Poynt does not link to its sale (a non-referenced refund).
|
|
27112
|
+
* @type {string}
|
|
27113
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27114
|
+
*/
|
|
27115
|
+
'parentId'?: string;
|
|
27116
|
+
/**
|
|
27117
|
+
* Poynt\'s `Transaction.status`. A sale\'s approval must carry CAPTURED, a refund\'s REFUNDED, a revert\'s VOIDED; any other is kept for ops and the session is not settled.
|
|
27118
|
+
* @type {string}
|
|
27119
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27120
|
+
*/
|
|
27121
|
+
'transactionStatus'?: string;
|
|
27122
|
+
/**
|
|
27123
|
+
* Poynt\'s `Transaction.action` (SALE, REFUND). Kept in the stored answer, not checked.
|
|
27124
|
+
* @type {string}
|
|
27125
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27126
|
+
*/
|
|
27127
|
+
'transactionAction'?: string;
|
|
27128
|
+
/**
|
|
27129
|
+
* Poynt\'s `Transaction.partiallyApproved`. An approval for part of the amount is kept for ops and the session is not settled. Absent reads as false.
|
|
27130
|
+
* @type {boolean}
|
|
27131
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27132
|
+
*/
|
|
27133
|
+
'partiallyApproved'?: boolean;
|
|
27134
|
+
/**
|
|
27135
|
+
* How many of the Payment\'s transactions Poynt approved. Absent or 1 is the normal case; 2 or more is kept for ops and the session is not settled.
|
|
27136
|
+
* @type {number}
|
|
27137
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27138
|
+
*/
|
|
27139
|
+
'approvedTransactionCount'?: number;
|
|
27140
|
+
/**
|
|
27141
|
+
* The currency charged, ISO 4217 alpha code (`amounts.currency`). Required on a sale\'s or a refund\'s approval, and must be the session\'s.
|
|
27142
|
+
* @type {string}
|
|
27143
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27144
|
+
*/
|
|
27145
|
+
'currency'?: string;
|
|
27146
|
+
/**
|
|
27147
|
+
* What the card was charged or refunded, in cents (`amounts.transactionAmount`), tip included. Required on a sale\'s or a refund\'s approval: a sale\'s must be the session\'s amount plus its tip, a refund\'s the refund\'s amount. One that does not match is kept for ops and the session is not settled. Not checked on a revert, which gives back the whole sale.
|
|
27148
|
+
* @type {number}
|
|
27149
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27150
|
+
*/
|
|
27151
|
+
'transactionAmount'?: number;
|
|
27152
|
+
/**
|
|
27153
|
+
* The tip in `amounts.tipAmount`, in cents. Kept in the stored answer; the payment event\'s tip is the session\'s, since the payment app takes no tip of its own.
|
|
27154
|
+
* @type {number}
|
|
27155
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27156
|
+
*/
|
|
27157
|
+
'tipAmount'?: number;
|
|
27158
|
+
/**
|
|
27159
|
+
* The card brand, Poynt\'s `card.type`.
|
|
27160
|
+
* @type {string}
|
|
27161
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27162
|
+
*/
|
|
27163
|
+
'cardType'?: string;
|
|
27164
|
+
/**
|
|
27165
|
+
* The card\'s first six digits (`card.numberFirst6`); they tell a benefit card. Six digits exactly.
|
|
27166
|
+
* @type {string}
|
|
27167
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27168
|
+
*/
|
|
27169
|
+
'numberFirst6'?: string;
|
|
27170
|
+
/**
|
|
27171
|
+
* The card\'s last four digits (`card.numberLast4`). A refund whose card differs from the sale\'s is recorded and logged, never refused. Four digits exactly.
|
|
27172
|
+
* @type {string}
|
|
27173
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27174
|
+
*/
|
|
27175
|
+
'numberLast4'?: string;
|
|
27176
|
+
/**
|
|
27177
|
+
* The issuer\'s approval code (`processorResponse.approvalCode`; Poynt\'s top-level `approvalCode` is null on the N950). Optional: shown on the payment event, never required.
|
|
27178
|
+
* @type {string}
|
|
27179
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27180
|
+
*/
|
|
27181
|
+
'approvalCode'?: string;
|
|
27182
|
+
/**
|
|
27183
|
+
* The acquirer\'s retrieval reference number (`processorResponse.retrievalRefNum`).
|
|
27184
|
+
* @type {string}
|
|
27185
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27186
|
+
*/
|
|
27187
|
+
'retrievalRefNum'?: string;
|
|
27188
|
+
/**
|
|
27189
|
+
* `processorResponse.status`: Successful or Failure. Kept, not checked.
|
|
27190
|
+
* @type {string}
|
|
27191
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27192
|
+
*/
|
|
27193
|
+
'processorStatus'?: string;
|
|
27194
|
+
/**
|
|
27195
|
+
* `processorResponse.statusMessage`: why a transaction failed, in Poynt\'s words. Stored, trimmed, as the session\'s errorMessage when the session ends without money; a blank one (the N950 sends a single space when it has none) is replaced by the server\'s own words.
|
|
27196
|
+
* @type {string}
|
|
27197
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27198
|
+
*/
|
|
27199
|
+
'processorStatusMessage'?: string;
|
|
27200
|
+
/**
|
|
27201
|
+
* Nexi\'s own reference of the transaction (the `npay-reference-number` reference), as the Nexi portal shows it. Kept, not checked.
|
|
27202
|
+
* @type {string}
|
|
27203
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27204
|
+
*/
|
|
27205
|
+
'nexiReferenceNumber'?: string;
|
|
27206
|
+
/**
|
|
27207
|
+
* When Poynt created the transaction, ISO 8601, as the device\'s clock says. Kept in the stored answer only; the payment event\'s time is the server\'s.
|
|
27208
|
+
* @type {string}
|
|
27209
|
+
* @memberof RecordNexiOnDeviceResultDtoAnswer
|
|
27210
|
+
*/
|
|
27211
|
+
'createdAt'?: string;
|
|
27212
|
+
}
|
|
26658
27213
|
/**
|
|
26659
27214
|
*
|
|
26660
27215
|
* @export
|
|
@@ -31132,6 +31687,74 @@ export interface SaveEpassiCredentialsDto {
|
|
|
31132
31687
|
*/
|
|
31133
31688
|
'posName': string;
|
|
31134
31689
|
}
|
|
31690
|
+
/**
|
|
31691
|
+
*
|
|
31692
|
+
* @export
|
|
31693
|
+
* @interface SavedPartnerDto
|
|
31694
|
+
*/
|
|
31695
|
+
export interface SavedPartnerDto {
|
|
31696
|
+
/**
|
|
31697
|
+
*
|
|
31698
|
+
* @type {PartnerWrite}
|
|
31699
|
+
* @memberof SavedPartnerDto
|
|
31700
|
+
*/
|
|
31701
|
+
'write': PartnerWrite;
|
|
31702
|
+
/**
|
|
31703
|
+
*
|
|
31704
|
+
* @type {SavedPartnerDtoPartner}
|
|
31705
|
+
* @memberof SavedPartnerDto
|
|
31706
|
+
*/
|
|
31707
|
+
'partner': SavedPartnerDtoPartner;
|
|
31708
|
+
}
|
|
31709
|
+
/**
|
|
31710
|
+
* The partner as it is after the save; its key is the one it was saved under, which a key asked in another case is changed to
|
|
31711
|
+
* @export
|
|
31712
|
+
* @interface SavedPartnerDtoPartner
|
|
31713
|
+
*/
|
|
31714
|
+
export interface SavedPartnerDtoPartner {
|
|
31715
|
+
/**
|
|
31716
|
+
* The partner\'s id, which never changes: a provider row links to it, and an order keeps it with the partner\'s name and logo as they were when the order was saved
|
|
31717
|
+
* @type {string}
|
|
31718
|
+
* @memberof SavedPartnerDtoPartner
|
|
31719
|
+
*/
|
|
31720
|
+
'id': string;
|
|
31721
|
+
/**
|
|
31722
|
+
* The partner\'s key, which never changes once created: orders keep it. A platform Munchi connected before the partner standard has its channel name as key (Wolt, WoltStorefront, UberEats, Foodora, Bolt, ResQ); a partner on the partner standard a slug: words of lowercase letters and digits joined by single -, starting with a letter, 2 to 41 characters, that names no Munchi channel
|
|
31723
|
+
* @type {string}
|
|
31724
|
+
* @memberof SavedPartnerDtoPartner
|
|
31725
|
+
*/
|
|
31726
|
+
'key': string;
|
|
31727
|
+
/**
|
|
31728
|
+
* The partner\'s name as the apps show it
|
|
31729
|
+
* @type {string}
|
|
31730
|
+
* @memberof SavedPartnerDtoPartner
|
|
31731
|
+
*/
|
|
31732
|
+
'name': string;
|
|
31733
|
+
/**
|
|
31734
|
+
* The partner\'s logo, an https address; null when it has none
|
|
31735
|
+
* @type {string}
|
|
31736
|
+
* @memberof SavedPartnerDtoPartner
|
|
31737
|
+
*/
|
|
31738
|
+
'logoUrl': string | null;
|
|
31739
|
+
/**
|
|
31740
|
+
* Whether the partner is active
|
|
31741
|
+
* @type {boolean}
|
|
31742
|
+
* @memberof SavedPartnerDtoPartner
|
|
31743
|
+
*/
|
|
31744
|
+
'isActive': boolean;
|
|
31745
|
+
/**
|
|
31746
|
+
* When the partner was added, ISO 8601 in UTC
|
|
31747
|
+
* @type {string}
|
|
31748
|
+
* @memberof SavedPartnerDtoPartner
|
|
31749
|
+
*/
|
|
31750
|
+
'createdAt': string;
|
|
31751
|
+
/**
|
|
31752
|
+
* When the partner was last changed, ISO 8601 in UTC
|
|
31753
|
+
* @type {string}
|
|
31754
|
+
* @memberof SavedPartnerDtoPartner
|
|
31755
|
+
*/
|
|
31756
|
+
'updatedAt': string;
|
|
31757
|
+
}
|
|
31135
31758
|
/**
|
|
31136
31759
|
*
|
|
31137
31760
|
* @export
|
|
@@ -37756,6 +38379,31 @@ export interface UpsertNexiDto {
|
|
|
37756
38379
|
*/
|
|
37757
38380
|
'password'?: string;
|
|
37758
38381
|
}
|
|
38382
|
+
/**
|
|
38383
|
+
*
|
|
38384
|
+
* @export
|
|
38385
|
+
* @interface UpsertPartnerDto
|
|
38386
|
+
*/
|
|
38387
|
+
export interface UpsertPartnerDto {
|
|
38388
|
+
/**
|
|
38389
|
+
* The partner\'s name as the apps show it, 1 to 60 characters once the spaces around it are removed
|
|
38390
|
+
* @type {string}
|
|
38391
|
+
* @memberof UpsertPartnerDto
|
|
38392
|
+
*/
|
|
38393
|
+
'name': string;
|
|
38394
|
+
/**
|
|
38395
|
+
* The partner\'s logo, an https address of at most 2048 characters (Munchi keeps its logos on Google Cloud Storage). null removes it; absent: a new partner has none, and a partner already there keeps its own
|
|
38396
|
+
* @type {string}
|
|
38397
|
+
* @memberof UpsertPartnerDto
|
|
38398
|
+
*/
|
|
38399
|
+
'logoUrl'?: string | null;
|
|
38400
|
+
/**
|
|
38401
|
+
* Whether the partner is active. Absent: a new partner is active, and a partner already there keeps its own
|
|
38402
|
+
* @type {boolean}
|
|
38403
|
+
* @memberof UpsertPartnerDto
|
|
38404
|
+
*/
|
|
38405
|
+
'isActive'?: boolean;
|
|
38406
|
+
}
|
|
37759
38407
|
/**
|
|
37760
38408
|
*
|
|
37761
38409
|
* @export
|
|
@@ -38415,11 +39063,17 @@ export interface VendureSellerUpsertDto {
|
|
|
38415
39063
|
*/
|
|
38416
39064
|
'enabled': boolean;
|
|
38417
39065
|
/**
|
|
38418
|
-
* The Clerk user ids of the venue\'s owners. Each is trimmed and added to the owners the venue has;
|
|
39066
|
+
* The Clerk user ids of the venue\'s owners. Each is trimmed and added to the owners the venue has; an owner is removed only when owners_removed lists it. An empty list or none keeps them as they are
|
|
38419
39067
|
* @type {Array<string>}
|
|
38420
39068
|
* @memberof VendureSellerUpsertDto
|
|
38421
39069
|
*/
|
|
38422
39070
|
'owners'?: Array<string>;
|
|
39071
|
+
/**
|
|
39072
|
+
* The owner keys Vendure removed from the venue in this change: a Clerk user\'s externalId or a Clerk user id. Each is trimmed and removed from the owners the venue has, unless owners sends it too; an owner not listed here is never removed. Absent or empty means nothing was removed. Vendure builds from before its remove-owner route never send it
|
|
39073
|
+
* @type {Array<string>}
|
|
39074
|
+
* @memberof VendureSellerUpsertDto
|
|
39075
|
+
*/
|
|
39076
|
+
'owners_removed'?: Array<string>;
|
|
38423
39077
|
/**
|
|
38424
39078
|
* The venue\'s opening hours, seven days Sunday first, stored on the venue as sent: each day { enabled, lapses: [{ open: { hour, minute }, close: { hour, minute } }] }. Only checked to be a list. An empty list or none keeps the stored schedule
|
|
38425
39079
|
* @type {Array<object>}
|
|
@@ -50993,6 +51647,13 @@ export declare const OpsApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
50993
51647
|
* @throws {RequiredError}
|
|
50994
51648
|
*/
|
|
50995
51649
|
disconnectDeliveryPlatform: (venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51650
|
+
/**
|
|
51651
|
+
* The partner directory: every delivery platform Munchi works with, active or not, by key, with its name and logo. Read from the cache, which a save clears.
|
|
51652
|
+
* @summary Every delivery partner, by key
|
|
51653
|
+
* @param {*} [options] Override http request option.
|
|
51654
|
+
* @throws {RequiredError}
|
|
51655
|
+
*/
|
|
51656
|
+
listPartners: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50996
51657
|
/**
|
|
50997
51658
|
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
50998
51659
|
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
@@ -51010,6 +51671,15 @@ export declare const OpsApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
51010
51671
|
* @throws {RequiredError}
|
|
51011
51672
|
*/
|
|
51012
51673
|
searchVenues: (search: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51674
|
+
/**
|
|
51675
|
+
* Creates the partner under the key, or changes the one there. The key itself never changes: orders keep it. A platform Munchi connected before the partner standard uses its channel name as key. The key is read in any case and saved as a platform\'s channel name (wolt as Wolt) or in lowercase (Fin-Delivery as fin-delivery); the answer\'s partner.key is the key saved. Only the fields sent change a partner already there. The directory\'s cache is cleared after the save.
|
|
51676
|
+
* @summary Add a delivery partner, or change its name, logo or active state
|
|
51677
|
+
* @param {string} key The partner\'s key
|
|
51678
|
+
* @param {UpsertPartnerDto} upsertPartnerDto
|
|
51679
|
+
* @param {*} [options] Override http request option.
|
|
51680
|
+
* @throws {RequiredError}
|
|
51681
|
+
*/
|
|
51682
|
+
upsertPartner: (key: string, upsertPartnerDto: UpsertPartnerDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51013
51683
|
};
|
|
51014
51684
|
/**
|
|
51015
51685
|
* OpsApi - functional programming interface
|
|
@@ -51042,6 +51712,13 @@ export declare const OpsApiFp: (configuration?: Configuration) => {
|
|
|
51042
51712
|
* @throws {RequiredError}
|
|
51043
51713
|
*/
|
|
51044
51714
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisconnectedDeliveryPlatformDto>>;
|
|
51715
|
+
/**
|
|
51716
|
+
* The partner directory: every delivery platform Munchi works with, active or not, by key, with its name and logo. Read from the cache, which a save clears.
|
|
51717
|
+
* @summary Every delivery partner, by key
|
|
51718
|
+
* @param {*} [options] Override http request option.
|
|
51719
|
+
* @throws {RequiredError}
|
|
51720
|
+
*/
|
|
51721
|
+
listPartners(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PartnerDto>>>;
|
|
51045
51722
|
/**
|
|
51046
51723
|
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
51047
51724
|
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
@@ -51059,6 +51736,15 @@ export declare const OpsApiFp: (configuration?: Configuration) => {
|
|
|
51059
51736
|
* @throws {RequiredError}
|
|
51060
51737
|
*/
|
|
51061
51738
|
searchVenues(search: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VenueFoundDto>>>;
|
|
51739
|
+
/**
|
|
51740
|
+
* Creates the partner under the key, or changes the one there. The key itself never changes: orders keep it. A platform Munchi connected before the partner standard uses its channel name as key. The key is read in any case and saved as a platform\'s channel name (wolt as Wolt) or in lowercase (Fin-Delivery as fin-delivery); the answer\'s partner.key is the key saved. Only the fields sent change a partner already there. The directory\'s cache is cleared after the save.
|
|
51741
|
+
* @summary Add a delivery partner, or change its name, logo or active state
|
|
51742
|
+
* @param {string} key The partner\'s key
|
|
51743
|
+
* @param {UpsertPartnerDto} upsertPartnerDto
|
|
51744
|
+
* @param {*} [options] Override http request option.
|
|
51745
|
+
* @throws {RequiredError}
|
|
51746
|
+
*/
|
|
51747
|
+
upsertPartner(key: string, upsertPartnerDto: UpsertPartnerDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedPartnerDto>>;
|
|
51062
51748
|
};
|
|
51063
51749
|
/**
|
|
51064
51750
|
* OpsApi - factory interface
|
|
@@ -51091,6 +51777,13 @@ export declare const OpsApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
51091
51777
|
* @throws {RequiredError}
|
|
51092
51778
|
*/
|
|
51093
51779
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: any): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
51780
|
+
/**
|
|
51781
|
+
* The partner directory: every delivery platform Munchi works with, active or not, by key, with its name and logo. Read from the cache, which a save clears.
|
|
51782
|
+
* @summary Every delivery partner, by key
|
|
51783
|
+
* @param {*} [options] Override http request option.
|
|
51784
|
+
* @throws {RequiredError}
|
|
51785
|
+
*/
|
|
51786
|
+
listPartners(options?: any): AxiosPromise<Array<PartnerDto>>;
|
|
51094
51787
|
/**
|
|
51095
51788
|
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
51096
51789
|
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
@@ -51108,6 +51801,15 @@ export declare const OpsApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
51108
51801
|
* @throws {RequiredError}
|
|
51109
51802
|
*/
|
|
51110
51803
|
searchVenues(search: string, limit?: number, options?: any): AxiosPromise<Array<VenueFoundDto>>;
|
|
51804
|
+
/**
|
|
51805
|
+
* Creates the partner under the key, or changes the one there. The key itself never changes: orders keep it. A platform Munchi connected before the partner standard uses its channel name as key. The key is read in any case and saved as a platform\'s channel name (wolt as Wolt) or in lowercase (Fin-Delivery as fin-delivery); the answer\'s partner.key is the key saved. Only the fields sent change a partner already there. The directory\'s cache is cleared after the save.
|
|
51806
|
+
* @summary Add a delivery partner, or change its name, logo or active state
|
|
51807
|
+
* @param {string} key The partner\'s key
|
|
51808
|
+
* @param {UpsertPartnerDto} upsertPartnerDto
|
|
51809
|
+
* @param {*} [options] Override http request option.
|
|
51810
|
+
* @throws {RequiredError}
|
|
51811
|
+
*/
|
|
51812
|
+
upsertPartner(key: string, upsertPartnerDto: UpsertPartnerDto, options?: any): AxiosPromise<SavedPartnerDto>;
|
|
51111
51813
|
};
|
|
51112
51814
|
/**
|
|
51113
51815
|
* OpsApi - interface
|
|
@@ -51144,6 +51846,14 @@ export interface OpsApiInterface {
|
|
|
51144
51846
|
* @memberof OpsApiInterface
|
|
51145
51847
|
*/
|
|
51146
51848
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
51849
|
+
/**
|
|
51850
|
+
* The partner directory: every delivery platform Munchi works with, active or not, by key, with its name and logo. Read from the cache, which a save clears.
|
|
51851
|
+
* @summary Every delivery partner, by key
|
|
51852
|
+
* @param {*} [options] Override http request option.
|
|
51853
|
+
* @throws {RequiredError}
|
|
51854
|
+
* @memberof OpsApiInterface
|
|
51855
|
+
*/
|
|
51856
|
+
listPartners(options?: AxiosRequestConfig): AxiosPromise<Array<PartnerDto>>;
|
|
51147
51857
|
/**
|
|
51148
51858
|
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
51149
51859
|
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
@@ -51163,6 +51873,16 @@ export interface OpsApiInterface {
|
|
|
51163
51873
|
* @memberof OpsApiInterface
|
|
51164
51874
|
*/
|
|
51165
51875
|
searchVenues(search: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<Array<VenueFoundDto>>;
|
|
51876
|
+
/**
|
|
51877
|
+
* Creates the partner under the key, or changes the one there. The key itself never changes: orders keep it. A platform Munchi connected before the partner standard uses its channel name as key. The key is read in any case and saved as a platform\'s channel name (wolt as Wolt) or in lowercase (Fin-Delivery as fin-delivery); the answer\'s partner.key is the key saved. Only the fields sent change a partner already there. The directory\'s cache is cleared after the save.
|
|
51878
|
+
* @summary Add a delivery partner, or change its name, logo or active state
|
|
51879
|
+
* @param {string} key The partner\'s key
|
|
51880
|
+
* @param {UpsertPartnerDto} upsertPartnerDto
|
|
51881
|
+
* @param {*} [options] Override http request option.
|
|
51882
|
+
* @throws {RequiredError}
|
|
51883
|
+
* @memberof OpsApiInterface
|
|
51884
|
+
*/
|
|
51885
|
+
upsertPartner(key: string, upsertPartnerDto: UpsertPartnerDto, options?: AxiosRequestConfig): AxiosPromise<SavedPartnerDto>;
|
|
51166
51886
|
}
|
|
51167
51887
|
/**
|
|
51168
51888
|
* OpsApi - object-oriented interface
|
|
@@ -51200,6 +51920,14 @@ export declare class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
|
51200
51920
|
* @memberof OpsApi
|
|
51201
51921
|
*/
|
|
51202
51922
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DisconnectedDeliveryPlatformDto, any, {}>>;
|
|
51923
|
+
/**
|
|
51924
|
+
* The partner directory: every delivery platform Munchi works with, active or not, by key, with its name and logo. Read from the cache, which a save clears.
|
|
51925
|
+
* @summary Every delivery partner, by key
|
|
51926
|
+
* @param {*} [options] Override http request option.
|
|
51927
|
+
* @throws {RequiredError}
|
|
51928
|
+
* @memberof OpsApi
|
|
51929
|
+
*/
|
|
51930
|
+
listPartners(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerDto[], any, {}>>;
|
|
51203
51931
|
/**
|
|
51204
51932
|
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
51205
51933
|
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
@@ -51219,6 +51947,16 @@ export declare class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
|
51219
51947
|
* @memberof OpsApi
|
|
51220
51948
|
*/
|
|
51221
51949
|
searchVenues(search: string, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueFoundDto[], any, {}>>;
|
|
51950
|
+
/**
|
|
51951
|
+
* Creates the partner under the key, or changes the one there. The key itself never changes: orders keep it. A platform Munchi connected before the partner standard uses its channel name as key. The key is read in any case and saved as a platform\'s channel name (wolt as Wolt) or in lowercase (Fin-Delivery as fin-delivery); the answer\'s partner.key is the key saved. Only the fields sent change a partner already there. The directory\'s cache is cleared after the save.
|
|
51952
|
+
* @summary Add a delivery partner, or change its name, logo or active state
|
|
51953
|
+
* @param {string} key The partner\'s key
|
|
51954
|
+
* @param {UpsertPartnerDto} upsertPartnerDto
|
|
51955
|
+
* @param {*} [options] Override http request option.
|
|
51956
|
+
* @throws {RequiredError}
|
|
51957
|
+
* @memberof OpsApi
|
|
51958
|
+
*/
|
|
51959
|
+
upsertPartner(key: string, upsertPartnerDto: UpsertPartnerDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedPartnerDto, any, {}>>;
|
|
51222
51960
|
}
|
|
51223
51961
|
/**
|
|
51224
51962
|
* OrderCompletionApi - axios parameter creator
|
|
@@ -53620,6 +54358,15 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53620
54358
|
* @throws {RequiredError}
|
|
53621
54359
|
*/
|
|
53622
54360
|
initiateNetsSession: (initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54361
|
+
/**
|
|
54362
|
+
* Stores a DISPATCHED Nexi session for a sale the device\'s own payment app (Poynt, on the Newland N950) will take. Its sessionId is the reference the payment app is given; the device then reports the app\'s answer to nexi/on-device/result, and the server writes the order. Refused for a venue whose channel does not pay by Nexi. Nexi is not called, nothing follows the session, and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
54363
|
+
* @summary Start a Nexi sale on the device\'s own card reader
|
|
54364
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
54365
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. A key this venue\'s on-device sale already holds answers that sale as it stands; a key any other payment holds is refused.
|
|
54366
|
+
* @param {*} [options] Override http request option.
|
|
54367
|
+
* @throws {RequiredError}
|
|
54368
|
+
*/
|
|
54369
|
+
initiateNexiOnDeviceSession: (initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53623
54370
|
/**
|
|
53624
54371
|
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
53625
54372
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
@@ -53713,6 +54460,14 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53713
54460
|
* @throws {RequiredError}
|
|
53714
54461
|
*/
|
|
53715
54462
|
recordManualPayment: (createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54463
|
+
/**
|
|
54464
|
+
* Settles an on-device Nexi sale, refund or revert with Poynt\'s answer, decided by Poynt\'s payment status. COMPLETED makes a sale SUCCESS, REFUNDED makes a refund REFUNDED, VOIDED makes a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. DECLINED makes it FAILED (payment.declined), CANCELED makes it CANCELLED, FAILED makes it FAILED. A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference, except a decline or a cancel, which may come without one; a revert\'s names the sale\'s Poynt transaction as its transactionId or parentId. An approval may replace a failure or a cancel (a payment recovered after the app was killed); an end without money replaces only the wait. An answer that may have moved money but cannot be recorded (AUTHORIZED, HOLD, READ_CARD_ONLY, another kind\'s approval, a partial approval, several approvals, another amount or currency) is kept on the session, which stays DISPATCHED, ops are alerted, and the request is refused. A refund to another card than the sale\'s is recorded and logged. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
54465
|
+
* @summary Record the device\'s payment app answer for an on-device Nexi session
|
|
54466
|
+
* @param {RecordNexiOnDeviceResultDto} recordNexiOnDeviceResultDto
|
|
54467
|
+
* @param {*} [options] Override http request option.
|
|
54468
|
+
* @throws {RequiredError}
|
|
54469
|
+
*/
|
|
54470
|
+
recordNexiOnDeviceResult: (recordNexiOnDeviceResultDto: RecordNexiOnDeviceResultDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53716
54471
|
/**
|
|
53717
54472
|
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
53718
54473
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
@@ -53737,6 +54492,14 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53737
54492
|
* @throws {RequiredError}
|
|
53738
54493
|
*/
|
|
53739
54494
|
refundNetsSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54495
|
+
/**
|
|
54496
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. Only a sale the device\'s own card reader took is accepted. The device then makes the refund on its payment app with the card presented (Poynt\'s non-referenced refund) and the refund\'s sessionId as its reference, and reports the answer to nexi/on-device/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54497
|
+
* @summary Start a card refund of an on-device Nexi sale
|
|
54498
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54499
|
+
* @param {*} [options] Override http request option.
|
|
54500
|
+
* @throws {RequiredError}
|
|
54501
|
+
*/
|
|
54502
|
+
refundNexiOnDeviceSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53740
54503
|
/**
|
|
53741
54504
|
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
53742
54505
|
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
@@ -53786,6 +54549,14 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53786
54549
|
* @throws {RequiredError}
|
|
53787
54550
|
*/
|
|
53788
54551
|
revertNetsSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54552
|
+
/**
|
|
54553
|
+
* Stores a DISPATCHED reversal session for the whole sale. Only a sale the device\'s own card reader took is accepted. The device then voids the sale on its payment app with no card (Poynt\'s void, by the sale\'s transaction id, which is the payment event\'s id) and reports the answer, with the reversal\'s sessionId, to nexi/on-device/result; once VOIDED, reconciliation writes the reversal onto the order. The server alone decides whether the sale may still be voided: up to 55 minutes after the sale was started, never on a closed order, and never once the sale has refund activity. `amount` is ignored: a void gives back the whole sale. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54554
|
+
* @summary Start a revert (void) of an on-device Nexi sale
|
|
54555
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54556
|
+
* @param {*} [options] Override http request option.
|
|
54557
|
+
* @throws {RequiredError}
|
|
54558
|
+
*/
|
|
54559
|
+
revertNexiOnDeviceSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53789
54560
|
/**
|
|
53790
54561
|
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
53791
54562
|
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
@@ -53904,6 +54675,15 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
53904
54675
|
* @throws {RequiredError}
|
|
53905
54676
|
*/
|
|
53906
54677
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiateNetsSessionResponseDto>>;
|
|
54678
|
+
/**
|
|
54679
|
+
* Stores a DISPATCHED Nexi session for a sale the device\'s own payment app (Poynt, on the Newland N950) will take. Its sessionId is the reference the payment app is given; the device then reports the app\'s answer to nexi/on-device/result, and the server writes the order. Refused for a venue whose channel does not pay by Nexi. Nexi is not called, nothing follows the session, and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
54680
|
+
* @summary Start a Nexi sale on the device\'s own card reader
|
|
54681
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
54682
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. A key this venue\'s on-device sale already holds answers that sale as it stands; a key any other payment holds is refused.
|
|
54683
|
+
* @param {*} [options] Override http request option.
|
|
54684
|
+
* @throws {RequiredError}
|
|
54685
|
+
*/
|
|
54686
|
+
initiateNexiOnDeviceSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
53907
54687
|
/**
|
|
53908
54688
|
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
53909
54689
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
@@ -53997,6 +54777,14 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
53997
54777
|
* @throws {RequiredError}
|
|
53998
54778
|
*/
|
|
53999
54779
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>>;
|
|
54780
|
+
/**
|
|
54781
|
+
* Settles an on-device Nexi sale, refund or revert with Poynt\'s answer, decided by Poynt\'s payment status. COMPLETED makes a sale SUCCESS, REFUNDED makes a refund REFUNDED, VOIDED makes a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. DECLINED makes it FAILED (payment.declined), CANCELED makes it CANCELLED, FAILED makes it FAILED. A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference, except a decline or a cancel, which may come without one; a revert\'s names the sale\'s Poynt transaction as its transactionId or parentId. An approval may replace a failure or a cancel (a payment recovered after the app was killed); an end without money replaces only the wait. An answer that may have moved money but cannot be recorded (AUTHORIZED, HOLD, READ_CARD_ONLY, another kind\'s approval, a partial approval, several approvals, another amount or currency) is kept on the session, which stays DISPATCHED, ops are alerted, and the request is refused. A refund to another card than the sale\'s is recorded and logged. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
54782
|
+
* @summary Record the device\'s payment app answer for an on-device Nexi session
|
|
54783
|
+
* @param {RecordNexiOnDeviceResultDto} recordNexiOnDeviceResultDto
|
|
54784
|
+
* @param {*} [options] Override http request option.
|
|
54785
|
+
* @throws {RequiredError}
|
|
54786
|
+
*/
|
|
54787
|
+
recordNexiOnDeviceResult(recordNexiOnDeviceResultDto: RecordNexiOnDeviceResultDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NexiOnDeviceResultViewDto>>;
|
|
54000
54788
|
/**
|
|
54001
54789
|
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
54002
54790
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
@@ -54021,6 +54809,14 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
54021
54809
|
* @throws {RequiredError}
|
|
54022
54810
|
*/
|
|
54023
54811
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54812
|
+
/**
|
|
54813
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. Only a sale the device\'s own card reader took is accepted. The device then makes the refund on its payment app with the card presented (Poynt\'s non-referenced refund) and the refund\'s sessionId as its reference, and reports the answer to nexi/on-device/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54814
|
+
* @summary Start a card refund of an on-device Nexi sale
|
|
54815
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54816
|
+
* @param {*} [options] Override http request option.
|
|
54817
|
+
* @throws {RequiredError}
|
|
54818
|
+
*/
|
|
54819
|
+
refundNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54024
54820
|
/**
|
|
54025
54821
|
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54026
54822
|
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
@@ -54070,6 +54866,14 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
54070
54866
|
* @throws {RequiredError}
|
|
54071
54867
|
*/
|
|
54072
54868
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetsRevertResponseDto>>;
|
|
54869
|
+
/**
|
|
54870
|
+
* Stores a DISPATCHED reversal session for the whole sale. Only a sale the device\'s own card reader took is accepted. The device then voids the sale on its payment app with no card (Poynt\'s void, by the sale\'s transaction id, which is the payment event\'s id) and reports the answer, with the reversal\'s sessionId, to nexi/on-device/result; once VOIDED, reconciliation writes the reversal onto the order. The server alone decides whether the sale may still be voided: up to 55 minutes after the sale was started, never on a closed order, and never once the sale has refund activity. `amount` is ignored: a void gives back the whole sale. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54871
|
+
* @summary Start a revert (void) of an on-device Nexi sale
|
|
54872
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54873
|
+
* @param {*} [options] Override http request option.
|
|
54874
|
+
* @throws {RequiredError}
|
|
54875
|
+
*/
|
|
54876
|
+
revertNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54073
54877
|
/**
|
|
54074
54878
|
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54075
54879
|
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
@@ -54188,6 +54992,15 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54188
54992
|
* @throws {RequiredError}
|
|
54189
54993
|
*/
|
|
54190
54994
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
54995
|
+
/**
|
|
54996
|
+
* Stores a DISPATCHED Nexi session for a sale the device\'s own payment app (Poynt, on the Newland N950) will take. Its sessionId is the reference the payment app is given; the device then reports the app\'s answer to nexi/on-device/result, and the server writes the order. Refused for a venue whose channel does not pay by Nexi. Nexi is not called, nothing follows the session, and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
54997
|
+
* @summary Start a Nexi sale on the device\'s own card reader
|
|
54998
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
54999
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. A key this venue\'s on-device sale already holds answers that sale as it stands; a key any other payment holds is refused.
|
|
55000
|
+
* @param {*} [options] Override http request option.
|
|
55001
|
+
* @throws {RequiredError}
|
|
55002
|
+
*/
|
|
55003
|
+
initiateNexiOnDeviceSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
54191
55004
|
/**
|
|
54192
55005
|
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
54193
55006
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
@@ -54281,6 +55094,14 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54281
55094
|
* @throws {RequiredError}
|
|
54282
55095
|
*/
|
|
54283
55096
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<RecordManualPaymentResultDto>;
|
|
55097
|
+
/**
|
|
55098
|
+
* Settles an on-device Nexi sale, refund or revert with Poynt\'s answer, decided by Poynt\'s payment status. COMPLETED makes a sale SUCCESS, REFUNDED makes a refund REFUNDED, VOIDED makes a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. DECLINED makes it FAILED (payment.declined), CANCELED makes it CANCELLED, FAILED makes it FAILED. A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference, except a decline or a cancel, which may come without one; a revert\'s names the sale\'s Poynt transaction as its transactionId or parentId. An approval may replace a failure or a cancel (a payment recovered after the app was killed); an end without money replaces only the wait. An answer that may have moved money but cannot be recorded (AUTHORIZED, HOLD, READ_CARD_ONLY, another kind\'s approval, a partial approval, several approvals, another amount or currency) is kept on the session, which stays DISPATCHED, ops are alerted, and the request is refused. A refund to another card than the sale\'s is recorded and logged. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
55099
|
+
* @summary Record the device\'s payment app answer for an on-device Nexi session
|
|
55100
|
+
* @param {RecordNexiOnDeviceResultDto} recordNexiOnDeviceResultDto
|
|
55101
|
+
* @param {*} [options] Override http request option.
|
|
55102
|
+
* @throws {RequiredError}
|
|
55103
|
+
*/
|
|
55104
|
+
recordNexiOnDeviceResult(recordNexiOnDeviceResultDto: RecordNexiOnDeviceResultDto, options?: any): AxiosPromise<NexiOnDeviceResultViewDto>;
|
|
54284
55105
|
/**
|
|
54285
55106
|
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
54286
55107
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
@@ -54305,6 +55126,14 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54305
55126
|
* @throws {RequiredError}
|
|
54306
55127
|
*/
|
|
54307
55128
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
55129
|
+
/**
|
|
55130
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. Only a sale the device\'s own card reader took is accepted. The device then makes the refund on its payment app with the card presented (Poynt\'s non-referenced refund) and the refund\'s sessionId as its reference, and reports the answer to nexi/on-device/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55131
|
+
* @summary Start a card refund of an on-device Nexi sale
|
|
55132
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55133
|
+
* @param {*} [options] Override http request option.
|
|
55134
|
+
* @throws {RequiredError}
|
|
55135
|
+
*/
|
|
55136
|
+
refundNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
54308
55137
|
/**
|
|
54309
55138
|
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54310
55139
|
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
@@ -54354,6 +55183,14 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54354
55183
|
* @throws {RequiredError}
|
|
54355
55184
|
*/
|
|
54356
55185
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<NetsRevertResponseDto>;
|
|
55186
|
+
/**
|
|
55187
|
+
* Stores a DISPATCHED reversal session for the whole sale. Only a sale the device\'s own card reader took is accepted. The device then voids the sale on its payment app with no card (Poynt\'s void, by the sale\'s transaction id, which is the payment event\'s id) and reports the answer, with the reversal\'s sessionId, to nexi/on-device/result; once VOIDED, reconciliation writes the reversal onto the order. The server alone decides whether the sale may still be voided: up to 55 minutes after the sale was started, never on a closed order, and never once the sale has refund activity. `amount` is ignored: a void gives back the whole sale. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55188
|
+
* @summary Start a revert (void) of an on-device Nexi sale
|
|
55189
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55190
|
+
* @param {*} [options] Override http request option.
|
|
55191
|
+
* @throws {RequiredError}
|
|
55192
|
+
*/
|
|
55193
|
+
revertNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
54357
55194
|
/**
|
|
54358
55195
|
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54359
55196
|
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
@@ -54480,6 +55317,16 @@ export interface PaymentSessionApiInterface {
|
|
|
54480
55317
|
* @memberof PaymentSessionApiInterface
|
|
54481
55318
|
*/
|
|
54482
55319
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
55320
|
+
/**
|
|
55321
|
+
* Stores a DISPATCHED Nexi session for a sale the device\'s own payment app (Poynt, on the Newland N950) will take. Its sessionId is the reference the payment app is given; the device then reports the app\'s answer to nexi/on-device/result, and the server writes the order. Refused for a venue whose channel does not pay by Nexi. Nexi is not called, nothing follows the session, and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
55322
|
+
* @summary Start a Nexi sale on the device\'s own card reader
|
|
55323
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
55324
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. A key this venue\'s on-device sale already holds answers that sale as it stands; a key any other payment holds is refused.
|
|
55325
|
+
* @param {*} [options] Override http request option.
|
|
55326
|
+
* @throws {RequiredError}
|
|
55327
|
+
* @memberof PaymentSessionApiInterface
|
|
55328
|
+
*/
|
|
55329
|
+
initiateNexiOnDeviceSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
54483
55330
|
/**
|
|
54484
55331
|
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
54485
55332
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
@@ -54584,6 +55431,15 @@ export interface PaymentSessionApiInterface {
|
|
|
54584
55431
|
* @memberof PaymentSessionApiInterface
|
|
54585
55432
|
*/
|
|
54586
55433
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
55434
|
+
/**
|
|
55435
|
+
* Settles an on-device Nexi sale, refund or revert with Poynt\'s answer, decided by Poynt\'s payment status. COMPLETED makes a sale SUCCESS, REFUNDED makes a refund REFUNDED, VOIDED makes a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. DECLINED makes it FAILED (payment.declined), CANCELED makes it CANCELLED, FAILED makes it FAILED. A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference, except a decline or a cancel, which may come without one; a revert\'s names the sale\'s Poynt transaction as its transactionId or parentId. An approval may replace a failure or a cancel (a payment recovered after the app was killed); an end without money replaces only the wait. An answer that may have moved money but cannot be recorded (AUTHORIZED, HOLD, READ_CARD_ONLY, another kind\'s approval, a partial approval, several approvals, another amount or currency) is kept on the session, which stays DISPATCHED, ops are alerted, and the request is refused. A refund to another card than the sale\'s is recorded and logged. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
55436
|
+
* @summary Record the device\'s payment app answer for an on-device Nexi session
|
|
55437
|
+
* @param {RecordNexiOnDeviceResultDto} recordNexiOnDeviceResultDto
|
|
55438
|
+
* @param {*} [options] Override http request option.
|
|
55439
|
+
* @throws {RequiredError}
|
|
55440
|
+
* @memberof PaymentSessionApiInterface
|
|
55441
|
+
*/
|
|
55442
|
+
recordNexiOnDeviceResult(recordNexiOnDeviceResultDto: RecordNexiOnDeviceResultDto, options?: AxiosRequestConfig): AxiosPromise<NexiOnDeviceResultViewDto>;
|
|
54587
55443
|
/**
|
|
54588
55444
|
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
54589
55445
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
@@ -54611,6 +55467,15 @@ export interface PaymentSessionApiInterface {
|
|
|
54611
55467
|
* @memberof PaymentSessionApiInterface
|
|
54612
55468
|
*/
|
|
54613
55469
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
55470
|
+
/**
|
|
55471
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. Only a sale the device\'s own card reader took is accepted. The device then makes the refund on its payment app with the card presented (Poynt\'s non-referenced refund) and the refund\'s sessionId as its reference, and reports the answer to nexi/on-device/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55472
|
+
* @summary Start a card refund of an on-device Nexi sale
|
|
55473
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55474
|
+
* @param {*} [options] Override http request option.
|
|
55475
|
+
* @throws {RequiredError}
|
|
55476
|
+
* @memberof PaymentSessionApiInterface
|
|
55477
|
+
*/
|
|
55478
|
+
refundNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
54614
55479
|
/**
|
|
54615
55480
|
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54616
55481
|
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
@@ -54666,6 +55531,15 @@ export interface PaymentSessionApiInterface {
|
|
|
54666
55531
|
* @memberof PaymentSessionApiInterface
|
|
54667
55532
|
*/
|
|
54668
55533
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<NetsRevertResponseDto>;
|
|
55534
|
+
/**
|
|
55535
|
+
* Stores a DISPATCHED reversal session for the whole sale. Only a sale the device\'s own card reader took is accepted. The device then voids the sale on its payment app with no card (Poynt\'s void, by the sale\'s transaction id, which is the payment event\'s id) and reports the answer, with the reversal\'s sessionId, to nexi/on-device/result; once VOIDED, reconciliation writes the reversal onto the order. The server alone decides whether the sale may still be voided: up to 55 minutes after the sale was started, never on a closed order, and never once the sale has refund activity. `amount` is ignored: a void gives back the whole sale. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55536
|
+
* @summary Start a revert (void) of an on-device Nexi sale
|
|
55537
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55538
|
+
* @param {*} [options] Override http request option.
|
|
55539
|
+
* @throws {RequiredError}
|
|
55540
|
+
* @memberof PaymentSessionApiInterface
|
|
55541
|
+
*/
|
|
55542
|
+
revertNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
54669
55543
|
/**
|
|
54670
55544
|
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54671
55545
|
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
@@ -54799,6 +55673,16 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54799
55673
|
* @memberof PaymentSessionApi
|
|
54800
55674
|
*/
|
|
54801
55675
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateNetsSessionResponseDto, any, {}>>;
|
|
55676
|
+
/**
|
|
55677
|
+
* Stores a DISPATCHED Nexi session for a sale the device\'s own payment app (Poynt, on the Newland N950) will take. Its sessionId is the reference the payment app is given; the device then reports the app\'s answer to nexi/on-device/result, and the server writes the order. Refused for a venue whose channel does not pay by Nexi. Nexi is not called, nothing follows the session, and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
55678
|
+
* @summary Start a Nexi sale on the device\'s own card reader
|
|
55679
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
55680
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. A key this venue\'s on-device sale already holds answers that sale as it stands; a key any other payment holds is refused.
|
|
55681
|
+
* @param {*} [options] Override http request option.
|
|
55682
|
+
* @throws {RequiredError}
|
|
55683
|
+
* @memberof PaymentSessionApi
|
|
55684
|
+
*/
|
|
55685
|
+
initiateNexiOnDeviceSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
54802
55686
|
/**
|
|
54803
55687
|
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
54804
55688
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
@@ -54903,6 +55787,15 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54903
55787
|
* @memberof PaymentSessionApi
|
|
54904
55788
|
*/
|
|
54905
55789
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecordManualPaymentResultDto, any, {}>>;
|
|
55790
|
+
/**
|
|
55791
|
+
* Settles an on-device Nexi sale, refund or revert with Poynt\'s answer, decided by Poynt\'s payment status. COMPLETED makes a sale SUCCESS, REFUNDED makes a refund REFUNDED, VOIDED makes a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. DECLINED makes it FAILED (payment.declined), CANCELED makes it CANCELLED, FAILED makes it FAILED. A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference, except a decline or a cancel, which may come without one; a revert\'s names the sale\'s Poynt transaction as its transactionId or parentId. An approval may replace a failure or a cancel (a payment recovered after the app was killed); an end without money replaces only the wait. An answer that may have moved money but cannot be recorded (AUTHORIZED, HOLD, READ_CARD_ONLY, another kind\'s approval, a partial approval, several approvals, another amount or currency) is kept on the session, which stays DISPATCHED, ops are alerted, and the request is refused. A refund to another card than the sale\'s is recorded and logged. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
55792
|
+
* @summary Record the device\'s payment app answer for an on-device Nexi session
|
|
55793
|
+
* @param {RecordNexiOnDeviceResultDto} recordNexiOnDeviceResultDto
|
|
55794
|
+
* @param {*} [options] Override http request option.
|
|
55795
|
+
* @throws {RequiredError}
|
|
55796
|
+
* @memberof PaymentSessionApi
|
|
55797
|
+
*/
|
|
55798
|
+
recordNexiOnDeviceResult(recordNexiOnDeviceResultDto: RecordNexiOnDeviceResultDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NexiOnDeviceResultViewDto, any, {}>>;
|
|
54906
55799
|
/**
|
|
54907
55800
|
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
54908
55801
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
@@ -54930,6 +55823,15 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54930
55823
|
* @memberof PaymentSessionApi
|
|
54931
55824
|
*/
|
|
54932
55825
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
55826
|
+
/**
|
|
55827
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. Only a sale the device\'s own card reader took is accepted. The device then makes the refund on its payment app with the card presented (Poynt\'s non-referenced refund) and the refund\'s sessionId as its reference, and reports the answer to nexi/on-device/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55828
|
+
* @summary Start a card refund of an on-device Nexi sale
|
|
55829
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55830
|
+
* @param {*} [options] Override http request option.
|
|
55831
|
+
* @throws {RequiredError}
|
|
55832
|
+
* @memberof PaymentSessionApi
|
|
55833
|
+
*/
|
|
55834
|
+
refundNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
54933
55835
|
/**
|
|
54934
55836
|
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54935
55837
|
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
@@ -54985,6 +55887,15 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54985
55887
|
* @memberof PaymentSessionApi
|
|
54986
55888
|
*/
|
|
54987
55889
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NetsRevertResponseDto, any, {}>>;
|
|
55890
|
+
/**
|
|
55891
|
+
* Stores a DISPATCHED reversal session for the whole sale. Only a sale the device\'s own card reader took is accepted. The device then voids the sale on its payment app with no card (Poynt\'s void, by the sale\'s transaction id, which is the payment event\'s id) and reports the answer, with the reversal\'s sessionId, to nexi/on-device/result; once VOIDED, reconciliation writes the reversal onto the order. The server alone decides whether the sale may still be voided: up to 55 minutes after the sale was started, never on a closed order, and never once the sale has refund activity. `amount` is ignored: a void gives back the whole sale. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
55892
|
+
* @summary Start a revert (void) of an on-device Nexi sale
|
|
55893
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
55894
|
+
* @param {*} [options] Override http request option.
|
|
55895
|
+
* @throws {RequiredError}
|
|
55896
|
+
* @memberof PaymentSessionApi
|
|
55897
|
+
*/
|
|
55898
|
+
revertNexiOnDeviceSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
54988
55899
|
/**
|
|
54989
55900
|
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
54990
55901
|
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|