HeritagePay API
​string · required​string · enum​string · required​string · minLength: 4 · maxLength: 8 · required​string · required​string · required​string · minLength: 6 · maxLength: 6 · required​string · required​string · email​string · required​string · minLength: 6 · maxLength: 6 · required​string​string​integer​string​object​string · required​string · required​string​string​number · required​string​string​string​string​string​string​number · required​string · required​string · required​string​number · required​string · required​string · required​string​number · required​string · required​string · required​string​string​string​number​string · date​string​string​string​number · required​string​string​string​string​string​number​string​string​string​string · uri · required​string[] · required​string​string · required​string · required​string​string · enum​string · uuid · required​string · required​string · required​string · required​boolean · required​string​string · date-time​string · date-time​string · required​string · required​string​string​string​string​string​integer · min: 0​string · enum​string · uuid · required​string · required​string · required​string · required​string · required​boolean · required​string​string​string​string​integer​boolean​string · date-time​string · date-time​string · required​string · required​string · enum​string · enum​string​string · email​string​string​string · uuid · required​string · required​string · required​string · required​string · required​boolean · required​string​string​string​string​boolean​string · date-time​string · date-time​string · required​string · required​string · enum​string · enum​string​string · uuid · required​string · required​string · required​string · required​string · required​boolean · required​string​string · date-time​boolean​string · date-time​string · date-time​string · required​string · required​string · required​string​integer · min: 1 · max: 1000​integer · min: 0 · max: 1000​string · enum​boolean​string​string · date​string​string · uuid · required​string · required​string · required​string · required​integer · required​integer · required​string · required​string · required​boolean · required​boolean · required​string​string​string · date​string​boolean​string · date-time​string · date-time​string · required​string · required​string · required​string​string · enum​string​string · pattern: ​string​string · enum​string​integer · min: 0 · max: 2147483647​string · enum​string · enum​string · enum​string · enum​string​string​string​string · uuid · required​string · required​string · required​string · required​string · required​string · required​boolean · required​boolean · required​string​string​string​string​string​string​integer​string​string​string​string · date-time​string​string​string​string · date-time​string · date-time​string · date-time​string · required​string · required​integer · min: 0 · required​string · required​string​string​string​string · enum​string · enum​string​string​string​string​string · uuid · required​string · required​string · required​integer · required​string · required​string · required​string · required​boolean · required​boolean · required​boolean · required​string​string​string​string​string​string​string · date-time​string · date-time​string · date-time​string​string · date-time​string · date-time​string · maxLength: 100 · required​string · maxLength: 80 · required​string · enum​string · maxLength: 160​string · enum​integer · min: 1 · max: 100​string · maxLength: 80​string · maxLength: 1000​string · date-time​string · date-time​string · date-time​string · maxLength: 1000​string · enum · required​string · maxLength: 160 · required​string · enum · required​string · maxLength: 80​string · maxLength: 1000​string · date-time​string · date-time​string · date-time​string · date-time​string · maxLength: 1000​string · uuid · required​string · required​string · required​string · required​string · required​integer · required​integer · required​string · required​string​string​string​string · date-time​string · date-time​string · date-time​string​string · date-time​string · date-time​string · required​string · required​string · required​string​string · uuid​string​string​string · enum​string · enum​string​integer · min: 0​integer · min: 0​integer · min: 0​string​string · date-time​string · enum​string · enum​string · enum​integer · min: 0
Properties for Variant 1:​string · required​string · uuid​string​string​string​string​string​string · enum​string · enum​string​integer · min: 0​integer · min: 0​integer · min: 0​string​string · date-time​string · enum​string · enum​string · enum​integer · min: 0​integer · required​integer · required​integer · required​integer · required​integer · required​integer · required​integer · required​integer · required​integer · required​integer · required​integer · required​string · required​string · uuid · required​string · required​string · required​string · required​string · required​string · required​integer · required​integer · required​string · required​string · required​string · required​string · required​integer · required​string​string​string​integer​string​string · date-time​string · date-time​string · date-time​string · required​string · required​string · required​string​string · enum​string​integer · min: 0 · max: 1000000​integer · min: 0 · max: 1000000​string · enum​string​string · date-time​string · enum​string​string​string​integer · required​integer · required​integer · required​integer · required​integer · required​integer · required​string · required​string · uuid · required​string · required​string · required​string · required​string · required​integer · required​integer · required​string · required​string · required​string · required​boolean · required​boolean · required​string​string​string​string · date-time​string​string​string​string · date-time​string · date-time​string · required​integer · min: 1 · max: 10000 · required​string · pattern: ​string​string · enum​string​string​string · enum​string · enum​boolean​string · enum​string​string​string​string · required​integer · min: 1 · max: 10000 · required​string · required​string · required​string · enum · required​string · pattern: ​string​string​string​string · date-time​string​integer · required​integer · required​integer​string​string · uuid · required​string · required​integer · required​string · required​string · required​string · required​string · required​string · required​boolean · required​string · required​string​string​string​string​string​string​string · date-time​string · date-time​string · required​string · required​integer · min: 1 · max: 10000 · required​string[] · minItems: 1 · maxItems: 20 · required​string · enum​string​string · enum​string · enum​string​string​string​string · date-time​string · date-time​string · date-time​string​string · enum · required​string · required​string · required​string · enum · required​string​string · pattern: ​string · date-time​string · date-time​string · date-time​string​integer · required​integer · required​integer · required​integer · required​string · required​string · required​integer · min: 1 · max: 10000 · required​string · enum · required​string · enum · required​string · enum · required​string[] · minItems: 1 · maxItems: 20 · required​string · required​string​string​string​string​string · date-time​string · date-time​string · date-time​object​string​string · date-time​string · date-time​string · required​integer · min: 1 · max: 10000 · required​string · required​string​string​string · enum​string · enum​string​string · pattern: ​string · date-time​string · date-time​string​integer · required​integer · required​integer · required​integer · required​integer · required​string · uuid · required​string · required​integer · required​string · required​string · required​string · required​string​string​string​string​string · date-time​string · date-time​string​string · date-time​string · date-time​string · required​string · required​string · enum · required​string · required​string​string​integer · min: 1 · max: 10000​string · enum​string​string · date-time​integer · required​integer · required​string · date-time​string · uuid · required​string · required​string · required​string · required​string · required​string · required​string​string​integer​string​string · date-time​string · date-time​string · required​string · required​string​string · enum​string​integer · min: 0 · max: 1000000​integer · min: 0 · max: 1000000​string · enum​string​string · date-time​string​string​string · required​string · required​integer · min: 1 · max: 10000​string​string​string​string · enum​string​string​string · maxLength: 120 · required​string · enum · required​string · maxLength: 1000​integer · required​integer · required​integer · required​integer · required​integer · required​string · uuid · required​string · required​string · required​string · required​integer · required​integer · required​integer​string​string​string​string​string​string · date-time​string · date-time
Schemas
OtpIssueRequest
phonepurposeEnum values:
register
login
reset_pin
OtpVerifyRequest
phonecodeRegisterRequest
phonefullNamepinotpTokenemailLoginRequest
phonepinAuthTokenResponse
accessTokenrefreshTokenexpiresInendUserIdwalletProvisioningFeatureInterestRequest
featureKeysourcelocaleregionTransferRequest
amountfromBlnkBalanceIdtoBlnkBalanceIdrecipientAliascurrencyreferencenoteCashInRequest
amountprovidermsisdncurrencyAirtimeRequest
amountmsisdnoperatorcountryIso2BillPayRequest
amountbilleraccountReferencecountryIso2SavingsPotRequest
namedescriptiontargetAmounttargetDatecurrencyiconcolorSavingsMovementRequest
amountsourceWalletBalanceIddestinationWalletBalanceIdreferenceVirtualCardRequest
labeldescriptionspendingLimitcurrencycolorreferenceWebhookSubscriptionRequest
urleventTypessecretMarketplaceProgrammeRequest
programmeRefnamedescriptionstatusEnum values:
draft
active
paused
completed
cancelled
Default: draft
MarketplaceProgramme
idprogrammeRefnamestatusisActivedescriptioncreatedAtupdatedAtMarketplaceProgrammeListResponse
​MarketplaceProgramme[] · required
MarketplaceOpportunityRequest
opportunityReftitleprogrammeRefdescriptionbuyerNamelocationcurrencyestimatedValueMinorstatusEnum values:
draft
open
assigned
in_progress
completed
cancelled
Default: draft
MarketplaceOpportunity
idopportunityReftitlecurrencystatusisActiveprogrammeRefdescriptionbuyerNamelocationestimatedValueMinorcontractablecreatedAtupdatedAtMarketplaceOpportunityListResponse
​MarketplaceOpportunity[] · required
MarketplaceParticipantRequest
participantRefdisplayNameroleEnum values:
buyer
supplier
contractor
verifier
funder
operator
Default: supplier
statusEnum values:
draft
active
suspended
archived
Default: draft
walletPhonecontactEmailcountryIso2notesMarketplaceParticipant
idparticipantRefdisplayNamerolestatusisActivewalletPhonecontactEmailcountryIso2notesassignablecreatedAtupdatedAtMarketplaceParticipantListResponse
​MarketplaceParticipant[] · required
MarketplaceAssignmentRequest
opportunityRefparticipantRefroleEnum values:
supplier
contractor
verifier
funder
operator
Default: supplier
statusEnum values:
proposed
assigned
accepted
declined
cancelled
completed
Default: assigned
notesMarketplaceAssignment
idopportunityRefparticipantRefrolestatusisActivenotesassignedAtlocksOpportunitycreatedAtupdatedAtMarketplaceAssignmentListResponse
​MarketplaceAssignment[] · required
MarketplaceMilestoneRequest
milestoneRefopportunityReftitlecontractRefexpectedCountDefault: 1
completedCountDefault: 0
statusEnum values:
planned
in_progress
pending_review
approved
rejected
completed
blocked
Default: planned
evidenceRequiredDefault: true
paymentRuledueDatenotesMarketplaceMilestone
idmilestoneRefopportunityReftitleexpectedCountcompletedCountprogressLabelstatusevidenceRequiredisActivecontractRefpaymentRuledueDatenotesreadyForReviewcreatedAtupdatedAtMarketplaceMilestoneListResponse
​MarketplaceMilestone[] · required
MarketplaceEvidenceRequest
evidenceRefmilestoneReftitleparticipantRefevidenceTypeEnum values:
photo
pdf
report
receipt
note
other
Default: other
uriVault, object storage, signed URL, or partner evidence reference.
checksumSha256^[a-fA-F0-9]{64}$contentTypestorageProviderEnum values:
vault
object_storage
signed_url
partner
manual
Default: vault
objectKeyObject key or vault path without credentials.
byteSizeattachmentStatusEnum values:
referenced
uploaded
verified
missing
Default: referenced
visibilityEnum values:
operator_only
participant_visible
wallet_holder_visible
Default: operator_only
retentionPolicyEnum values:
standard
contract_lifetime
regulatory_hold
delete_after_review
Default: standard
statusEnum values:
submitted
under_review
approved
rejected
Default: submitted
notesreviewNoterejectionReasonRequired when status is rejected.
MarketplaceEvidence
idevidenceRefmilestoneRefevidenceTypetitlestatusreviewClosedisActiveparticipantRefurichecksumSha256contentTypestorageProviderobjectKeybyteSizeattachmentStatusvisibilityretentionPolicyverifiedAtnotesreviewNoterejectionReasonreviewedAtcreatedAtupdatedAtMarketplaceEvidenceListResponse
​MarketplaceEvidence[] · required
MarketplacePaymentControlRequest
controlRefmilestoneRefamountMinorcurrencyevidenceRefApproved evidence reference backing release eligibility.
contractRefbeneficiaryParticipantRefrailEnum values:
wallet
mobile_money
bank
manual
other
Default: manual
statusEnum values:
draft
release_eligible
pending_approval
approved
submitted
settled
failed
blocked
Default: draft
approvalNoterejectionReasonexternalReferencenotesMarketplacePaymentControl
idcontrolRefmilestoneRefamountMinorcurrencyrailstatusexecutionApprovedterminalisActiveevidenceRefcontractRefbeneficiaryParticipantRefapprovalNoterejectionReasonexternalReferenceapprovedAtsubmittedAtsettledAtnotescreatedAtupdatedAtMarketplacePaymentControlListResponse
​MarketplacePaymentControl[] · required
MarketplacePaymentExecutionRequest
executionRefcontrolRefproviderEnum values:
wallet_gateway
mobile_money_gateway
bank_gateway
blnk
manual
partner
Default: manual
providerExecutionRefExternal gateway or provider execution id when available.
statusEnum values:
queued
submitted
settled
failed
cancelled
manual_review
Default: queued
attemptNumberDefault: 1
responseCoderesponseMessageProvider-safe response message. Do not include secrets or raw PII.
submittedAtsettledAtfailedAt​object
Small safe metadata object. Do not include secrets.
notesMarketplacePaymentProviderEventRequest
providerProvider that emitted the callback or reconciliation result.
Enum values:
wallet_gateway
mobile_money_gateway
bank_gateway
blnk
manual
partner
providerExecutionRefExternal provider execution id already stored on a marketplace payment execution.
statusProvider state to apply to the existing execution.
Enum values:
queued
submitted
settled
failed
cancelled
manual_review
responseCoderesponseMessageProvider-safe response detail. Do not include secrets or raw PII.
occurredAtTimestamp supplied by the provider or reconciliation run.
submittedAtsettledAtfailedAt​object
Small safe metadata object. Do not include secrets.
notesMarketplacePaymentExecution
idexecutionRefcontrolRefproviderstatusattemptNumberamountMinorcurrencyproviderExecutionRefresponseCoderesponseMessagesubmittedAtsettledAtfailedAt​object
notescreatedAtupdatedAtMarketplacePaymentExecutionListResponse
​MarketplacePaymentExecution[] · required
ContractVaultRequest
contractRefInstitution contract or procurement reference.
titlecounterpartyNameSupplier, contractor, or counterparty display name.
phoneWallet holder phone in E.164 format.
endUserIdWallet holder id.
programmeNameopportunityRefMarketplace opportunity, tender, or value-chain lot reference.
participantRoleEnum values:
buyer
supplier
contractor
verifier
funder
operator
statusEnum values:
pending_activation
active
in_progress
pending_review
funded
disbursing
completed
blocked
currencycontractValueMinormilestoneTotalmilestoneCompletednextMilestoneLabelnextMilestoneDueAtcontrolProfileEnum values:
standard
treasury_control
restricted_disbursement
evidence_required
paymentControlStatusEnum values:
not_started
awaiting_evidence
pending_approval
ready_to_disburse
disbursing
disbursed
blocked
anchoringStatusEnum values:
not_anchored
ready_to_anchor
anchored
failed
evidenceCountoneOf
Exactly one variant must match.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: phone | |
| type = object · requires: endUserId |
phoneWallet holder phone in E.164 format.
endUserIdWallet holder id.
contractRefInstitution contract or procurement reference.
titlecounterpartyNameSupplier, contractor, or counterparty display name.
programmeNameopportunityRefMarketplace opportunity, tender, or value-chain lot reference.
participantRoleEnum values:
buyer
supplier
contractor
verifier
funder
operator
statusEnum values:
pending_activation
active
in_progress
pending_review
funded
disbursing
completed
blocked
currencycontractValueMinormilestoneTotalmilestoneCompletednextMilestoneLabelnextMilestoneDueAtcontrolProfileEnum values:
standard
treasury_control
restricted_disbursement
evidence_required
paymentControlStatusEnum values:
not_started
awaiting_evidence
pending_approval
ready_to_disburse
disbursing
disbursed
blocked
anchoringStatusEnum values:
not_anchored
ready_to_anchor
anchored
failed
evidenceCountContractVaultSummary
totalContractsactiveContractspendingReviewopenMilestonescompletedMilestonestotalMilestonesmarketplaceContractsopenPaymentControlsanchoredContractsevidenceCount​object · required
totalValueMinorcurrencyContractVaultRecord
idcontractReftitlecounterpartyNamestatuscurrencymilestoneTotalmilestoneCompletedmilestoneProgresscontrolProfilepaymentControlStatusanchoringStatusevidenceCount​object · required
​ContractCommitment[] · required
Structured commitments attached to this scoped contract.
programmeNameopportunityRefparticipantRolecontractValueMinornextMilestoneLabelnextMilestoneDueAtlastActivityAtcreatedAtContractVaultListResponse
​ContractVaultSummary · required
​ContractVaultRecord[] · required
ContractCommitmentRequest
contractRefcommitmentReftitledescriptionClause, operational detail, or extracted text.
categoryEnum values:
deliverable
quantity
payment
compliance
reporting
other
unitLabelexpectedQuantitycompletedQuantitystatusEnum values:
pending
in_progress
satisfied
blocked
cancelled
verifierRefdueDatesourceEnum values:
manual
extracted
imported
extractionRefevidencePolicynotesContractCommitmentSummary
totalCommitmentscompletedCommitmentsblockedCommitmentsneedsAttentionexpectedQuantitycompletedQuantityprogressLabelContractCommitment
idcontractRefcommitmentReftitlecategoryexpectedQuantitycompletedQuantityprogressLabelstatussourcecompleteneedsAttentiondescriptionunitLabelverifierRefdueDateextractionRefevidencePolicynotescreatedAtupdatedAtContractCommitmentListResponse
​ContractCommitmentSummary · required
​ContractCommitment[] · required
ContractVersionRequest
contractRefversionNumbercontentHash^[A-Fa-f0-9]{64}$ · requiredtitlehashAlgorithmEnum values:
sha256
documentUristorageRefstatusEnum values:
draft
pending_signature
signed
superseded
voided
signatureStatusEnum values:
not_required
pending
partially_signed
signed
rejected
isCurrentsourceEnum values:
manual
upload
extracted
imported
extractionRefsignerSummary​object
notesContractVersionAnchorEventRequest
contractRefversionNumberanchorRefprovideranchoringStatusEnum values:
not_anchored
ready_to_anchor
anchored
failed
contentHash^[A-Fa-f0-9]{64}$chainIdtransactionHashvaultRefoccurredAt​object
notesContractVersionSummary
totalVersionssignedVersionscurrentVersionNumbercurrentProofLabelContractVersion
idcontractRefversionNumbercontentHashhashAlgorithmproofLabelstatussignatureStatusisCurrentsourcetitledocumentUristorageRefextractionRefsignerSummary​object
notescreatedAtupdatedAtContractVersionListResponse
​ContractVersionSummary · required
​ContractVersion[] · required
ContractSignatureProviderRequestInput
requestRefcontractRefversionNumbersignerRefsproviderEnum values:
manual
provider_gateway
partner_api
wet_signature
qualified_electronic
Default: manual
providerRequestRefstatusEnum values:
requested
sent
viewed
completed
rejected
expired
cancelled
failed
Default: requested
channelEnum values:
email
sms
whatsapp
in_app
manual
Default: manual
titlesignerSummarycallbackUrlexpiresAtsentAtcompletedAt​object
notesContractSignatureProviderEventRequest
providerEnum values:
manual
provider_gateway
partner_api
wet_signature
qualified_electronic
providerRequestRefsignerRefstatusEnum values:
pending
sent
viewed
signed
rejected
expired
proofRefproofHash^[A-Fa-f0-9]{64}$occurredAtsignedAtrejectedAt​object
notesContractSignatureProviderRequestSummary
totalRequestsactiveRequestscompletedRequestsfailedRequestsContractSignatureProviderRequest
requestRefcontractRefversionNumberproviderEnum values:
manual
provider_gateway
partner_api
wet_signature
qualified_electronic
Default: manual
statusEnum values:
requested
sent
viewed
completed
rejected
expired
cancelled
failed
Default: requested
channelEnum values:
email
sms
whatsapp
in_app
manual
Default: manual
signerRefsidproviderRequestReftitlesignerSummarycallbackUrlexpiresAtsentAtcompletedAtmetadatanotescreatedAtupdatedAtContractSignatureProviderRequestListResponse
​ContractSignatureProviderRequestSummary · required
​ContractSignatureProviderRequest[] · required
ContractSignatureRequest
contractRefversionNumbersignerRefsignerRolesignerLabelstatusEnum values:
pending
sent
viewed
signed
rejected
expired
Default: pending
methodEnum values:
manual
otp
provider
wet_signature_upload
qualified_electronic
Default: manual
proofRefproofHash^[A-Fa-f0-9]{64}$signedAtrejectedAt​object
notesContractSignatureSummary
totalSignaturessignedSignaturespendingSignaturesrejectedSignaturesexpiredSignaturesContractSignature
idcontractRefversionNumbersignerRefstatusmethodsignerRolesignerLabelproofRefproofHashsignedAtrejectedAt​object
notescreatedAtupdatedAtContractSignatureListResponse
​ContractSignatureSummary · required
​ContractSignature[] · required
ContractEventRequest
contractRefeventRefeventTypeEnum values:
contract_recorded
version_recorded
signature_requested
signature_recorded
commitment_recorded
commitment_progressed
evidence_recorded
payment_control_recorded
titledescriptioncommitmentRefversionNumbersourceEnum values:
manual
system
extracted
imported
gateway
anchoring
actorRef​object
Small structured metadata. Do not include secrets.
occurredAtContractEventSummary
totalEventscontractRefslatestOccurredAtContractEvent
idcontractRefeventRefeventTypetitlesourcedescriptioncommitmentRefversionNumberactorRef​object
occurredAtcreatedAtContractEventListResponse
​ContractEventSummary · required
​ContractEvent[] · required
ExtractedCommitmentInput
commitmentReftitledescriptioncategoryEnum values:
deliverable
quantity
payment
compliance
reporting
other
unitLabelexpectedQuantitycompletedQuantitystatusEnum values:
pending
in_progress
satisfied
blocked
cancelled
verifierRefdueDateevidencePolicynotesContractExtractionRequest
contractRefextractionRefsourceVersionNumberdocumentUristorageRefengineRefstatusEnum values:
received
proposed
accepted
rejected
failed
summary​object
Small structured extractor metadata. Do not include secrets.
notes​ExtractedCommitmentInput[] · maxItems: 50
ContractExtractionDecisionRequest
extractionRefstatusEnum values:
accepted
rejected
notesContractExtractionSummary
totalExtractionsproposedExtractionsacceptedExtractionsfailedExtractionscommitmentCountContractExtraction
idcontractRefextractionRefstatuscommitmentCountacceptedCommitmentCountsourceVersionNumberdocumentUristorageRefengineRefsummary​object
notescreatedAtupdatedAtContractExtractionListResponse
​ContractExtractionSummary · required
​ContractExtraction[] · required