PayPM Platform API
​string · uuid · required​integer · min: 1​integer · min: 1 · max: 100​string​string · enum
​string · uuid · required​string · required​string · enum · required​string · required​string · enum · required​string · date-time · required​string · uuid​string​string​string · enum​string · uuid​string​string · enum​string · enum​string · date-time​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · uuid​string​string​string · enum​string · uuid​string​string · enum​string · enum​string · date-time​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · uuid​string​string​string · enum​string · uuid​string​string · enum​string · enum​string · date-time​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · uuid​string​string​string · enum​string · uuid​string​string · enum​string · enum​string · date-time​string · date-time​string · date-time
​string · uuid · required​string · enum​string​string · enum​string · enum​string · date-time
​string · uuid · required​integer · min: 1​integer · min: 1 · max: 100​string​string · enum
​string · uuid · required​string · date-time · required​string · date-time · required​string​string · date-time​string · date-time​string · enum​integer​string​integer​string​string​string · enum​​
​string · uuid · required​string · uuid · required​string · uuid​string​string · uuid​string​string​string​string · date-time​string · date-time
​string · uuid · required​integer · min: 1​integer · min: 1 · max: 100​string​string · enum
​string · uuid · required​string · uuid · required​string · required​string · uuid​string · uuid​string · uuid​string · uuid​string · enum​string · enum​string · date-time
​string · uuid · required​string · uuid · required​string · uuid​string · uuid​string · uuid​string · uuid​string · enum​string · enum​string · date-time
​string · uuid · required​string · uuid​string​string​string​string​string​string​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · minLength: 1 · maxLength: 100 · required​string · minLength: 1 · maxLength: 100​string · enum​string · uri · maxLength: 2048​string · maxLength: 3​string · maxLength: 1000​string · maxLength: 1000​string · uuid​string​string​string​string​string​string​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · uuid​string​string​string​string​string​string​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · minLength: 1 · maxLength: 100​string · minLength: 1 · maxLength: 100​string · enum​string · uri · maxLength: 2048​string · maxLength: 3​string · maxLength: 1000​string · maxLength: 1000​boolean​string · uuid​string​string​string​string​string​string​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · uuid​string​string​string​string​string​string​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · uuid​string · uuid​string​string​string · uuid​string​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · minLength: 1 · maxLength: 100 · required​string · email · maxLength: 254 · required​string · enum​string · enum​string · uuid​string​string​string · uuid​string​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · uuid​string​string​string · uuid​string​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · uuid​string · minLength: 1 · maxLength: 100​string · email · maxLength: 254​string · enum​string · enum​boolean​string · uuid​string​string​string · uuid​string​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · uuid​string · uuid​string​string​string · uuid​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · minLength: 1 · maxLength: 100 · required​string · maxLength: 1000​string · maxLength: 20​string · uuid​string​string​string · uuid​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · uuid​string​string​string · uuid​string​string​string​boolean​string · date-time​string · date-time
​string · uuid · required​string · uuid · required​string · uuid​string · minLength: 1 · maxLength: 100​string · maxLength: 1000​string · maxLength: 20​boolean​string · uuid​string​string​string · uuid​string​string​string​boolean​string · date-time​string · date-time
List pay intents in actor scope
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/pay-intents
path Parameters
merchantBusinessIdquery Parameters
pageDefault: 1
limitDefault: 10
sortByDefault: createdAt
sortOrderEnum values:
ASC
DESC
Default: DESC
List pay intents in actor scope › Responses
Paginated pay intents.
Create a pay intent
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/pay-intents
Requires Idempotency-Key, exact positive XOF minor units, and one presentation channel. Does not authorize a wallet debit or claim settlement.
path Parameters
merchantBusinessIdHeaders
Idempotency-KeyCreate a pay intent › Request Body
instrumentTypeEnum values:
DYNAMIC_QR
PAYMENT_LINK
amountMinorUnitsExact positive amount in minor units.
currencyEnum values:
XOF
expiresAtISO-8601 expiry, no more than 24 hours in the future.
Create a pay intent › Responses
Pay intent created.
iddeploymentIdmerchantBusinessIdinstrumentTypeEnum values:
DYNAMIC_QR
PAYMENT_LINK
instrumentReferenceOpaque presentation reference. It is not payment authorization.
amountMinorUnitscurrencyEnum values:
XOF
statusEnum values:
OPEN
CANCELLED
EXPIRED
PAID
expiresAtcreatedAtupdatedAtGet a pay intent by id
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/pay-intents/{id}
path Parameters
merchantBusinessIdidGet a pay intent by id › Responses
Pay intent.
iddeploymentIdmerchantBusinessIdinstrumentTypeEnum values:
DYNAMIC_QR
PAYMENT_LINK
instrumentReferenceOpaque presentation reference. It is not payment authorization.
amountMinorUnitscurrencyEnum values:
XOF
statusEnum values:
OPEN
CANCELLED
EXPIRED
PAID
expiresAtcreatedAtupdatedAtCancel a pay intent
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/pay-intents/{id}/cancel
path Parameters
merchantBusinessIdidCancel a pay intent › Responses
Pay intent cancelled.
iddeploymentIdmerchantBusinessIdinstrumentTypeEnum values:
DYNAMIC_QR
PAYMENT_LINK
instrumentReferenceOpaque presentation reference. It is not payment authorization.
amountMinorUnitscurrencyEnum values:
XOF
statusEnum values:
OPEN
CANCELLED
EXPIRED
PAID
expiresAtcreatedAtupdatedAtFinalize an OPEN pay intent from existing immutable settlement proof
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/pay-intents/{id}/reconcile-settlement
path Parameters
merchantBusinessIdidFinalize an OPEN pay intent from existing immutable settlement proof › Responses
Pay intent reconciled from existing settlement proof.
iddeploymentIdmerchantBusinessIdinstrumentTypeEnum values:
DYNAMIC_QR
PAYMENT_LINK
instrumentReferenceOpaque presentation reference. It is not payment authorization.
amountMinorUnitscurrencyEnum values:
XOF
statusEnum values:
OPEN
CANCELLED
EXPIRED
PAID
expiresAtcreatedAtupdatedAtResolve a public pay instrument by opaque reference
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/pay-instruments/{reference}
Feature-gated public capability read. Possession permits presentation only and never authorizes payment. Does not return intent id, business id, subject, or idempotency metadata.
path Parameters
referenceResolve a public pay instrument by opaque reference › Responses
Instrument type, amount, currency, status, and expiry.
instrumentTypeEnum values:
DYNAMIC_QR
PAYMENT_LINK
amountMinorUnitscurrencyEnum values:
XOF
statusEnum values:
OPEN
CANCELLED
EXPIRED
PAID
expiresAtList settlement receipts in actor scope
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/settlement-receipts
path Parameters
merchantBusinessIdquery Parameters
pageDefault: 1
limitDefault: 10
sortByDefault: createdAt
sortOrderEnum values:
ASC
DESC
Default: DESC
List settlement receipts in actor scope › Responses
Paginated settlement receipts.
Get a settlement statement for a UTC period
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/settlement-receipts/statement
path Parameters
merchantBusinessIdquery Parameters
fromInclusive UTC start of the statement period
toExclusive UTC end of the statement period
Get a settlement statement for a UTC period › Responses
Settlement statement.
merchantBusinessIdfromtocurrencyEnum values:
XOF
settlementCountgrossSettledMinorUnitscompletedReversalCountreversedMinorUnitsnetSettledMinorUnitsmdrStatusEnum values:
UNCONFIGURED
mdrFeeMinorUnitsnetAfterMdrMinorUnitsGet a settlement receipt by id
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/settlement-receipts/{id}
path Parameters
merchantBusinessIdidGet a settlement receipt by id › Responses
Settlement receipt.
idmerchantBusinessIdpayIntentIdamountMinorUnitscurrencyproviderTransactionIdsettledAtcreatedAtList reversal requests in actor scope
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/reversal-requests
path Parameters
merchantBusinessIdquery Parameters
pageDefault: 1
limitDefault: 10
sortByDefault: createdAt
sortOrderEnum values:
ASC
DESC
Default: DESC
List reversal requests in actor scope › Responses
Paginated reversal requests.
Request staff review of a receipt-backed terminal settlement conflict
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/reversal-requests/pay-intents/{payIntentId}
Creates a reversal request. No approval or money movement occurs on this route.
path Parameters
merchantBusinessIdpayIntentIdHeaders
Idempotency-KeyRequest staff review of a receipt-backed terminal settlement conflict › Responses
Reversal request created.
idmerchantBusinessIdpayIntentIdsettlementReceiptIdreasonEnum values:
TERMINAL_STATE_CONFLICT
statusNo approval or money movement has occurred.
Enum values:
REQUESTED
createdAtGet a reversal request by id
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/reversal-requests/{id}
path Parameters
merchantBusinessIdidGet a reversal request by id › Responses
Reversal request.
idmerchantBusinessIdpayIntentIdsettlementReceiptIdreasonEnum values:
TERMINAL_STATE_CONFLICT
statusNo approval or money movement has occurred.
Enum values:
REQUESTED
createdAtList merchant organizations in actor scope
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/organizations
path Parameters
merchantBusinessIdList merchant organizations in actor scope › Responses
Merchant organizations.
iddeploymentIdmerchantBusinessIdlegalNametradeNamekybStatuskybEvidenceUrlcurrencyblnkBalanceIdblnkLedgerIdisActivecreatedAtupdatedAtCreate merchant organization (KYB pending)
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/organizations
path Parameters
merchantBusinessIdCreate merchant organization (KYB pending) › Request Body
legalNametradeNamekybStatusEnum values:
pending
approved
rejected
suspended
Default: pending
kybEvidenceUrlcurrencyDefault: XOF
blnkBalanceIdblnkLedgerIdCreate merchant organization (KYB pending) › Responses
Merchant organization created.
iddeploymentIdmerchantBusinessIdlegalNametradeNamekybStatuskybEvidenceUrlcurrencyblnkBalanceIdblnkLedgerIdisActivecreatedAtupdatedAtGet merchant organization by id
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/organizations/{id}
path Parameters
merchantBusinessIdidGet merchant organization by id › Responses
Merchant organization.
iddeploymentIdmerchantBusinessIdlegalNametradeNamekybStatuskybEvidenceUrlcurrencyblnkBalanceIdblnkLedgerIdisActivecreatedAtupdatedAtUpdate merchant organization
PUT
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/organizations/{id}
path Parameters
merchantBusinessIdidUpdate merchant organization › Request Body
legalNametradeNamekybStatusEnum values:
pending
approved
rejected
suspended
kybEvidenceUrlcurrencyblnkBalanceIdblnkLedgerIdisActiveUpdate merchant organization › Responses
Merchant organization updated.
iddeploymentIdmerchantBusinessIdlegalNametradeNamekybStatuskybEvidenceUrlcurrencyblnkBalanceIdblnkLedgerIdisActivecreatedAtupdatedAtGet KYB status and evidence
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/organizations/{id}/kyb
Update KYB status and evidence
PUT
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/organizations/{id}/kyb
path Parameters
merchantBusinessIdidUpdate KYB status and evidence › Responses
KYB updated.
iddeploymentIdmerchantBusinessIdlegalNametradeNamekybStatuskybEvidenceUrlcurrencyblnkBalanceIdblnkLedgerIdisActivecreatedAtupdatedAtList staff in actor scope
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/staff
path Parameters
merchantBusinessIdquery Parameters
merchantOrganizationIdList staff in actor scope › Responses
Staff members.
iddeploymentIdmerchantBusinessIdmerchantOrganizationIdnameemailrolestatusisActivecreatedAtupdatedAtInvite staff member in actor scope
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/staff
path Parameters
merchantBusinessIdInvite staff member in actor scope › Request Body
merchantOrganizationIdnameemailroleEnum values:
owner
operator
viewer
Default: operator
statusEnum values:
active
invited
suspended
Default: invited
Invite staff member in actor scope › Responses
Staff member invited.
iddeploymentIdmerchantBusinessIdmerchantOrganizationIdnameemailrolestatusisActivecreatedAtupdatedAtGet staff member by id
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/staff/{id}
path Parameters
merchantBusinessIdidGet staff member by id › Responses
Staff member.
iddeploymentIdmerchantBusinessIdmerchantOrganizationIdnameemailrolestatusisActivecreatedAtupdatedAtUpdate staff member
PUT
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/staff/{id}
path Parameters
merchantBusinessIdidUpdate staff member › Request Body
merchantOrganizationIdnameemailroleEnum values:
owner
operator
viewer
statusEnum values:
active
invited
suspended
isActiveUpdate staff member › Responses
Staff member updated.
iddeploymentIdmerchantBusinessIdmerchantOrganizationIdnameemailrolestatusisActivecreatedAtupdatedAtList outlets in actor scope
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/outlets
path Parameters
merchantBusinessIdquery Parameters
merchantOrganizationIdList outlets in actor scope › Responses
Outlets.
iddeploymentIdmerchantBusinessIdmerchantOrganizationIdnameaddressphoneisActivecreatedAtupdatedAtCreate outlet in actor scope
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/outlets
path Parameters
merchantBusinessIdCreate outlet in actor scope › Request Body
merchantOrganizationIdnameaddressphoneCreate outlet in actor scope › Responses
Outlet created.
iddeploymentIdmerchantBusinessIdmerchantOrganizationIdnameaddressphoneisActivecreatedAtupdatedAtGet outlet by id
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/outlets/{id}
path Parameters
merchantBusinessIdidGet outlet by id › Responses
Outlet.
iddeploymentIdmerchantBusinessIdmerchantOrganizationIdnameaddressphoneisActivecreatedAtupdatedAtUpdate outlet
PUT
https://sandbox-heritagepay-api.paypm.net/api/v1
/merchant/v1/businesses/{merchantBusinessId}/outlets/{id}
path Parameters
merchantBusinessIdidUpdate outlet › Request Body
merchantOrganizationIdnameaddressphoneisActiveUpdate outlet › Responses
Outlet updated.
iddeploymentIdmerchantBusinessIdmerchantOrganizationIdnameaddressphoneisActivecreatedAtupdatedAt