Skip to content

API · pipoint ​

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.

15 query · 9 mutation.

Query ​

customerIdentity ​

eKYC state, identity and images of a customer (EKY-01).

query · SDL không ghi quyền

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

Trả về CustomerEkycIdentity!

FieldKiểuMô tả
accountIdID!
linkedBoolean!The customer has a PiPoint link (false: PiPoint is not asked, NOT_VERIFIED).
statusPointIdentityDisplayStatus!
verificationEkycVerification
identityEkycIdentityData
imagesEkycImages
requestEkycLatestRequest

customerPointHistory ​

Requires point_adjust.read (ADJ-01, WEB_ADMIN operations / finance). One page of the account's PiPoint wallet history read through PiPoint on every call (no cache); pass the previous nextCursor for the next page. limit is 1-100.

query · quyền: point_adjust.read

Tham sốKiểuMặc địnhMô tả
accountIdID!
cursorString
limitInt20

Trả về CustomerPointHistory!

FieldKiểuMô tả
stateCustomerPointHistoryState!
items[PointHistoryItem!]!
nextCursorStringOpaque cursor of the next page; null at the end of the history.
unavailableReasonStringPROVIDER_ERROR | TIMEOUT | NOT_CONFIGURED when UNKNOWN.
providerModePointProviderMode!

ekycRequest ​

One request with identity, checklist and images (EKY-01; never your own: forbidden self_review).

query · SDL không ghi quyền

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

Trả về EkycRequestDetail!

