Menu
Platform
AI
Alerts and status pages
App store purchases
Credits
Generated Assets
Knowledge
KV
Localization
Notifications
Organizations
Payments
Queues
Realtime
Sandboxes
Storage
Workflows
API reference
- Overview
- Access API keys
- Agent sessions API
- Agent versions API
- Agents API
- AI models API
- Artifacts API
- Assets API
- Auth configs API
- Bank receipts API
- Bank transfer accounts API
- Buckets API
- Builds API
- Catalogs API
- Chat profiles API
- Chat reports API
- Chat sticker packs API
- Checkout policies API
- Checkout sessions API
- Config changes API
- Config flags API
- Config segments API
- Connection providers API
- Connections API
- Connectors API
- Credit grants API
- Customer organizations API
- Customer subscriptions API
- Databases API
- Documents API
- Email domains API
- End users API
- Entities API
- Entitlement grants API
- Entries API
- Environments API
- Episodes API
- Error events API
- Error groups API
- Events API
- Exchange rates API
- Generations API
- Glossaries API
- Goals API
- Identities API
- Inbound emails API
- Inbound endpoints API
- Inbound sms API
- Invitations API
- Job runs API
- Jobs API
- Knowledge schemas API
- KV API
- KV namespaces API
- Lease events API
- Leases API
- Licence keys API
- Licence tokens API
- Mail domains API
- Mail routes API
- Mailbox connect links API
- Mailbox OAUTH apps API
- Mailboxes API
- Memberships API
- Memories API
- Memory stores API
- Merchant accounts API
- Message topics API
- Messages API
- OAUTH clients API
- Objects API
- Organization roles API
- Owner pools API
- Phone numbers API
- Portal sessions API
- Preferences API
- Price catalogs API
- Processor events API
- Projects API
- Queued executions API
- Queues API
- Realtime channels API
- Realtime members API
- Realtime messages API
- Recipients API
- Relations API
- Releases API
- Revenue API
- Revenue facts API
- Revenue sources API
- Runs API
- Sandbox shapes API
- Schedules API
- Scrubbing policies API
- Search API
- Search indexes API
- Secret versions API
- Secrets API
- Service enablements API
- Service observations API
- Services API
- Serving routes API
- Session events API
- Sessions API
- Signing key versions
- Signing keys
- Sms numbers API
- Source maps API
- Spaces API
- Store connections API
- Store purchases API
- Subscriptions API
- Suppressions API
- Tax threshold statuses API
- Templates API
- Test clocks API
- Token exchanges API
- Transfers API
- Trust policies API
- Trusted issuers API
- Uptime checks API
- Uptime manifests API
- Uptime sources API
- Usage events API
- Usage invoices API
- Usage meter prices API
- Usage meters API
- Usage reservations API
- Usage settings API
- Usage tiers API
- Volumes API
- Waits API
- Webhook deliveries API
- Webhook endpoints API
- Workflows API
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Record a bank receipt
RecordBankReceipt through the project-scoped bank transfer API.
RecordBankReceipt through the project-scoped bank transfer API.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_receipts:record - Scope
billing:bank_receipts:write - Effect
write— a successful call changes state. - Collection bank_receipts
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The environment recording the receipt. Required. |
checkout_session | string | The checkout against which bank statement evidence is recorded. Required. |
bank_transaction_id | string | Bank statement transaction identity. Required. |
amount_minor | int64 | Actual received minor units. Required. |
currency_code | string | Actual currency. Required. |
received_time | timestamp | Bank receipt time. Required. |
reference | string | Actual statement reference; absent references are held. |
payer_evidence | string | Bank statement evidence or secure evidence locator. Required. |
ambiguous | bool | Hold evidence with unresolved payer or bank ambiguity. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | Resource name. |
uid | string | Stable resource identity. Output only. |
meta | ResourceMeta | Resource metadata. Output only. |
checkout_session | string | The checkout this receipt was submitted against. Output only. |
bank_transaction_id | string | The bank statement transaction identity. Output only. |
amount_minor | int64 | Amount actually received in minor units. Output only. |
currency_code | string | Currency actually received. Output only. |
received_time | timestamp | Bank-reported receipt time. Output only. |
reference | string | Reference observed on the bank statement; empty is held. Output only. |
payer_evidence | string | Evidence locator or statement evidence; screenshots alone are not proof. Output only. |
confirmer | string | Authenticated principal that recorded this receipt. Output only. |
state | string | paid, held, rejected, refunded or reversed. Output only. |
hold_reason | string | Why settlement was held. Output only. |
entries | BankReceiptEntry[] | Append-only human resolution, refund and reversal history. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#BankReceiptEntry
| Field | Type | What it is |
|---|---|---|
kind | string | accept, reject, refund or reversal. Output only. |
evidence | string | Operator evidence supporting this decision. Output only. |
confirmer | string | Authenticated decision maker. Output only. |
create_time | timestamp | UTC decision time. Output only. |
external_reference | string | Bank refund/reversal reference, when applicable. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.RESOURCE_ALREADY_EXISTS— A Resource with this name exists.INVALID_STATE— The Resource is in a state that forbids the call.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.UNAVAILABLE— The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_receipts:record" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"amount_minor":1,"bank_transaction_id":"…","checkout_session":"…","currency_code":"…","payer_evidence":"…","received_time":{}}'