Cashier-initiated enrollment: create a PENDING_PROOF wallet + SMS a verification link

curl --request POST \
  --url https://api.feddi.io/v1/partner/enroll/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "meta": {
    "partner_request_id": "1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f",
    "occurred_at": "2026-06-05T09:40:00Z",
    "sent_at": "2026-06-05T09:40:01Z",
    "api_version": "2026-06-01"
  },
  "context": {
    "merchant_id": "11111111-1111-1111-1111-111111111111",
    "branch_id": "22222222-2222-2222-2222-222222222222",
    "terminal_id": "POS-360-0007",
    "cashier_id": "cashier-42",
    "partner_session_id": "ord-99841",
    "feddi_session_id": "33333333-3333-3333-3333-333333333333"
  },
  "phone": "+97433001122",
  "provider_customer_id": "odoo-cust-5521",
  "wallet_program_id": null,
  "language": "en"
}
'

import requests

url = "https://api.feddi.io/v1/partner/enroll/initiate"

payload = {
    "meta": {
        "partner_request_id": "1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f",
        "occurred_at": "2026-06-05T09:40:00Z",
        "sent_at": "2026-06-05T09:40:01Z",
        "api_version": "2026-06-01"
    },
    "context": {
        "merchant_id": "11111111-1111-1111-1111-111111111111",
        "branch_id": "22222222-2222-2222-2222-222222222222",
        "terminal_id": "POS-360-0007",
        "cashier_id": "cashier-42",
        "partner_session_id": "ord-99841",
        "feddi_session_id": "33333333-3333-3333-3333-333333333333"
    },
    "phone": "+97433001122",
    "provider_customer_id": "odoo-cust-5521",
    "wallet_program_id": None,
    "language": "en"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    meta: {
      partner_request_id: '1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f',
      occurred_at: '2026-06-05T09:40:00Z',
      sent_at: '2026-06-05T09:40:01Z',
      api_version: '2026-06-01'
    },
    context: {
      merchant_id: '11111111-1111-1111-1111-111111111111',
      branch_id: '22222222-2222-2222-2222-222222222222',
      terminal_id: 'POS-360-0007',
      cashier_id: 'cashier-42',
      partner_session_id: 'ord-99841',
      feddi_session_id: '33333333-3333-3333-3333-333333333333'
    },
    phone: '+97433001122',
    provider_customer_id: 'odoo-cust-5521',
    wallet_program_id: null,
    language: 'en'
  })
};

