Request a payment instance

A payment instance is a virtual TPE. You create payment links under it. Use one instance for each place that should settle and report separately, such as a branch or a tenant of your product.

Your token needs the instances:write scope, and your identification, brand and bank account must be accepted.

Request the instance

A request opens a transaction for the activation fee. Send an Idempotency-Key so that a retry can't start a second activation.

curl -X POST https://api.mytpe.app/api/ext/instances \
  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN" \
  -H "Idempotency-Key: branch-alger-activation" \
  -F "title=Boutique Centrale, Alger" \
  -F "identification_id=your-identification-id" \
  -F "brand_id=your-brand-id" \
  -F "bank_account_id=your-bank-account-id" \
  -F "payment_method=online"

{
  "data": {
    "transaction_id": "8e7d6c5b-4a39-2817-0f6e-5d4c3b2a1908",
    "status": "processing",
    "payment_method": "online",
    "amount": "3000.00",
    "currency": "DZD",
    "form_url": "https://gateway.example/payment/abc123"
  }
}

Pay the activation

• If payment_method is online, send the merchant to form_url.
• If it's bank_transfer or cheque, attach a payment_proof file to the request. A MyTPE officer checks it.

Wait until the instance is ready

An instance has two statuses:

To be notified, subscribe to the payment_instance.acceptance_changed webhook event. When acceptance_status is ready and status is active, you can create payment links.

For every value, see Statuses and enums and Payment instances.