payabli/integration-skills

payabli-customers

Use when working with Payabli customer records — creating, reading, listing or searching, updating, or deleting customers, or showing a customer's transaction history (any CRM or customer portal).

ソースを見る

使い方

  1. インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
  2. 必要なツール、認証情報、対応環境を原文で確認します。
  3. 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/payabli/integration-skills --skill payabli-customers

開始前の確認

  • 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
  • スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文

見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。

Payabli customers

Manage the Pay In customer lifecycle: create, read, list/search, update, delete, and transaction history.

Load fundamentals first

If payabli-fundamentals is not already loaded, load it now, then continue.

On load

If payabli-integration.md exists at the repo root, read it; honor its ## SDK value.

Customers are per-paypoint and usually the first call

Each paypoint keeps its own customer list — customers aren't shared across paypoints. A customer is usually the first thing you create, since you can't run a charge without one. https://docs.payabli.com/guides/pay-ops-developer-customers-manage.md

Create a customer

POST /Customer/single/{entry}. The body is flat — firstname, lastname, email, and the rest sit at the top level, not wrapped in customerData the way the transaction endpoints nest them.

Custom key-value data goes in `additionalFields` on `POST /Customer/single/{entry}` and `PUT /Customer/{customerId}`. Those endpoints silently ignore additionalData: a request that sends it returns 200 and stores nothing. Transaction requests are the opposite: put custom customer data in customerData.additionalData, because customerData.additionalFields is dropped. A PUT with additionalFields merges into the existing keys. Read the stored values back from AdditionalFields on the customer record.

Custom identifiers drive matching — read the config before your first create. A create or update must supply a value for at least one of the paypoint's configured identifier fields, named in an identifierFields array (reads and deletes use customerId in the path and don't need it). Which fields count is configured per paypoint, so pull them first with GET /Paypoint/settings/{entry} rather than assuming email/customerNumber; if the request supplies no value for any configured identifier, the call returns 400 Invalid customer identifiers. When a paypoint has none configured, matching falls back to customerNumber. The configured set also decides whether a create dedupes onto an existing record or makes a new one. See payabli-fundamentals → Customer identifiers. https://docs.payabli.com/guides/pay-ops-developer-customers-manage.md

Casing gotcha: requests take lowercase fields (firstname, lastname, email, phone, address1), but responses return them PascalCase (Firstname, Lastname, Email, Phone, Address1) alongside camelCase IDs (customerId, customerNumber, customerStatus). Map case-insensitively rather than assuming one casing across the round trip.

Response envelopes differ by operation — check the shape per call. Create (POST /Customer/single/{entry}) returns { isSuccess, responseData } on HTTP 200, where responseData is the full created customer record (not just the id) — read the new id from responseData.customerId; read (GET /Customer/{customerId}) returns the customer record bare (no wrapper); list (GET /Query/customers/{entry}) returns { Summary, Records }. Don't assume a uniform envelope across the three.

Read, update, delete

Read one with GET /Customer/{customerId}, update with PUT /Customer/{customerId}, and delete with DELETE /Customer/{customerId}. The customerStatus field is an integer (0 inactive, 1 active, 85 locked, -99 deleted). https://docs.payabli.com/guides/pay-ops-developer-customers-manage.md A customer's saved payment methods come back on this record as a top-level StoredMethods[] array (each with its IdPmethod — the value you charge as storedMethodId) — there is no separate token-list or Query route for them; see payabli-tokenization.

List and search customers

GET /Query/customers/{entry}, or GET /Query/customers/org/{orgId} for organization-wide results. Filter with fieldName(condition)=value (for example email(eq)=..., lastname(ct)=..., customernumber(eq)=..., status(in)=1|0) and paginate with fromRecord/limitRecord. The response wraps results in { Summary, Records }. For the full filter syntax, operators, and exports, use payabli-reporting rather than reinventing them.

Unrecognized filter fields are silently ignored — the query then returns every record. Field names also differ per endpoint: the customer-number filter is customernumber on /Query/customers but customerNumber on /Query/transactions. Use the exact field name from that endpoint's API reference and verify the result count actually narrowed, since a bad field name fails silently rather than erroring. See payabli-reporting. https://docs.payabli.com/guides/pay-ops-developer-customers-manage.md

Customer transaction history

To show a customer's history, query the transactions endpoint filtered by customer: GET /Query/transactions/{entry}?customerId(eq)=... (or customerNumber(eq)=...). Each record carries a numeric TransStatus; decode it from the Pay In status reference when rendering history.

Boundaries

  • Charging a customer and the payment surfaces → payabli-accept-payments
  • Saving a payment method on a customer → payabli-tokenization
  • Recurring charges → payabli-subscriptions
  • Pay Out vendors (the vendor equivalent of this skill) → payabli-vendors
  • Query filter syntax, exports, and reconciliation → payabli-reporting
同じリポジトリから

関連する Skills

すべての Skills
payabli
コミュニティ

payabli-accept-payments

Use when writing code that accepts payments through Payabli: charging cards or ACH, integrating embedded payment components or a hosted payment page, handling Apple Pay or Google Pay, or processing voids and refunds. Boundaries — subscriptions: payabli-subscriptions; invoices and payment links: payabli-invoices; disputes and refund-failure recovery: payabli-disputes. Reads payabli-integration.md on load if present.

1時間の導入数
1
GitHub Stars
0
更新日
10月23日
payabli
コミュニティ

payabli-bills

Use when building accounts-payable automation on Payabli — capturing vendor bills (manual entry or OCR) and paying them through Pay Out. Distinct from raw payouts (payabli-send-payments): a bill is a captured vendor invoice that you then pay. Reads payabli-integration.md on load if present.

1時間の導入数
1
GitHub Stars
0
更新日
10月23日
payabli
コミュニティ

payabli-boarding

Use when onboarding merchants to Payabli through the API — creating the business, its people, paypoints, and bank accounts, opening a boarding application, validating and submitting it, answering underwriting requests, or tracking an application's status and enablement. Moving an existing integration off the legacy /Boarding/ endpoints lives in payabli-boarding-migration. Reads payabli-integration.md on load if present.

1時間の導入数
1
GitHub Stars
0
更新日
10月23日
payabli
コミュニティ

payabli-boarding-migration

Use when moving an existing integration off Payabli's legacy boarding endpoints (/Boarding/app, /Boarding/read, boarding links) to intelligent boarding — converting legacy application payloads to the new records, mapping fields, values, and statuses, or planning the cutover before the legacy sunset. Building boarding from scratch lives in payabli-boarding. Reads payabli-integration.md on load if present.

1時間の導入数
1
GitHub Stars
0
更新日
10月23日