Skip to main content
API docs by Redocly

Account Management (1.34.83)

Download OpenAPI specification:Download

Account Management and Payments

Account

List accounts for a user

List accounts for a user

Authorizations:
oauth2
path Parameters
profile_id
required
string
query Parameters
page
number >= 1
page_size
number >= 1

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ]
}

Get an account by id

Get an account by id

Authorizations:
oauth2
path Parameters
profile_id
required
string
account_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nickname": "string",
  • "institution_id": "string",
  • "institution_name": "string",
  • "institution_logo": "string",
  • "status_e": "string",
  • "rail_e": "string",
  • "current_balance_pennies": 0,
  • "available_balance_pennies": 0,
  • "last_four": "string",
  • "currency_e": "string",
  • "locked_at": "string",
  • "archived": 0,
  • "primary": true
}

Invoice

Retrieve an invoice by invoice number

Retrieve an invoice by invoice number

Authorizations:
oauth2
path Parameters
invoice_number
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "invoice_number": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "status_e": "string",
  • "total_amount_pennies": 0,
  • "tips_pennies": 0,
  • "amount_paid_pennies": 0,
  • "metadata": {
    }
}

Creates a new invoice to be paid

Creates a new invoice to be paid

Authorizations:
oauth2
Request Body schema: application/json
payee_profile_id
required
string
due_date
string or null
total_amount_pennies
required
number
pay_in_full
boolean
object
idempotency_uuid
required
string

Responses

Request samples

Content type
application/json
{
  • "payee_profile_id": "string",
  • "due_date": "string",
  • "total_amount_pennies": 0,
  • "pay_in_full": true,
  • "metadata": {
    },
  • "idempotency_uuid": "string"
}

Response samples

Content type
application/json
{
  • "invoice_id": "string"
}

Update an invoice

Update an invoice

Authorizations:
oauth2
path Parameters
profile_id
required
string
invoice_id
required
string
Request Body schema: application/json
total_amount_pennies
number
pay_in_full
boolean
object

Responses

Request samples

Content type
application/json
{
  • "total_amount_pennies": 0,
  • "pay_in_full": true,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{ }

Retrieve an invoice

Retrieve an invoice

Authorizations:
oauth2
path Parameters
profile_id
required
string
invoice_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "invoice_number": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "status_e": "string",
  • "total_amount_pennies": 0,
  • "tips_pennies": 0,
  • "amount_paid_pennies": 0,
  • "pay_in_full": true,
  • "metadata": {
    }
}

Cancel an invoice

Cancel an invoice

Authorizations:
oauth2
path Parameters
profile_id
required
string
invoice_id
required
string

Responses

Response samples

Content type
application/json
{ }

List invoices

List invoices

Authorizations:
oauth2
path Parameters
profile_id
required
string
query Parameters
page
number >= 1
page_size
number >= 1
transaction_id
string
search_term
string
start_date
string
end_date
string

Responses

Response samples

Content type
application/json
{
  • "invoices": [
    ]
}

Transaction

Create a new transaction

Create a new transaction

Authorizations:
oauth2
Request Body schema: application/json
payer_profile_id
required
string
invoice_id
required
string
source_account_id
required
string
amount_pennies
required
number
tip_pennies
number
object
object
idempotency_uuid
required
string
object

Responses

Request samples

Content type
application/json
{
  • "payer_profile_id": "string",
  • "invoice_id": "string",
  • "source_account_id": "string",
  • "amount_pennies": 0,
  • "tip_pennies": 0,
  • "invoice_metadata": {
    },
  • "metadata": {
    },
  • "idempotency_uuid": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "transaction_id": "string",
  • "transactionEvents": [
    ],
  • "notificationEmails": [
    ],
  • "payee_profile_id": "string",
  • "date": "string"
}

List transactions

List transactions

Authorizations:
oauth2
query Parameters
page
number >= 1
page_size
number >= 1
invoice_id
string
profile_id
string
search_term
string
start_date
string
end_date
string
object

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Get a transaction

Get a transaction

Authorizations:
oauth2
path Parameters
transaction_id
required
string

Responses

Response samples

Content type
application/json
{
  • "payer_profile_id": "string",
  • "invoice_id": "string",
  • "source_account_id": "string",
  • "amount_pennies": 0,
  • "tip_pennies": 0,
  • "idempotency_uuid": "string",
  • "status_e": "string",
  • "source_return_reason": "string",
  • "source_return_message": "string",
  • "source_return_timeframe": "string",
  • "source_account_nocs": [
    ],
  • "destination_return_reason": "string",
  • "destination_return_message": "string",
  • "destination_return_timeframe": "string",
  • "destination_account_nocs": [
    ],
  • "received_date": "string",
  • "settle_date": "string",
  • "return_date": "string",
  • "ach_effective_date": "string",
  • "ip_address": "string",
  • "originating_country": "string",
  • "originating_region": "string",
  • "originating_city": "string",
  • "originating_continent": "string",
  • "originating_latitude": 0,
  • "originating_longitude": 0,
  • "carrier": "string",
  • "mobile_country_code": "string",
  • "mobile_network_code": "string",
  • "is_flagged": true,
  • "is_ip_tor": true,
  • "is_ip_vpn": true,
  • "is_ip_icloud_relay": true,
  • "is_ip_proxy": true,
  • "is_ip_datacenter": true,
  • "is_ip_anonymous": true,
  • "is_ip_known_abuser": true,
  • "is_ip_known_attacker": true,
  • "is_ip_threat": true,
  • "is_ip_bogon": true,
  • "ip_blocklists": [
    ],
  • "metadata": {
    }
}

List all transaction events

List all transaction events, or list events for a specific transaction, or all events for a profile

Authorizations:
oauth2
query Parameters
page
number >= 1
page_size
number >= 1
transaction_id
string
profile_id
string
event_name
string
start_date
string
end_date
string

Responses

Response samples

Content type
application/json
{
  • "transactionEvents": [
    ]
}

Webhook

Create webhooks for the current client credentials

Create webhooks for the current client credentials

Authorizations:
oauth2
path Parameters
profile_id
required
string
Request Body schema: application/json
name
required
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "webhook": {
    }
}

List webhooks for the current client credentials

List webhooks for the current client credentials

Authorizations:
oauth2
path Parameters
profile_id
required
string
query Parameters
page
number >= 1
page_size
number >= 1

Responses

Response samples

Content type
application/json
{
  • "webhooks": [
    ]
}