Giao diện
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ểu | Mặc định | Mô tả |
|---|---|---|---|
accountId | ID! |
Trả về CustomerEkycIdentity!
| Field | Kiểu | Mô tả |
|---|---|---|
accountId | ID! | |
linked | Boolean! | The customer has a PiPoint link (false: PiPoint is not asked, NOT_VERIFIED). |
status | PointIdentityDisplayStatus! | |
verification | EkycVerification | |
identity | EkycIdentityData | |
images | EkycImages | |
request | EkycLatestRequest |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
accountId | ID! | ||
cursor | String | ||
limit | Int | 20 |
Trả về CustomerPointHistory!
| Field | Kiểu | Mô tả |
|---|---|---|
state | CustomerPointHistoryState! | |
items | [PointHistoryItem!]! | |
nextCursor | String | Opaque cursor of the next page; null at the end of the history. |
unavailableReason | String | PROVIDER_ERROR | TIMEOUT | NOT_CONFIGURED when UNKNOWN. |
providerMode | PointProviderMode! |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
requestId | ID! |
Trả về EkycRequestDetail!
| Field | Kiểu | Mô tả |
|---|---|---|
requestId | ID! | |
accountId | ID | |
ownRequest | Boolean! | |
platform | String | Platform the request was sent from (decisions only for PIDEAL's own). |
status | EkycRequestStatus! | |
startedAt | DateTime | |
createdAt | DateTime | |
closedAt | DateTime | |
identity | EkycIdentityData | |
checklist | [EkycChecklistItem!] | The four 'Kết quả eKYC' lines (null when PiPoint did not check). |
submitMin | Int | Score below which a request cannot be sent / from which PiPoint approves itself. |
threshold | Int | |
faceScore | Int | |
reviewReasons | [String!]! | |
decision | EkycDecisionMark | |
rejectCode | String | |
rejectReason | String | Text the user reads (template or the admin's reason). |
rejectReasonCode | EkycRejectReason | |
images | EkycImages |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
filter | EkycRequestFilter | ||
page | Int | 1 | |
pageSize | Int | 30 |
Trả về EkycRequestPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [EkycRequestItem!]! | |
total | Int! | |
page | Int! | |
pageSize | Int! | |
totalPages | Int! |
myPointWallet
Requires wallet.read (own wallet, APP_USER/APP_SALE).
query · quyền: wallet.read
Không có tham số.
Trả về PointWallet!
| Field | Kiểu | Mô tả |
|---|---|---|
identityStatus | PointIdentityStatus! | |
identityReason | PointIdentityReason | Set only when identityStatus is NOT_VERIFIED for a reason the app shows differently. |
identityDisplayStatus | PointIdentityDisplayStatus | PiPoint display level; null until the eKYC status was synced (or no eKYC source). |
linkStatus | PointLinkStatus! | |
linkedAt | DateTime | |
balance | PointBalance! | |
providerMode | PointProviderMode! |
pointAdjustment
Chưa có description trong SDL.
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
id | ID! |
Trả về PointAdjustment!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
accountId | ID! | |
recipientName | String | PPI-P7-05: the recipient's name (profile); null when unknown. |
recipientPhoneMasked | String | PPI-P7-05: the recipient's phone as staff see it (masked, never whole); null for an email-only account. |
role | PointAdjustRole! | |
direction | PointAdjustDirection! | |
points | PointAmount! | |
reasonCode | String! | Set by the server from the source: MANUAL_ADJUST (requestPointAdjust), RETURN_RECALL (PPI-P7-05) or FAILED_DELIVERY_RECALL (#479). |
reasonText | String! | |
evidenceMediaIds | [ID!]! | Private INTERNAL_DOCUMENT media ids of an older slip; empty since PPI-P7-05 (no evidence). |
reconciliationItemId | ID | |
correctsRequestId | ID | |
relatedOrderId | ID | |
rateSnapshotVnd | String! | AS-03 interim rate (VND per point) frozen at the proposal. |
ratePolicyVersion | String! | |
payloadHash | String! | What the checker approves; send it back with the decision. |
status | PointAdjustStatus! | |
origin | PointAdjustOrigin! | |
recall | PointAdjustRecall | The recall basis of a RETURN_RECALL slip; null for a manual one. |
requestedBy | ID | The maker; null for a RETURN_RECALL slip the system wrote. |
requestedAt | DateTime! | When the maker proposed it (a RETURN_RECALL slip: when the system wrote it). |
decidedBy | ID | |
decidedAt | DateTime | |
decisionNote | String | |
businessDate | String | VN date of the approval: the report month basis (GAP-119). |
pointRequestId | String | The ADJUST request id sent to PiPoint (approved only). |
delivery | PointAdjustDelivery | |
version | Int! | expectedVersion for the decision. |
pointAdjustments
Proposals, newest first (ADJ-01).
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
status | PointAdjustStatus | ||
accountId | ID | ||
page | Int | ||
pageSize | Int |
Trả về PointAdjustmentPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [PointAdjustment!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! |
pointHistory
Requires wallet.read. page is capped at 100 (provider calls per read).
query · quyền: wallet.read
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
page | Int | 1 | |
pageSize | Int | 20 |
Trả về PointHistoryPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [PointHistoryItem!]! | |
page | Int! | |
pageSize | Int! | |
total | Int | |
hasMore | Boolean | |
state | PointReadState! | |
sourceStatus | SourceStatus! | |
unavailableReason | String | |
providerMode | PointProviderMode! |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
runDate | String! |
Trả về [PointReconciliationRun!]!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
runDate | String! | VN business date YYYY-MM-DD; the window is exactly that VN day. |
runVersion | Int! | |
triggerKind | String! | SCHEDULED or RERUN |
requestedBy | ID | |
status | PaymentReconciliationRunStatus! | |
sourceStatus | SourceStatus! | READY only when COMPLETE; INCOMPLETE and UNKNOWN never mean zero or matched. |
windowStart | DateTime! | |
windowEnd | DateTime! | |
startedAt | DateTime! | |
finishedAt | DateTime | |
errorCode | String | |
unknownCarriedOver | Int | Requests still UNKNOWN that were carried to a later day; not a discrepancy. |
local | PointReconSide | |
remote | PointReconSide | |
paymentCheck | PointReconPaymentCheck | |
items | [PointDiscrepancy!]! |
pointReport
Chưa có description trong SDL.
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
id | ID! |
Trả về PointReport!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
month | String! | VN month, YYYY-MM. |
reportVersion | Int! | |
status | PointReportStatus! | |
timezone | String! | |
rateBasis | String! | How VND was computed: sum of per-transaction rate snapshots. |
cutoffAt | DateTime! | Requests accepted up to this instant are in the figures. |
requestCount | Int! | |
netIssuedPoints | PointAmount! | ISSUE - CANCEL_ISSUE, signed, never clamped. |
netIssuedVnd | String! | |
netRedeemedPoints | PointAmount! | REDEEM - REVERSE_REDEEM, signed. A separate metric: never combined with net issued. |
netRedeemedVnd | String! | |
adjustCreditPoints | PointAmount! | |
adjustCreditVnd | String! | |
adjustDebitPoints | PointAmount! | |
adjustDebitVnd | String! | |
pendingPoints | PointAmount | PIDEAL'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. |
pendingVnd | String | pendingPoints at each request's own rate snapshot, exact. Null with pendingPoints. |
openDiscrepancyCount | Int! | Unresolved reconciliation discrepancy lines of the month; never hidden, never auto-matched. Shown when settling; does not block the SETTLED marker (sow/10 s8). |
settledBy | ID | |
settledAt | DateTime | |
settlementNote | String | |
lines | [PointReportLine!]! | |
corrections | [PointReportCorrection!]! | Corrections recorded in this month for earlier SETTLED months. |
version | Int! | 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ểu | Mặc định | Mô tả |
|---|---|---|---|
month | String | ||
status | PointReportStatus | ||
page | Int | ||
pageSize | Int |
Trả về PointReportPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [PointReport!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
id | ID! |
Trả về PointRequestDetail!
| Field | Kiểu | Mô tả |
|---|---|---|
request | PointRequest! | |
originalRequest | PointRequest | The 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ểu | Mặc định | Mô tả |
|---|---|---|---|
filter | PointRequestFilter | ||
page | Int | ||
pageSize | Int |
Trả về PointRequestPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [PointRequest!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! |
rankAdjustment
Chưa có description trong SDL.
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
id | ID! |
Trả về RankAdjustment!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
accountId | ID! | |
recipientName | String | PPI-P7-05: the customer's name (profile); null when unknown. |
recipientPhoneMasked | String | PPI-P7-05: the customer's phone as staff see it (masked, never whole); null for an email-only account. |
points | PointAmount! | |
reasonCode | String! | Set by the server: RANK_ONLY_DEBIT (operations, PPI-P7-05) or RETURN_RECALL (the system's, E-09d). |
reasonText | String! | |
evidenceMediaIds | [ID!]! | Private INTERNAL_DOCUMENT media ids of an older slip; empty since PPI-P7-05 (no evidence). |
sourceAdjustmentId | ID | The ADJUST DEBIT slip the wallet refused for insufficient points (null only on an older free proposal). |
payloadHash | String! | What the checker approves; send it back with the decision. |
status | PointAdjustStatus! | |
requestedBy | ID | The operations maker; null when the system wrote it for a return-recall slip PiPoint refused (E-09d). |
requestedAt | DateTime! | |
decidedBy | ID | |
decidedAt | DateTime | |
decisionNote | String | |
version | Int! | expectedVersion for the decision. |
rankAdjustments
Rank-only debits, newest first (ADJ-01).
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
status | PointAdjustStatus | ||
accountId | ID | ||
page | Int | ||
pageSize | Int |
Trả về RankAdjustmentPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [RankAdjustment!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | DecidePointAdjustInput! |
Trả về PointAdjustmentResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
adjustment | PointAdjustment! |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | DecideRankDebitInput! |
Trả về RankAdjustmentResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
rankAdjustment | RankAdjustment! |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | DecideEkycRequestInput! |
Trả về DecideEkycRequestResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
decision | EkycDecisionOutcome! |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | LinkPointAccountInput! |
Trả về LinkPointAccountResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | point_account_links id. |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
linkStatus | PointLinkStatus! | |
linkedAt | DateTime! | |
providerMode | PointProviderMode! | |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | DecidePointAdjustInput! |
Trả về PointAdjustmentResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
adjustment | PointAdjustment! |
rejectRankDebit
A different person (finance) rejects: the rank never moves (F-07, MFA).
mutation · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
input | DecideRankDebitInput! |
Trả về RankAdjustmentResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
rankAdjustment | RankAdjustment! |
requestPointAdjust
Operations maker proposes an ADJUST (F-06, MFA). Nothing is sent.
mutation · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
input | RequestPointAdjustInput! |
Trả về PointAdjustmentResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
adjustment | PointAdjustment! |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | RequestRankDebitInput! |
Trả về RankAdjustmentResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
rankAdjustment | RankAdjustment! |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | SettlePointReportInput! |
Trả về PointReportResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
report | PointReport! |