Skip to content

API · payment ​

Trang sinh tự động

Parse từ schema.graphql (SDL backend export) bằng parser graphql. Mô tả và quyền lấy nguyên văn từ description trong SDL.

17 query · 17 mutation.

Query ​

cancellationDecision ​

Chưa có description trong SDL.

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
orderIdID!

Trả về CancellationDecision!

FieldKiểuMô tả
idID!
orderIdID!
campaignTypeCampaignType!
causeCancellationCause!
timingCancellationTiming!
policyVersionString!Interim policy version the decision was taken under.
outcomeCancellationOutcome!
cashDispositionString!REFUND_ALL_CAPTURES | KEEP_DEPOSIT | UNDECIDED
pointsDispositionString!REVERSE_ALL_ORIGINAL_REDEEM | KEEP_USED | UNDECIDED
policyRefStringThe open decision / gap when the outcome is POLICY_UNDECIDED.
basis[String!]!Source rule ids the decision rests on.
refundCaseIdID
refundableCashVndVndAmountFrom the refund case, when one exists (sum of the original captures).
pointsToReversePointAmountFrom the refund case, when one exists (entire original REDEEM).
heldCashVndVndAmountFORFEIT only: the captured cash that is kept.
heldPointsPointAmountFORFEIT only: the redeemed points that are kept.
retainedCycleCountInt!
retainedDeliveries[RetainedDelivery!]!
decidedAtDateTime!

cashbookEntries ​

Automatic receipts and reversals, latest first. Requires cashbook.read (RCP-01, Finance).

query · quyền: cashbook.read

Tham sốKiểuMặc địnhMô tả
orderIdID
entryTypeCashbookEntryType
obligationKindCashbookObligationKind
fromDateTime
toDateTime
pageInt
pageSizeInt

Trả về CashbookEntryPage!

FieldKiểuMô tả
items[CashbookEntry!]!
pageInt!
pageSizeInt!
totalInt!

cashbookFundView ​

Read-only deposit-fund view; model-governed figures are POLICY_UNDECIDED. Requires cashbook.read.

query · quyền: cashbook.read

Tham sốKiểuMặc địnhMô tả
fromDateTime
toDateTime

Trả về CashbookFundView!

FieldKiểuMô tả
fromDateTime
toDateTime
modelDecisionFundFigureStatus!Deposit/remaining receipt sums are sourced facts; the four fund figures need the model.
modelReasonString!NO_APPROVED_VERSION or APPROVED_MODEL_NOT_BUILT.
lines[CashbookFundLine!]!
heldFundFigure!
appliedFundFigure!
refundedFundFigure!
forfeitedFundFigure!

codCollection ​

One COD collection with its evidence. Requires payment.read (Finance).

query · quyền: payment.read

Tham sốKiểuMặc địnhMô tả
idID!

Trả về CodCollection!

FieldKiểuMô tả
idID!
obligationIdID!
orderIdID!
orderCodeString!#298 business order code (temporary format, NEW-SL-12).
orderCycleIdID
cycleNoInt
statusCodStatus!
versionInt!
amountDueVndVndAmount!
shipmentIdID
collectorCarrierCodeString
assignedAtDateTime
deliveredAtDateTime
collectionCodCollectionEvidenceSet once; may arrive before delivery (kept until delivered).
completedAtDateTimeWhen delivered AND collected both held.
remittanceCodRemittance
awaitingRemittanceBoolean!COLLECTED without remittance evidence (no deadline is sourced).
updatedAtDateTime!

codCollections ​

COD collections, latest change first. Requires payment.read (Finance).

query · quyền: payment.read

Tham sốKiểuMặc địnhMô tả
statusCodStatus
orderIdID
pageInt
pageSizeInt

Trả về CodCollectionPage!

FieldKiểuMô tả
items[CodCollection!]!
pageInt!
pageSizeInt!
totalInt!

codReconciliation ​

PRC-01 reconcile.read (Finance): every COD run version of one VN date, newest first.

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
runDateString!

Trả về [CodReconciliationRun!]!

FieldKiểuMô tả
idID!
runDateString!VN business date YYYY-MM-DD; the window is exactly that VN day.
runVersionInt!
triggerKindString!SCHEDULED or RERUN
statusPaymentReconciliationRunStatus!
sourceStatusSourceStatus!READY only when COMPLETE; INCOMPLETE/UNKNOWN never mean zero.
windowStartDateTime!
windowEndDateTime!
startedAtDateTime!
finishedAtDateTime
errorCodeString
datasetHashStringSHA-256 hex of the COD dataset the run read (COMPLETE only).
rowsConsideredInt
totalsCodReconciliationTotals
items[CodDiscrepancy!]!
gaps[CodRemittanceGap!]!

