NAME

Net::API::Stripe::Treasury::ReceivedDebit - The ReceivedDebit object

SYNOPSIS

VERSION

    v0.1.0

DESCRIPTION

ReceivedDebits represent funds pulled from a FinancialAccount. These are not initiated from the FinancialAccount.

METHODS

id string

Unique identifier for the object.

object string

String representing the object's type. Objects of the same type share the same value.

amount integer

Amount (in cents) transferred.

created timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

currency currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

description string

An arbitrary string attached to the object. Often useful for displaying to users.

failure_code string

Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.

financial_account string

The FinancialAccount that funds were pulled from.

hosted_regulatory_receipt_url string

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

initiating_payment_method_details hash

Details about how a ReceivedDebit was created.

It has the following properties:

balance string

Set when type is balance.

billing_details hash

The contact details of the person or business referenced by the received payment method details.

When expanded, this is a Net::API::Stripe::Billing::Details object.

financial_account hash

Set when type is financial_account. This is a FinancialAccount ID.

When expanded, this is a Net::API::Stripe::Connect::ExternalAccount::Card object.

issuing_card string

Set when type is issuing_card. This is an Issuing Card ID.

type string

Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.

us_bank_account hash

Set when type is us_bank_account.

When expanded, this is a Net::API::Stripe::Connect::ExternalAccount::Bank object.

linked_flows hash

Other flows linked to a ReceivedDebit.

It has the following properties:

debit_reversal string

The DebitReversal created as a result of this ReceivedDebit being reversed.

inbound_transfer string

Set if the ReceivedDebit is associated with an InboundTransfer's return of funds.

issuing_authorization string

Set if the ReceivedDebit was created due to an Issuing Authorization object.

issuing_transaction string

Set if the ReceivedDebit is also viewable as an Issuing Dispute object.

livemode boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

network string

The network used for the ReceivedDebit.

reversal_details hash

Details describing when a ReceivedDebit might be reversed.

It has the following properties:

deadline timestamp

Time before which a ReceivedDebit can be reversed.

restricted_reason string

Set if a ReceivedDebit can't be reversed.

status string

Status of the ReceivedDebit. ReceivedDebits are created with a status of either succeeded (approved) or failed (declined). The failure reason can be found under the failure_code.

transaction expandable

The Transaction associated with this object.

When expanded this is an Net::API::Stripe::Treasury::Transaction object.

API SAMPLE

[ { "amount" : "54321", "created" : "1662261086", "currency" : "usd", "description" : "Stripe Test", "failure_code" : null, "financial_account" : "fa_1Le9F32eZvKYlo2CjbQcDQUE", "hosted_regulatory_receipt_url" : "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKN6u0JgGMgaJXJ5gPWM6NpNVsxwbJ0H2IYdjE-FeJWvCxhxTRMtAqNeU_wiSFNdGGWnGiwIbGaTowMIXAsm7Eie-ou_Wuw", "id" : "rd_1Le9F42eZvKYlo2CkeS54zSl", "initiating_payment_method_details" : { "billing_details" : { "address" : { "city" : null, "country" : null, "line1" : null, "line2" : null, "postal_code" : null, "state" : null }, "email" : null, "name" : "Jane Austen" }, "type" : "us_bank_account", "us_bank_account" : { "bank_name" : "STRIPE TEST BANK", "last4" : "6789", "routing_number" : "110000000" } }, "linked_flows" : { "debit_reversal" : null, "inbound_transfer" : null, "issuing_authorization" : null, "issuing_transaction" : null }, "livemode" : 0, "network" : "ach", "object" : "treasury.received_debit", "reversal_details" : { "deadline" : "1662508800", "restricted_reason" : null }, "status" : "succeeded", "transaction" : "trxn_1Le9F32eZvKYlo2C2dtkse82" } ]

HISTORY

v0.1.0

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation

COPYRIGHT & LICENSE

Copyright (c) 2019-2022 DEGUEST Pte. Ltd.

You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.

cpanm Net::API::Stripe

perl -MCPAN -e shell
install Net::API::Stripe