• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
ExternalPaymentDetails

Stores details about an external payment.

Contains only non-confidential information. For more information, see Take External Payments.

Properties

Name Description
type
string

Required

The type of external payment the seller received. It can be one of the following:

  • CHECK - Paid using a physical check.
  • BANK_TRANSFER - Paid using external bank transfer.
  • OTHER_GIFT_CARD - Paid using a non-Square gift card.
  • CRYPTO - Paid using a crypto currency.
  • SQUARE_CASH - Paid using Square Cash App.
  • SOCIAL - Paid using peer-to-peer payment applications.
  • EXTERNAL - A third-party application gathered this payment outside of Square.
  • EMONEY - Paid using an E-money provider.
  • CARD - A credit or debit card that Square does not support.
  • STORED_BALANCE - Use for house accounts, store credit, and so forth.
  • OTHER - A type not listed here.
Max Length 50
source
string

Required

A description of the external payment source. For example, "Food Delivery Service".

Max Length 255
source_id
string

An ID to associate the payment to its originating source.

Max Length 255
source_fee_money
Money

The fees paid to the source. The amount_money minus this field is the net amount seller receives.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?