fetch('https://api.feddi.io/v1/partner/enroll/initiate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.feddi.io/v1/partner/enroll/initiate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'meta' => [
        'partner_request_id' => '1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f',
        'occurred_at' => '2026-06-05T09:40:00Z',
        'sent_at' => '2026-06-05T09:40:01Z',
        'api_version' => '2026-06-01'
    ],
    'context' => [
        'merchant_id' => '11111111-1111-1111-1111-111111111111',
        'branch_id' => '22222222-2222-2222-2222-222222222222',
        'terminal_id' => 'POS-360-0007',
        'cashier_id' => 'cashier-42',
        'partner_session_id' => 'ord-99841',
        'feddi_session_id' => '33333333-3333-3333-3333-333333333333'
    ],
    'phone' => '+97433001122',
    'provider_customer_id' => 'odoo-cust-5521',
    'wallet_program_id' => null,
    'language' => 'en'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.feddi.io/v1/partner/enroll/initiate"

	payload := strings.NewReader("{\n  \"meta\": {\n    \"partner_request_id\": \"1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f\",\n    \"occurred_at\": \"2026-06-05T09:40:00Z\",\n    \"sent_at\": \"2026-06-05T09:40:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\",\n    \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n    \"terminal_id\": \"POS-360-0007\",\n    \"cashier_id\": \"cashier-42\",\n    \"partner_session_id\": \"ord-99841\",\n    \"feddi_session_id\": \"33333333-3333-3333-3333-333333333333\"\n  },\n  \"phone\": \"+97433001122\",\n  \"provider_customer_id\": \"odoo-cust-5521\",\n  \"wallet_program_id\": null,\n  \"language\": \"en\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.feddi.io/v1/partner/enroll/initiate")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meta\": {\n    \"partner_request_id\": \"1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f\",\n    \"occurred_at\": \"2026-06-05T09:40:00Z\",\n    \"sent_at\": \"2026-06-05T09:40:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\",\n    \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n    \"terminal_id\": \"POS-360-0007\",\n    \"cashier_id\": \"cashier-42\",\n    \"partner_session_id\": \"ord-99841\",\n    \"feddi_session_id\": \"33333333-3333-3333-3333-333333333333\"\n  },\n  \"phone\": \"+97433001122\",\n  \"provider_customer_id\": \"odoo-cust-5521\",\n  \"wallet_program_id\": null,\n  \"language\": \"en\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.feddi.io/v1/partner/enroll/initiate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"meta\": {\n    \"partner_request_id\": \"1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f\",\n    \"occurred_at\": \"2026-06-05T09:40:00Z\",\n    \"sent_at\": \"2026-06-05T09:40:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\",\n    \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n    \"terminal_id\": \"POS-360-0007\",\n    \"cashier_id\": \"cashier-42\",\n    \"partner_session_id\": \"ord-99841\",\n    \"feddi_session_id\": \"33333333-3333-3333-3333-333333333333\"\n  },\n  \"phone\": \"+97433001122\",\n  \"provider_customer_id\": \"odoo-cust-5521\",\n  \"wallet_program_id\": null,\n  \"language\": \"en\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "wallet_user_id": "wu_aa01",
    "customer_state": "pending_proof",
    "phone": "+97433001122",
    "wallet_program_id": "wp_77",
    "verification_sent": true,
    "verification_channel": "sms",
    "verification_expires_at": "2026-06-05T10:10:00Z",
    "provider_customer_map_created": false,
    "is_new": true,
    "session_id": "33333333-3333-3333-3333-333333333333"
  },
  "error": null,
  "meta": {
    "request_id": "req_en1",
    "idempotency_replayed": false,
    "api_version": "2026-06-01",
    "data_completeness_score": 55
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": false,
  "data": null,
  "error": {
    "code": "WALLET_PROGRAM_AMBIGUOUS",
    "message": "Phone resolves to multiple wallet programs; specify wallet_program_id.",
    "details": {
      "candidates": [
        "wp_77",
        "wp_91"
      ]
    }
  },
  "meta": {
    "request_id": "req_en9",
    "idempotency_replayed": false,
    "api_version": "2026-06-01"
  }
}

enrollment

Cashier-initiated enrollment: create a PENDING_PROOF wallet + SMS a verification link

Initiates cashier-led customer enrollment by creating a wallet identity in the PENDING_PROOF state and sending the customer an SMS verification link. This is step 1 of the two-step signup flow; step 2 is POST /enroll/verify, where the customer proves phone ownership.

The request supplies a phone number, which is normalized to E.164 and used to find-or-create the customer’s wallet identity in the PENDING_PROOF state, scoped to (merchant_id, normalized_phone). A single-use, short-TTL signed verification link is then issued and delivered by SMS.

No money moves and no provider-customer link is created at this step. Both occur only at POST /enroll/verify once the customer proves ownership of the phone number.

The PENDING_PROOF wallet identity acts as an escrow target. Any promotional value accrued for an unverified customer (for example a top-up bonus or cashback) is held as a LOCKED promotional grant until verification flips the state and releases it.

A wallet identity is unique on (merchant_id, normalized_phone): the same phone number at a different merchant is a different customer. Wallet balances and grants are isolated per merchant in a closed loop and do not cross merchant boundaries.

This endpoint is idempotent on the Idempotency-Key header. A retry with the same key replays the original wallet identity and verification link without sending a new SMS and without resetting the resend rate-limit window.

If a feddi_session_id is supplied, the enrollment is associated with the live checkout session; otherwise the enrollment is standalone.

The verification SMS is transactional and does not require marketing consent opt-in.

POST

enroll

initiate

