Ach Return Fees1

Address4

API Credentials1

Balance Transactions2

Bank Account3

Bind Insurance1

Business4

Checkouts6

Disputes6

Document3

Fee Configurations5

Forwarding3

Identity4

Payee Bank Accounts3

Payee Payments3

Payees5

Payer Accounts2

Payment Method Groups5

Payment Method Imports2

Payment Methods5

Payments8

Payout Holds2

Payouts4

Platform Ledger1

Platform Settlements2

Proceeds3

Provisioning1

Refunds3

Reports3

Sub Accounts5

Terminals6

Terminals Orders3

Terms and Conditions1

Web Component Tokens1

Sub Accounts

Get a Payout Account

Get information about the currently active payout bank account of a sub account.

get/sub_accounts/{id}/payout_account

Request

Base URL
https://api.justifi.ai/v1
Auth
none declared. Required headers: Authorization
TypeScript
https://skmtc.dev/justifi/apis/justifi-api-documentation/docs/sub_accounts/:id/payout_account/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Response

Successfully get the active payout bank account a sub account

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "payout_bank_account",
  "data": {
    "country": "US",
    "currency": "usd"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.