external-payment-details.md

External Payment Details

Stores details about an external payment. Contains only non-confidential information. For more information, see Take External Payments.

Structure

ExternalPaymentDetails

Fields

Name	Type	Tags	Description	Getter
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. - FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals - OTHER - A type not listed here. Constraints: Maximum Length: 50	String getType()
Source	String	Required	A description of the external payment source. For example, "Food Delivery Service". Constraints: Maximum Length: 255	String getSource()
SourceId	String	Optional	An ID to associate the payment to its originating source. Constraints: Maximum Length: 255	String getSourceId()
SourceFeeMoney	Money	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.	Money getSourceFeeMoney()

Example (as JSON)

{
  "type": "type8",
  "source": "source8",
  "source_id": "source_id6",
  "source_fee_money": {
    "amount": 130,
    "currency": "BTC"
  }
}