assembly-payments/lib/resources/bpay_accounts.d.ts

Assembly Payments API Typescript/Javascript Bindings

import { Client } from '../client';
import { BpayAccount, BpayAccountDeletion, SingleUser, BpayAccountRequestBody } from '../types';
declare const _default: (client: Client) => {
    /**
     * @description Show details of a specific **BPay Account** using a given `:id`.
     *
     * @tags BPay Accounts
     * @name ShowBPayAccount
     * @summary Show BPay Account
     * @request GET:/bpay_accounts/{id}
     * @secure
     */
    showBPayAccount: (id: string) => Promise<BpayAccount>;
    /**
     * @description Redact a **BPay Account** using a given `:id`. Redacted **BPay Accounts** can no longer be used as a Disbursement destination.
     *
     * @tags BPay Accounts
     * @name RedactBPayAccount
     * @summary Redact BPay Account (Future Feature)
     * @request DELETE:/bpay_accounts/{id}
     * @secure
     */
    redactBPayAccount: (id: string) => Promise<BpayAccountDeletion>;
    /**
     * @description Create a **BPay Account** to be used as a Disbursement destination.
     *
     * @tags BPay Accounts
     * @name CreateBPayAccount
     * @summary Create BPay Account
     * @request POST:/bpay_accounts
     * @secure
     */
    createBPayAccount: (data: BpayAccountRequestBody) => Promise<BpayAccount>;
    /**
     * @description Show the **User** the **BPay Account** is associated with using a given `:id`.
     *
     * @tags BPay Accounts
     * @name ShowBPayAccountUser
     * @summary Show BPay Account User
     * @request GET:/bpay_accounts/{id}/users
     * @secure
     */
    showBPayAccountUser: (id: string) => Promise<SingleUser>;
};
export default _default;