FieldKiểuMô tả
requestIdID!
accountIdID
ownRequestBoolean!
platformStringPlatform the request was sent from (decisions only for PIDEAL's own).
statusEkycRequestStatus!
startedAtDateTime
createdAtDateTime
closedAtDateTime
identityEkycIdentityData
checklist[EkycChecklistItem!]The four 'Kết quả eKYC' lines (null when PiPoint did not check).
submitMinIntScore below which a request cannot be sent / from which PiPoint approves itself.
thresholdInt
faceScoreInt
reviewReasons[String!]!
decisionEkycDecisionMark
rejectCodeString
rejectReasonStringText the user reads (template or the admin's reason).
rejectReasonCodeEkycRejectReason
imagesEkycImages

ekycRequests ​

PIDEAL's eKYC requests at PiPoint (EKY-01 ekyc.read). REVIEW only: oldest first; otherwise newest first.

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
filterEkycRequestFilter
pageInt1
pageSizeInt30

Trả về EkycRequestPage!

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

myPointWallet ​

Requires wallet.read (own wallet, APP_USER/APP_SALE).

query · quyền: wallet.read

Không có tham số.

Trả về PointWallet!

FieldKiểuMô tả
identityStatusPointIdentityStatus!
identityReasonPointIdentityReasonSet only when identityStatus is NOT_VERIFIED for a reason the app shows differently.
identityDisplayStatusPointIdentityDisplayStatusPiPoint display level; null until the eKYC status was synced (or no eKYC source).
linkStatusPointLinkStatus!
linkedAtDateTime
balancePointBalance!
providerModePointProviderMode!

pointAdjustment ​

Chưa có description trong SDL.

query · SDL không ghi quyền

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

Trả về PointAdjustment!

FieldKiểuMô tả
idID!
accountIdID!
recipientNameStringPPI-P7-05: the recipient's name (profile); null when unknown.
recipientPhoneMaskedStringPPI-P7-05: the recipient's phone as staff see it (masked, never whole); null for an email-only account.
rolePointAdjustRole!
directionPointAdjustDirection!
pointsPointAmount!
reasonCodeString!Set by the server from the source: MANUAL_ADJUST (requestPointAdjust), RETURN_RECALL (PPI-P7-05) or FAILED_DELIVERY_RECALL (#479).
reasonTextString!
evidenceMediaIds[ID!]!Private INTERNAL_DOCUMENT media ids of an older slip; empty since PPI-P7-05 (no evidence).
reconciliationItemIdID
correctsRequestIdID
relatedOrderIdID
rateSnapshotVndString!AS-03 interim rate (VND per point) frozen at the proposal.
ratePolicyVersionString!
payloadHashString!What the checker approves; send it back with the decision.
statusPointAdjustStatus!
originPointAdjustOrigin!
recallPointAdjustRecallThe recall basis of a RETURN_RECALL slip; null for a manual one.
requestedByIDThe maker; null for a RETURN_RECALL slip the system wrote.
requestedAtDateTime!When the maker proposed it (a RETURN_RECALL slip: when the system wrote it).
decidedByID
decidedAtDateTime
decisionNoteString
businessDateStringVN date of the approval: the report month basis (GAP-119).
pointRequestIdStringThe ADJUST request id sent to PiPoint (approved only).
deliveryPointAdjustDelivery
versionInt!expectedVersion for the decision.

pointAdjustments ​

Proposals, newest first (ADJ-01).

query · SDL không ghi quyền

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

Trả về PointAdjustmentPage!

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

pointHistory ​

Requires wallet.read. page is capped at 100 (provider calls per read).

query · quyền: wallet.read

Tham sốKiểuMặc địnhMô tả
pageInt1
pageSizeInt20

Trả về PointHistoryPage!

FieldKiểuMô tả
items[PointHistoryItem!]!
pageInt!
pageSizeInt!
totalInt
hasMoreBoolean
statePointReadState!
sourceStatusSourceStatus!
unavailableReasonString
providerModePointProviderMode!

pointReconciliation ​

PRC-01 reconcile.read (Finance): every PiPoint daily 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ề [PointReconciliationRun!]!

FieldKiểuMô tả
idID!
runDateString!VN business date YYYY-MM-DD; the window is exactly that VN day.
runVersionInt!
triggerKindString!SCHEDULED or RERUN
requestedByID
statusPaymentReconciliationRunStatus!
sourceStatusSourceStatus!READY only when COMPLETE; INCOMPLETE and UNKNOWN never mean zero or matched.
windowStartDateTime!
windowEndDateTime!
startedAtDateTime!
finishedAtDateTime
errorCodeString
unknownCarriedOverIntRequests still UNKNOWN that were carried to a later day; not a discrepancy.
localPointReconSide
remotePointReconSide
paymentCheckPointReconPaymentCheck
items[PointDiscrepancy!]!

pointReport ​

Chưa có description trong SDL.

query · SDL không ghi quyền

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

Trả về PointReport!

FieldKiểuMô tả
idID!
monthString!VN month, YYYY-MM.
reportVersionInt!
statusPointReportStatus!
timezoneString!
rateBasisString!How VND was computed: sum of per-transaction rate snapshots.
cutoffAtDateTime!Requests accepted up to this instant are in the figures.
requestCountInt!
netIssuedPointsPointAmount!ISSUE - CANCEL_ISSUE, signed, never clamped.
netIssuedVndString!
netRedeemedPointsPointAmount!REDEEM - REVERSE_REDEEM, signed. A separate metric: never combined with net issued.
netRedeemedVndString!
adjustCreditPointsPointAmount!
adjustCreditVndString!
adjustDebitPointsPointAmount!
adjustDebitVndString!
pendingPointsPointAmountPIDEAL's Pending (E-08): ISSUE into PENDING - CANCEL_ISSUE, signed, from PIDEAL data only, chưa qua PiPoint (D-01 = A). Null on a version built before E-08.
pendingVndStringpendingPoints at each request's own rate snapshot, exact. Null with pendingPoints.
openDiscrepancyCountInt!Unresolved reconciliation discrepancy lines of the month; never hidden, never auto-matched. Shown when settling; does not block the SETTLED marker (sow/10 s8).
settledByID
settledAtDateTime
settlementNoteString
lines[PointReportLine!]!
corrections[PointReportCorrection!]!Corrections recorded in this month for earlier SETTLED months.
versionInt!expectedVersion for settlePointReport.

pointReports ​

Report versions newest first (PRP-01). month is a VN month YYYY-MM.

query · SDL không ghi quyền

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

Trả về PointReportPage!

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

pointRequest ​

PPI-P8-01 (ADJ-01): one point command with its original, follow-ups and reconciliation items.

query · SDL không ghi quyền

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

Trả về PointRequestDetail!

FieldKiểuMô tả
requestPointRequest!
originalRequestPointRequestThe command this one follows (RELEASE / CANCEL_ISSUE of an ISSUE, REVERSE_REDEEM of a REDEEM).
followUps[PointRequest!]!Commands that follow this one, newest first.
discrepancies[PointRequestDiscrepancy!]!

pointRequests ​

PPI-P8-01 (ADJ-01 point_adjust.read): point commands PIDEAL sent to PiPoint, newest first, pageSize <= 100.

query · SDL không ghi quyền

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

Trả về PointRequestPage!

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

rankAdjustment ​

Chưa có description trong SDL.

query · SDL không ghi quyền

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

Trả về RankAdjustment!

FieldKiểuMô tả
idID!
accountIdID!
recipientNameStringPPI-P7-05: the customer's name (profile); null when unknown.
recipientPhoneMaskedStringPPI-P7-05: the customer's phone as staff see it (masked, never whole); null for an email-only account.
pointsPointAmount!
reasonCodeString!Set by the server: RANK_ONLY_DEBIT (operations, PPI-P7-05) or RETURN_RECALL (the system's, E-09d).
reasonTextString!
evidenceMediaIds[ID!]!Private INTERNAL_DOCUMENT media ids of an older slip; empty since PPI-P7-05 (no evidence).
sourceAdjustmentIdIDThe ADJUST DEBIT slip the wallet refused for insufficient points (null only on an older free proposal).
payloadHashString!What the checker approves; send it back with the decision.
statusPointAdjustStatus!
requestedByIDThe operations maker; null when the system wrote it for a return-recall slip PiPoint refused (E-09d).
requestedAtDateTime!
decidedByID
decidedAtDateTime
decisionNoteString
versionInt!expectedVersion for the decision.

rankAdjustments ​

Rank-only debits, newest first (ADJ-01).

query · SDL không ghi quyền

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

Trả về RankAdjustmentPage!

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

Mutation ​

approvePointAdjust ​

A different person (finance) approves: exactly one ADJUST is queued for PiPoint (F-07, MFA).

mutation · SDL không ghi quyền

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

Trả về PointAdjustmentResult!

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

approveRankDebit ​

A different person (finance) approves: one signed rank entry, the customer is evaluated at once (F-07, MFA).

mutation · SDL không ghi quyền

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

Trả về RankAdjustmentResult!

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

decideEkycRequest ​

Approve or reject a REVIEW request sent from PIDEAL (EKY-02 ekyc.review: admin, super_admin, MFA step-up ekyc.review, never your own request). Errors: forbidden self_review / ekyc_review_forbidden / step_up_required, conflict ekyc_request_closed / account_deletion_pending, provider_unknown (reload the request), validation_failed.

mutation · SDL không ghi quyền

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

Trả về DecideEkycRequestResult!

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

linkPointAccount ​

Requires wallet.link (own account, APP_USER/APP_SALE) AND a verified eKYC identity: conflict ekyc_not_verified / ekyc_status_unknown, or policy_undecided DEC-PP-IDENTITY while no eKYC source exists. Lookup timeout is provider_unknown (retry with the same requestId), never "no wallet"; LOOKUP_ONLY without a wallet is not_found pipoint_account_not_found. An identity already linked to another account is conflict identity_collision. Deprecated (PPI-P5-02): the link is made at PiPoint sign-in (exchange); an existing link answers LINKED with no eKYC check and no PiPoint call, and a LIVE provider without a link is not_found pipoint_account_not_found.

mutation · quyền: wallet.link

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

Trả về LinkPointAccountResult!

FieldKiểuMô tả
aggregateIdID!point_account_links id.
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
linkStatusPointLinkStatus!
linkedAtDateTime!
providerModePointProviderMode!
pointRequestIds[ID!]!PiPoint request ids used by this command; empty when already linked.

rejectPointAdjust ​

A different person (finance) rejects: nothing is ever sent (F-07, MFA).

mutation · SDL không ghi quyền

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

Trả về PointAdjustmentResult!

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

rejectRankDebit ​

A different person (finance) rejects: the rank never moves (F-07, MFA).

mutation · SDL không ghi quyền

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

Trả về RankAdjustmentResult!

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

requestPointAdjust ​

Operations maker proposes an ADJUST (F-06, MFA). Nothing is sent.

mutation · SDL không ghi quyền

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

Trả về PointAdjustmentResult!

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

requestRankDebit ​

Operations maker proposes the rank-only debit of a slip PiPoint refused for insufficient points (F-06, MFA). The rank does not move yet.

mutation · SDL không ghi quyền

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

Trả về RankAdjustmentResult!

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

settlePointReport ​

Finance marks an ended month's DRAFT as settled, offline (PRP-02, MFA). Marker only.

mutation · SDL không ghi quyền

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

Trả về PointReportResult!

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

Sinh từ ad83b0aea · 820 migration · PostgreSQL 17