Reference
Statuses & enums Every status and enumerated value used across MyTPE Pay resources, in one place.
This page is the single source of truth for every enumerated value the API returns. Each API
resource links here for the enums it uses. Values are the exact strings sent and accepted by the
API.
Identifications , brands , and
bank accounts all share one review status. When refused, the reason
field explains why.
Value Meaning pendingSubmitted, awaiting MyTPE review. acceptedApproved — can back a payment instance. refusedRejected. Read reason, fix, and resubmit.
trader.onboarding_changed webhooks report the trader's overall KYC progress.
Value Meaning not_startedNo KYC submitted yet. kyc_in_progressKYC partially filled in. kyc_pendingKYC submitted, awaiting review. kyc_rejectedKYC was rejected. kyc_approvedKYC fully approved. suspendedAccount suspended. closedAccount closed.
A payment instance carries two independent enums.
The instance can only accept payments when this is ready.
Value Meaning pending_documentsDocuments still required. documents_submittedSubmitted, under review. rejectedLicense rejected. Read acceptance_reason. readyApproved — the instance can accept payments.
Value Meaning activeOperating normally. suspendedTemporarily disabled; cannot accept payments.
A payment link uses three enums.
Value Meaning draftCreated but not yet payable. activePublished and accepting payments. pausedTemporarily not accepting payments. exhaustedUsage limit reached (terminal). expiredPast its window / expiry (terminal). archivedPermanently closed (terminal).
Value Meaning fixedA single set amount. openPayer chooses, optionally within min_amount/max_amount.
Value Meaning one_shotOne payment, then exhausted. limitedUp to max_uses payments, then exhausted. reusableUnlimited until archived. capped_amountCloses when total_collected ≥ target_amount. time_windowPayable only between starts_at and ends_at. whitelistOnly listed allowed_payers may pay.
A transaction represents a single payment attempt (a link payment or an instance activation).
These are the values surfaced in transaction.* webhooks .
Value Meaning processingStarted, awaiting the gateway result. pendingAwaiting confirmation (e.g. offline proof review). paidPayment succeeded. failedAnything not paid/pending/processing — refused, timed out, cancelled, error.
The success value is paid, not Completed. The gateway never returns Completed/Failed;
filtering on those silently matches nothing.
Value Meaning freeNo payment required. onlineCard payment via the gateway redirect (form_url). bank_transferSettled by bank transfer; needs proof + manual confirmation. chequeSettled by cheque; needs proof + manual confirmation.
For methods that require manual verification.
Value Meaning requires_verificationAwaiting an officer's check. confirmedVerified and accepted. failedVerification failed. rejectedRejected by the reviewer.
The processor behind an online transaction.
Value Provider satimSatim.dz satim_epgSatim EPG mastercardMastercard poste_dzPoste.dz
Value Meaning draftEditable; cannot be attached to a link. publishedLive; can be attached to payment links. archivedRetired.
The data_type of a form field.
Value Renders as stringSingle‑line text. textMulti‑line text. integer / number / decimalNumeric input. boolean / toggleCheckbox / switch. emailEmail input. phonePhone input. urlURL input. selectSingle‑choice dropdown. (needs options) multi_selectMulti‑choice → array. (needs options) radioSingle choice. (needs options) checkboxMulti choice → array. (needs options) date / time / datetimeDate/time pickers.
multi_select and checkbox store an array of values. select, multi_select, radio, and
checkbox require an options array of { value, label }.
Event types delivered by webhooks . The live catalogue is at
GET /webhooks/events.
Event Fires when transaction.createdA transaction is opened. transaction.processingIt enters processing. transaction.pendingIt awaits confirmation. transaction.paidPayment succeeds. transaction.failedPayment ends in any non‑success state.
Event Fires when payment_instance.createdAn instance is requested. payment_instance.activatedIt becomes active. payment_instance.suspendedIt is suspended. payment_instance.acceptance_changedIts acceptance_status changes. payment_instance.updatedIt is updated. payment_instance.deletedIt is deleted. payment_instance.restoredA deleted instance is restored.
Event Fires when payment_link.createdA link is created. payment_link.publishedIt is published. payment_link.pausedIt is paused. payment_link.resumedIt is resumed. payment_link.updatedIt is updated. payment_link.archivedIt is archived. payment_link.paidA payment against it succeeds. payment_link.exhaustedIt reaches its usage/amount limit. payment_link.expiredIt passes its window/expiry.
Event Fires when form.submittedA payer submits an attached form. identification.approved / identification.rejectedAn identification is reviewed. brand.approved / brand.rejectedA brand is reviewed. bank_account.approved / bank_account.rejectedA bank account is reviewed. trader.onboarding_changedThe trader's onboarding status changes.
Open in Postman