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

sylphx money bank_receipts

Every sylphx money bank_receipts command: its argument, its flags and a run line.

The bank_receipts commands of Sylphx Money, as the CLI spells them: the same calls as the bank_receipts API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#get

GetBankReceipt through the project-scoped bank transfer API.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx money bank-receipts get orgs/acme/projects/shop/envs/production/bank_receipts/bank-receipt

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.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx money bank-receipts list orgs/acme/projects/shop/envs/production

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

Flags

FlagTypeWhat it does
--page-sizeintDefault 50, at most 1000.
--page-tokenstringToken from the preceding page.
--filterstringOptional state equality: held, paid, rejected, refunded or reversed.

#record

RecordBankReceipt through the project-scoped bank transfer API.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx money bank-receipts record orgs/acme/projects/shop/envs/production

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

Flags

FlagTypeWhat it does
--checkout-sessionstringThe checkout against which bank statement evidence is recorded. Required.
--bank-transaction-idstringBank statement transaction identity. Required.
--amount-minorintActual received minor units. Required.
--currency-codestringActual currency. Required.
--received-timetimestampBank receipt time. Required.
--referencestringActual statement reference; absent references are held.
--payer-evidencestringBank statement evidence or secure evidence locator. Required.
--ambiguousboolHold evidence with unresolved payer or bank ambiguity.

#resolve

ResolveBankReceipt through the project-scoped bank transfer API.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx money bank-receipts resolve orgs/acme/projects/shop/envs/production/bank_receipts/bank-receipt

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

Flags

FlagTypeWhat it does
--decisionstringaccept or reject; accept requires the exact amount and currency. Required.
--evidencestringHuman resolution evidence. Required.

#reverse

ReverseBankReceipt through the project-scoped bank transfer API.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx money bank-receipts reverse orgs/acme/projects/shop/envs/production/bank_receipts/bank-receipt

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

Flags

FlagTypeWhat it does
--kindstringrefund or reversal, for the full receipt. Required.
--evidencestringVerified bank evidence. Required.
--external-referencestringUnique bank refund or reversal identity. Required.