funds ​

The funds vouchers may use: the cash fund and one per company bank account (VCH-01).

query · SDL không ghi quyền

Không có tham số.

Trả về [Fund!]!

FieldKiểuMô tả
codeString!
kindFundKind!
nameString!
bankNameStringBANK only.
accountTailStringBANK only: the last 4 to 6 digits of the account number, never the whole number.
statusFundStatus!

momoReconciliation ​

PRC-01 reconcile.read (Finance): every run version of one VN date, newest first.

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
runDateString!

Trả về [PaymentReconciliationRun!]!

FieldKiểuMô tả
idID!
providerString!
providerModeString!MOCK only until G-FIN (DEC-FIN-MOMO-LIVE).
runDateString!VN business date YYYY-MM-DD; the window is exactly that VN day.
runVersionInt!
triggerKindString!SCHEDULED or RERUN
statusPaymentReconciliationRunStatus!
sourceStatusSourceStatus!READY only when COMPLETE; INCOMPLETE/UNKNOWN never mean zero.
windowStartDateTime!
windowEndDateTime!
startedAtDateTime!
finishedAtDateTime
errorCodeString
datasetHashStringSHA-256 hex of the provider dataset (COMPLETE only).
totals[PaymentReconciliationTotal!]!Empty unless COMPLETE.
matchedCountInt
unknownCarriedOverInt
items[PaymentDiscrepancy!]!

orderPayments ​

payment.read (F-01 Finance): the tenders, transactions, allocations and periods of one order.

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
orderIdID!

Trả về OrderPaymentView!

FieldKiểuMô tả
orderIdID!
orderCodeString#298 business order code (temporary format, NEW-SL-12); null for an id that is no visible order.
tenders[OrderPaymentTender!]!
periods[OrderPaymentPeriod!]!
totalVndVndAmount
paidVndVndAmount
refundedVndVndAmount
remainingVndVndAmount

paymentObligations ​

payment.read (F-01 Finance): every payment obligation, newest first.

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
filterPaymentObligationFilter
pageInt
pageSizeInt

Trả về PaymentObligationPage!

FieldKiểuMô tả
items[PaymentObligationRow!]!
pageInt!
pageSizeInt!
totalInt!

paymentsNeedingAttention ​

