Liking cljdoc? Tell your friends :D

stream.clojure.stripe.api.treasury

Info: This ns is auto-generated from the Stripe OpenAPI spec.

Info: This ns is auto-generated from the Stripe OpenAPI spec.
raw docstring

create-credit-reversalsclj

(create-credit-reversals {:keys [body]})

Create a CreditReversal

HTTP Method: POST Endpoint: /v1/treasury/credit_reversals

Example Usage: (create-credit-reversals {})

Create a CreditReversal

HTTP Method: POST
Endpoint: /v1/treasury/credit_reversals

Example Usage:
  (create-credit-reversals {})
sourceraw docstring

create-debit-reversalsclj

(create-debit-reversals {:keys [body]})

Create a DebitReversal

HTTP Method: POST Endpoint: /v1/treasury/debit_reversals

Example Usage: (create-debit-reversals {})

Create a DebitReversal

HTTP Method: POST
Endpoint: /v1/treasury/debit_reversals

Example Usage:
  (create-debit-reversals {})
sourceraw docstring

create-financial-accountsclj

(create-financial-accounts {:keys [body]})

Create a FinancialAccount

HTTP Method: POST Endpoint: /v1/treasury/financial_accounts

Example Usage: (create-financial-accounts {})

Create a FinancialAccount

HTTP Method: POST
Endpoint: /v1/treasury/financial_accounts

Example Usage:
  (create-financial-accounts {})
sourceraw docstring

create-inbound-transfersclj

(create-inbound-transfers {:keys [body]})

Create an InboundTransfer

HTTP Method: POST Endpoint: /v1/treasury/inbound_transfers

Example Usage: (create-inbound-transfers {})

Create an InboundTransfer

HTTP Method: POST
Endpoint: /v1/treasury/inbound_transfers

Example Usage:
  (create-inbound-transfers {})
sourceraw docstring

create-outbound-paymentsclj

(create-outbound-payments {:keys [body]})

Create an OutboundPayment

HTTP Method: POST Endpoint: /v1/treasury/outbound_payments

Example Usage: (create-outbound-payments {})

Create an OutboundPayment

HTTP Method: POST
Endpoint: /v1/treasury/outbound_payments

Example Usage:
  (create-outbound-payments {})
sourceraw docstring

create-outbound-transfersclj

(create-outbound-transfers {:keys [body]})

Create an OutboundTransfer

HTTP Method: POST Endpoint: /v1/treasury/outbound_transfers

Example Usage: (create-outbound-transfers {})

Create an OutboundTransfer

HTTP Method: POST
Endpoint: /v1/treasury/outbound_transfers

Example Usage:
  (create-outbound-transfers {})
sourceraw docstring

list-all-credit-reversalsclj

(list-all-credit-reversals {:keys [query-params]})

List all CreditReversals

HTTP Method: GET Endpoint: /v1/treasury/credit_reversals

Query Parameters:

  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • financial-account (String): Returns objects associated with this FinancialAccount. (required)
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • received-credit (String): Only return CreditReversals for the ReceivedCredit ID.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
  • status (String): Only return CreditReversals for a given status.

Example Usage: (list-all-credit-reversals {:query-params {:limit 10}})

List all CreditReversals

HTTP Method: GET
Endpoint: /v1/treasury/credit_reversals

Query Parameters:
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - financial-account (String): Returns objects associated with this FinancialAccount. (required)
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - received-credit (String): Only return CreditReversals for the ReceivedCredit ID.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  - status (String): Only return CreditReversals for a given status.

Example Usage:
  (list-all-credit-reversals {:query-params {:limit 10}})
sourceraw docstring

list-all-debit-reversalsclj

(list-all-debit-reversals {:keys [query-params]})

List all DebitReversals

HTTP Method: GET Endpoint: /v1/treasury/debit_reversals

Query Parameters:

  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • financial-account (String): Returns objects associated with this FinancialAccount. (required)
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • received-debit (String): Only return DebitReversals for the ReceivedDebit ID.
  • resolution (String): Only return DebitReversals for a given resolution.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
  • status (String): Only return DebitReversals for a given status.

Example Usage: (list-all-debit-reversals {:query-params {:limit 10}})

List all DebitReversals

HTTP Method: GET
Endpoint: /v1/treasury/debit_reversals

Query Parameters:
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - financial-account (String): Returns objects associated with this FinancialAccount. (required)
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - received-debit (String): Only return DebitReversals for the ReceivedDebit ID.
  - resolution (String): Only return DebitReversals for a given resolution.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  - status (String): Only return DebitReversals for a given status.

