{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?connect,{" "}
auth,{" "}
account_verify,{" "}
unknown
),
}
]}
/>
## Error
The error event is sent for any element that encounters any error while it's active.
```bash
methodelements://general
?op=error
&element_type=unknown
&type=INVALID_REQUEST
&sub_type=EXPIRED_TOKEN
&message=The public element token is no longer valid. Element tokens are short lived and can only be used once. Request a new element token and try your request again.
&code=400
```
The event payload will have the following form:
connect,{" "}
auth,{" "}
account_verify,{" "}
unknown
),
},
{
name: 'code',
type: 'integer',
description: 'The status code of the response.',
},
{
name: 'type',
type: 'string',
description: 'A broad description of the error',
},
{
name: 'sub_type',
type: 'string',
description: 'The specific error type',
},
{
name: 'message',
type: 'string',
description: 'A human-readable message providing more details about the error',
},
]}
/>
## Exit
The exit event is the last event in the element flow, at this point your app should no longer present the Method Element. Exit is triggered after an error, a user requested exit or a successful element event.
```bash
methodelements://general
?op=exit
&element_type=connect
```
The event payload will have the following form:
connect,{" "}
auth,{" "}
account_verify,{" "}
unknown
),
}
]}
/>
# Events Overview
export const ParamList = ({items, is_child = false}) => {
return items.map(item => {
const field_props = {
id: Math.random().toString(),
body: item.name,
name: item.name,
type: item.type,
required: item.required
};
const enums = item.enums || [];
const items = item.items || [];
const has_items = items?.length > 0;
const has_enums = enums?.length > 0;
const should_default_open = item.defaultOpen | false;
const render_child_item = () => {
const child_props = {
title: has_enums ? "Possible enum values" : "properties"
};
if (should_default_open) child_props.defaultOpen = true;
const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
const is_last = idx === enums.length - 1;
const is_2nd_to_last = idx === enums.length - 2;
return <>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?page.
}, {
name: 'page_limit',
type: 'string',
required: false,
description: `The number of ${resource_name} to return per page.`
}];
export const ParamList = ({items, is_child = false}) => {
return items.map(item => {
const field_props = {
id: Math.random().toString(),
body: item.name,
name: item.name,
type: item.type,
required: item.required
};
const enums = item.enums || [];
const items = item.items || [];
const has_items = items?.length > 0;
const has_enums = enums?.length > 0;
const should_default_open = item.defaultOpen | false;
const render_child_item = () => {
const child_props = {
title: has_enums ? "Possible enum values" : "properties"
};
if (should_default_open) child_props.defaultOpen = true;
const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
const is_last = idx === enums.length - 1;
const is_2nd_to_last = idx === enums.length - 2;
return <>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?page.
}, {
name: 'page_limit',
type: 'string',
required: false,
description: `The number of ${resource_name} to return per page.`
}];
export const ParamList = ({items, is_child = false}) => {
return items.map(item => {
const field_props = {
id: Math.random().toString(),
body: item.name,
name: item.name,
type: item.type,
required: item.required
};
const enums = item.enums || [];
const items = item.items || [];
const has_items = items?.length > 0;
const has_enums = enums?.length > 0;
const should_default_open = item.defaultOpen | false;
const render_child_item = () => {
const child_props = {
title: has_enums ? "Possible enum values" : "properties"
};
if (should_default_open) child_props.defaultOpen = true;
const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
const is_last = idx === enums.length - 1;
const is_2nd_to_last = idx === enums.length - 2;
return <>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?visa and mastercard credit
cards.
brand_AMxtjQzAfDCRP identifies Chase Sapphire Reserve).
),
},
{
name: 'brands.url',
type: 'string',
required: false,
description: 'The URL of the card art.',
},
{
name: 'brands.name',
type: 'string',
required: false,
description: 'The brand name of the card.',
}
],
},
{
name: 'shared',
type: 'boolean',
required: false,
description: (
<>
If true, Method requires additional verification (AccountVerificationSession of type pre_auth)
to return the definite brand for an Account, and multiple brands might be returned.
{"\r \r"}
If false, all verification requirements have been completed, and the brand has been returned by the issuer.
)
},
{
name: 'status',
type: 'enum',
required: false,
description: 'status of the CardBrand.',
enums: [
{
name: 'completed',
description: 'The CardBrand request successfully completed.',
},
{
name: 'failed',
description: (<>
The CardBrand request failed to complete. See{" "}
error field.
)
},
],
},
(get_common_parameters('CardBrand').error),
(get_common_parameters('CardBrand').created_at),
(get_common_parameters('CardBrand').updated_at),
]}
/>
## Webhook Payload
The [Webhook](/reference/webhooks/overview) payload will contain the following information:
```json
{
"id": "string",
"type": "card_brand.create" | "card_brand.update",
"path": "/accounts/{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?withdraw.
),
},
{
name: 'reason',
type: 'string',
required: true,
description: (
<>
Available Reasons: holder_withdrew_consent.
),
}
]}
/>
## Returns
Returns the Account with `status` set to `disabled`.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?page.
}, {
name: 'page_limit',
type: 'string',
required: false,
description: `The number of ${resource_name} to return per page.`
}];
export const ParamList = ({items, is_child = false}) => {
return items.map(item => {
const field_props = {
id: Math.random().toString(),
body: item.name,
name: item.name,
type: item.type,
required: item.required
};
const enums = item.enums || [];
const items = item.items || [];
const has_items = items?.length > 0;
const has_enums = enums?.length > 0;
const should_default_open = item.defaultOpen | false;
const render_child_item = () => {
const child_props = {
title: has_enums ? "Possible enum values" : "properties"
};
if (should_default_open) child_props.defaultOpen = true;
const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
const is_last = idx === enums.length - 1;
const is_2nd_to_last = idx === enums.length - 2;
return <>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?error property for more information.
),
},
{ name: 'closed', description: 'The Account has been closed, and is either fully paid-off or no longer exists.' },
]),
get_common_parameters('Account').type([
{ name: 'ach', description: 'A bank account (Checking or Savings).' },
{ name: 'liability', description: 'A debt-type account (Credit Card, Mortgage, etc).' },
]),
{
name: 'liability.mch_id',
type: 'string',
description: 'The ID of the Merchant to which a liability Account is linked.',
},
{
name: 'liability.type',
type: 'enum',
description: (
<>
The type of the liability Account to
retrieve. See Account Liability Types.
),
},
{
name: 'liability.ownership',
type: 'enum',
description: 'The holder\'s ownership type relative to the Account.',
enums: ['primary', 'authorized', 'joint', 'unknown'],
},
...get_pagination_defaults('Accounts'),
ExpandableFieldsQueryParams('account'),
]}
/>
## Returns
Returns a list of Accounts.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?error property for more information.
),
},
{ name: 'closed', description: 'The Account has been closed, and is either fully paid-off or no longer exists.' },
]),
{
...get_common_parameters('Account').type(['liability']),
description: 'The type of Account. A debt-type account (Credit Card, Mortgage, etc).',
},
{
name: 'liability',
type: 'object | null',
description: 'Liability Account information',
items: [
{
name: 'liability.name',
type: 'string',
description: 'A presentable name for the liability. Ex. Chase Sapphire Credit Card',
},
{
name: 'liability.mch_id',
type: 'string',
description: 'Unique identifier of the Merchant associated with this Account.',
},
{
name: 'liability.mask',
type: 'string | null',
description: 'The last 4 digits of the associated account number.',
},
{
name: 'liability.type',
type: 'enum',
description: (
<>
The type of liability
account. See
Account Liability Types.
),
},
{
name: 'liability.ownership',
type: 'enum',
description: 'Indicates the type of ownership that the related Entity has over the Account.',
enums: [
{ name: 'primary', description: 'Refers to the main account holder.' },
{ name: 'authorized', description: 'The related holder was granted permission by the primary holder.' },
{ name: 'joint', description: 'The ownership on the Account is shared between two or more holders.' },
{ name: 'unknown', description: 'The ownership status cannot be determined.' },
],
},
{
name: 'liability.fingerprint',
type: 'string',
description: 'A SHA-512 hash of the account number.',
},
],
},
get_expandable_field('latest_verification_session'),
{
name: "products",
type: "string[]",
description: (
<>
A list of products that the Account has access to. See{" "}
Product Names
.
),
},
{
name: "restricted_products",
type: "string[]",
description: (
<>
A list of products that the Account can have access to but is
missing some requirements. See{" "}
Product Names
.
),
},
{
name: "subscriptions",
type: "string[]",
description: (
<>
A list of products that the Account is subscribed to. See{" "}
Subscription Names
.
),
},
{
name: "available_subscriptions",
type: "string[]",
description: (
<>
A list of products that the Account can enroll into a subscription with. See{" "}
Subscription Names
.
),
},
{
name: "restricted_subscriptions",
type: "string[]",
description: (
<>
A list of products that the Account can subscribe to but is missing some requirements. See{" "}
Subscription Names
.
),
},
get_common_parameters('Account').error,
get_common_parameters('Account').metadata,
get_common_parameters('Account').created_at,
get_common_parameters('Account').updated_at,
]}
/>
## Additional Properties based on liability type
error property for more information.
),
},
{ name: 'closed', description: 'The Account has been closed, and is either fully paid-off or no longer exists.' },
]),
{
...get_common_parameters('Account').type(['ach']),
description: 'The type of Account. A bank account (Checking or Savings).',
},
{
name: 'ach',
type: 'object | null',
required: false,
description: 'ACH Account information.',
items: [
{
name: 'ach.type',
type: 'enum',
required: false,
description: 'The type of ACH Account.',
enums: ['checking', 'savings'],
},
{
name: 'ach.routing',
type: 'string',
required: false,
description: 'ABA routing number of the ACH Account. (maximum of 9 characters)',
},
{
name: 'ach.number',
type: 'string',
required: false,
description: 'Account number of the ACH Account. (maximum of 17 characters).',
},
],
},
get_expandable_field('latest_verification_session'),
{
name: "products",
type: "string[]",
description: (
<>
A list of products that the Account has access to. See{" "}
Product Names
.
),
},
{
name: "restricted_products",
type: "string[]",
description: (
<>
A list of products that the Account can have access to but is
missing some requirements. See{" "}
Product Names
.
),
},
get_common_parameters('Account').error,
get_common_parameters('Account').metadata,
get_common_parameters('Account').created_at,
get_common_parameters('Account').updated_at,
]}
/>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?page.
}, {
name: 'page_limit',
type: 'string',
required: false,
description: `The number of ${resource_name} to return per page.`
}];
export const ParamList = ({items, is_child = false}) => {
return items.map(item => {
const field_props = {
id: Math.random().toString(),
body: item.name,
name: item.name,
type: item.type,
required: item.required
};
const enums = item.enums || [];
const items = item.items || [];
const has_items = items?.length > 0;
const has_enums = enums?.length > 0;
const should_default_open = item.defaultOpen | false;
const render_child_item = () => {
const child_props = {
title: has_enums ? "Possible enum values" : "properties"
};
if (should_default_open) child_props.defaultOpen = true;
const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
const is_last = idx === enums.length - 1;
const is_2nd_to_last = idx === enums.length - 2;
return <>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?error field.
),
},
]),
get_common_parameters("Sensitive").error,
get_common_parameters("Sensitive").created_at,
get_common_parameters("Sensitive").updated_at,
]}
/>
## Additional Properties based on type
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?page.
}, {
name: 'page_limit',
type: 'string',
required: false,
description: `The number of ${resource_name} to return per page.`
}];
export const ParamList = ({items, is_child = false}) => {
return items.map(item => {
const field_props = {
id: Math.random().toString(),
body: item.name,
name: item.name,
type: item.type,
required: item.required
};
const enums = item.enums || [];
const items = item.items || [];
const has_items = items?.length > 0;
const has_enums = enums?.length > 0;
const should_default_open = item.defaultOpen | false;
const render_child_item = () => {
const child_props = {
title: has_enums ? "Possible enum values" : "properties"
};
if (should_default_open) child_props.defaultOpen = true;
const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
const is_last = idx === enums.length - 1;
const is_2nd_to_last = idx === enums.length - 2;
return <>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?page.
}, {
name: 'page_limit',
type: 'string',
required: false,
description: `The number of ${resource_name} to return per page.`
}];
export const ParamList = ({items, is_child = false}) => {
return items.map(item => {
const field_props = {
id: Math.random().toString(),
body: item.name,
name: item.name,
type: item.type,
required: item.required
};
const enums = item.enums || [];
const items = item.items || [];
const has_items = items?.length > 0;
const has_enums = enums?.length > 0;
const should_default_open = item.defaultOpen | false;
const render_child_item = () => {
const child_props = {
title: has_enums ? "Possible enum values" : "properties"
};
if (should_default_open) child_props.defaultOpen = true;
const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
const is_last = idx === enums.length - 1;
const is_2nd_to_last = idx === enums.length - 2;
return <>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{liability_type}.,
items: alphabetically_sort_fields(default_fields),
defaultOpen: true
};
};
export const get_common_parameters = (resource_name = 'resource') => {
return {
id: {
name: 'id',
type: "string",
required: false,
description: `Unique identifier for the ${resource_name}.`
},
entity_id: {
name: 'entity_id',
type: 'string',
required: false,
description: 'The ID of the associated Entity.'
},
account_id: {
name: 'account_id',
type: 'string',
required: false,
description: 'The ID of the associated Account.'
},
error: {
name: 'error',
type: 'object | null',
required: false,
description: <>
An object representing an error that occurred while processing
this {resource_name}. See {resource_name} errors.
},
status_error: {
name: 'status_error',
type: 'object | null',
required: false,
description: <>
An object representing an error that occurred while processing
this {resource_name}. See {resource_name} errors.
},
metadata: {
name: 'metadata',
type: 'object | null',
required: false,
description: <>
Additional data provided during creation.
See metadata
},
created_at: {
name: 'created_at',
type: 'string',
required: false,
description: `Timestamp of when the ${resource_name} was created.`
},
updated_at: {
name: 'updated_at',
type: 'string',
required: false,
description: `Timestamp of when the ${resource_name} was last updated.`
},
status: (enums = []) => ({
name: 'status',
type: 'enum',
required: false,
description: `Status of the ${resource_name}.`,
enums
}),
type: (enums = []) => ({
name: 'type',
type: 'enum',
required: false,
description: `The type of ${resource_name}.`,
enums
})
};
};
export const ParamList = ({items, is_child = false}) => {
return items.map(item => {
const field_props = {
id: Math.random().toString(),
body: item.name,
name: item.name,
type: item.type,
required: item.required
};
const enums = item.enums || [];
const items = item.items || [];
const has_items = items?.length > 0;
const has_enums = enums?.length > 0;
const should_default_open = item.defaultOpen | false;
const render_child_item = () => {
const child_props = {
title: has_enums ? "Possible enum values" : "properties"
};
if (should_default_open) child_props.defaultOpen = true;
const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
const is_last = idx === enums.length - 1;
const is_2nd_to_last = idx === enums.length - 2;
return <>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?micro_deposits type, this
state indicates that the micro-deposit transactions have not yet been sent. For all
other types, this means that the verification session has been created but not yet
updated with any data.
),
},
{
name: 'in_progress',
description: (
<>
The AccountVerificationSession is in progress. For micro_deposits type, this
state indicates that the micro-deposit transactions have been sent and the session can be
updated with the amounts to complete verification. This state is irrelevant for all other types.
),
},
{
name: 'verified',
description: 'The AccountVerificationSession has been successfully verified.',
},
{
name: 'failed',
description: (
<>
The AccountVerificationSession has failed verification based on the provided
data. See error for details.
),
},
])),
{
name: 'type',
type: 'enum',
required: false,
description: (
<>
The type of the AccountVerificationSession. See Verification Types.
),
},
{
name: 'micro_deposits',
type: 'object | null',
required: false,
description: (
<>
This object will be populated if the AccountVerificationSession is
of type micro_deposits
),
items: [
{
name: 'micro_deposits.amounts',
type: 'number[]',
required: false,
description: 'The latest amounts that this AccountVerificationSession was updated with.',
}
]
},
{
name: 'plaid',
type: 'object | null',
required: false,
description: (
<>
This object will be populated if the AccountVerificationSession is
of type plaid.
),
items: [
{
name: 'plaid.balances',
type: 'object[]',
description: (<>The raw balance data received from Plaid. See account balances.),
},
{
name: 'plaid.transactions',
type: 'object[]',
description: (<>The raw transaction data received from Plaid. See account transactions.),
},
]
},
{
name: 'mx',
type: 'object | null',
required: false,
description: (
<>
This object will be populated if the AccountVerificationSession is
of type mx.
),
items: [
{
name: 'mx.account',
type: "object",
description: (<>The raw account data received from MX. See account balances.),
},
{
name: 'mx.transactions',
type: "object[]",
description: (<>The list of the raw transaction data received from MX. See account transactions.),
}
]
},
{
name: 'teller',
type: 'object | null',
required: false,
description: (
<>
This object will be populated if the AccountVerificationSession is
of type teller.
),
items: [
{
name: 'teller.account',
type: "object",
description: (<>The raw balance data received from Teller. See account balances.),
},
{
name: 'teller.transactions',
type: "object[]",
description: (<>The list of the raw transaction data received from MX. See account transactions.),
},
]
},
{
name: 'auto_verify',
type: 'object | null',
required: false,
description: (
<>
This object will be populated if the AccountVerificationSession is
of type auto_verify.
),
items: [], // empty object
},
{
name: 'trusted_provisioner',
type: 'object | null',
required: false,
description: (
<>
This object will be populated if the AccountVerificationSession is
of type trusted_provisioner.
),
items: [],
},
{
name: 'standard',
type: 'object | null',
required: false,
description: (
<>
This object will be populated if the AccountVerificationSession is
of type standard.
),
items: [
{
name: 'standard.number',
type: 'string | null',
required: false,
description: (
<>
The masked card number. If this is null, that indicates that the
number needs to be provided for completing verification.
)
}
]
},
{
name: 'pre_auth',
type: 'object | null',
required: false,
description: (
<>
This object will be populated if the AccountVerificationSession is
of type pre_auth.
),
items: [
{
name: 'pre_auth.number',
type: 'string | null',
required: false,
description: (
<>
The masked card number. If this is null, that indicates that
the number needs to be provided for completing verification.
)
},
{
name: 'pre_auth.exp_month',
type: 'string | null',
required: false,
description: (
<>
The masked card expiration month. If this is null, that indicates that
the expiration month needs to be provided for completing verification.
)
},
{
name: 'pre_auth.exp_year',
type: 'string | null',
required: false,
description: (
<>
The masked card expiration year. If this is null, that indicates that
the expiration year needs to be provided for completing verification.
)
},
{
name: 'pre_auth.exp_check',
type: 'enum',
required: false,
description: (
<>
The card expiration verification check result. If this is fail, that indicates that
the card could not be verified given the expiration data, and the AccountVerificationSession needs
to be updated with the correct expiration data to complete verification.
),
enums: [
{
name: 'pass',
description: 'The verification check passed.',
},
{
name: 'fail',
description: 'The verification check failed.',
},
{
name: 'unavailable',
description: 'The verification check is unavailable due to a restriction by the card networks.',
},
],
},
{
name: 'pre_auth.cvv',
type: 'string | null',
required: false,
description: (
<>
The masked card cvv. If this is null, that indicates that
the cvv needs to be provided for completing verification.
)
},
{
name: 'pre_auth.cvv_check',
type: 'enum',
required: false,
description: (
<>
The card cvv verification check result. If this is fail, that indicates that
the card could not be verified given the cvv, and the AccountVerificationSession needs to
be updated with the correct cvv to complete verification.
),
enums: [
{
name: 'pass',
description: 'The verification check passed.',
},
{
name: 'fail',
description: 'The verification check failed.',
},
{
name: 'unavailable',
description: 'The verification check is unavailable due to a restriction by the card networks.',
},
],
},
{
name: 'pre_auth.pre_auth_check',
type: 'enum',
required: false,
description: 'The pre_auth verification check result.',
enums: [
{
name: 'pass',
description: 'The verification check passed.',
},
{
name: 'fail',
description: 'The verification check failed.',
},
{
name: 'unavailable',
description: 'The verification check is unavailable due to a restriction by the card networks.',
},
],
},
]
},
(get_common_parameters('AccountVerificationSession').error),
(get_common_parameters('AccountVerificationSession').created_at),
(get_common_parameters('AccountVerificationSession').updated_at),
]}
/>
## Verification Types
| Type | Description |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `micro_deposits` | To verify a checking or savings account, two small amounts between \$0.20 - \$0.99 of money will be deposited into the ACH account, once received (within 1 - 3 business days) the account holder will then verify the amounts (in cents) that were deposited. |
| `plaid` | The ACH Account is verified by providing [balance](https://plaid.com/products/balance/#balance-data) and [transaction](https://plaid.com/products/transactions) data from Plaid. |
| `teller` | The ACH Account is verified by providing [balance](https://teller.io/docs/reference/account/balances#properties) and [transaction](https://teller.io/docs/reference/account/transactions#properties) data from Teller. |
| `mx` | The ACH Account is verified by providing [account](https://docs.mx.com/reference/platform-reference/reference/account-fields) and [transaction](https://docs.mx.com/reference/platform-reference/reference/transaction-fields) data from MX. |
| `trusted_provisioner` | The ACH Account is auto verified based on whitelisted routing numbers for the team. |
| `auto_verify` | The ACH account is verified automatically upon creation, if this configuration is enabled for the team. |
| `standard` | The Liability Account is verified in real-time by the isuser by providing the full account/card number. |
| `pre_auth` | The Credit Card Account is verified in real-time by the issuer and card networks by providing the full card number, expiration date, and cvv. |
## Webhook Payload
The [Webhook](/reference/webhooks/overview) payload will contain the following information:
```json
{
"id": "string",
"type": "account_verification_session.create" | "account_verification_session.update",
"path": "/accounts/{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?in\_progress, indicating that the micro-deposit transactions
have been sent.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?null or the
associated \*\_check value is fail should be provided
in the update request.
null),
},
{
name: 'pre_auth.exp_month',
type: 'string',
required: false,
description: (<>The card expiration month. This will be required to verify the account if the expiration month on the AccountVerificationSession object is null
or the exp_check field is fail),
},
{
name: 'pre_auth.exp_year',
type: 'string',
required: false,
description: (<>The card expiration year. This will be required to verify the account if the expiration year on the AccountVerificationSession object is null
or the exp_check field is fail),
},
{
name: 'pre_auth.cvv',
type: 'string',
required: false,
description: (<>The card cvv code. This will be required to verify the account if the cvv on the AccountVerificationSession object is null
or the cvv_check field is fail),
},
],
},
]}
/>
## Returns
Returns an AccountVerificationSession object.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?null),
},
],
},
]}
/>
## Returns
Returns an AccountVerificationSession object.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?entity_id must also be provided).),
},
{
name: 'entity',
type: 'object',
required: false,
description: (
<>
Information about the entity that the Element session will initiate for.
See the Individual Entity page for information about fields in the individual object.
),
items: []
},
{
name: 'account_filters',
type: 'object',
required: false,
description: 'Optional filters to restrict which liability types are shown or to restrict how many accounts the user can select.',
items: [
{
name: 'liability_types',
type: 'enum',
required: false,
description: `A list of liability types that should be shown for the user.`,
enums: ['auto_loan', 'mortgage', 'credit_card', 'loan', 'student_loan', 'personal_loan'],
},
{
name: 'selection_type',
type: 'enum',
required: false,
description: `Indicates whether the user should be able to only select one or multiple accounts.`,
enums: ['single', 'multiple'],
},
]
}
]
},
{
name: 'balance_transfer',
type: 'object',
required: false,
description: 'Information needed if creating a Balance Transfer Element token.',
items: [
{
name: 'payout_amount_min',
type: 'number',
required: true,
description: 'The minimum amount that needs to be paid out per creditor.'
},
{
name: 'minimum_loan_amount',
type: 'number',
required: true,
description: 'The minimum loan amount that should be requested.'
},
{
name: 'payout_residual_amount_max',
type: 'number',
required: true,
description: 'The maximum residual amount that can be paid out, after payments to creditors.'
},
{
name: 'loan_details_requested_amount',
type: 'number',
required: true,
description: 'The amount of the loan that is requested.'
},
{
name: 'loan_details_requested_rate',
type: 'number',
required: true,
description: 'The interest rate of the loan that is requested.'
},
{
name: 'loan_details_requested_term',
type: 'number',
required: true,
description: 'The term of the loan that is requested.'
},
{
name: 'loan_details_requested_monthly_payment',
type: 'number',
required: true,
description: 'The monthly payment of the loan that is requested.'
}
]
},
]}
/>
## Returns
The element token that was created.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?withdraw.
),
},
{
name: 'reason',
type: 'string',
required: true,
description: (
<>
Available Reasons: entity_withdrew_consent.
),
}
]}
/>
## Returns
Returns the entity with `status` set to `disabled`.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?page.
}, {
name: 'page_limit',
type: 'string',
required: false,
description: `The number of ${resource_name} to return per page.`
}];
export const ExpandableFieldsQueryParams = (resource_type = 'all') => {
const entity = [{
name: 'connect',
description: <>This is an Entity property, and refers to the Connect Object.
}, {
name: 'credit_score',
description: <>This is an Entity property, and refers to the CreditScore Object.
}, {
name: 'attribute',
description: <>This is an Entity property, and refers to the Attribute Object.
}, {
name: 'identity_latest_verification_session',
description: <>This is an Entity property, and refers to the EntityVerificationSession Object.
}, {
name: 'phone_latest_verification_session',
description: <>This is an Entity property, and refers to the EntityVerificationSession Object.
}];
const account = [{
name: 'sensitive',
description: <>This is an Account property, and refers to the Sensitive Object.
}, {
name: 'balance',
description: <>This is an Account property, and refers to the Balance Object.
}, {
name: 'card_brand',
description: <>This is an Account property, and refers to the CardBrand Object.
}, {
name: 'payoff',
description: <>This is an Account property, and refers to the Payoff Object.
}, {
name: 'transactions',
description: <>This is an Account property, and refers to the Transaction Object.
}, {
name: 'update',
description: <>This is an Account property, and refers to the Update Object.
}, {
name: 'latest_verification_session',
description: <>This is an Account property, and refers to the AccountVerificationSession Object.
}];
const ExpandableFieldsByResourceType = {
entity,
account,
all: Array.from(new Set([...entity, ...account]))
};
return {
name: "expand",
type: "enum[]",
description: <>
Attributes that can be expanded into an object to
provide additional information.
,
enums: [...ExpandableFieldsByResourceType[resource_type].map(expandable_field => ({
...expandable_field
}))]
};
};
export const ParamList = ({items, is_child = false}) => {
return items.map(item => {
const field_props = {
id: Math.random().toString(),
body: item.name,
name: item.name,
type: item.type,
required: item.required
};
const enums = item.enums || [];
const items = item.items || [];
const has_items = items?.length > 0;
const has_enums = enums?.length > 0;
const should_default_open = item.defaultOpen | false;
const render_child_item = () => {
const child_props = {
title: has_enums ? "Possible enum values" : "properties"
};
if (should_default_open) child_props.defaultOpen = true;
const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
const is_last = idx === enums.length - 1;
const is_2nd_to_last = idx === enums.length - 2;
return <>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?Verification and can access most of Method's products. Verification requirements
are set on a team-by-team basis and some verification might be auto populated.
),
},
{
name: "incomplete",
description: (
<>
The Entity has not completed all Verification requirements based on the PII provided and your team's restrictions.
)
},
{
name: "disabled",
description: (
<>
The Entity has been disabled and no longer has access to Method's products.
Entities can transition into the disabled status if
an Entity withdraws consent (via the Consent endpoint or via a Payment failure)
),
},
]),
{
name: "verification",
type: "object",
description: "Verification status of the Entity. Verification requirements are set on a team-by-team basis.",
items: [
{
name: "verification.identity",
type: "object",
description: "Identity verification status for the Entity.",
items: [
{
name: "verification.identity.verified",
type: "boolean",
description:
"The Entity's identity, who they claim to be, has been verified.",
},
{
name: "verification.identity.matched",
type: "boolean",
description:
"The Entity's identity has been matched through a Method trusted provider.",
},
{
name: "verification.identity.latest_verification_session",
type: "string | null",
description: (
<>
The ID of the latest verification session for the Entity's
identity.{" "}
Verification requirements) See{" "}
Product Names
.
),
},
{
name: "subscriptions",
type: "string[]",
description: (
<>
A list of products that the Entity is subscribed to. See{" "}
Subscription Names
.
),
},
{
name: "available_subscriptions",
type: "string[]",
description: (
<>
A list of products that the Entity can enroll into a subscription
with. See{" "}
Subscription Names
.
),
},
{
name: "restricted_subscriptions",
type: "string[]",
description: (
<>
A list of products that the Entity can subscribe to but is missing
some requirements. (e.g. Missing Verification requirements) See{" "}
Subscription Names
.
),
},
get_common_parameters("Entity").metadata,
get_common_parameters("Entity").created_at,
get_common_parameters("Entity").updated_at,
]}
/>
disabled status if
an Entity revokes authorization for a payment that has already
been sent.
),
},
]),
get_common_parameters("Entity").metadata,
get_common_parameters("Entity").created_at,
get_common_parameters("Entity").updated_at,
]}
/>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?phone
identity
identity
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?INVALID_AUTHORIZATION, INVALID_REQUEST,
or API_ERROR.
),
},
{
name: "error.code",
type: "number",
description:
"The HTTP error code. This is the same as the status code.",
},
{
name: "error.sub_type",
type: "string",
description:
"This field gives more unique types that will be used to identify the error.",
},
{
name: "error.message",
type: "string",
description:
"A human-readable message providing more details about the error.",
},
],
},
]}
/>
#### HTTP STATUS CODE SUMMARY
| code | function | Description |
| ----- | ------------------- | ------------------------------------------------------------------------------------------------ |
| `200` | `OK` | Everything worked as expected. |
| `400` | `Bad Request` | The request was unacceptable, often due to missing a required parameter. |
| `401` | `Unauthorized` | No valid API key provided. |
| `403` | `Forbidden` | The API key doesn't have permissions to perform the request. |
| `404` | `Not Found` | The requested resource doesn't exist. |
| `429` | `Too Many Requests` | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
| `500` | `Server Errors` | Something went wrong on Method's end. |
page.
}, {
name: 'page_limit',
type: 'string',
required: false,
description: `The number of ${resource_name} to return per page.`
}];
export const ParamList = ({items, is_child = false}) => {
return items.map(item => {
const field_props = {
id: Math.random().toString(),
body: item.name,
name: item.name,
type: item.type,
required: item.required
};
const enums = item.enums || [];
const items = item.items || [];
const has_items = items?.length > 0;
const has_enums = enums?.length > 0;
const should_default_open = item.defaultOpen | false;
const render_child_item = () => {
const child_props = {
title: has_enums ? "Possible enum values" : "properties"
};
if (should_default_open) child_props.defaultOpen = true;
const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
const is_last = idx === enums.length - 1;
const is_2nd_to_last = idx === enums.length - 2;
return <>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?JPMCB CARD pertains
to a Chase Credit Card.
),
},
{
name: 'provider_id.plaid',
type: 'string',
required: false,
description: 'The Plaid Institution ID for the Merchant to filter for.',
},
{
name: 'provider_id.mx',
type: 'string',
required: false,
description: 'The MX ID for the Merchant to filter for.',
},
{
name: 'provider_id.finicity',
type: 'string',
required: false,
description: 'The Finicity ID for the Merchant to filter for.',
},
{
name: 'provider_id.dpp',
type: 'string',
required: false,
description: 'The DebtPayPro ID for the Merchant to filter for.',
},
]}
/>
## Returns
Returns a list of Merchants objects.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?mch\_301761) is
different from Capital One Auto Loan (mch\_301760)
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?The ID of an Account from which the Payment funds will be retrieved.
Ensure that the following checks have been done on an Account before it is used as a Payment source:
activepayments value in
their products property.
The ID of an Account where the Payment funds will be sent to.
In the Method ecosystem, these can be either ach or liability typed
accounts.
Ensure that the following checks have been done on an Account before it is used as a Payment destination:
activepayments value in
their products property.
Payment fee information. If provided, the payment will incur a fee which will be deducted from the total amount received by the destination Account.
), items: [ { name: 'fee.type', type: 'enum', required: false, description: 'The type of fee applied to the Payment.', enums: [ { name: 'total', description: ( <> This fee type will deduct a flat fee from the amount received by the destination Account. ), }, { name: 'markup', description: ( <> This fee type will deduct a fee on top of Method's per-payment fee from the amount received by the destination Account. ), }, ], }, { name: 'fee.amount', type: 'number', required: false, description: 'The amount (in cents) of the fee.', }, ], }, ]} /> ## Returns Returns a Payment object. The Payment will be sent based on the cutoff times. The `status` of the Payment will be updated when the Payment is sent to our banking networks.{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?pending
page.
}, {
name: 'page_limit',
type: 'string',
required: false,
description: `The number of ${resource_name} to return per page.`
}];
export const ParamList = ({items, is_child = false}) => {
return items.map(item => {
const field_props = {
id: Math.random().toString(),
body: item.name,
name: item.name,
type: item.type,
required: item.required
};
const enums = item.enums || [];
const items = item.items || [];
const has_items = items?.length > 0;
const has_enums = enums?.length > 0;
const should_default_open = item.defaultOpen | false;
const render_child_item = () => {
const child_props = {
title: has_enums ? "Possible enum values" : "properties"
};
if (should_default_open) child_props.defaultOpen = true;
const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
const is_last = idx === enums.length - 1;
const is_2nd_to_last = idx === enums.length - 2;
return <>
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?This fee type will deduct a flat fee from the amount received by the destination Account.
Example: If a $10.00 Payment is created with a total fee of $2.00, then the resulting amount received by the destination Account will be $8.00. This means that you make total of $2.00 from the Payment. However, the Method fee for this Payment will still be included in your monthly invoice.
This fee type will deduct a fee on top of Method's per-Payment fee from the amount received by the destination Account.
Example: If a $10.00 Payment is created with a markup fee of $2.00 and your Method fee is $1.00, then the resulting amount received by the destination Account will be $7.00 (Amount - Markup Fee - Method Fee). This means that you make $2.00 from the Payment. Additionally, the Method fee has already been covered by the source Account, and this completed Payment will not be included in your monthly invoice.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?/simulate and will
be in the following format where RESOURCE\_NAME refers any
resource that supports simulations.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?failed, or reversal_processing.
),
enums: [
{ name: '10001', description: 'Insufficient funds error.' },
{ name: '10002', description: 'Unauthorized Payment error.' },
{ name: '10003', description: 'Invalid Account error.' },
{ name: '10005', description: 'Unauthorized Source error.' },
{ name: '10006', description: 'Unauthorized Destination error.' },
{ name: '10007', description: 'Invalid Source error.' },
{ name: '10008', description: 'Invalid Destination error.' },
{ name: '10009', description: 'Rejected By Destination error.' },
{ name: '10010', description: 'Invalid Amount error.' },
]
}
]}
/>
## Returns
Returns a Payment object with the updated status.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?base64 encoded string in
the Authorization header of the Webhook.
This can be used by your application to ensure the integrity of
incoming Webhook events.
),
},
{
name: 'expand_event',
type: 'boolean',
required: false,
description: (
<>
Whether to expand the event object in the Webhook payload. (default: false)
),
}
]}
/>
## Returns
Returns the newly created Webhook object.
{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?{enum_item}
{is_last && ''}
{is_2nd_to_last && ' or '}
{!is_last && !is_2nd_to_last && ', '}
;
});
const enum_list = has_enums && !has_inline_enums && {enum_item.name}
{enum_item.description}
)}{item.description} {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
{enum_list} {item_list} ; }; return is_child ?