Cashier-initiated enrollment: create a PENDING_PROOF wallet + SMS a verification link

curl --request POST \
  --url https://api.feddi.io/v1/partner/enroll/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "meta": {
    "partner_request_id": "1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f",
    "occurred_at": "2026-06-05T09:40:00Z",
    "sent_at": "2026-06-05T09:40:01Z",
    "api_version": "2026-06-01"
  },
  "context": {
    "merchant_id": "11111111-1111-1111-1111-111111111111",
    "branch_id": "22222222-2222-2222-2222-222222222222",
    "terminal_id": "POS-360-0007",
    "cashier_id": "cashier-42",
    "partner_session_id": "ord-99841",
    "feddi_session_id": "33333333-3333-3333-3333-333333333333"
  },
  "phone": "+97433001122",
  "provider_customer_id": "odoo-cust-5521",
  "wallet_program_id": null,
  "language": "en"
}
'

import requests

url = "https://api.feddi.io/v1/partner/enroll/initiate"

payload = {
    "meta": {
        "partner_request_id": "1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f",
        "occurred_at": "2026-06-05T09:40:00Z",
        "sent_at": "2026-06-05T09:40:01Z",
        "api_version": "2026-06-01"
    },
    "context": {
        "merchant_id": "11111111-1111-1111-1111-111111111111",
        "branch_id": "22222222-2222-2222-2222-222222222222",
        "terminal_id": "POS-360-0007",
        "cashier_id": "cashier-42",
        "partner_session_id": "ord-99841",
        "feddi_session_id": "33333333-3333-3333-3333-333333333333"
    },
    "phone": "+97433001122",
    "provider_customer_id": "odoo-cust-5521",
    "wallet_program_id": None,
    "language": "en"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    meta: {
      partner_request_id: '1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f',
      occurred_at: '2026-06-05T09:40:00Z',
      sent_at: '2026-06-05T09:40:01Z',
      api_version: '2026-06-01'
    },
    context: {
      merchant_id: '11111111-1111-1111-1111-111111111111',
      branch_id: '22222222-2222-2222-2222-222222222222',
      terminal_id: 'POS-360-0007',
      cashier_id: 'cashier-42',
      partner_session_id: 'ord-99841',
      feddi_session_id: '33333333-3333-3333-3333-333333333333'
    },
    phone: '+97433001122',
    provider_customer_id: 'odoo-cust-5521',
    wallet_program_id: null,
    language: 'en'
  })
};

