Object Index / Definition

You are viewing an old version of the API
ExternalPaymentDetails

Additional details about EXTERNAL type payments.

Properties

Name Description
type
string

Required

The type of External payment which can be one of: CHECK - Paid by a physical check BANKTRANSFER - Paid by ACH or other bank transfer OTHERGIFTCARD - Paid by a non-square gift card CRYPTO - Paid via a crypto currency SQUARECASH - Paid via Square Cash app SOCIAL - Venmo, WeChatPay, AliPay, etc. EXTERNAL - A 3rd party application gathered this payment outside of Square EMONEY - A Japanese e-money brand Square doesn’t support CREDIT/DEBIT - A credit/debit card Square doesn’t support OTHER - A type not listed here

source
string

Required

A description of the source of the external payment, e.g. “Uber Eats”, “Stripe”, “Shopify”.

Limit 255 characters

source_id
string

An ID to associate this payment to its originating source

Limit 255 characters.

source_fee_money
Money

The total of fees paid to the source. (amountmoney - sourcefee_money) = net money to the merchant

Share Feedback

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