Example Usage:
  (list-all-debit-reversals {:query-params {:limit 10}})
sourceraw docstring

list-all-financial-accountsclj

(list-all-financial-accounts {:keys [query-params]})

List all FinancialAccounts

HTTP Method: GET Endpoint: /v1/treasury/financial_accounts

Query Parameters:

  • created (Unknown): Only return FinancialAccounts that were created during the given date interval.
  • ending-before (String): An object ID cursor for use in pagination.
  • expand (Array): Specifies which fields in the response should be expanded.
  • limit (Integer): A limit ranging from 1 to 100 (defaults to 10).
  • starting-after (String): An object ID cursor for use in pagination.
  • status (String): Only return FinancialAccounts that have the given status: open or closed

Example Usage: (list-all-financial-accounts {:query-params {:limit 10}})

List all FinancialAccounts

HTTP Method: GET
Endpoint: /v1/treasury/financial_accounts

Query Parameters:
  - created (Unknown): Only return FinancialAccounts that were created during the given date interval.
  - ending-before (String): An object ID cursor for use in pagination.
  - expand (Array): Specifies which fields in the response should be expanded.
  - limit (Integer): A limit ranging from 1 to 100 (defaults to 10).
  - starting-after (String): An object ID cursor for use in pagination.
  - status (String): Only return FinancialAccounts that have the given status: `open` or `closed`

Example Usage:
  (list-all-financial-accounts {:query-params {:limit 10}})
sourceraw docstring

list-all-financial-accounts-financial-account-featuresclj

(list-all-financial-accounts-financial-account-features
  {:keys [financial-account-id query-params]})

Retrieve FinancialAccount Features

HTTP Method: GET Endpoint: /v1/treasury/financial_accounts/{financial-account-id}/features

Path Parameters:

  • financial-account-id (String): The financial-account-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (list-all-financial-accounts-financial-account-features {:financial-account-id example-financial-account-id :query-params {:limit 10}})

Retrieve FinancialAccount Features

HTTP Method: GET
Endpoint: /v1/treasury/financial_accounts/{financial-account-id}/features

Path Parameters:
  - financial-account-id (String): The financial-account-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (list-all-financial-accounts-financial-account-features {:financial-account-id example-financial-account-id :query-params {:limit 10}})
sourceraw docstring

list-all-inbound-transfersclj

(list-all-inbound-transfers {:keys [query-params]})

List all InboundTransfers

HTTP Method: GET Endpoint: /v1/treasury/inbound_transfers

Query Parameters:

  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • financial-account (String): Returns objects associated with this FinancialAccount. (required)
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
  • status (String): Only return InboundTransfers that have the given status: processing, succeeded, failed or canceled.

Example Usage: (list-all-inbound-transfers {:query-params {:limit 10}})

List all InboundTransfers

HTTP Method: GET
Endpoint: /v1/treasury/inbound_transfers

Query Parameters:
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - financial-account (String): Returns objects associated with this FinancialAccount. (required)
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  - status (String): Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.

Example Usage:
  (list-all-inbound-transfers {:query-params {:limit 10}})
sourceraw docstring

list-all-outbound-paymentsclj

(list-all-outbound-payments {:keys [query-params]})

List all OutboundPayments

HTTP Method: GET Endpoint: /v1/treasury/outbound_payments

Query Parameters:

  • created (Unknown): Only return OutboundPayments that were created during the given date interval.
  • customer (String): Only return OutboundPayments sent to this customer.
  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • financial-account (String): Returns objects associated with this FinancialAccount. (required)
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
  • status (String): Only return OutboundPayments that have the given status: processing, failed, posted, returned, or canceled.

Example Usage: (list-all-outbound-payments {:query-params {:limit 10}})

List all OutboundPayments

HTTP Method: GET
Endpoint: /v1/treasury/outbound_payments

