Interface Payment

export Payment

interface Payment {
    acceptance_status?: null | string;
    amount?: Amount;
    created_at?: string;
    direction?: PaymentDirection;
    fee_direction?: FeeDirection;
    fees?: null | LineItem[];
    from?: BasicContact;
    funding_id?: null | string;
    funding_type?: FundingType;
    id?: null | string;
    invoice_id?: null | string;
    ledger_type?: LedgerType;
    memo?: null | string;
    messsage?: null | string;
    object?: null | string;
    original_amount?: Amount;
    payment_cycle_id?: null | string;
    payment_cycle_memo?: null | string;
    payment_direction?: PaymentRecordDirection;
    payment_display_status?: TransactionDisplayStatusEnum;
    payment_processing_details?: PaymentProcessingDetails;
    payment_source?: PaymentSource;
    payout_id?: null | string;
    short_id?: null | string;
    status?: null | string;
    status_description?: null | string;
    tenant_id?: null | string;
    testmode?: boolean;
    to?: BasicContact;
    total_fees?: Amount;
    transaction_id?: null | string;
    transfer_id?: null | string;
    updates?: null | TransactionUpdates[];
    user_id?: null | string;
    wallet_key?: null | string;
    wallet_transaction_id?: null | string;
}

Properties

acceptance_status? amount? created_at? direction? fee_direction? fees? from? funding_id? funding_type? id? invoice_id? ledger_type? memo? messsage? object? original_amount? payment_cycle_id? payment_cycle_memo? payment_direction? payment_display_status? payment_processing_details? payment_source? payout_id? short_id? status? status_description? tenant_id? testmode? to? total_fees? transaction_id? transfer_id? updates? user_id? wallet_key? wallet_transaction_id?

Properties

Optionalacceptance_status

acceptance_status?: null | string

Flag: An indicator representing the payment acceptance status, distinct from the overall payment status.

Optionalamount

amount?: Amount

Optionalcreated_at

created_at?: string

Optionaldirection

direction?: PaymentDirection

Optionalfee_direction

fee_direction?: FeeDirection

Optionalfees

fees?: null | LineItem[]

Optionalfrom

from?: BasicContact

Optionalfunding_id

funding_id?: null | string

Optionalfunding_type

funding_type?: FundingType

Optionalid

id?: null | string

Optionalinvoice_id

invoice_id?: null | string

Invoice External ID for Payment Cycle Invoice Funding Source

Optionalledger_type

ledger_type?: LedgerType

Optionalmemo

memo?: null | string

A memo to include with the payment

Optionalmesssage

messsage?: null | string

To store various payment-related information

Optionalobject

object?: null | string

The name of this object

Optionaloriginal_amount

original_amount?: Amount

Optionalpayment_cycle_id

payment_cycle_id?: null | string

Payment Cycle identifier.

Optionalpayment_cycle_memo

payment_cycle_memo?: null | string

Global Payment Cycle Memo

Optionalpayment_direction

payment_direction?: PaymentRecordDirection

Optionalpayment_display_status

payment_display_status?: TransactionDisplayStatusEnum

Optionalpayment_processing_details

payment_processing_details?: PaymentProcessingDetails

Optionalpayment_source

payment_source?: PaymentSource

Optionalpayout_id

payout_id?: null | string

Payment payout id

Optionalshort_id

short_id?: null | string

Optionalstatus

status?: null | string

The status of the payment

Optionalstatus_description

status_description?: null | string

User Display Status

Optionaltenant_id

tenant_id?: null | string

Id of the account authorized to send payments

Optionaltestmode

testmode?: boolean

If true, the request is in test mode, and will be processed as a test transaction. test bank accounts and test debit cards can be used.

Optionalto

to?: BasicContact

Optionaltotal_fees

total_fees?: Amount

Optionaltransaction_id

transaction_id?: null | string

Transaction IDs are used internally to group payment objects

Optionaltransfer_id

transfer_id?: null | string

Payment transfer id

Optionalupdates

updates?: null | TransactionUpdates[]

Transaction summary of each payment’s journey

Optionaluser_id

user_id?: null | string

Id of the initiating user

Optionalwallet_key

wallet_key?: null | string

Wallet id

Optionalwallet_transaction_id

wallet_transaction_id?: null | string

The transaction identifier from the wallet provider (external id)

Settings

Member Visibility

On This Page

Properties