Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

Bank receipts

Immutable evidence of an incoming bank credit and its decisions.

Immutable evidence of an incoming bank credit and its decisions.

Service Sylphx Money · Resource type money.sylphx.com/BankReceipt · Name pattern orgs/{org}/projects/{project}/envs/{env}/bank_receipts/{bank_receipt} · Shape record

#Fields

FieldTypeWhat it is
namestringResource name.
uidstringStable resource identity. Output only.
metaResourceMetaResource metadata. Output only.
checkout_sessionstringThe checkout this receipt was submitted against. Output only.
bank_transaction_idstringThe bank statement transaction identity. Output only.
amount_minorint64Amount actually received in minor units. Output only.
currency_codestringCurrency actually received. Output only.
received_timetimestampBank-reported receipt time. Output only.
referencestringReference observed on the bank statement; empty is held. Output only.
payer_evidencestringEvidence locator or statement evidence; screenshots alone are not proof. Output only.
confirmerstringAuthenticated principal that recorded this receipt. Output only.
statestringpaid, held, rejected, refunded or reversed. Output only.
hold_reasonstringWhy settlement was held. Output only.
entriesBankReceiptEntry[]Append-only human resolution, refund and reversal history. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGetBankReceipt through the project-scoped bank transfer API.
GETlistLists incoming bank evidence, including receipts held for review.
POSTrecordRecordBankReceipt through the project-scoped bank transfer API.
POSTresolveResolveBankReceipt through the project-scoped bank transfer API.
POSTreverseReverseBankReceipt through the project-scoped bank transfer API.

#get

GetBankReceipt through the project-scoped bank transfer API.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_receipts/bank-receipt · scope billing:bank_receipts:read · effect read · Request, response and examples

#list

Lists incoming bank evidence, including receipts held for review.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_receipts · scope billing:bank_receipts:read · effect read · paginated · Request, response and examples

#record

RecordBankReceipt through the project-scoped bank transfer API.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_receipts:record · scope billing:bank_receipts:write · effect write · Request, response and examples

#resolve

ResolveBankReceipt through the project-scoped bank transfer API.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_receipts/bank-receipt:resolve · scope billing:bank_receipts:write · effect write · Request, response and examples

#reverse

ReverseBankReceipt through the project-scoped bank transfer API.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_receipts/bank-receipt:reverse · scope billing:bank_receipts:write · effect write · Request, response and examples