Query Parameters:
  - created (Unknown): Only return OutboundPayments that were created during the given date interval.
  - customer (String): Only return OutboundPayments sent to this customer.
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - financial-account (String): Returns objects associated with this FinancialAccount. (required)
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  - status (String): Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`.

Example Usage:
  (list-all-outbound-payments {:query-params {:limit 10}})
sourceraw docstring

list-all-outbound-transfersclj

(list-all-outbound-transfers {:keys [query-params]})

List all OutboundTransfers

HTTP Method: GET Endpoint: /v1/treasury/outbound_transfers

Query Parameters:

  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • financial-account (String): Returns objects associated with this FinancialAccount. (required)
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
  • status (String): Only return OutboundTransfers that have the given status: processing, canceled, failed, posted, or returned.

Example Usage: (list-all-outbound-transfers {:query-params {:limit 10}})

List all OutboundTransfers

HTTP Method: GET
Endpoint: /v1/treasury/outbound_transfers

Query Parameters:
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - financial-account (String): Returns objects associated with this FinancialAccount. (required)
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  - status (String): Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.

Example Usage:
  (list-all-outbound-transfers {:query-params {:limit 10}})
sourceraw docstring

list-all-received-creditsclj

(list-all-received-credits {:keys [query-params]})

List all ReceivedCredits

HTTP Method: GET Endpoint: /v1/treasury/received_credits

Query Parameters:

  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • financial-account (String): The FinancialAccount that received the funds. (required)
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • linked-flows (Object): Only return ReceivedCredits described by the flow.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
  • status (String): Only return ReceivedCredits that have the given status: succeeded or failed.

Example Usage: (list-all-received-credits {:query-params {:limit 10}})

List all ReceivedCredits

HTTP Method: GET
Endpoint: /v1/treasury/received_credits

Query Parameters:
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - financial-account (String): The FinancialAccount that received the funds. (required)
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - linked-flows (Object): Only return ReceivedCredits described by the flow.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  - status (String): Only return ReceivedCredits that have the given status: `succeeded` or `failed`.

Example Usage:
  (list-all-received-credits {:query-params {:limit 10}})
sourceraw docstring

list-all-received-debitsclj

(list-all-received-debits {:keys [query-params]})

List all ReceivedDebits

HTTP Method: GET Endpoint: /v1/treasury/received_debits

Query Parameters:

  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • financial-account (String): The FinancialAccount that funds were pulled from. (required)
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
  • status (String): Only return ReceivedDebits that have the given status: succeeded or failed.

Example Usage: (list-all-received-debits {:query-params {:limit 10}})

List all ReceivedDebits

HTTP Method: GET
Endpoint: /v1/treasury/received_debits

Query Parameters:
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - financial-account (String): The FinancialAccount that funds were pulled from. (required)
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  - status (String): Only return ReceivedDebits that have the given status: `succeeded` or `failed`.

Example Usage:
  (list-all-received-debits {:query-params {:limit 10}})
sourceraw docstring

list-all-transaction-entriesclj

(list-all-transaction-entries {:keys [query-params]})

List all TransactionEntries

HTTP Method: GET Endpoint: /v1/treasury/transaction_entries

Query Parameters:

  • created (Unknown): Only return TransactionEntries that were created during the given date interval.
  • effective-at (Unknown): The effective-at parameter.
  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • financial-account (String): Returns objects associated with this FinancialAccount. (required)
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • order-by (String): The results are in reverse chronological order by created or effective_at. The default is created.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
  • transaction (String): Only return TransactionEntries associated with this Transaction.

Example Usage: (list-all-transaction-entries {:query-params {:limit 10}})

List all TransactionEntries

HTTP Method: GET
Endpoint: /v1/treasury/transaction_entries

Query Parameters:
  - created (Unknown): Only return TransactionEntries that were created during the given date interval.
  - effective-at (Unknown): The effective-at parameter.
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - financial-account (String): Returns objects associated with this FinancialAccount. (required)
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - order-by (String): The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  - transaction (String): Only return TransactionEntries associated with this Transaction.

Example Usage:
  (list-all-transaction-entries {:query-params {:limit 10}})
sourceraw docstring

list-all-transactionsclj

(list-all-transactions {:keys [query-params]})

List all Transactions

HTTP Method: GET Endpoint: /v1/treasury/transactions

Query Parameters:

  • created (Unknown): Only return Transactions that were created during the given date interval.
  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • financial-account (String): Returns objects associated with this FinancialAccount. (required)
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • order-by (String): The results are in reverse chronological order by created or posted_at. The default is created.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
  • status (String): Only return Transactions that have the given status: open, posted, or void.
  • status-transitions (Object): A filter for the status_transitions.posted_at timestamp. When using this filter, status=posted and order_by=posted_at must also be specified.

Example Usage: (list-all-transactions {:query-params {:limit 10}})

List all Transactions

HTTP Method: GET
Endpoint: /v1/treasury/transactions

Query Parameters:
  - created (Unknown): Only return Transactions that were created during the given date interval.
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - financial-account (String): Returns objects associated with this FinancialAccount. (required)
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - order-by (String): The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  - status (String): Only return Transactions that have the given status: `open`, `posted`, or `void`.
  - status-transitions (Object): A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.

Example Usage:
  (list-all-transactions {:query-params {:limit 10}})
sourceraw docstring

post-financial-accounts-financial-account-closeclj

(post-financial-accounts-financial-account-close {:keys [financial-account-id
                                                         body]})

Close a FinancialAccount

HTTP Method: POST Endpoint: /v1/treasury/financial_accounts/{financial-account-id}/close

Path Parameters:

  • financial-account-id (String): The financial-account-id parameter. (required)

Example Usage: (post-financial-accounts-financial-account-close {:financial-account-id example-financial-account-id})

Close a FinancialAccount

HTTP Method: POST
Endpoint: /v1/treasury/financial_accounts/{financial-account-id}/close

Path Parameters:
  - financial-account-id (String): The financial-account-id parameter. (required)

Example Usage:
  (post-financial-accounts-financial-account-close {:financial-account-id example-financial-account-id})
sourceraw docstring

post-inbound-transfers-inbound-transfer-cancelclj

(post-inbound-transfers-inbound-transfer-cancel {:keys [inbound-transfer-id
                                                        body]})

Cancel an InboundTransfer

HTTP Method: POST Endpoint: /v1/treasury/inbound_transfers/{inbound-transfer-id}/cancel

Path Parameters:

  • inbound-transfer-id (String): The inbound-transfer-id parameter. (required)

Example Usage: (post-inbound-transfers-inbound-transfer-cancel {:inbound-transfer-id example-inbound-transfer-id})

Cancel an InboundTransfer

HTTP Method: POST
Endpoint: /v1/treasury/inbound_transfers/{inbound-transfer-id}/cancel

Path Parameters:
  - inbound-transfer-id (String): The inbound-transfer-id parameter. (required)

Example Usage:
  (post-inbound-transfers-inbound-transfer-cancel {:inbound-transfer-id example-inbound-transfer-id})
sourceraw docstring

post-outbound-payments-id-cancelclj

(post-outbound-payments-id-cancel {:keys [outbound-payment-id body]})

Cancel an OutboundPayment

HTTP Method: POST Endpoint: /v1/treasury/outbound_payments/{outbound-payment-id}/cancel

Path Parameters:

  • outbound-payment-id (String): The outbound-payment-id parameter. (required)

Example Usage: (post-outbound-payments-id-cancel {:outbound-payment-id example-outbound-payment-id})

Cancel an OutboundPayment

HTTP Method: POST
Endpoint: /v1/treasury/outbound_payments/{outbound-payment-id}/cancel

Path Parameters:
  - outbound-payment-id (String): The outbound-payment-id parameter. (required)

Example Usage:
  (post-outbound-payments-id-cancel {:outbound-payment-id example-outbound-payment-id})
sourceraw docstring

post-outbound-transfers-outbound-transfer-cancelclj

(post-outbound-transfers-outbound-transfer-cancel {:keys [outbound-transfer-id
                                                          body]})

Cancel an OutboundTransfer

HTTP Method: POST Endpoint: /v1/treasury/outbound_transfers/{outbound-transfer-id}/cancel

Path Parameters:

  • outbound-transfer-id (String): The outbound-transfer-id parameter. (required)

Example Usage: (post-outbound-transfers-outbound-transfer-cancel {:outbound-transfer-id example-outbound-transfer-id})

Cancel an OutboundTransfer

HTTP Method: POST
Endpoint: /v1/treasury/outbound_transfers/{outbound-transfer-id}/cancel

Path Parameters:
  - outbound-transfer-id (String): The outbound-transfer-id parameter. (required)

Example Usage:
  (post-outbound-transfers-outbound-transfer-cancel {:outbound-transfer-id example-outbound-transfer-id})
sourceraw docstring

retrieve-credit-reversals-credit-reversalclj

(retrieve-credit-reversals-credit-reversal {:keys [credit-reversal-id
                                                   query-params]})

Retrieve a CreditReversal

HTTP Method: GET Endpoint: /v1/treasury/credit_reversals/{credit-reversal-id}

Path Parameters:

  • credit-reversal-id (String): The credit-reversal-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-credit-reversals-credit-reversal {:credit-reversal-id example-credit-reversal-id :query-params {:limit 10}})

Retrieve a CreditReversal

HTTP Method: GET
Endpoint: /v1/treasury/credit_reversals/{credit-reversal-id}

Path Parameters:
  - credit-reversal-id (String): The credit-reversal-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-credit-reversals-credit-reversal {:credit-reversal-id example-credit-reversal-id :query-params {:limit 10}})
sourceraw docstring

retrieve-debit-reversals-debit-reversalclj

(retrieve-debit-reversals-debit-reversal {:keys [debit-reversal-id
                                                 query-params]})

Retrieve a DebitReversal

HTTP Method: GET Endpoint: /v1/treasury/debit_reversals/{debit-reversal-id}

Path Parameters:

  • debit-reversal-id (String): The debit-reversal-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-debit-reversals-debit-reversal {:debit-reversal-id example-debit-reversal-id :query-params {:limit 10}})

Retrieve a DebitReversal

HTTP Method: GET
Endpoint: /v1/treasury/debit_reversals/{debit-reversal-id}

Path Parameters:
  - debit-reversal-id (String): The debit-reversal-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-debit-reversals-debit-reversal {:debit-reversal-id example-debit-reversal-id :query-params {:limit 10}})
sourceraw docstring

retrieve-financial-accounts-financial-accountclj

(retrieve-financial-accounts-financial-account {:keys [financial-account-id
                                                       query-params]})

Retrieve a FinancialAccount

HTTP Method: GET Endpoint: /v1/treasury/financial_accounts/{financial-account-id}

Path Parameters:

  • financial-account-id (String): The financial-account-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-financial-accounts-financial-account {:financial-account-id example-financial-account-id :query-params {:limit 10}})

Retrieve a FinancialAccount

HTTP Method: GET
Endpoint: /v1/treasury/financial_accounts/{financial-account-id}

Path Parameters:
  - financial-account-id (String): The financial-account-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-financial-accounts-financial-account {:financial-account-id example-financial-account-id :query-params {:limit 10}})
sourceraw docstring

retrieve-inbound-transfers-idclj

(retrieve-inbound-transfers-id {:keys [inbound-transfer-id query-params]})

Retrieve an InboundTransfer

HTTP Method: GET Endpoint: /v1/treasury/inbound_transfers/{inbound-transfer-id}

Path Parameters:

  • inbound-transfer-id (String): The inbound-transfer-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-inbound-transfers-id {:inbound-transfer-id example-inbound-transfer-id :query-params {:limit 10}})

Retrieve an InboundTransfer

HTTP Method: GET
Endpoint: /v1/treasury/inbound_transfers/{inbound-transfer-id}

Path Parameters:
  - inbound-transfer-id (String): The inbound-transfer-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-inbound-transfers-id {:inbound-transfer-id example-inbound-transfer-id :query-params {:limit 10}})
sourceraw docstring

retrieve-outbound-payments-idclj

(retrieve-outbound-payments-id {:keys [outbound-payment-id query-params]})

Retrieve an OutboundPayment

HTTP Method: GET Endpoint: /v1/treasury/outbound_payments/{outbound-payment-id}

Path Parameters:

  • outbound-payment-id (String): The outbound-payment-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-outbound-payments-id {:outbound-payment-id example-outbound-payment-id :query-params {:limit 10}})

Retrieve an OutboundPayment

HTTP Method: GET
Endpoint: /v1/treasury/outbound_payments/{outbound-payment-id}

Path Parameters:
  - outbound-payment-id (String): The outbound-payment-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-outbound-payments-id {:outbound-payment-id example-outbound-payment-id :query-params {:limit 10}})
sourceraw docstring

retrieve-outbound-transfers-outbound-transferclj

(retrieve-outbound-transfers-outbound-transfer {:keys [outbound-transfer-id
                                                       query-params]})

Retrieve an OutboundTransfer

HTTP Method: GET Endpoint: /v1/treasury/outbound_transfers/{outbound-transfer-id}

Path Parameters:

  • outbound-transfer-id (String): The outbound-transfer-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-outbound-transfers-outbound-transfer {:outbound-transfer-id example-outbound-transfer-id :query-params {:limit 10}})

Retrieve an OutboundTransfer

HTTP Method: GET
Endpoint: /v1/treasury/outbound_transfers/{outbound-transfer-id}

Path Parameters:
  - outbound-transfer-id (String): The outbound-transfer-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-outbound-transfers-outbound-transfer {:outbound-transfer-id example-outbound-transfer-id :query-params {:limit 10}})
sourceraw docstring

retrieve-received-credits-idclj

(retrieve-received-credits-id {:keys [received-credit-id query-params]})

Retrieve a ReceivedCredit

HTTP Method: GET Endpoint: /v1/treasury/received_credits/{received-credit-id}

Path Parameters:

  • received-credit-id (String): The received-credit-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-received-credits-id {:received-credit-id example-received-credit-id :query-params {:limit 10}})

Retrieve a ReceivedCredit

HTTP Method: GET
Endpoint: /v1/treasury/received_credits/{received-credit-id}

Path Parameters:
  - received-credit-id (String): The received-credit-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-received-credits-id {:received-credit-id example-received-credit-id :query-params {:limit 10}})
sourceraw docstring

retrieve-received-debits-idclj

(retrieve-received-debits-id {:keys [received-debit-id query-params]})

Retrieve a ReceivedDebit

HTTP Method: GET Endpoint: /v1/treasury/received_debits/{received-debit-id}

Path Parameters:

  • received-debit-id (String): The received-debit-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-received-debits-id {:received-debit-id example-received-debit-id :query-params {:limit 10}})

Retrieve a ReceivedDebit

HTTP Method: GET
Endpoint: /v1/treasury/received_debits/{received-debit-id}

Path Parameters:
  - received-debit-id (String): The received-debit-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-received-debits-id {:received-debit-id example-received-debit-id :query-params {:limit 10}})
sourceraw docstring

retrieve-transaction-entries-idclj

(retrieve-transaction-entries-id {:keys [transaction-entrie-id query-params]})

Retrieve a TransactionEntry

HTTP Method: GET Endpoint: /v1/treasury/transaction_entries/{transaction-entrie-id}

Path Parameters:

  • transaction-entrie-id (String): The transaction-entrie-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-transaction-entries-id {:transaction-entrie-id example-transaction-entrie-id :query-params {:limit 10}})

Retrieve a TransactionEntry

HTTP Method: GET
Endpoint: /v1/treasury/transaction_entries/{transaction-entrie-id}

Path Parameters:
  - transaction-entrie-id (String): The transaction-entrie-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-transaction-entries-id {:transaction-entrie-id example-transaction-entrie-id :query-params {:limit 10}})
sourceraw docstring

retrieve-transactions-idclj

(retrieve-transactions-id {:keys [transaction-id query-params]})

Retrieve a Transaction

HTTP Method: GET Endpoint: /v1/treasury/transactions/{transaction-id}

Path Parameters:

  • transaction-id (String): The transaction-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-transactions-id {:transaction-id example-transaction-id :query-params {:limit 10}})

Retrieve a Transaction

HTTP Method: GET
Endpoint: /v1/treasury/transactions/{transaction-id}

Path Parameters:
  - transaction-id (String): The transaction-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-transactions-id {:transaction-id example-transaction-id :query-params {:limit 10}})
sourceraw docstring

update-financial-accounts-financial-accountclj

(update-financial-accounts-financial-account {:keys [financial-account-id
                                                     body]})

Update a FinancialAccount

HTTP Method: POST Endpoint: /v1/treasury/financial_accounts/{financial-account-id}

Path Parameters:

  • financial-account-id (String): The financial-account-id parameter. (required)

Example Usage: (update-financial-accounts-financial-account {:financial-account-id example-financial-account-id})

Update a FinancialAccount

HTTP Method: POST
Endpoint: /v1/treasury/financial_accounts/{financial-account-id}

Path Parameters:
  - financial-account-id (String): The financial-account-id parameter. (required)

Example Usage:
  (update-financial-accounts-financial-account {:financial-account-id example-financial-account-id})
sourceraw docstring

update-financial-accounts-financial-account-featuresclj

(update-financial-accounts-financial-account-features
  {:keys [financial-account-id body]})

Update FinancialAccount Features

HTTP Method: POST Endpoint: /v1/treasury/financial_accounts/{financial-account-id}/features

Path Parameters:

  • financial-account-id (String): The financial-account-id parameter. (required)

Example Usage: (update-financial-accounts-financial-account-features {:financial-account-id example-financial-account-id})

Update FinancialAccount Features

HTTP Method: POST
Endpoint: /v1/treasury/financial_accounts/{financial-account-id}/features

Path Parameters:
  - financial-account-id (String): The financial-account-id parameter. (required)

Example Usage:
  (update-financial-accounts-financial-account-features {:financial-account-id example-financial-account-id})
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close