fetch('https://api.feddi.io/v1/partner/enroll/initiate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.feddi.io/v1/partner/enroll/initiate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'meta' => [
        'partner_request_id' => '1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f',
        'occurred_at' => '2026-06-05T09:40:00Z',
        'sent_at' => '2026-06-05T09:40:01Z',
        'api_version' => '2026-06-01'
    ],
    'context' => [
        'merchant_id' => '11111111-1111-1111-1111-111111111111',
        'branch_id' => '22222222-2222-2222-2222-222222222222',
        'terminal_id' => 'POS-360-0007',
        'cashier_id' => 'cashier-42',
        'partner_session_id' => 'ord-99841',
        'feddi_session_id' => '33333333-3333-3333-3333-333333333333'
    ],
    'phone' => '+97433001122',
    'provider_customer_id' => 'odoo-cust-5521',
    'wallet_program_id' => null,
    'language' => 'en'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.feddi.io/v1/partner/enroll/initiate"

	payload := strings.NewReader("{\n  \"meta\": {\n    \"partner_request_id\": \"1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f\",\n    \"occurred_at\": \"2026-06-05T09:40:00Z\",\n    \"sent_at\": \"2026-06-05T09:40:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\",\n    \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n    \"terminal_id\": \"POS-360-0007\",\n    \"cashier_id\": \"cashier-42\",\n    \"partner_session_id\": \"ord-99841\",\n    \"feddi_session_id\": \"33333333-3333-3333-3333-333333333333\"\n  },\n  \"phone\": \"+97433001122\",\n  \"provider_customer_id\": \"odoo-cust-5521\",\n  \"wallet_program_id\": null,\n  \"language\": \"en\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.feddi.io/v1/partner/enroll/initiate")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meta\": {\n    \"partner_request_id\": \"1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f\",\n    \"occurred_at\": \"2026-06-05T09:40:00Z\",\n    \"sent_at\": \"2026-06-05T09:40:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\",\n    \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n    \"terminal_id\": \"POS-360-0007\",\n    \"cashier_id\": \"cashier-42\",\n    \"partner_session_id\": \"ord-99841\",\n    \"feddi_session_id\": \"33333333-3333-3333-3333-333333333333\"\n  },\n  \"phone\": \"+97433001122\",\n  \"provider_customer_id\": \"odoo-cust-5521\",\n  \"wallet_program_id\": null,\n  \"language\": \"en\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.feddi.io/v1/partner/enroll/initiate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"meta\": {\n    \"partner_request_id\": \"1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f\",\n    \"occurred_at\": \"2026-06-05T09:40:00Z\",\n    \"sent_at\": \"2026-06-05T09:40:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\",\n    \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n    \"terminal_id\": \"POS-360-0007\",\n    \"cashier_id\": \"cashier-42\",\n    \"partner_session_id\": \"ord-99841\",\n    \"feddi_session_id\": \"33333333-3333-3333-3333-333333333333\"\n  },\n  \"phone\": \"+97433001122\",\n  \"provider_customer_id\": \"odoo-cust-5521\",\n  \"wallet_program_id\": null,\n  \"language\": \"en\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "wallet_user_id": "wu_aa01",
    "customer_state": "pending_proof",
    "phone": "+97433001122",
    "wallet_program_id": "wp_77",
    "verification_sent": true,
    "verification_channel": "sms",
    "verification_expires_at": "2026-06-05T10:10:00Z",
    "provider_customer_map_created": false,
    "is_new": true,
    "session_id": "33333333-3333-3333-3333-333333333333"
  },
  "error": null,
  "meta": {
    "request_id": "req_en1",
    "idempotency_replayed": false,
    "api_version": "2026-06-01",
    "data_completeness_score": 55
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": false,
  "data": null,
  "error": {
    "code": "WALLET_PROGRAM_AMBIGUOUS",
    "message": "Phone resolves to multiple wallet programs; specify wallet_program_id.",
    "details": {
      "candidates": [
        "wp_77",
        "wp_91"
      ]
    }
  },
  "meta": {
    "request_id": "req_en9",
    "idempotency_replayed": false,
    "api_version": "2026-06-01"
  }
}

Authorizations

Authorization

string

header

required

POS terminal JWT minted by /auth/token; carries integrationId + terminal/cashier claims (server-trusted).

Headers

Idempotency-Key

string<uuid>

required

Partner-generated UUID; the ONE dedup key for all mutating endpoints. 24h TTL. Same key + same payload -> byte-identical replay; same key + different payload -> IDEMPOTENCY_KEY_REUSED (422).

Body

application/json

Body for POST /enroll/initiate. The cashier supplies a phone (E.164-normalized server-side) and optionally the POS provider customer-id.

context

object

required

Canonical request context, shared across all partner domains. merchant_id is key-enforced to a merchant the calling credential is authorized for (a platform-scoped credential acts only on its own tenants), so it is never a free-text trust field: a merchant_id outside the credential's authority is rejected rather than honored.

Show child attributes

phone

string

required

The customer's phone; normalized to E.164 server-side. The identity key is (merchant_id, normalized_phone).

Response

PENDING_PROOF proto-wallet created (or idempotent replay) and the verification SMS dispatched. No money moved, no provider-customer link yet.

The standard response envelope that every enveloped endpoint serializes through. ok is a boolean discriminator: when ok is true, the typed result is carried in data; when ok is false, a typed error object is returned instead. The meta object is uniform across the entire API surface.

boolean

required

Overview

Endpoints

Cashier-initiated enrollment: create a PENDING_PROOF wallet + SMS a verification link

Authorizations

Headers

Body

Response