/ 
Net-API-Stripe-v2.0.5
River stage one • 1 direct dependent • 1 total dependent
/ Net::API::Stripe::Treasury::OutboundPayment

NAME

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

SYNOPSIS

VERSION

v0.1.0

DESCRIPTION

Use OutboundPayments to send funds to another party's external bank account or FinancialAccount. To send money to an account belonging to the same user, use an OutboundTransfer.

Simulate OutboundPayment state changes with the /v1/test_helpers/treasury/outbound_payments endpoints. These methods can only be called on test mode objects.

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.

cancelable boolean

Returns true if the object can be canceled, and false otherwise.

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.

customer string

ID of the customer to whom an OutboundPayment is sent.

description string

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

destination_payment_method string

The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using destination_payment_method_data.

destination_payment_method_details hash

Details about the PaymentMethod for an OutboundPayment.

It has the following properties:

billing_details hash

Contact details for the person or business receiving the OutboundPayment.

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

financial_account hash

Details about the financial_account.

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

type string

The type of the payment method used in the OutboundPayment.

us_bank_account hash

Details about the us_bank_account.

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

end_user_details hash

Details about the end user.

It has the following properties:

ip_address string

IP address of the user initiating the OutboundPayment. Set if present is set to true. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.

present boolean

true`` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise,false`.

expected_arrival_date timestamp

The date when funds are expected to arrive in the destination account.

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.

livemode boolean

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

metadata hash

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

returned_details hash

Details about a returned OutboundPayment. Only set when the status is returned.

It has the following properties:

code string

Reason for the return.

transaction string expandable

The Transaction associated with this object.

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

statement_descriptor string

The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).

status string

Current status of the OutboundPayment: processing, failed, posted, returned, canceled. An OutboundPayment is processing if it has been created and is pending. The status changes to posted once the OutboundPayment has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundPayment fails to arrive at its destination, its status will change to returned.

status_transitions hash

Hash containing timestamps of when the object transitioned to a particular status.

It has the following properties:

canceled_at timestamp

Timestamp describing when an OutboundPayment changed status to canceled.

failed_at timestamp

Timestamp describing when an OutboundPayment changed status to failed.

posted_at timestamp

Timestamp describing when an OutboundPayment changed status to posted.

returned_at timestamp

Timestamp describing when an OutboundPayment changed status to returned.

transaction expandable

The Transaction associated with this object.

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

API SAMPLE

[ { "amount" : "10000", "cancelable" : 1, "created" : "1662261086", "currency" : "usd", "customer" : null, "description" : "OutboundPayment to a 3rd party", "destination_payment_method" : null, "destination_payment_method_details" : { "billing_details" : { "address" : { "city" : "San Francisco", "country" : "US", "line1" : "1234 Fake Street", "line2" : null, "postal_code" : "94102", "state" : "CA" }, "email" : null, "name" : "Jane Austen" }, "type" : "us_bank_account", "us_bank_account" : { "account_holder_type" : "individual", "account_type" : "checking", "bank_name" : "STRIPE TEST BANK", "fingerprint" : "1JWtPxqbdX5Gamtz", "last4" : "6789", "network" : "ach", "routing_number" : "110000000" } }, "end_user_details" : { "ip_address" : null, "present" : 0 }, "expected_arrival_date" : "1662422400", "financial_account" : "fa_1Le9F32eZvKYlo2CjbQcDQUE", "hosted_regulatory_receipt_url" : "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKN6u0JgGMga0Su026sg6NpNF_5Q6tvMEpWEUiDbGDU97VaAIklGS9OIDXmvjiWY8npbpXaOBAk0SB9UCp4Ga0Qx_Ft3Ksg", "id" : "obp_1Le9F42eZvKYlo2CBS5f6W7m", "livemode" : 0, "metadata" : {}, "object" : "treasury.outbound_payment", "returned_details" : null, "statement_descriptor" : "payment", "status" : "processing", "status_transitions" : { "canceled_at" : null, "failed_at" : null, "posted_at" : null, "returned_at" : null }, "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.