payment.read (F-01 Finance): payments that need a person (#479). Read only.

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
kindPaymentAttentionKind
pageInt
pageSizeInt

Trả về PaymentAttentionPage!

FieldKiểuMô tả
items[PaymentAttentionItem!]!Oldest first.
pageInt!
pageSizeInt!
totalInt!Rows of the requested kind (all kinds without a filter), all pages.
unknownCountInt!
needsReviewCountInt!
compensationRejectedCountInt!
eventConflictCountInt!
holdReleaseFailedCountInt!
unknownAfterMinutesInt!An UNKNOWN attempt is listed once it is this old (PAYMENT_ATTENTION_UNKNOWN_AFTER_MINUTES, default 30).

paymentTransactions ​

payment.read (F-01 Finance): provider captures and refunds with their attempt and obligation, newest first.

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
filterPaymentTransactionFilter
pageInt
pageSizeInt

Trả về PaymentTransactionPage!

FieldKiểuMô tả
items[PaymentTransactionRow!]!
pageInt!
pageSizeInt!
totalInt!

refundCase ​

One refund case with its legs and history. Requires refund.read (RFD-01).

query · quyền: refund.read

Tham sốKiểuMặc địnhMô tả
idID!

Trả về RefundCase!

FieldKiểuMô tả
idID!
orderIdID!
orderCodeString!#298 business order code (temporary format, NEW-SL-12).
buyerIdID!
originRefundOrigin!
sourceRefundSource!COD_REFUSAL when a refused COD opened this MANUAL case, else the origin.
caseTypeString!FULL_REFUND (forfeiture is not a refund case: a FORFEITED order is refused) or PARTIAL_REFUND (FU-575, DEC-CP-SHORTAGE: the share of a partial shortage, origin SHORTAGE; FU-FORFEIT: the share of one forfeited Recurring cycle, origin FORFEIT); #479 B: NO_REFUND (origin RETURN: nothing refunded, keptCashVnd / keptPoints kept); #479 C: EXCESS_REFUND (origin EXCESS_DEPOSIT).
scopeString!FULL_ORDER (the whole refundable remainder of the order) or PARTIAL_UNITS (exactly the stored share of the cancelled units); no partial amount can be requested. #479 B: RETURNED_ORDER (a Mua chung return) or RETURNED_CYCLE (one Mua định kỳ cycle, returnCycleNo); #479 C: EXCESS_DEPOSIT.
statusRefundCaseStatus!
progressRefundProgress!
versionInt!
approvalRequiredBoolean!
requestedByID
requestReasonString
refundableCashVndVndAmount!Sum of the cash legs (every collected capture's refundable remainder; the deposit share for PARTIAL_UNITS).
pointsToReversePointAmount!Sum of the point legs (every original REDEEM's unreversed points; the points share for PARTIAL_UNITS).
decidedByID
decidedAtDateTime
decisionNoteString
thresholdPolicyVersionIdID
evidenceMediaIds[ID!]!
ruleVersions[String!]!
completedAtDateTime
returnCycleNoInt#479 B (origin RETURN): the returned Mua định kỳ cycle; null for a Mua chung return and every other case.
returnedOnString#479 B (origin RETURN): day of the return, YYYY-MM-DD (Vietnam); null otherwise.
keptCashVndVndAmount#479 B (origin RETURN): cash of the unit the shop keeps (NO_REFUND: everything paid); null otherwise.
keptPointsPointAmount#479 B (origin RETURN): Pi-Point of the unit not given back; null otherwise.
opsNoteString#479 B (origin RETURN): internal Operations note; null when none. requestReason holds the reason.
overpaymentCaseIdID#479 C (origin EXCESS_DEPOSIT): the cọc dư case this claim refunds; null otherwise.
createdAtDateTime!
updatedAtDateTime!
branches[RefundLeg!]!
history[RefundHistoryEntry!]!
profileReadyBoolean!True when the customer sent a receiver profile. A transfer cannot be recorded before.
receiverProfileRefundReceiverProfileMasked; null unless the caller holds order.refund.process (NFR #5).
transferRecordRefundTransferRecord
cancelledAtDateTimeWhen the order was cancelled (null when unknown).
cancelReasonStringCause code of the cancellation decision (CAMPAIGN_FAILED, BUYER_PRE_CLOSE, SHORTAGE, FORFEITURE), null when unknown. No free text.
cancelReasonCodeOrderCancelReasonCodeG2I-P1-03 (O5, #371): the reason code the buyer picked when cancelling the order; null for any other cancellation or none.
cancelNoteStringG2I-P1-03: the buyer's own words when cancelling (staff only); null when none.

refundCases ​

Refund cases, newest first. Requires refund.read (RFD-01, Finance). orderCode (#479): exact business order code, any letter case; an unknown code matches nothing.

query · quyền: refund.read

Tham sốKiểuMặc địnhMô tả
statusRefundCaseStatus
orderIdID
orderCodeString
pageInt
pageSizeInt

Trả về RefundCasePage!

FieldKiểuMô tả
items[RefundCase!]!
pageInt!
pageSizeInt!
totalInt!

unappliedPayments ​

PRC-01 reconcile.read (Finance): captured money not applied to an obligation. Read only (GAP-149 / GAP-1620).

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
reasonUnappliedPaymentReason
stateUnappliedPaymentState
intentIdID#479: only the captures of this payment attempt (PaymentIntent id).
limitInt50

Trả về UnappliedPaymentQueue!

FieldKiểuMô tả
items[UnappliedPayment!]!A page, oldest first.
totalCountInt!Rows matching the filters (all pages).
totalUnappliedVndVndAmount!Sum of unappliedVnd over all matching rows.
resolutionUnappliedResolutionStatus!

voucher ​

Chưa có description trong SDL.

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
idID!

Trả về Voucher!

FieldKiểuMô tả
idID!
kindFinanceVoucherKind!
statusVoucherStatus!
fundCodeString!
amountVndVndAmount!Positive integer VND (REVERSAL: copied from the original).
currencyString!
reasonString!
orderIdID
orderCodeString#298 business order code of orderId (temporary format, NEW-SL-12); null without an order and in a command result.
transactionIdID
originalVoucherIdIDREVERSAL only: the APPROVED voucher it corrects.
reversedByVoucherIdIDAPPROVED RECEIPT/PAYMENT only: its live reversal.
evidenceMediaIds[ID!]!Private internal documents (media ids), frozen at submit.
createdByID!
createdAtDateTime!
updatedByID!
updatedAtDateTime!
submittedByID
submittedAtDateTime
payloadHashStringHash of the submitted content and policy; the checker sends it back to approve.
policyVoucherPolicySnapshot
approvedByID
approvedAtDateTime
cashbookEntryIdIDThe cashbook entry an APPROVED voucher posted (one).
cancelledByID
cancelledAtDateTime
rejectionVoucherRejectionSingle voucher read only: the last time a checker sent it back to its maker.
automaticEntryIdIDSingle voucher read only: the automatic entry of the same provider transaction (duplicate source).
versionInt!

vouchers ​

Manual vouchers, newest first (VCH-01).

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
kindFinanceVoucherKind
statusVoucherStatus
orderIdID
pageInt
pageSizeInt

Trả về VoucherPage!

FieldKiểuMô tả
items[Voucher!]!
pageInt!
pageSizeInt!
totalInt!

Mutation ​

approveVoucher ​

A different person approves exactly what they reviewed: APPROVED, immutable, one cashbook entry (VCH-04, MFA).

mutation · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
inputApproveVoucherInput!

Trả về VoucherResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
voucherVoucher!

cancelPaymentSession ​

#479 T14. Closes the provider session of the buyer's own open payment attempt (DEPOSIT or REMAINING), then asks the provider: the attempt ends FAILED and a new one may start, unless the provider reports it paid (then it is applied as paid). A deposit attempt's checkout follows. Requires payment.start (U-05, own order). status UNKNOWN while the provider has not confirmed. Refused: already_paid, session_not_open (no session yet, or the attempt already ended), attempt_in_progress (a capture is in flight).

mutation · quyền: payment.start

Tham sốKiểuMặc địnhMô tả
inputCancelPaymentSessionInput!

Trả về StartPaymentResult!

FieldKiểuMô tả
aggregateIdID!The payment intent id.
versionInt!
statusCommandStatus!UNKNOWN while the provider outcome is undecided.
requestIdID!
correlationIdID!
nextActionNextActioncomplete_mock_checkout | check_payment_status | order_placed | deposit_failed.
intentPaymentIntent!

cancelVoucher ​

Cancel an own DRAFT or SUBMITTED voucher (VCH-02).

mutation · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
inputVoucherCommandInput!

Trả về VoucherResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
voucherVoucher!

confirmRefundTransfer ​

Xac nhan da hoan tien (DH-US-07 AC04): the order's payment becomes REFUNDED, logged, the customer is notified. order.refund.process. Errors: validation_failed (transactionCode, transferredOn, note), stale_version, conflict (refund_not_waiting, profile_required, transfer_already_recorded, transaction_code_reuse, legs_in_progress, case_not_approved), forbidden.

mutation · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
inputConfirmRefundTransferInput!

Trả về ConfirmRefundTransferResult!

FieldKiểuMô tả
aggregateIdID!The refund case id.
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
orderIdID!
refundCaseIdID!
outcomeRefundRecordOutcome!APPLIED, or EXISTING when this confirm (same request or same code) was already saved.
caseStatusString!REFUNDED, or APPROVED while its Pi-Point legs are still running (they complete it).
paymentStatusPaymentAxis!REFUNDED (Da hoan tien) or PARTIALLY_REFUNDED (Hoan mot phan: a Recurring order with a delivered cycle).
statusVersionInt!
transferRefundConfirmedTransfer!

recordCodCollection ​

Legacy order-level manual COD collection (A-FF-03). Requires cod.collect. No web caller since U19-P4-02.

mutation · quyền: cod.collect

Tham sốKiểuMặc địnhMô tả
inputRecordCodCollectionInput!

Trả về CodCommandResult!

FieldKiểuMô tả
aggregateIdID!The COD collection id.
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
codStatusCodStatus!
remittanceIdID

recordCodRemittance ​

Remittance evidence of a COLLECTED COD. Requires cod.remit (COD-02, Finance).

mutation · quyền: cod.remit

Tham sốKiểuMặc địnhMô tả
inputRecordCodRemittanceInput!

Trả về CodCommandResult!

FieldKiểuMô tả
aggregateIdID!The COD collection id.
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
codStatusCodStatus!
remittanceIdID

recordReturnNoRefund ​

#479 B. Operations record that a returned unit paid in full (a Mua chung order in Hoàn hàng, or one Mua định kỳ cycle in Hoàn hàng) is NOT refunded: one RETURN refund case (NO_REFUND, CLOSED, kept = everything paid, reason, date, note) and the unit's payment status RETURN_NO_REFUND "Không hoàn tiền (hoàn hàng)". Idempotent by requestId. Requires order.refund.process; the buyer of the order is refused. Errors: validation_failed (reason, returnedOn, note, cycleNo), not_found, stale_version, conflict (already_recorded, not_returned, not_paid), forbidden.

mutation · quyền: order.refund.process

Tham sốKiểuMặc địnhMô tả
inputRecordReturnNoRefundInput!

Trả về RecordReturnNoRefundResult!

FieldKiểuMô tả
aggregateIdID!The RETURN refund case id.
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
orderIdID!
refundCaseIdID!
cycleNoInt
outcomeReturnRefundOutcome!
caseStatusRefundCaseStatus!
keptCashVndVndAmount!
keptPointsPointAmount!
returnedOnString!
paymentStatusPaymentAxis!The payment status of the unit (the order, or the cycle): RETURN_NO_REFUND.
statusVersionInt!status_version of the unit after the record.

rejectVoucher ​

A different person sends a SUBMITTED voucher back to its maker with a reason; the voucher returns to DRAFT (VCH-04, MFA).

mutation · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
inputRejectVoucherInput!

Trả về VoucherResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
voucherVoucher!

requestRefundInfoUpdate ​

Bao khach cap nhat lai (DH-US-16): the payment goes back to WAITING_REFUND_REQUEST; the customer sees the refund as REJECTED with the reason code (and the note when visible) and gets an in-app notice. order.refund.process. Errors: validation_failed (reasonCode, reason, customerNote), stale_version, conflict (refund_not_waiting, profile_required, profile_locked), forbidden.

mutation · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
inputRequestRefundInfoUpdateInput!

Trả về RequestRefundInfoUpdateResult!

FieldKiểuMô tả
aggregateIdID!The refund case id.
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
orderIdID!
refundCaseIdID!
outcomeRefundRecordOutcome!APPLIED, or UNCHANGED for a replay of the same request.
paymentStatusPaymentAxis!WAITING_REFUND_REQUEST (Cho yeu cau hoan) until the customer sends the request again.
statusVersionInt!
rejectedRevisionInt!The revision of the customer's request that was sent back.

resolveDiscrepancy ​

PRC-02 reconcile.resolve (Finance): handle one payment discrepancy item.

mutation · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
inputResolveDiscrepancyInput!

Trả về ResolveDiscrepancyPayload!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdString!
correlationIdString!
itemPaymentDiscrepancy!

retryRefundBranch ​

Recovers a REJECTED leg (never an UNKNOWN one). Requires refund.recover (RFD-02).

mutation · quyền: refund.recover

Tham sốKiểuMặc địnhMô tả
inputRetryRefundBranchInput!

Trả về RefundCommandResult!

FieldKiểuMô tả
aggregateIdID!The refund case id.
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
refundCaseIdID!
orderIdID!
caseStatusRefundCaseStatus!
progressRefundProgress!
approvalRequiredBoolean!
refundableCashVndVndAmount!
pointsToReversePointAmount!
legCountInt!

saveVoucherDraft ​

Create or revise a DRAFT voucher (VCH-02).

mutation · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
inputSaveVoucherDraftInput!

Trả về VoucherResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
voucherVoucher!

selectRemainingPaymentMethod ​

U19-P2-21. The buyer chooses or changes the remaining payment method of an own CONFIRMED order (ORD-04 payment.method_select, OWN). ONLINE opens the online remaining. Errors (extensions.reason): conflict not_confirmed, method_locked (Dang dong goi or later), payment_pending (an online payment is in progress), already_paid, cod_obligation_open; forbidden for another buyer's order; stale_version. U28-P2-03 (DEC-U28-04): a Mua định kỳ order switches COD -> ONLINE per cycle (cycles at Đang đóng gói keep their COD): conflict nothing_remaining when the online amount is <= 0, all_cycles_locked when no cycle is open. PAF (S9, DEC-PAF-09): a Mua chung order with an open COD remaining switches COD -> ONLINE too (the COD obligation is cancelled) until it is at Đang đóng gói.

mutation · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
inputSelectRemainingPaymentMethodInput!

Trả về SelectRemainingPaymentMethodResult!

FieldKiểuMô tả
aggregateIdID!The order id.
versionInt!Version of the choice after the command.
statusCommandStatus!
requestIdID!
correlationIdID!
methodOrderPaymentMethod!
previousMethodOrderPaymentMethod!
changedBoolean!False when the method was already the requested one.
remainingObligationIdIDONLINE: the REMAINING obligation to pay with startRemainingPayment (null when nothing is left to pay).
amountVndVndAmountU28-P2-03 (DEC-U28-04). ONLINE: the amount of that obligation; null otherwise.
lockedCycleNos[Int!]U28-P2-03. Mua định kỳ: cycles at Đang đóng gói or later that keep their fixed COD; null for Mua chung.

startDepositCheckout ​

Starts (or, with the same requestId, re-checks) the whole deposit checkout of an order: the point REDEEM first when the order uses points, then the online cash deposit. A rejected or unknown REDEEM starts no cash; a failed cash deposit after an accepted REDEEM reverses the full points once. A failed attempt leaves the order waiting for its deposit: a new requestId retries it (same order, same points). Requires payment.start (U-05, own order).

mutation · quyền: payment.start

Tham sốKiểuMặc địnhMô tả
inputStartDepositCheckoutInput!

Trả về StartDepositCheckoutResult!

FieldKiểuMô tả
aggregateIdID!The checkout id.
versionInt!
statusCommandStatus!UNKNOWN while a provider outcome is undecided.
requestIdID!
correlationIdID!
nextActionNextActioncheck_checkout_status | complete_mock_checkout | order_placed | points_rejected_requote | deposit_failed | points_refund_needs_support. deposit_failed and points_rejected_requote: the order is still DEPOSIT_PENDING; retry it with a new requestId.
checkoutDepositCheckout!
intentPaymentIntentThe cash deposit attempt, once it exists (complete the mock checkout with it).

startRemainingPayment ​

P3-05. Starts (or re-checks, same requestId) the ONE full online remaining payment of a closed (LOCKED) order, never per recurring cycle. Requires payment.start (U-05, own order). Refused when already paid, while an attempt is live (UNKNOWN: provider_unknown) or for a COD obligation. A lower final price never reaches here: it is an offline overpayment case. nextAction: complete_mock_checkout | check_payment_status | remaining_paid | remaining_payment_failed.

mutation · quyền: payment.start

Tham sốKiểuMặc địnhMô tả
inputStartRemainingPaymentInput!

Trả về StartPaymentResult!

FieldKiểuMô tả
aggregateIdID!The payment intent id.
versionInt!
statusCommandStatus!UNKNOWN while the provider outcome is undecided.
requestIdID!
correlationIdID!
nextActionNextActioncomplete_mock_checkout | check_payment_status | order_placed | deposit_failed.
intentPaymentIntent!

submitRefundRequest ​

APP_USER (refund.submit, own order): sends or sends again the refund request while the payment status is WAITING_REFUND_REQUEST; it becomes WAITING_REFUND. #479 C: with refundCaseId, the request of one cọc dư claim while OrderRefund.excessClaim.canSubmitRequest (the payment status does not move). Errors: forbidden (another customer's order), validation_failed (field), stale_version, conflict (refund_not_requestable, no_cash_to_transfer, profile_locked).

mutation · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
inputSubmitRefundRequestInput!

Trả về RefundSubmitResult!

FieldKiểuMô tả
aggregateIdID!The order id.
versionInt!status_version of the order.
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
orderIdID!
refundCaseIdID!
outcomeRefundRecordOutcome!APPLIED (a new revision) or UNCHANGED (this command already ran).
paymentStatusPaymentAxis!WAITING_REFUND after a submission; #479 C: the order's own payment status, unchanged, for an excess claim.
revisionInt!
citizenIdMaskedString!
accountNumberMaskedString!
holderMatchesIdNameBoolean!The account holder name matches the name on the CCCD (accent/case-insensitive). A sign only.

submitVoucher ​

Maker submits with evidence; the FUNDS_VOUCHER policy is evaluated and frozen (VCH-03, MFA).

mutation · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
inputVoucherCommandInput!

Trả về VoucherResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
voucherVoucher!

Sinh từ ad83b0aea · 820 migration · PostgreSQL 17