TransactionsPaths

Defined in: src/transactions/types.gen.ts:2

Properties

/v2/accounts/card

/v2/accounts/card: object

Defined in: src/transactions/types.gen.ts:3

delete?

optional delete?: undefined

get

get: object

List card accounts

Description

This endpoint lists all accounts of card type.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Returns a list of card accounts.

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object[]

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

/v2/accounts/card/primary/statements

/v2/accounts/card/primary/statements: object

Defined in: src/transactions/types.gen.ts:23

delete?

optional delete?: undefined

get

get: object

List primary card account statements.

Description

This endpoint lists all finalized statements for the primary card account.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.cursor?

optional cursor?: string | null

get.parameters.query.limit?

optional limit?: number | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Returns a list of primary card account statements.

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.items

items: object[]

get.responses.200.content.application/json.next_cursor?

optional next_cursor?: string | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

/v2/accounts/cash

/v2/accounts/cash: object

Defined in: src/transactions/types.gen.ts:43

delete?

optional delete?: undefined

get

get: object

List cash accounts

Description

This endpoint lists all the existing cash accounts with their status.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Returns a list of cash accounts.

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.items

items: object[]

get.responses.200.content.application/json.next_cursor?

optional next_cursor?: string | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

/v2/accounts/cash/{id}

/v2/accounts/cash/{id}: object

Defined in: src/transactions/types.gen.ts:63

delete?

optional delete?: undefined

get

get: object

Get cash account by ID

Description

This endpoint returns the cash account associated with the provided ID with its status.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.id

id: string

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Returns the cash account.

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.account_number

account_number: string

get.responses.200.content.application/json.available_balance

available_balance: object

get.responses.200.content.application/json.available_balance.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

get.responses.200.content.application/json.available_balance.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

get.responses.200.content.application/json.current_balance

current_balance: object

get.responses.200.content.application/json.current_balance.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

get.responses.200.content.application/json.current_balance.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

get.responses.200.content.application/json.id

id: string

Description

ID of the cash account

get.responses.200.content.application/json.name

name: string

get.responses.200.content.application/json.primary

primary: boolean

Description

Whether or not this account is the primary account. There will always be only one primary account.

get.responses.200.content.application/json.routing_number

routing_number: string

get.responses.200.content.application/json.status?

optional status?: "ACTIVE" | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

/v2/accounts/cash/{id}/statements

/v2/accounts/cash/{id}/statements: object

Defined in: src/transactions/types.gen.ts:83

delete?

optional delete?: undefined

get

get: object

List cash account statements.

Description

This endpoint lists all finalized statements for the cash account by ID.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.id

id: string

get.parameters.query?

optional query?: object

get.parameters.query.cursor?

optional cursor?: string | null

get.parameters.query.limit?

optional limit?: number | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Returns a list of cash account statements.

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.items

items: object[]

get.responses.200.content.application/json.next_cursor?

optional next_cursor?: string | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

/v2/accounts/cash/primary

/v2/accounts/cash/primary: object

Defined in: src/transactions/types.gen.ts:103

delete?

optional delete?: undefined

get

get: object

Get primary cash account

Description

This endpoint returns the primary cash account with its status. There will always be only one primary account.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: undefined

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Returns the primary cash account.

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.account_number

account_number: string

get.responses.200.content.application/json.available_balance

available_balance: object

get.responses.200.content.application/json.available_balance.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

get.responses.200.content.application/json.available_balance.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

get.responses.200.content.application/json.current_balance

current_balance: object

get.responses.200.content.application/json.current_balance.amount

amount: number

Format: int64

Description

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.

Example

get.responses.200.content.application/json.current_balance.currency

currency: string | null

Description

The type of currency, in ISO 4217 format.

Default

USD

Example

USD

get.responses.200.content.application/json.id

id: string

Description

ID of the cash account

get.responses.200.content.application/json.name

name: string

get.responses.200.content.application/json.primary

primary: boolean

Description

Whether or not this account is the primary account. There will always be only one primary account.

get.responses.200.content.application/json.routing_number

routing_number: string

get.responses.200.content.application/json.status?

optional status?: "ACTIVE" | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

/v2/transactions/card/primary

/v2/transactions/card/primary: object

Defined in: src/transactions/types.gen.ts:123

delete?

optional delete?: undefined

get

get: object

List transactions for all card accounts.

Description

This endpoint lists all settled transactions for all card accounts. Regular users may only fetch their own “PURCHASE”,“REFUND” and “CHARGEBACK” settled transactions.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path?

optional path?: undefined

get.parameters.query?

optional query?: object

get.parameters.query.cursor?

optional cursor?: string | null

get.parameters.query.expand[]?

optional expand[]?: string[] | null

get.parameters.query.limit?

optional limit?: number | null

get.parameters.query.posted_at_start?

optional posted_at_start?: string | null

Description

Shows only transactions with a posted_at_date on or after this date-time. This parameter is the date-time notation as defined by RFC 3339, section 5.6

Example

2022-12-12T23:59:59.999

get.parameters.query.user_ids?

optional user_ids?: string[] | null

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Returns a list of card transactions.

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.items

items: object[]

get.responses.200.content.application/json.next_cursor?

optional next_cursor?: string | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined

/v2/transactions/cash/{id}

/v2/transactions/cash/{id}: object

Defined in: src/transactions/types.gen.ts:144

delete?

optional delete?: undefined

get

get: object

List transactions for the selected cash account.

Description

This endpoint lists all transactions for the cash account with the selected ID.

get.parameters

parameters: object

get.parameters.cookie?

optional cookie?: undefined

get.parameters.header?

optional header?: undefined

get.parameters.path

path: object

get.parameters.path.id

id: string

get.parameters.query?

optional query?: object

get.parameters.query.cursor?

optional cursor?: string | null

get.parameters.query.limit?

optional limit?: number | null

get.parameters.query.posted_at_start?

optional posted_at_start?: string | null

Description

Shows only transactions with a posted_at_date on or after this date-time. This parameter is the date-time notation as defined by RFC 3339, section 5.6

Example

2022-12-12T23:59:59.999

get.requestBody?

optional requestBody?: undefined

get.responses

responses: object

get.responses.200

200: object

Description

Returns a list of cash transactions.

get.responses.200.content

content: object

get.responses.200.content.application/json

application/json: object

get.responses.200.content.application/json.items

items: object[]

get.responses.200.content.application/json.next_cursor?

optional next_cursor?: string | null

get.responses.200.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.400

400: object

Description

Bad request

get.responses.400.content?

optional content?: undefined

get.responses.400.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.401

401: object

Description

Unauthorized

get.responses.401.content?

optional content?: undefined

get.responses.401.headers

headers: object

Index Signature

[name: string]: unknown

get.responses.403

403: object

Description

Forbidden

get.responses.403.content?

optional content?: undefined

get.responses.403.headers

headers: object

Index Signature

[name: string]: unknown

head?

optional head?: undefined

options?

optional options?: undefined

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

patch?

optional patch?: undefined

post?

optional post?: undefined

put?

optional put?: undefined

trace?

optional trace?: undefined