정사각형 결제(독립 게시자)(미리 보기)

Square는 보안 신용 카드 처리에서 판매 솔루션에 이르기까지 수백만 명의 판매자가 비즈니스를 운영하는 데 도움이 됩니다. 이 커넥터에는 결제, 터미널, 주문, 구독, 송장, 카탈로그, 인벤토리 및 고객 엔드포인트에 대한 작업이 포함되어 있습니다.

이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.

서비스	클래스	Regions
Copilot Studio	Premium	다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD)
논리 앱	스탠다드	다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD)
Power Apps	Premium	다음을 제외한 모든 Power Apps 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD)
Power Automate	Premium	다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD)

연락처
이름	트로이 테일러
URL	https://www.hitachisolutions.com
전자 메일	ttaylor@hitachisolutions.com

커넥터 메타데이터
게시자	트로이 테일러
웹 사이트	https://squareup.com/
개인 정보 보호 정책	https://squareup.com/us/en/legal/general/privacy
카테고리	상업; 판매 및 CRM

제한 한도

Name	호출	갱신 기간
연결당 API 호출	100	60초

동작

Apple Pay 도메인 등록	웹 및 스퀘어에서 Apple Pay와 함께 사용할 도메인을 활성화합니다. Apple이 이 도메인에서 유효성 검사를 수행하여 Apple Pay 사용 도메인으로 올바르게 설정되었는지 확인합니다.
Batch upsert 카탈로그 개체	제공된 개체 목록을 기반으로 최대 10,000개의 대상 개체를 만들거나 업데이트합니다. 대상 개체는 일괄 처리로 그룹화되고 각 일괄 처리는 모두 또는 전혀 없는 방식으로 삽입/업데이트됩니다. 일괄 처리 내의 개체가 어떤 식으로든 형식이 잘못되었거나 데이터베이스 제약 조건을 위반하는 경우 해당 항목을 포함하는 전체 일괄 처리는 무시됩니다. 그러나 동일한 요청의 다른 일괄 처리는 여전히 성공할 수 있습니다. 각 일괄 처리에는 최대 1,000개의 개체가 포함될 수 있으며, 요청의 총 개체 수(항목, 변형, 한정자 목록, 할인 및 세금)가 10,000개 이하인 한 일괄 처리가 처리됩니다.
Batch 인벤토리 변경 내용 검색	제공된 필터 조건에 따라 기록 실제 개수 및 조정을 반환합니다.
Batch 카탈로그 개체 검색	제공된 ID를 기반으로 개체 집합을 반환합니다. 집합에 반환된 각 CatalogItem에는 모든 CatalogItemVariation 개체, CatalogModifierList 개체에 대한 참조 및 해당 개체에 적용되는 CatalogTax 개체의 ID를 포함한 모든 자식 정보가 포함됩니다.
idempotency 키로 결제 취소	요청에 지정된 idempotency 키로 식별된 결제를 취소(voids)합니다. CreatePayment 요청의 상태를 알 수 없는 경우(예: CreatePayment 요청을 보낸 후 네트워크 오류가 발생하고 응답을 받지 못하는 경우) 이 메서드를 사용합니다. 이 경우 Square에 이 엔드포인트를 사용하여 결제를 취소하도록 지시할 수 있습니다. 요청에서 취소하려는 CreatePayment 요청에서 제공한 것과 동일한 idempotency 키를 제공합니다. 결제를 취소한 후 CreatePayment 요청을 다시 제출할 수 있습니다. 지정된 idempotency 키를 사용한 결제를 찾을 수 없는 경우 아무 작업도 수행되지 않으며 엔드포인트가 성공적으로 반환됩니다.
Upsert 카탈로그 개체	대상 CatalogObject를 만들거나 업데이트합니다.
검색 주문	하나 이상의 위치에 대한 모든 주문을 검색합니다. 주문에는 Square 에코시스템(예: Point of Sale, Invoices 및 Connect API)에 진입한 방법 또는 시기에 관계없이 모든 판매, 반품 및 교환이 포함됩니다.
결제 나열	요청을 만드는 계정에서 수행한 지불 목록을 검색합니다. 결과는 결국 일관되며, 새로운 지불 또는 지불 변경 내용이 나타나려면 몇 초 정도 걸릴 수 있습니다.
결제 만들기	제공된 원본을 사용하여 결제를 만듭니다. 이 엔드포인트를 사용하여 카드(신용/직불 카드 또는 스퀘어 기프트 카드)를 청구하거나 판매자가 Square 외부에서 받은 결제(구매자로부터의 현금 결제 또는 외부 법인이 판매자를 대신하여 처리한 결제)를 기록할 수 있습니다.
결제 받기	특정 결제에 대한 세부 정보를 검색합니다.
결제 업데이트	결제를 승인됨 상태로 업데이트합니다. 이 엔드포인트를 사용하여 amount_money 업데이트하고 tip_money 수 있습니다.
결제 완료	결제를 완료(캡처)합니다. 기본적으로 결제는 생성 직후에 완료되도록 설정됩니다.
결제 취소	결제를 취소(무효)합니다. 이 엔드포인트를 사용하여 APPROVED 상태의 결제를 취소할 수 있습니다.
결제 환불 받기	refund_id 사용하여 특정 환불을 검색합니다.
고객 검색	단일 고객에 대한 세부 정보를 반환합니다.
고객 검색	지원되는 쿼리 필터를 사용하여 Square 계정과 연결된 고객 프로필을 검색합니다. 명시적 쿼리 필터 없이 SearchCustomers를 호출하면 given_name 및 family_name 따라 사전순으로 정렬된 모든 고객 프로필이 반환됩니다.
고객 그룹 검색	특정 고객 그룹을 검색합니다.
고객 그룹 나열	비즈니스의 고객 그룹 목록을 검색합니다.
고객 그룹 만들기	비즈니스에 대한 새 고객 그룹을 만듭니다.
고객 그룹 삭제	group_id 값으로 식별된 고객 그룹을 삭제합니다.
고객 그룹 업데이트	고객 그룹을 업데이트합니다.
고객 나열	Square 계정과 연결된 고객 프로필을 나열합니다. 정상적인 운영 조건에서 새로 만들거나 업데이트된 고객 프로필은 30초 미만의 시간 안에 나열 작업에 사용할 수 있게 됩니다. 경우에 따라 새 프로필 또는 업데이트된 프로필의 전파는 특히 네트워크 인시던트 및 중단 중에 1분 이상 걸릴 수 있습니다.
고객 만들기	비즈니스에 대한 새 고객을 만듭니다.
고객 삭제	비즈니스에서 고객 프로필을 삭제합니다. 또한 이 작업은 파일의 연결된 카드의 연결을 해제합니다.
고객 세그먼트 검색	특정 고객 세그먼트를 검색합니다.
고객 세그먼트 나열	비즈니스의 고객 세그먼트 목록을 검색합니다.
고객 업데이트	고객 프로필을 업데이트합니다. 특성을 변경하려면 새 값을 지정합니다. 특성을 제거하려면 값을 빈 문자열 또는 빈 개체로 지정합니다.
고객에게 그룹 추가	고객에게 그룹 멤버 자격을 추가합니다. 고객은 customer_id 값으로 식별되고 고객 그룹은 group_id 값으로 식별됩니다.
고객에서 그룹 제거	고객에서 그룹 멤버 자격을 제거합니다. 고객은 customer_id 값으로 식별되고 고객 그룹은 group_id 값으로 식별됩니다.
구독 검색	구독을 검색합니다.
구독 검색	구독을 검색합니다. 결과는 구독 생성 날짜별로 시간순으로 정렬됩니다. 요청이 둘 이상의 위치 ID를 지정하는 경우 엔드포인트는 위치 ID를 기준으로 결과를 정렬한 다음 각 위치 내에서 만든 날짜를 기준으로 정렬합니다. 쿼리에 위치가 지정되지 않으면 모든 위치가 검색됩니다.
구독 다시 시작	비활성화된 구독을 다시 시작합니다.
구독 만들기	구독 플랜에 대한 고객의 구독을 만듭니다. 요청에서 파일에 카드를 제공하는 경우 Square는 구독에 대한 카드를 청구합니다. 그렇지 않으면 Square는 고객의 이메일 주소에 청구서를 청구합니다. 요청에 선택적 start_date 포함하지 않는 한 구독이 즉시 시작됩니다. 각 개별 구독은 특정 위치와 연결됩니다.
구독 업데이트	구독을 업데이트합니다. 구독 필드 값을 설정, 수정 및 지울 수 있습니다.
구독 이벤트 나열	특정 구독에 대한 모든 이벤트를 나열합니다.
구독 취소	canceled_date 필드를 활성 청구 기간의 끝으로 설정합니다. 이 날짜 이후에 상태가 ACTIVE에서 CANCELED로 변경됩니다.
복제 순서(베타)	기존 순서를 복제하여 DRAFT 상태에서 새 순서를 만듭니다. 새로 만든 주문에는 원래 주문에서 복사한 핵심 필드(예: 품목, 세금 및 할인)만 있습니다.
분쟁 검색	특정 분쟁에 대한 세부 정보를 반환합니다.
분쟁 나열	특정 계정과 관련된 분쟁 목록을 반환합니다.
분쟁 수락	분쟁의 손실을 수락합니다. Square는 분쟁 금액을 카드 소유자에게 반환하고 분쟁 상태를 ACCEPTED로 업데이트합니다. 제곱은 판매자의 광장 계정에서 분쟁 금액을 차변합니다. Square 계정에 충분한 자금이 없는 경우 Square는 연결된 은행 계좌를 인출합니다.
분쟁 증거 검색	요청 URL 경로의 증명 정보 ID로 지정된 증명 정보 메타데이터를 반환합니다. 나중에 참조하려면 업로드한 증거의 복사본을 유지해야 합니다. 증거를 업로드한 후에는 다운로드할 수 없습니다.
분쟁 증거 나열	분쟁과 관련된 증거 목록을 반환합니다.
분쟁 증거 삭제	분쟁에서 지정된 증거를 제거합니다.
분쟁 증거 텍스트 만들기	분쟁 챌린지의 증거로 사용할 텍스트를 업로드합니다.
순서 검색	ID별로 주문을 검색합니다.
순서 계산(베타)	애플리케이션에서 주문을 만들지 않고 주문 가격을 미리 볼 수 있습니다.
인벤토리 물리적 개수 검색	제공된 physical_count_id InventoryPhysicalCount 개체를 반환합니다.
인벤토리 수 검색	지정된 위치 집합에서 지정된 CatalogObject의 현재 계산 재고 수를 검색합니다.
인벤토리 전송 검색(베타)	제공된 transfer_id InventoryTransfer 개체를 반환합니다.
인벤토리 조정 검색	제공된 adjustment_id InventoryAdjustment 개체를 반환합니다.
일괄 처리 검색 인벤토리 수	요청된 위치에서 제공된 CatalogObjects의 현재 개수를 반환합니다.
일괄 처리 검색 주문	ID로 주문 집합을 검색합니다. 지정된 주문 ID가 없으면 오류를 생성하는 대신 ID가 무시됩니다.
일괄 처리 변경 인벤토리	제공된 항목 수량에 조정 및 개수를 적용합니다. 성공: 요청에서 참조되는 모든 개체에 대해 현재 계산된 개수를 반환합니다.
일괄 처리 삭제 카탈로그 개체	제공된 대상 ID 목록에 따라 CatalogItems 집합을 삭제하고 응답에서 성공적으로 삭제된 ID 집합을 반환합니다.
주문 만들기	구매 제품 및 구매에 적용할 설정에 대한 정보를 포함할 수 있는 새 주문을 만듭니다.
주문 업데이트(베타)	필드를 추가, 바꾸기 또는 삭제하여 열린 순서를 업데이트합니다. COMPLETED 또는 CANCELED 상태의 주문은 업데이트할 수 없습니다.
주문 지불(베타)	하나 이상의 승인된 결제를 사용하여 주문을 지불하거나 총 0으로 주문을 정정합니다. 요청에 나열된 payment_ids 합계는 주문 합계와 같아야 합니다. 총 금액이 0인 주문은 요청에 빈 payment_ids 배열을 지정하여 지불된 것으로 표시할 수 있습니다.
증거 제출	카드 소유자의 은행에 증거를 제출합니다. 증거를 제출하기 전에 Square는 사용 가능한 모든 증거를 컴파일합니다. 여기에는 CreateDisputeEvidenceFile 및 CreateDisputeEvidenceText 엔드포인트를 사용하여 업로드된 증거와 사용 가능한 경우 Square에서 자동으로 제공하는 증명 정보가 포함됩니다.
지불 환불 나열	요청을 하는 계정에 대한 환불 목록을 검색합니다. 결과는 결국 일관되며, 새로운 환불 또는 환불 변경 내용이 표시되기까지 몇 초 정도 걸릴 수 있습니다.
청구서 가져오기	청구서 ID로 청구서를 검색합니다.
청구서 검색	필터에 지정된 위치에서 청구서를 검색합니다.
청구서 게시	지정된 초안 청구서를 게시합니다. 청구서가 게시된 후 Square는 청구서 구성에 따라 후속 작업을 수행합니다. 예를 들어 Square는 고객의 전자 메일 주소로 청구서를 보내거나, 파일에서 고객의 카드를 청구하거나, 아무 작업도 수행하지 않습니다. Square는 또한 Square 호스팅 송장 페이지에서 청구서를 사용할 수 있도록 합니다.
청구서 나열	지정된 위치에 대한 청구서 목록을 반환합니다.
청구서 만들기	Orders API를 사용하여 만든 주문에 대한 초안 청구서를 만듭니다. 초안 청구서는 계정에 남아 있으며 아무런 조치도 취하지 않습니다. Square에서 처리하려면 먼저 청구서를 게시해야 합니다(고객의 전자 메일 주소로 보내거나 파일에서 고객의 카드를 청구).
청구서 삭제	지정된 청구서를 삭제합니다. 청구서가 삭제되면 관련 주문 상태가 CANCELED로 변경됩니다. 초안 청구서만 삭제할 수 있습니다(처리가 예약된 송장을 포함하여 게시된 청구서는 삭제할 수 없음).
청구서 업데이트	필드를 수정하거나 필드를 지우거나 둘 다 사용하여 청구서를 업데이트합니다.
청구서 취소	청구서를 취소합니다. 판매자는 취소된 청구서에 대한 결제를 수집할 수 없습니다.
카드 검색	특정 카드에 대한 세부 정보를 검색합니다.
카드 나열	요청을 만드는 계정이 소유한 카드 목록을 검색합니다.
카드 만들기	기존 가맹점에 파일의 카드를 추가합니다.
카드 사용 안 함	카드를 사용하지 않도록 설정하여 추가 업데이트 또는 요금을 방지합니다. 이미 사용하지 않도록 설정된 카드를 사용하지 않도록 설정할 수 있지만 아무런 효과가 없습니다.
카탈로그 개체 검색	제공된 ID에 따라 단일 CatalogItem을 CatalogObject로 반환합니다. 반환된 개체에는 CatalogItemVariation 자식, CatalogModifierList 개체에 대한 참조 및 해당 개체에 적용되는 CatalogTax 개체의 ID를 비롯한 모든 관련 CatalogItem 정보가 포함됩니다.
카탈로그 개체 검색	지정된 쿼리 필터 중 하나 이상에 대해 항목 또는 항목 변형에 대한 사용자 지정 특성 값을 제외하고 지원되는 검색 특성 값을 일치시켜 모든 형식의 CatalogObject를 검색합니다.
카탈로그 개체 삭제	제공된 ID에 따라 단일 CatalogObject를 삭제하고 응답에서 성공적으로 삭제된 ID 집합을 반환합니다. 삭제는 대상 개체의 모든 자식도 삭제되는 연속 이벤트입니다. 예를 들어 CatalogItem을 삭제하면 CatalogItemVariation 자식도 모두 삭제됩니다.
카탈로그 나열	카탈로그에 원하는 형식 집합의 모든 개체(예: 모든 CatalogItem 및 CatalogTax 개체)가 포함된 CatalogObjects 목록을 반환합니다. ListCatalog는 삭제된 카탈로그 항목을 반환하지 않습니다.
카탈로그 정보	BatchUpsertCatalogObjects 엔드포인트에서 사용할 수 있는 일괄 처리 크기 제한과 같은 Square Catalog API에 대한 정보를 검색합니다.
터미널 체크 아웃 가져오기	checkout_id 터미널 체크 아웃 요청을 검색합니다.
터미널 체크 아웃 검색	요청을 만드는 계정에서 만든 터미널 체크 아웃 요청의 필터링된 목록을 검색합니다.
터미널 체크 아웃 만들기	터미널 체크 아웃 요청을 만들고 지정된 디바이스로 보내 요청된 금액에 대한 결제를 수행합니다.
터미널 체크 아웃 취소	요청 상태가 허용하는 경우 터미널 체크 아웃 요청을 취소합니다.
터미널 환불 검색	요청을 만드는 판매자가 만든 Interac 터미널 환불 요청의 필터링된 목록을 검색합니다.
터미널 환불 만들기	Square 터미널에서 완료된 Interac 결제를 환불해 달라는 요청을 만듭니다.
터미널 환불 받기	ID별로 Interac 터미널 환불 개체를 검색합니다.
터미널 환불 취소	요청 상태가 허용하는 경우 환불 요청 ID로 Interac 터미널 환불 요청을 취소합니다.
항목 세금 업데이트	전체 항목에서 upsert를 수행할 필요 없이 대상 CatalogItem에 적용되는 CatalogTax 개체를 업데이트합니다.
항목 한정자 목록 업데이트	전체 항목에서 upsert를 수행하지 않고도 대상 CatalogItem에 적용되는 CatalogModifierList 개체를 업데이트합니다.
환불 결제	결제를 환불합니다. 전체 지불 금액 또는 일부를 환불할 수 있습니다. 이 엔드포인트를 사용하여 카드 결제를 환불하거나 현금 또는 외부 결제의 환불을 기록할 수 있습니다.

Apple Pay 도메인 등록

작업 ID:: ApplePayRegister

웹 및 스퀘어에서 Apple Pay와 함께 사용할 도메인을 활성화합니다. Apple이 이 도메인에서 유효성 검사를 수행하여 Apple Pay 사용 도메인으로 올바르게 설정되었는지 확인합니다.

매개 변수

Name	키	필수	형식	Description
도메인 이름	domain_name	True	string	APPLE Pay에 등록될 RFC-1034에 설명된 도메인 이름입니다.

반환

Name	경로	형식	Description
상태	status	string	도메인 등록의 상태입니다.

Batch upsert 카탈로그 개체

작업 ID:: CatalogBatchUpsert

제공된 개체 목록을 기반으로 최대 10,000개의 대상 개체를 만들거나 업데이트합니다. 대상 개체는 일괄 처리로 그룹화되고 각 일괄 처리는 모두 또는 전혀 없는 방식으로 삽입/업데이트됩니다. 일괄 처리 내의 개체가 어떤 식으로든 형식이 잘못되었거나 데이터베이스 제약 조건을 위반하는 경우 해당 항목을 포함하는 전체 일괄 처리는 무시됩니다. 그러나 동일한 요청의 다른 일괄 처리는 여전히 성공할 수 있습니다. 각 일괄 처리에는 최대 1,000개의 개체가 포함될 수 있으며, 요청의 총 개체 수(항목, 변형, 한정자 목록, 할인 및 세금)가 10,000개 이하인 한 일괄 처리가 처리됩니다.

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
유형	type	string	이 개체의 형식입니다.
아이디	id	string	이 개체를 참조할 식별자입니다.
모든 위치에 있음	present_at_all_locations	boolean	true이면 이 개체는 absent_at_location_ids 필드에 지정된 위치를 제외한 모든 위치(이후 위치 포함)에 있습니다. false이면 이 개체는 present_at_location_ids 필드에 지정된 위치를 제외하고 이후 위치와 같은 위치에 없습니다. 지정하지 않으면 기본값은 true입니다.
이름	name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
Description	title	string	항목의 설명입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
범주 ID	category_id	string	항목 범주의 ID(있는 경우)입니다.
세금 ID	tax_ids	array of string
유형	type	string	이 개체의 형식입니다. 각 개체 형식에는 아래의 해당 *_data 필드 내에서 구조화된 형식으로 표현되는 예상 속성이 있습니다.
아이디	id	string	이 개체를 참조할 식별자입니다.
모든 위치에 있음	present_at_all_locations	boolean	모든 위치에 있는지 여부입니다.
항목 ID	item_id	string	항목의 식별자입니다.
이름	name	string	항목의 이름입니다.
가격 책정 유형	pricing_type	string	가격 책정 유형입니다.
금액	amount	integer	금액입니다.
통화	currency	string	통화입니다.
이름	name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
이름	name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
계산 단계	calculation_phase	string	납부액의 소계 또는 합계를 기준으로 세금이 계산되는지 여부입니다.
포함 유형	inclusion_type	string	세금이 ADDITIVE인지 아니면 INCLUSIVE인지 여부입니다.
백분율	percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호가 없는 10진수 형식의 세금 백분율입니다. 값 7.5는 7.5%해당합니다.
사용자 지정 금액에 적용	applies_to_custom_amounts	boolean	true이면 특정 CatalogItem과 연결되지 않은 Square Point of Sale 앱에 입력된 사용자 지정 금액에 요금이 적용됩니다.
활성화됨	enabled	boolean	Square Point of Sale 앱에서 세금이 사용(true)으로 표시되는지 여부를 나타내는 부울 플래그입니다(false).

반환

Name	경로	형식	Description
개체	objects	array of object
유형	objects.type	string	이 개체의 형식입니다.
아이디	objects.id	string	Square에서 발급한 고유한 식별자입니다.
업데이트 날짜	objects.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
버전	objects.version	integer	개체의 현재 버전입니다.
삭제됨	objects.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
모든 위치에 있음	objects.present_at_all_locations	boolean	true이면 이 개체는 absent_at_location_ids 필드에 지정된 위치를 제외한 모든 위치(이후 위치 포함)에 있습니다. false이면 이 개체는 present_at_location_ids 필드에 지정된 위치를 제외하고 이후 위치와 같은 위치에 없습니다. 지정하지 않으면 기본값은 true입니다.
이름	objects.item_data.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
Description	objects.item_data.title	string	항목의 설명입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
범주 ID	objects.item_data.category_id	string	항목 범주의 ID(있는 경우)입니다.
세금 ID	objects.item_data.tax_ids	array of string
Variations	objects.item_data.variations	array of object
유형	objects.item_data.variations.type	string	이 개체의 형식입니다. 각 개체 형식에는 아래의 해당 *_data 필드 내에서 구조화된 형식으로 표현되는 예상 속성이 있습니다.
아이디	objects.item_data.variations.id	string	이 개체를 참조할 식별자입니다.
업데이트 날짜	objects.item_data.variations.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
버전	objects.item_data.variations.version	integer	개체의 버전입니다. 개체를 업데이트할 때 제공된 버전은 데이터베이스의 버전과 일치해야 합니다. 그렇지 않으면 쓰기가 충돌하는 것으로 거부됩니다.
삭제됨	objects.item_data.variations.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
모든 위치에 있음	objects.item_data.variations.present_at_all_locations	boolean	present_at_all_locations false인 경우에도 개체가 있는 위치 목록입니다. 여기에는 비활성화된 위치가 포함될 수 있습니다.
항목 ID	objects.item_data.variations.item_variation_data.item_id	string	이 항목 변형이 있는 개체의 ID입니다.
이름	objects.item_data.variations.item_variation_data.name	string	이 항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
서수	objects.item_data.variations.item_variation_data.ordinal	integer	이 항목 변형을 표시해야 하는 순서입니다. 이 값은 읽기 전용입니다.
가격 책정 유형	objects.item_data.variations.item_variation_data.pricing_type	string	판매 시 항목 변형의 가격이 고정되었는지 또는 결정되는지 여부를 나타냅니다.
금액	objects.item_data.variations.item_variation_data.price_money.amount	integer	통화로 표시된 통화의 가장 작은 교단에 있는 금액입니다. 예를 들어 통화가 USD인 경우 금액은 센트 단위입니다. 금액은 양수 또는 음수일 수 있습니다. 특정 사례에서 기호의 의미를 확인하려면 특정 필드 설명을 참조하세요.
통화	objects.item_data.variations.item_variation_data.price_money.currency	string	ISO 4217 형식의 통화 형식입니다. 예를 들어 미국 달러의 통화 코드는 USD입니다.
이름	objects.category_data.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
이름	objects.tax_data.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
계산 단계	objects.tax_data.calculation_phase	string	납부액의 소계 또는 합계를 기준으로 세금이 계산되는지 여부입니다.
포함 유형	objects.tax_data.inclusion_type	string	세금이 ADDITIVE인지 아니면 INCLUSIVE인지 여부입니다.
백분율	objects.tax_data.percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
사용자 지정 금액에 적용	objects.tax_data.applies_to_custom_amounts	boolean	true이면 특정 CatalogItem과 연결되지 않은 Square Point of Sale 앱에 입력된 사용자 지정 금액에 요금이 적용됩니다.
활성화됨	objects.tax_data.enabled	boolean	개체를 사용할 수 있는지 여부를 나타냅니다.
ID 매핑	id_mappings	array of object
클라이언트 개체 ID	id_mappings.client_object_id	string	새 CatalogObject에 대한 클라이언트에서 제공하는 임시 #접두사 ID입니다.
오브젝트 ID	id_mappings.object_id	string	서버에서 만든 영구 ID입니다.

Batch 인벤토리 변경 내용 검색

작업 ID:: InventoryBatchRetrieveChanges

제공된 필터 조건에 따라 기록 실제 개수 및 조정을 반환합니다.

매개 변수

Name	키	형식	Description
카탈로그 개체 ID	catalog_object_ids	array of string
위치 ID	location_ids	array of string
유형	types	array of string
States	states	array of string
업데이트 후	updated_after	string	RFC 3339 타임스탬프에 지정된 시간 이후의 calculated_at 값으로 결과를 반환하는 필터입니다.
이전에 업데이트됨	updated_before	string	RFC 3339 타임스탬프에 지정된 시간 이전의 created_at 또는 calculated_at 값으로 결과를 반환하는 필터입니다.

반환

Name	경로	형식	Description
Changes	changes	array of object
유형	changes.type	string	이 개체의 형식입니다.
아이디	changes.physical_count.id	string	개체의 식별자입니다.
참조 ID	changes.physical_count.reference_id	string	이 카드를 외부 시스템의 다른 엔터티와 연결하는 선택적 사용자 정의 참조 ID입니다.
카탈로그 개체 ID	changes.physical_count.catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
카탈로그 개체 형식	changes.physical_count.catalog_object_type	string	추적할 CatalogObject의 형식입니다.
주	changes.physical_count.state	string	항목의 관련 수량에 대한 현재 인벤토리 상태입니다.
위치 ID	changes.physical_count.location_id	string	이 입찰의 일부를 받는 받는 사람(가맹점 이외의)의 위치 ID입니다.
수량	changes.physical_count.quantity	string	물리적 개수의 영향을 받는 항목 수를 10진수 문자열로 지정합니다. 이 숫자는 소수점 이후 최대 5자리를 지원할 수 있습니다.
제품	changes.physical_count.source.product	string	애플리케이션의 제품 유형입니다.
애플리케이션 ID	changes.physical_count.source.application_id	string	애플리케이션에 할당된 정사각형 ID입니다.
이름	changes.physical_count.source.name	string	항목의 이름입니다.
직원 ID	changes.physical_count.employee_id	string	실제 개수를 담당하는 직원의 Square 생성 ID입니다.
발생 날짜	changes.physical_count.occurred_at	string	물리적 개수를 검사한 시기를 나타내는 클라이언트에서 생성된 RFC 3339 형식 타임스탬프입니다. 물리적 개수 업데이트의 경우 occurred_at 타임스탬프는 요청 시간을 기준으로 24시간 이상 또는 이후 버전일 수 없습니다.
만든 위치에서	changes.physical_count.created_at	string	물리적 개수가 만들어진 시기를 나타내는 클라이언트에서 생성된 RFC 3339 형식 타임스탬프입니다.

Batch 카탈로그 개체 검색

작업 ID:: CatalogBatchRetrieve

제공된 ID를 기반으로 개체 집합을 반환합니다. 집합에 반환된 각 CatalogItem에는 모든 CatalogItemVariation 개체, CatalogModifierList 개체에 대한 참조 및 해당 개체에 적용되는 CatalogTax 개체의 ID를 포함한 모든 자식 정보가 포함됩니다.

매개 변수

Name	키	형식	Description
개체 ID	object_ids	array of string
카탈로그 버전	catalog_version	integer	응답에 포함할 카탈로그 개체의 특정 버전입니다. 이렇게 하면 개체의 기록 버전을 검색할 수 있습니다. 지정된 버전 값이 CatalogObjects의 버전 특성과 일치합니다.
관련 개체 포함	include_related_objects	boolean	true이면 응답의 개체 필드에 CatalogItem이 포함되어 있으면 연결된 CatalogCategory 개체, CatalogTax 개체, CatalogImage 개체 및 CatalogModifierLists가 응답의 related_objects 필드에 반환됩니다. 응답의 개체 필드에 CatalogItemVariation이 포함되어 있으면 해당 부모 CatalogItem이 응답의 related_objects 필드에 반환됩니다.

반환

Name	경로	형식	Description
개체	objects	array of object
유형	objects.type	string	이 개체의 형식입니다.
아이디	objects.id	string	Square에서 발급한 고유한 식별자입니다.
업데이트 날짜	objects.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
버전	objects.version	integer	개체의 현재 버전입니다.
삭제됨	objects.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
모든 위치에 있음	objects.present_at_all_locations	boolean	true이면 이 개체는 absent_at_location_ids 필드에 지정된 위치를 제외한 모든 위치(이후 위치 포함)에 있습니다. false이면 이 개체는 present_at_location_ids 필드에 지정된 위치를 제외하고 이후 위치와 같은 위치에 없습니다. 지정하지 않으면 기본값은 true입니다.
이름	objects.item_data.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
Description	objects.item_data.title	string	항목의 설명입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
범주 ID	objects.item_data.category_id	string	항목 범주의 ID(있는 경우)입니다.
세금 ID	objects.item_data.tax_ids	array of string
Variations	objects.item_data.variations	array of object
유형	objects.item_data.variations.type	string	이 개체의 형식입니다. 각 개체 형식에는 아래의 해당 *_data 필드 내에서 구조화된 형식으로 표현되는 예상 속성이 있습니다.
아이디	objects.item_data.variations.id	string	이 개체를 참조할 식별자입니다.
업데이트 날짜	objects.item_data.variations.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
버전	objects.item_data.variations.version	integer	개체의 버전입니다. 개체를 업데이트할 때 제공된 버전은 데이터베이스의 버전과 일치해야 합니다. 그렇지 않으면 쓰기가 충돌하는 것으로 거부됩니다.
삭제됨	objects.item_data.variations.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
모든 위치에 있음	objects.item_data.variations.present_at_all_locations	boolean	present_at_all_locations false인 경우에도 개체가 있는 위치 목록입니다. 여기에는 비활성화된 위치가 포함될 수 있습니다.
항목 ID	objects.item_data.variations.item_variation_data.item_id	string	이 항목 변형이 있는 개체의 ID입니다.
이름	objects.item_data.variations.item_variation_data.name	string	이 항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
서수	objects.item_data.variations.item_variation_data.ordinal	integer	이 항목 변형을 표시해야 하는 순서입니다. 이 값은 읽기 전용입니다.
가격 책정 유형	objects.item_data.variations.item_variation_data.pricing_type	string	판매 시 항목 변형의 가격이 고정되었는지 또는 결정되는지 여부를 나타냅니다.
금액	objects.item_data.variations.item_variation_data.price_money.amount	integer	통화로 표시된 통화의 가장 작은 교단에 있는 금액입니다. 예를 들어 통화가 USD인 경우 금액은 센트 단위입니다. 금액은 양수 또는 음수일 수 있습니다. 특정 사례에서 기호의 의미를 확인하려면 특정 필드 설명을 참조하세요.
통화	objects.item_data.variations.item_variation_data.price_money.currency	string	ISO 4217 형식의 통화 형식입니다. 예를 들어 미국 달러의 통화 코드는 USD입니다.
관련 개체	related_objects	array of object
유형	related_objects.type	string	이 개체의 형식입니다.
아이디	related_objects.id	string	Square에서 발급한 고유한 식별자입니다.
업데이트 날짜	related_objects.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
버전	related_objects.version	integer	개체의 현재 버전입니다.
삭제됨	related_objects.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
모든 위치에 있음	related_objects.present_at_all_locations	boolean	true이면 이 개체는 absent_at_location_ids 필드에 지정된 위치를 제외한 모든 위치(이후 위치 포함)에 있습니다. false이면 이 개체는 present_at_location_ids 필드에 지정된 위치를 제외하고 이후 위치와 같은 위치에 없습니다. 지정하지 않으면 기본값은 true입니다.
이름	related_objects.category_data.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
이름	related_objects.tax_data.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
계산 단계	related_objects.tax_data.calculation_phase	string	납부액의 소계 또는 합계를 기준으로 세금이 계산되는지 여부입니다.
포함 유형	related_objects.tax_data.inclusion_type	string	세금이 ADDITIVE인지 아니면 INCLUSIVE인지 여부입니다.
백분율	related_objects.tax_data.percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
활성화됨	related_objects.tax_data.enabled	boolean	개체를 사용할 수 있는지 여부를 나타냅니다.

idempotency 키로 결제 취소

작업 ID:: PaymentCancelIdempotency

요청에 지정된 idempotency 키로 식별된 결제를 취소(voids)합니다. CreatePayment 요청의 상태를 알 수 없는 경우(예: CreatePayment 요청을 보낸 후 네트워크 오류가 발생하고 응답을 받지 못하는 경우) 이 메서드를 사용합니다. 이 경우 Square에 이 엔드포인트를 사용하여 결제를 취소하도록 지시할 수 있습니다. 요청에서 취소하려는 CreatePayment 요청에서 제공한 것과 동일한 idempotency 키를 제공합니다. 결제를 취소한 후 CreatePayment 요청을 다시 제출할 수 있습니다. 지정된 idempotency 키를 사용한 결제를 찾을 수 없는 경우 아무 작업도 수행되지 않으며 엔드포인트가 성공적으로 반환됩니다.

매개 변수

Name	키	필수	형식	Description
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.

반환

response: object

Upsert 카탈로그 개체

작업 ID:: CatalogUpsert

대상 CatalogObject를 만들거나 업데이트합니다.

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
아이디	id	string	Square에서 발급한 고유한 식별자입니다.
유형	type	string	이 개체의 형식입니다.
Abbreviation	abbreviation	string	Square Point of Sale 앱에 있는 항목의 표시 레이블 텍스트입니다. 문자열의 처음 5자까지만 사용됩니다. 이 특성은 검색할 수 있으며 값 길이는 유니코드 코드 포인트입니다.
Description	title	string	항목의 설명입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
이름	name	string	이름입니다.
아이디	id	string	카탈로그에서 이 개체를 참조할 식별자입니다.
유형	type	string	이 개체의 형식입니다.
항목 ID	item_id	string	이 항목 변형과 연결된 CatalogItem의 ID입니다.
이름	name	string	항목 변형의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
가격 책정 유형	pricing_type	string	판매 시 항목 변형의 가격이 고정되었는지 또는 결정되는지 여부를 나타냅니다.
금액	amount	integer	금액입니다.
통화	currency	string	통화입니다.

반환

Name	경로	형식	Description
유형	catalog_object.type	string	이 개체의 형식입니다.
아이디	catalog_object.id	string	Square에서 발급한 고유한 식별자입니다.
업데이트 날짜	catalog_object.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
버전	catalog_object.version	integer	이 개체의 현재 버전입니다.
삭제됨	catalog_object.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
present_at_all_locations	catalog_object.present_at_all_locations	boolean	true이면 이 개체는 absent_at_location_ids 필드에 지정된 위치를 제외한 모든 위치(이후 위치 포함)에 있습니다. false이면 이 개체는 present_at_location_ids 필드에 지정된 위치를 제외하고 이후 위치와 같은 위치에 없습니다. 지정하지 않으면 기본값은 true입니다.
이름	catalog_object.item_data.name	string	이름입니다.
Description	catalog_object.item_data.title	string	항목의 설명입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
Abbreviation	catalog_object.item_data.abbreviation	string	Square Point of Sale 앱에 있는 항목의 표시 레이블 텍스트입니다. 문자열의 처음 5자까지만 사용됩니다. 이 특성은 검색할 수 있으며 값 길이는 유니코드 코드 포인트입니다.
Variations	catalog_object.item_data.variations	array of object
유형	catalog_object.item_data.variations.type	string	이 개체의 형식입니다.
아이디	catalog_object.item_data.variations.id	string	카탈로그에서 이 개체를 참조할 식별자입니다.
업데이트 날짜	catalog_object.item_data.variations.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프입니다.
버전	catalog_object.item_data.variations.version	integer	개체의 버전입니다. 개체를 업데이트할 때 제공된 버전은 데이터베이스의 버전과 일치해야 합니다. 그렇지 않으면 쓰기가 충돌하는 것으로 거부됩니다.
삭제됨	catalog_object.item_data.variations.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
모든 위치에 있음	catalog_object.item_data.variations.present_at_all_locations	boolean	true이면 이 개체는 absent_at_location_ids 필드에 지정된 위치를 제외한 모든 위치(이후 위치 포함)에 있습니다. false이면 이 개체는 present_at_location_ids 필드에 지정된 위치를 제외하고 이후 위치와 같은 위치에 없습니다. 지정하지 않으면 기본값은 true입니다.
항목 ID	catalog_object.item_data.variations.item_variation_data.item_id	string	이 항목 변형과 연결된 CatalogItem의 ID입니다.
이름	catalog_object.item_data.variations.item_variation_data.name	string	항목 변형의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
서수	catalog_object.item_data.variations.item_variation_data.ordinal	integer	이 항목 변형을 표시해야 하는 순서입니다. 이 값은 읽기 전용입니다. 쓰기 시 부모 CatalogItem 내의 각 항목 변형에 대한 서수는 항목 변형의 위치에 따라 설정됩니다. 읽기 시 값이 순차적이거나 고유하지는 않습니다.
가격 책정 유형	catalog_object.item_data.variations.item_variation_data.pricing_type	string	판매 시 항목 변형의 가격이 고정되었는지 또는 결정되는지 여부를 나타냅니다.
스톡 가능	catalog_object.item_data.variations.item_variation_data.stockable	boolean	주식이 이 변형(TRUE)에 직접 계산되는지 또는 해당 구성 요소(FALSE)에서만 계산되는지 여부입니다. 이전 버전과의 호환성을 위해 누락된 값은 TRUE로 해석됩니다.
금액	catalog_object.item_data.variations.item_variation_data.price_money.amount	integer	금액입니다.
통화	catalog_object.item_data.variations.item_variation_data.price_money.currency	string	통화입니다.
제품 유형	catalog_object.item_data.product_type	string	항목의 제품 유형입니다. 항목을 만든 후에는 변경할 수 없습니다.
ID 매핑	id_mappings	array of object
클라이언트 개체 ID	id_mappings.client_object_id	string	새 CatalogObject에 대한 클라이언트에서 제공하는 임시 #접두사 ID입니다.
오브젝트 ID	id_mappings.object_id	string	서버에서 만든 영구 ID입니다.

검색 주문

작업 ID:: OrderSearch

하나 이상의 위치에 대한 모든 주문을 검색합니다. 주문에는 Square 에코시스템(예: Point of Sale, Invoices 및 Connect API)에 진입한 방법 또는 시기에 관계없이 모든 판매, 반품 및 교환이 포함됩니다.

매개 변수

Name	키	형식	Description
반환 항목	return_entries	boolean	검색 결과의 형식을 제어하는 부울입니다. true이면 SearchOrders는 OrderEntry 개체를 반환합니다. false이면 SearchOrders는 전체 순서 개체를 반환합니다.
한계	limit	integer	단일 페이지에서 반환할 결과 수에 대한 제한입니다. 제한은 권고입니다. 구현은 더 많거나 적은 결과를 반환할 수 있습니다. 제공된 제한이 음수, 0 또는 최대 제한인 1,000보다 높은 경우 무시됩니다.
위치 ID	location_ids	array of string
시작 날짜	start_at	string	시간 범위가 시작되는 시기를 나타내는 RFC 3339 형식의 날짜/시간 값입니다.
종료 기준	end_at	string	시간 범위가 종료되는 시기를 나타내는 RFC 3339 형식의 날짜/시간 값입니다.
States	states	array of string
정렬 필드	sort_field	string	정렬 기준 필드입니다.
정렬 순서	sort_order	string	결과가 반환되는 시간 순서입니다.

반환

Name	경로	형식	Description
주문 항목	order_entries	array of object
주문 ID	order_entries.order_id	string	주문의 ID입니다.
위치 ID	order_entries.location_id	string	위치의 식별자입니다.
버전	order_entries.version	integer	개체의 현재 버전입니다.
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

결제 나열

작업 ID:: PaymentList

요청을 만드는 계정에서 수행한 지불 목록을 검색합니다. 결과는 결국 일관되며, 새로운 지불 또는 지불 변경 내용이 나타나려면 몇 초 정도 걸릴 수 있습니다.

매개 변수

Name	키	형식	Description
시작 시간	begin_time	string	opened_at 쿼리의 포괄 시작 시간(ISO 8601 형식)입니다.
종료 시간	end_time	string	opened_at 쿼리의 전용 종료 날짜(ISO 8601 형식)입니다.
정렬 순서	sort_order	string	지정된 순서로 카드를 만든 시점을 기준으로 반환된 목록을 정렬합니다.
Cursor	cursor	string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
위치 ID	location_id	string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.
총계	total	integer	지불에 대한 total_money 정확한 금액입니다.
마지막 4	last_4	string	결제 카드의 마지막 4자리 숫자입니다.
카드 브랜드	card_brand	string	결제 카드의 브랜드(예: VISA)입니다.
한계	limit	integer	응답에서 반환할 수의 상한입니다.

반환

Name	경로	형식	Description
결제	payments	array of object
아이디	payments.id	string	Square에서 발급한 고유한 식별자입니다.
만든 위치에서	payments.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	payments.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
금액	payments.amount_money.amount	integer	금액입니다.
통화	payments.amount_money.currency	string	통화입니다.
상태	payments.status	string	이 개체의 현재 확인 상태입니다.
지연 기간	payments.delay_duration	string	Square가 결제에 delay_action 자동으로 적용할 때 결제가 생성된 후의 기간입니다.
원본 유형	payments.source_type	string	이 결제의 원본 유형입니다.
상태	payments.card_details.status	string	카드 결제의 현재 상태입니다. 상태는 권한 부여, 캡처됨, VOIDED 또는 FAILED일 수 있습니다.
카드 브랜드	payments.card_details.card.card_brand	string	카드의 브랜드입니다.
last_4	payments.card_details.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
Exp 월	payments.card_details.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	payments.card_details.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
지문	payments.card_details.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
카드 종류	payments.card_details.card.card_type	string	카드의 유형입니다.
선불 유형	payments.card_details.card.prepaid_type	string	카드가 선불인지 여부를 나타냅니다.
빈	payments.card_details.card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자
Entry 메서드	payments.card_details.entry_method	string	결제에 대한 카드의 세부 정보를 입력하는 데 사용되는 방법입니다. 메서드는 KEYED, SWIPED, EMV, ON_FILE 또는 CONTACTLESS일 수 있습니다.
Cvv 상태	payments.card_details.cvv_status	string	CVV(카드 확인 값) 확인에서 반환된 상태 코드입니다. 코드는 CVV_ACCEPTED, CVV_REJECTED 또는 CVV_NOT_CHECKED 수 있습니다.
Avs 상태	payments.card_details.avs_status	string	AVS(주소 확인 시스템) 확인에서 반환된 상태 코드입니다. 코드는 AVS_ACCEPTED, AVS_REJECTED 또는 AVS_NOT_CHECKED 수 있습니다.
인증 결과 코드	payments.card_details.auth_result_code	string	결제의 권한 부여 상태를 설명하는 카드 발급자에서 반환하는 상태 코드입니다.
문 설명	payments.card_details.statement_description	string	카드 네트워크에 전송된 문 설명입니다.
권한 있는 경우	payments.card_details.card_payment_timeline.authorized_at	string	지불 권한이 부여된 타임스탬프(RFC 3339 형식)입니다.
캡처한 위치에서	payments.card_details.card_payment_timeline.captured_at	string	지불이 캡처된 타임스탬프(RFC 3339 형식)입니다.
위치 ID	payments.location_id	string	위치의 식별자입니다.
주문 ID	payments.order_id	string	주문의 ID입니다.
처리 요금	payments.processing_fee	array of object
유효 날짜	payments.processing_fee.effective_at	string	수수료가 적용되는 시기의 타임스탬프(RFC 3339 형식)입니다.
유형	payments.processing_fee.type	string	이 개체의 형식입니다.
금액	payments.processing_fee.amount_money.amount	integer	금액입니다.
통화	payments.processing_fee.amount_money.currency	string	통화입니다.
비고	payments.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
금액	payments.total_money.amount	integer	금액입니다.
통화	payments.total_money.currency	string	통화입니다.
금액	payments.approved_money.amount	integer	금액입니다.
통화	payments.approved_money.currency	string	통화입니다.
영수증 번호	payments.receipt_number	string	결제의 영수증 번호입니다. 지불이 취소된 경우 필드가 없습니다.
영수증 URL	payments.receipt_url	string	결제 영수증의 URL입니다. 완료된 결제에 대해서만 필드가 채워집니다.
지연 조치	payments.delay_action	string	delay_duration 경과된 경우 결제에 적용할 작업입니다.
지연 시간	payments.delayed_until	string	RFC 3339 형식으로 delay_action 자동으로 적용되는 경우의 읽기 전용 타임스탬프입니다.
팀 구성원 ID	payments.team_member_id	string	개체와 연결된 팀 구성원에 대한 TeamMember 개체의 ID입니다.
정사각형 제품	payments.application_details.square_product	string	POS(Square Point of Sale), Square Invoices 또는 Square Virtual Terminal과 같은 Square 제품입니다.
애플리케이션 ID	payments.application_details.application_id	string	결제에 사용되는 애플리케이션에 할당된 Square ID입니다. 애플리케이션 개발자는 이 정보를 사용하여 애플리케이션이 처리한 지불을 식별할 수 있습니다. 예를 들어 개발자가 사용자 지정 애플리케이션을 사용하여 결제를 처리하는 경우 이 필드에는 개발자 대시보드의 애플리케이션 ID가 포함됩니다. 판매자가 Square App Marketplace 애플리케이션을 사용하여 결제를 처리하는 경우 필드에 해당 애플리케이션 ID가 포함됩니다.
버전 토큰	payments.version_token	string	낙관적 동시성에 사용됩니다. 이 불투명 토큰은 특정 버전의 Payment 개체를 식별합니다.

결제 만들기

작업 ID:: PaymentCreate

제공된 원본을 사용하여 결제를 만듭니다. 이 엔드포인트를 사용하여 카드(신용/직불 카드 또는 스퀘어 기프트 카드)를 청구하거나 판매자가 Square 외부에서 받은 결제(구매자로부터의 현금 결제 또는 외부 법인이 판매자를 대신하여 처리한 결제)를 기록할 수 있습니다.

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
금액	amount	integer	tip_money 포함하지 않고 이 지불에 대해 수락할 금액입니다.
통화	currency	string	3자 ISO 4217 통화 코드입니다.
원본 ID	source_id	string	이 결제에 대한 자금 출처의 ID입니다. Square 결제 양식에서 생성된 결제 토큰(카드 nonce) 또는 고객 API를 사용하여 만든 파일의 카드일 수 있습니다. 판매자가 Square 외부에서 받은 결제를 기록하는 경우 CASH 또는 EXTERNAL를 지정합니다.
자동 완성	autocomplete	boolean	true로 설정하면 가능한 경우 이 결제가 완료됩니다. false로 설정하면 이 지불은 명시적으로 완료(캡처됨) 또는 취소(무효화)될 때까지 승인된 상태로 유지됩니다.
고객 ID	customer_id	string	연결할 고객의 ID입니다.
위치 ID	location_id	string	위치 식별자입니다.
참조 ID	reference_id	string	고객 프로필을 다른 시스템의 엔터티와 연결하는 데 사용되는 선택적 두 번째 ID입니다.
비고	note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
금액	amount	integer	tip_money 포함하지 않고 이 지불에 대해 수락할 금액입니다.
통화	currency	string	3자 ISO 4217 통화 코드입니다.

반환

Name	경로	형식	Description
아이디	payment.id	string	Square에서 발급한 고유한 식별자입니다.
만든 위치에서	payment.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	payment.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
금액	payment.amount_money.amount	integer	금액입니다.
통화	payment.amount_money.currency	string	통화입니다.
금액	payment.app_fee_money.amount	integer	금액입니다.
통화	payment.app_fee_money.currency	string	통화입니다.
상태	payment.status	string	이 개체의 현재 확인 상태입니다.
지연 기간	payment.delay_duration	string	Square가 결제에 delay_action 자동으로 적용할 때 결제가 생성된 후의 기간입니다. 이 자동 delay_action delay_duration 기간 전에 터미널 상태(COMPLETED, CANCELED 또는 FAILED)에 도달하지 않는 결제에만 적용됩니다. 이 필드는 RFC 3339 형식으로 시간 기간으로 지정됩니다.
원본 유형	payment.source_type	string	이 결제의 원본 유형입니다. 현재 값에는 CARD, BANK_ACCOUNT, WALLET, CASH 또는 EXTERNAL가 포함됩니다.
상태	payment.card_details.status	string	현재 상태입니다.
카드 브랜드	payment.card_details.card.card_brand	string	카드의 브랜드입니다.
마지막 4	payment.card_details.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
Exp 월	payment.card_details.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	payment.card_details.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
지문	payment.card_details.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
카드 종류	payment.card_details.card.card_type	string	카드의 유형입니다.
선불 유형	payment.card_details.card.prepaid_type	string	카드가 선불인지 여부를 나타냅니다.
빈	payment.card_details.card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
Entry 메서드	payment.card_details.entry_method	string	결제에 대한 카드의 세부 정보를 입력하는 데 사용되는 방법입니다. 메서드는 KEYED, SWIPED, EMV, ON_FILE 또는 CONTACTLESS일 수 있습니다.
CVV 상태	payment.card_details.cvv_status	string	CVV(카드 확인 값) 확인에서 반환된 상태 코드입니다. 코드는 CVV_ACCEPTED, CVV_REJECTED 또는 CVV_NOT_CHECKED 수 있습니다.
AVS 상태	payment.card_details.avs_status	string	AVS(주소 확인 시스템) 확인에서 반환된 상태 코드입니다. 코드는 AVS_ACCEPTED, AVS_REJECTED 또는 AVS_NOT_CHECKED 수 있습니다.
인증 결과 코드	payment.card_details.auth_result_code	string	결제의 권한 부여 상태를 설명하는 카드 발급자에서 반환하는 상태 코드입니다.
문 설명	payment.card_details.statement_description	string	카드 네트워크에 전송된 문 설명입니다.
권한 있는 경우	payment.card_details.card_payment_timeline.authorized_at	string	지불 권한이 부여된 타임스탬프(RFC 3339 형식)입니다.
캡처한 위치에서	payment.card_details.card_payment_timeline.captured_at	string	지불이 캡처된 타임스탬프(RFC 3339 형식)입니다.
위치 ID	payment.location_id	string	위치의 식별자입니다.
주문 ID	payment.order_id	string	주문의 ID입니다.
참조 ID	payment.reference_id	string	선택적 사용자 정의 참조 ID입니다.
만든 위치에서	payment.risk_evaluation.created_at	string	만들어진 타임스탬프(RFC 3339 형식)입니다.
위험 수준	payment.risk_evaluation.risk_level	string	결제와 관련된 위험 수준입니다.
비고	payment.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
고객 ID	payment.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
금액	payment.total_money.amount	integer	금액입니다.
통화	payment.total_money.currency	string	통화입니다.
금액	payment.approved_money.amount	integer	금액입니다.
통화	payment.approved_money.currency	string	통화입니다.
영수증 번호	payment.receipt_number	string	결제의 영수증 번호입니다. 지불이 취소된 경우 필드가 없습니다.
영수증 URL	payment.receipt_url	string	결제 영수증의 URL입니다. 완료된 결제에 대해서만 필드가 채워집니다.
지연 조치	payment.delay_action	string	delay_duration 경과된 경우 결제에 적용할 작업입니다.
지연 시간	payment.delayed_until	string	RFC 3339 형식으로 delay_action 자동으로 적용되는 경우의 읽기 전용 타임스탬프입니다.
정사각형 제품	payment.application_details.square_product	string	POS(Square Point of Sale), Square Invoices 또는 Square Virtual Terminal과 같은 Square 제품입니다.
애플리케이션 ID	payment.application_details.application_id	string	애플리케이션에 할당된 읽기 전용 정사각형 ID입니다.
버전 토큰	payment.version_token	string	이 불투명 토큰은 특정 버전의 개체를 식별합니다.

결제 받기

작업 ID:: PaymentGet

특정 결제에 대한 세부 정보를 검색합니다.

매개 변수

Name	키	필수	형식	Description
결제 아이디	payment_id	True	string	결제의 식별자입니다.

반환

Name	경로	형식	Description
아이디	payment.id	string	Square에서 발급한 고유한 식별자입니다.
만든 위치에서	payment.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	payment.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
금액	payment.amount_money.amount	integer	금액입니다.
통화	payment.amount_money.currency	string	통화입니다.
상태	payment.status	string	이 개체의 현재 확인 상태입니다.
지연 기간	payment.delay_duration	string	Square가 결제에 delay_action 자동으로 적용할 때 결제가 생성된 후의 기간입니다. 이 자동 delay_action delay_duration 기간 전에 터미널 상태(COMPLETED, CANCELED 또는 FAILED)에 도달하지 않는 결제에만 적용됩니다. 이 필드는 RFC 3339 형식으로 시간 기간으로 지정됩니다.
원본 유형	payment.source_type	string	이 결제의 원본 유형입니다. 현재 값에는 CARD, BANK_ACCOUNT, WALLET, CASH 또는 EXTERNAL가 포함됩니다.
상태	payment.card_details.status	string	현재 상태입니다.
카드 브랜드	payment.card_details.card.card_brand	string	카드의 브랜드입니다.
마지막 4	payment.card_details.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
Exp 월	payment.card_details.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	payment.card_details.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
지문	payment.card_details.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
카드 종류	payment.card_details.card.card_type	string	카드의 유형입니다.
선불 유형	payment.card_details.card.prepaid_type	string	카드가 선불인지 여부를 나타냅니다.
빈	payment.card_details.card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
Entry 메서드	payment.card_details.entry_method	string	결제에 대한 카드의 세부 정보를 입력하는 데 사용되는 방법입니다. 메서드는 KEYED, SWIPED, EMV, ON_FILE 또는 CONTACTLESS일 수 있습니다.
CVV 상태	payment.card_details.cvv_status	string	CVV(카드 확인 값) 확인에서 반환된 상태 코드입니다. 코드는 CVV_ACCEPTED, CVV_REJECTED 또는 CVV_NOT_CHECKED 수 있습니다.
AVS 상태	payment.card_details.avs_status	string	AVS(주소 확인 시스템) 확인에서 반환된 상태 코드입니다. 코드는 AVS_ACCEPTED, AVS_REJECTED 또는 AVS_NOT_CHECKED 수 있습니다.
인증 결과 코드	payment.card_details.auth_result_code	string	결제의 권한 부여 상태를 설명하는 카드 발급자에서 반환하는 상태 코드입니다.
문 설명	payment.card_details.statement_description	string	카드 네트워크에 전송된 문 설명입니다.
권한 있는 경우	payment.card_details.card_payment_timeline.authorized_at	string	지불 권한이 부여된 타임스탬프(RFC 3339 형식)입니다.
캡처한 위치에서	payment.card_details.card_payment_timeline.captured_at	string	지불이 캡처된 타임스탬프(RFC 3339 형식)입니다.
위치 ID	payment.location_id	string	위치의 식별자입니다.
주문 ID	payment.order_id	string	주문의 ID입니다.
처리 요금	payment.processing_fee	array of object
유효 날짜	payment.processing_fee.effective_at	string	수수료가 적용되는 시기의 타임스탬프(RFC 3339 형식)입니다.
유형	payment.processing_fee.type	string	형식을 나타냅니다.
금액	payment.processing_fee.amount_money.amount	integer	금액입니다.
통화	payment.processing_fee.amount_money.currency	string	통화입니다.
비고	payment.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
금액	payment.total_money.amount	integer	금액입니다.
통화	payment.total_money.currency	string	통화입니다.
금액	payment.approved_money.amount	integer	금액입니다.
통화	payment.approved_money.currency	string	통화입니다.
직원 ID	payment.employee_id	string	Employee의 Square 생성 ID입니다.
영수증 번호	payment.receipt_number	string	결제의 영수증 번호입니다. 지불이 취소된 경우 필드가 없습니다.
영수증 URL	payment.receipt_url	string	결제 영수증의 URL입니다. 완료된 결제에 대해서만 필드가 채워집니다.
지연 조치	payment.delay_action	string	delay_duration 경과된 경우 결제에 적용할 작업입니다.
지연 시간	payment.delayed_until	string	RFC 3339 형식으로 delay_action 자동으로 적용되는 경우의 읽기 전용 타임스탬프입니다.
팀 구성원 ID	payment.team_member_id	string	팀 구성원의 ID입니다.
정사각형 제품	payment.application_details.square_product	string	POS(Square Point of Sale), Square Invoices 또는 Square Virtual Terminal과 같은 Square 제품입니다.
애플리케이션 ID	payment.application_details.application_id	string	애플리케이션에 할당된 읽기 전용 정사각형 ID입니다.
버전 토큰	payment.version_token	string	이 불투명 토큰은 특정 버전의 개체를 식별합니다.

결제 업데이트

작업 ID:: PaymentUpdate

결제를 승인됨 상태로 업데이트합니다. 이 엔드포인트를 사용하여 amount_money 업데이트하고 tip_money 수 있습니다.

매개 변수

Name	키	필수	형식	Description
결제 아이디	payment_id	True	string	결제의 식별자입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
금액	amount		integer	금액입니다.
통화	currency		string	통화입니다.
금액	amount		integer	금액입니다.
통화	currency		string	통화입니다.
버전 토큰	version_token		string	이 불투명 토큰은 특정 버전의 개체를 식별합니다.

반환

Name	경로	형식	Description
아이디	payment.id	string	Square에서 발급한 고유한 식별자입니다.
만든 위치에서	payment.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	payment.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
금액	payment.amount_money.amount	integer	금액입니다.
통화	payment.amount_money.currency	string	통화입니다.
금액	payment.tip_money.amount	integer	금액입니다.
통화	payment.tip_money.currency	string	통화입니다.
상태	payment.status	string	이 개체의 현재 확인 상태입니다.
지연 기간	payment.delay_duration	string	Square가 결제에 delay_action 자동으로 적용할 때 결제가 생성된 후의 기간입니다. 이 자동 delay_action delay_duration 기간 전에 터미널 상태(COMPLETED, CANCELED 또는 FAILED)에 도달하지 않는 결제에만 적용됩니다. 이 필드는 RFC 3339 형식으로 시간 기간으로 지정됩니다.
원본 유형	payment.source_type	string	이 결제의 원본 유형입니다. 현재 값에는 CARD, BANK_ACCOUNT, WALLET, CASH 또는 EXTERNAL가 포함됩니다.
상태	payment.card_details.status	string	현재 상태입니다.
카드 브랜드	payment.card_details.card.card_brand	string	카드의 브랜드입니다.
마지막 4	payment.card_details.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
Exp 월	payment.card_details.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	payment.card_details.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
지문	payment.card_details.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
카드 종류	payment.card_details.card.card_type	string	카드의 유형입니다.
선불 유형	payment.card_details.card.prepaid_type	string	카드가 선불인지 여부를 나타냅니다.
빈	payment.card_details.card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
Entry 메서드	payment.card_details.entry_method	string	결제에 대한 카드의 세부 정보를 입력하는 데 사용되는 방법입니다. 메서드는 KEYED, SWIPED, EMV, ON_FILE 또는 CONTACTLESS일 수 있습니다.
CVV 상태	payment.card_details.cvv_status	string	CVV(카드 확인 값) 확인에서 반환된 상태 코드입니다. 코드는 CVV_ACCEPTED, CVV_REJECTED 또는 CVV_NOT_CHECKED 수 있습니다.
AVS 상태	payment.card_details.avs_status	string	AVS(주소 확인 시스템) 확인에서 반환된 상태 코드입니다. 코드는 AVS_ACCEPTED, AVS_REJECTED 또는 AVS_NOT_CHECKED 수 있습니다.
인증 결과 코드	payment.card_details.auth_result_code	string	결제의 권한 부여 상태를 설명하는 카드 발급자에서 반환하는 상태 코드입니다.
문 설명	payment.card_details.statement_description	string	카드 네트워크에 전송된 문 설명입니다.
권한 있는 경우	payment.card_details.card_payment_timeline.authorized_at	string	지불 권한이 부여된 타임스탬프(RFC 3339 형식)입니다.
위치 ID	payment.location_id	string	위치의 식별자입니다.
주문 ID	payment.order_id	string	주문의 ID입니다.
만든 위치에서	payment.risk_evaluation.created_at	string	만들어진 타임스탬프(RFC 3339 형식)입니다.
위험 수준	payment.risk_evaluation.risk_level	string	결제와 관련된 위험 수준입니다.
비고	payment.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
고객 ID	payment.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
금액	payment.total_money.amount	integer	금액입니다.
통화	payment.total_money.currency	string	통화입니다.
금액	payment.approved_money.amount	integer	금액입니다.
통화	payment.approved_money.currency	string	통화입니다.
역량	payment.capabilities	array of string
영수증 번호	payment.receipt_number	string	결제의 영수증 번호입니다. 지불이 취소된 경우 필드가 없습니다.
지연 조치	payment.delay_action	string	delay_duration 경과된 경우 결제에 적용할 작업입니다.
지연 시간	payment.delayed_until	string	RFC 3339 형식으로 delay_action 자동으로 적용되는 경우의 읽기 전용 타임스탬프입니다.
정사각형 제품	payment.application_details.square_product	string	POS(Square Point of Sale), Square Invoices 또는 Square Virtual Terminal과 같은 Square 제품입니다.
애플리케이션 ID	payment.application_details.application_id	string	애플리케이션에 할당된 읽기 전용 정사각형 ID입니다.
버전 토큰	payment.version_token	string	이 불투명 토큰은 특정 버전의 개체를 식별합니다.

결제 완료

작업 ID:: PaymentComplete

결제를 완료(캡처)합니다. 기본적으로 결제는 생성 직후에 완료되도록 설정됩니다.

매개 변수

Name	키	필수	형식	Description
결제 아이디	payment_id	True	string	결제의 식별자입니다.

반환

Name	경로	형식	Description
아이디	payment.id	string	Square에서 발급한 고유한 식별자입니다.
만든 위치에서	payment.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	payment.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
금액	payment.amount_money.amount	integer	금액입니다.
통화	payment.amount_money.currency	string	통화입니다.
상태	payment.status	string	이 개체의 현재 확인 상태입니다.
지연 기간	payment.delay_duration	string	Square가 결제에 delay_action 자동으로 적용할 때 결제가 생성된 후의 기간입니다. 이 자동 delay_action delay_duration 기간 전에 터미널 상태(COMPLETED, CANCELED 또는 FAILED)에 도달하지 않는 결제에만 적용됩니다. 이 필드는 RFC 3339 형식으로 시간 기간으로 지정됩니다.
원본 유형	payment.source_type	string	이 결제의 원본 유형입니다. 현재 값에는 CARD, BANK_ACCOUNT, WALLET, CASH 또는 EXTERNAL가 포함됩니다.
상태	payment.card_details.status	string	현재 상태입니다.
카드 브랜드	payment.card_details.card.card_brand	string	카드의 브랜드입니다.
마지막 4	payment.card_details.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
Exp 월	payment.card_details.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	payment.card_details.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
지문	payment.card_details.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
카드 종류	payment.card_details.card.card_type	string	카드의 유형입니다.
선불 유형	payment.card_details.card.prepaid_type	string	카드가 선불인지 여부를 나타냅니다.
빈	payment.card_details.card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
Entry 메서드	payment.card_details.entry_method	string	결제에 대한 카드의 세부 정보를 입력하는 데 사용되는 방법입니다. 메서드는 KEYED, SWIPED, EMV, ON_FILE 또는 CONTACTLESS일 수 있습니다.
CVV 상태	payment.card_details.cvv_status	string	CVV(카드 확인 값) 확인에서 반환된 상태 코드입니다. 코드는 CVV_ACCEPTED, CVV_REJECTED 또는 CVV_NOT_CHECKED 수 있습니다.
AVS 상태	payment.card_details.avs_status	string	AVS(주소 확인 시스템) 확인에서 반환된 상태 코드입니다. 코드는 AVS_ACCEPTED, AVS_REJECTED 또는 AVS_NOT_CHECKED 수 있습니다.
인증 결과 코드	payment.card_details.auth_result_code	string	결제의 권한 부여 상태를 설명하는 카드 발급자에서 반환하는 상태 코드입니다.
문 설명	payment.card_details.statement_description	string	카드 네트워크에 전송된 문 설명입니다.
권한 있는 경우	payment.card_details.card_payment_timeline.authorized_at	string	지불 권한이 부여된 타임스탬프(RFC 3339 형식)입니다.
캡처한 위치에서	payment.card_details.card_payment_timeline.captured_at	string	지불이 캡처된 타임스탬프(RFC 3339 형식)입니다.
위치 ID	payment.location_id	string	위치의 식별자입니다.
주문 ID	payment.order_id	string	주문의 ID입니다.
처리 요금	payment.processing_fee	array of object
유효 날짜	payment.processing_fee.effective_at	string	수수료가 적용되는 시기의 타임스탬프(RFC 3339 형식)입니다.
유형	payment.processing_fee.type	string	형식을 나타냅니다.
금액	payment.processing_fee.amount_money.amount	integer	금액입니다.
통화	payment.processing_fee.amount_money.currency	string	통화입니다.
비고	payment.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
금액	payment.total_money.amount	integer	금액입니다.
통화	payment.total_money.currency	string	통화입니다.
금액	payment.approved_money.amount	integer	금액입니다.
통화	payment.approved_money.currency	string	통화입니다.
직원 ID	payment.employee_id	string	Employee의 Square 생성 ID입니다.
영수증 번호	payment.receipt_number	string	결제의 영수증 번호입니다. 지불이 취소된 경우 필드가 없습니다.
영수증 URL	payment.receipt_url	string	결제 영수증의 URL입니다. 완료된 결제에 대해서만 필드가 채워집니다.
지연 조치	payment.delay_action	string	delay_duration 경과된 경우 결제에 적용할 작업입니다.
지연 시간	payment.delayed_until	string	RFC 3339 형식으로 delay_action 자동으로 적용되는 경우의 읽기 전용 타임스탬프입니다.
팀 구성원 ID	payment.team_member_id	string	팀 구성원의 ID입니다.
정사각형 제품	payment.application_details.square_product	string	POS(Square Point of Sale), Square Invoices 또는 Square Virtual Terminal과 같은 Square 제품입니다.
애플리케이션 ID	payment.application_details.application_id	string	애플리케이션에 할당된 읽기 전용 정사각형 ID입니다.
버전 토큰	payment.version_token	string	이 불투명 토큰은 특정 버전의 개체를 식별합니다.

결제 취소

작업 ID:: PaymentCancel

결제를 취소(무효)합니다. 이 엔드포인트를 사용하여 APPROVED 상태의 결제를 취소할 수 있습니다.

매개 변수

Name	키	필수	형식	Description
결제 아이디	payment_id	True	string	결제의 식별자입니다.

반환

Name	경로	형식	Description
아이디	payment.id	string	Square에서 발급한 고유한 식별자입니다.
만든 위치에서	payment.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	payment.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
금액	payment.amount_money.amount	integer	금액입니다.
통화	payment.amount_money.currency	string	통화입니다.
금액	payment.tip_money.amount	integer	금액입니다.
통화	payment.tip_money.currency	string	통화입니다.
상태	payment.status	string	이 개체의 현재 확인 상태입니다.
지연 기간	payment.delay_duration	string	Square가 결제에 delay_action 자동으로 적용할 때 결제가 생성된 후의 기간입니다. 이 자동 delay_action delay_duration 기간 전에 터미널 상태(COMPLETED, CANCELED 또는 FAILED)에 도달하지 않는 결제에만 적용됩니다. 이 필드는 RFC 3339 형식으로 시간 기간으로 지정됩니다.
원본 유형	payment.source_type	string	이 결제의 원본 유형입니다. 현재 값에는 CARD, BANK_ACCOUNT, WALLET, CASH 또는 EXTERNAL가 포함됩니다.
상태	payment.card_details.status	string	현재 상태입니다.
카드 브랜드	payment.card_details.card.card_brand	string	카드의 브랜드입니다.
마지막 4	payment.card_details.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
Exp 월	payment.card_details.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	payment.card_details.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
지문	payment.card_details.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
카드 종류	payment.card_details.card.card_type	string	카드의 유형입니다.
선불 유형	payment.card_details.card.prepaid_type	string	카드가 선불인지 여부를 나타냅니다.
빈	payment.card_details.card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
Entry 메서드	payment.card_details.entry_method	string	결제에 대한 카드의 세부 정보를 입력하는 데 사용되는 방법입니다. 메서드는 KEYED, SWIPED, EMV, ON_FILE 또는 CONTACTLESS일 수 있습니다.
CVV 상태	payment.card_details.cvv_status	string	CVV(카드 확인 값) 확인에서 반환된 상태 코드입니다. 코드는 CVV_ACCEPTED, CVV_REJECTED 또는 CVV_NOT_CHECKED 수 있습니다.
AVS 상태	payment.card_details.avs_status	string	AVS(주소 확인 시스템) 확인에서 반환된 상태 코드입니다. 코드는 AVS_ACCEPTED, AVS_REJECTED 또는 AVS_NOT_CHECKED 수 있습니다.
인증 결과 코드	payment.card_details.auth_result_code	string	결제의 권한 부여 상태를 설명하는 카드 발급자에서 반환하는 상태 코드입니다.
문 설명	payment.card_details.statement_description	string	카드 네트워크에 전송된 문 설명입니다.
권한 있는 경우	payment.card_details.card_payment_timeline.authorized_at	string	지불 권한이 부여된 타임스탬프(RFC 3339 형식)입니다.
Voided At	payment.card_details.card_payment_timeline.voided_at	string	지불이 무효화된 타임스탬프(RFC 3339 형식)입니다.
위치 ID	payment.location_id	string	위치의 식별자입니다.
주문 ID	payment.order_id	string	주문의 ID입니다.
만든 위치에서	payment.risk_evaluation.created_at	string	만들어진 타임스탬프(RFC 3339 형식)입니다.
위험 수준	payment.risk_evaluation.risk_level	string	결제와 관련된 위험 수준입니다.
비고	payment.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
고객 ID	payment.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
금액	payment.total_money.amount	integer	금액입니다.
통화	payment.total_money.currency	string	통화입니다.
금액	payment.approved_money.amount	integer	금액입니다.
통화	payment.approved_money.currency	string	통화입니다.
지연 조치	payment.delay_action	string	delay_duration 경과된 경우 결제에 적용할 작업입니다.
지연 시간	payment.delayed_until	string	RFC 3339 형식으로 delay_action 자동으로 적용되는 경우의 읽기 전용 타임스탬프입니다.
정사각형 제품	payment.application_details.square_product	string	POS(Square Point of Sale), Square Invoices 또는 Square Virtual Terminal과 같은 Square 제품입니다.
애플리케이션 ID	payment.application_details.application_id	string	애플리케이션에 할당된 읽기 전용 정사각형 ID입니다.
버전 토큰	payment.version_token	string	이 불투명 토큰은 특정 버전의 개체를 식별합니다.

결제 환불 받기

작업 ID:: RefundGet

refund_id 사용하여 특정 환불을 검색합니다.

매개 변수

Name	키	필수	형식	Description
환불 ID	refund_id	True	string	환불의 식별자입니다.

반환

Name	경로	형식	Description
아이디	refund.id	string	Square에서 발급한 고유한 식별자입니다.
상태	refund.status	string	이 개체의 현재 확인 상태입니다.
금액	refund.amount_money.amount	integer	금액입니다.
통화	refund.amount_money.currency	string	통화입니다.
결제 아이디	refund.payment_id	string	결제의 고유 ID입니다.
주문 ID	refund.order_id	string	주문의 ID입니다.
만든 위치에서	refund.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	refund.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
처리 요금	refund.processing_fee	array of object
유효 날짜	refund.processing_fee.effective_at	string	수수료가 적용되는 시기의 타임스탬프(RFC 3339 형식)입니다.
유형	refund.processing_fee.type	string	형식을 나타냅니다.
금액	refund.processing_fee.amount_money.amount	integer	금액입니다.
통화	refund.processing_fee.amount_money.currency	string	통화입니다.
위치 ID	refund.location_id	string	위치의 식별자입니다.
이유	refund.reason	string	이 개체의 이유입니다.

고객 검색

작업 ID:: CustomerRetrieve

단일 고객에 대한 세부 정보를 반환합니다.

매개 변수

Name	키	필수	형식	Description
고객 ID	customer_id	True	string	고객의 식별자입니다.

반환

Name	경로	형식	Description
아이디	customer.id	string	Square에서 발급한 고유한 식별자입니다.
만든 위치에서	customer.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	customer.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
이름 (주어진 이름)	customer.given_name	string	고객 프로필과 연결된 지정된 이름(즉, 첫 번째)입니다.
성	customer.family_name	string	고객 프로필과 연결된 가족(즉, 마지막) 이름입니다.
이메일 주소	customer.email_address	string	고객 프로필과 연결된 이메일 주소입니다.
주소 줄 1	customer.address.address_line_1	string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
주소 줄 2	customer.address.address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	customer.address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	customer.address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	customer.address.postal_code	string	주소의 우편 번호입니다.
국가	customer.address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
전화 번호	customer.phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
참조 ID	customer.reference_id	string	선택적 사용자 정의 참조 ID입니다.
비고	customer.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
구독되지 않은 전자 메일	customer.preferences.email_unsubscribed	boolean	고객이 마케팅 캠페인 전자 메일에서 구독을 취소했는지 여부를 나타냅니다. 참 값은 고객이 현재 Square 판매자 또는 모든 Square 판매자로부터 전자 메일 마케팅을 옵트아웃하도록 선택했음을 의미합니다.
만들기 원본	customer.creation_source	string	생성 원본은 고객 프로필을 만드는 데 사용되는 메서드를 나타냅니다.
그룹 ID	customer.group_ids	array of string
세그먼트 ID	customer.segment_ids	array of string
버전	customer.version	integer	이 개체의 현재 버전입니다.

고객 검색

작업 ID:: CustomerSearch

지원되는 쿼리 필터를 사용하여 Square 계정과 연결된 고객 프로필을 검색합니다. 명시적 쿼리 필터 없이 SearchCustomers를 호출하면 given_name 및 family_name 따라 사전순으로 정렬된 모든 고객 프로필이 반환됩니다.

매개 변수

Name	키	형식	Description
퍼지	fuzzy	string	유사 항목 필터를 사용하여 특성이 지정된 쿼리와 일치하는 고객을 유사하게 선택할 수 있습니다. 유사 항목 옵션을 사용하면 검색 쿼리가 토큰화되고 각 쿼리 토큰이 검색된 특성의 어딘가에 일치해야 합니다. 단일 토큰 쿼리의 경우 부분 일치 작업과 사실상 동일한 동작입니다.
가치들	values	array of string
규칙	rule	string	필터 조건과 일치하는 고객 프로필을 결과에 포함할지 아니면 결과에서 제외해야 하는지를 나타냅니다.
시작 날짜	start_at	string	시간 범위가 시작되는 시기를 나타내는 RFC 3339 형식의 날짜/시간 값입니다.
종료 기준	end_at	string	시간 범위가 종료되는 시기를 나타내는 RFC 3339 형식의 날짜/시간 값입니다.
All	all	array of string
분야	field	string	하나 이상의 고객 특성을 정렬 키로 사용하여 검색된 고객 프로필을 정렬합니다.
순서	order	string	정렬 필드 값에 따라 결과를 정렬해야 하는 순서를 나타냅니다. 문자열은 표준 알파벳 비교를 사용하여 순서를 결정합니다.
한계	limit	integer	단일 페이지에서 반환할 결과 수에 대한 제한입니다. 제한은 권고입니다. 구현은 더 많거나 적은 결과를 반환할 수 있습니다. 제공된 제한이 음수, 0 또는 최대 제한인 1,000보다 높은 경우 무시됩니다.

반환

Name	경로	형식	Description
고객	customers	array of object
아이디	customers.id	string	Square에서 발급한 고유한 식별자입니다.
만든 위치에서	customers.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	customers.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
이름 (주어진 이름)	customers.given_name	string	고객 프로필과 연결된 지정된 이름(즉, 첫 번째)입니다.
성	customers.family_name	string	고객 프로필과 연결된 가족(즉, 마지막) 이름입니다.
이메일 주소	customers.email_address	string	고객 프로필과 연결된 이메일 주소입니다.
주소 줄 1	customers.address.address_line_1	string	주소의 첫 번째 줄입니다.
주소 줄 2	customers.address.address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	customers.address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	customers.address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	customers.address.postal_code	string	주소의 우편 번호입니다.
국가	customers.address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
전화 번호	customers.phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
참조 ID	customers.reference_id	string	고객 프로필을 다른 시스템의 엔터티와 연결하는 데 사용되는 선택적 두 번째 ID입니다.
구독되지 않은 전자 메일	customers.preferences.email_unsubscribed	boolean	고객이 마케팅 캠페인 전자 메일에서 구독을 취소했는지 여부를 나타냅니다. 참 값은 고객이 현재 Square 판매자 또는 모든 Square 판매자로부터 전자 메일 마케팅을 옵트아웃하도록 선택했음을 의미합니다. 이 값은 고객 API에서 읽기 전용입니다.
만들기 원본	customers.creation_source	string	생성 원본은 고객 프로필을 만드는 데 사용되는 메서드를 나타냅니다.
그룹 ID	customers.group_ids	array of string
세그먼트 ID	customers.segment_ids	array of string
버전	customers.version	integer	개체의 현재 버전입니다.
비고	customers.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

고객 그룹 검색

작업 ID:: CustomerGroupRetrieve

특정 고객 그룹을 검색합니다.

매개 변수

Name	키	필수	형식	Description
그룹 아이디	group_id	True	string	그룹의 식별자입니다.

반환

Name	경로	형식	Description
아이디	group.id	string	Square에서 발급한 고유한 식별자입니다.
이름	group.name	string	개체의 이름입니다.
만든 위치에서	group.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	group.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

고객 그룹 나열

작업 ID:: CustomerGroupList

비즈니스의 고객 그룹 목록을 검색합니다.

반환

Name	경로	형식	Description
Groups	groups	array of object
아이디	groups.id	string	Square에서 발급한 고유한 식별자입니다.
이름	groups.name	string	개체의 이름입니다.
만든 위치에서	groups.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	groups.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프

고객 그룹 만들기

작업 ID:: CustomGroupCreate

비즈니스에 대한 새 고객 그룹을 만듭니다.

매개 변수

Name	키	필수	형식	Description
이름	name		string	개체의 이름입니다.

반환

Name	경로	형식	Description
아이디	group.id	string	Square에서 발급한 고유한 식별자입니다.
이름	group.name	string	개체의 이름입니다.
만든 위치에서	group.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	group.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

고객 그룹 삭제

작업 ID:: CustomerGroupDelete

group_id 값으로 식별된 고객 그룹을 삭제합니다.

매개 변수

Name	키	필수	형식	Description
그룹 아이디	group_id	True	string	그룹의 식별자입니다.

반환

response: object

고객 그룹 업데이트

작업 ID:: CustomerGroupUpdate

고객 그룹을 업데이트합니다.

매개 변수

Name	키	필수	형식	Description
그룹 아이디	group_id	True	string	그룹의 식별자입니다.
이름	name		string	개체의 이름입니다.

반환

Name	경로	형식	Description
아이디	group.id	string	Square에서 발급한 고유한 식별자입니다.
이름	group.name	string	개체의 이름입니다.
만든 위치에서	group.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	group.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

고객 나열

작업 ID:: CustomerList

Square 계정과 연결된 고객 프로필을 나열합니다. 정상적인 운영 조건에서 새로 만들거나 업데이트된 고객 프로필은 30초 미만의 시간 안에 나열 작업에 사용할 수 있게 됩니다. 경우에 따라 새 프로필 또는 업데이트된 프로필의 전파는 특히 네트워크 인시던트 및 중단 중에 1분 이상 걸릴 수 있습니다.

매개 변수

Name	키	형식	Description
Cursor	cursor	string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
한계	limit	integer	응답에서 반환할 수의 상한입니다.
정렬 필드	sort_field	string	고객을 정렬하는 방법을 나타냅니다. 기본값은 DEFAULT입니다.
정렬 순서	sort_order	string	지정된 순서로 카드를 만든 시점을 기준으로 반환된 목록을 정렬합니다.

반환

Name	경로	형식	Description
고객	customers	array of object
아이디	customers.id	string	Square에서 발급한 고유한 식별자입니다.
만든 위치에서	customers.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	customers.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
이름 (주어진 이름)	customers.given_name	string	고객 프로필과 연결된 지정된 이름(즉, 첫 번째)입니다.
성	customers.family_name	string	고객 프로필과 연결된 가족(즉, 마지막) 이름입니다.
이메일 주소	customers.email_address	string	고객 프로필과 연결된 이메일 주소입니다.
주소 줄 1	customers.address.address_line_1	string	주소의 첫 번째 줄입니다.
주소 줄 2	customers.address.address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	customers.address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	customers.address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	customers.address.postal_code	string	주소의 우편 번호입니다.
국가	customers.address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
전화 번호	customers.phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
참조 ID	customers.reference_id	string	고객 프로필을 다른 시스템의 엔터티와 연결하는 데 사용되는 선택적 두 번째 ID입니다.
비고	customers.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
구독되지 않은 전자 메일	customers.preferences.email_unsubscribed	boolean	고객이 마케팅 캠페인 전자 메일에서 구독을 취소했는지 여부를 나타냅니다. 참 값은 고객이 현재 Square 판매자 또는 모든 Square 판매자로부터 전자 메일 마케팅을 옵트아웃하도록 선택했음을 의미합니다. 이 값은 고객 API에서 읽기 전용입니다.
만들기 원본	customers.creation_source	string	생성 원본은 고객 프로필을 만드는 데 사용되는 메서드를 나타냅니다.
그룹 ID	customers.group_ids	array of string
세그먼트 ID	customers.segment_ids	array of string
버전	customers.version	integer	개체의 현재 버전입니다.

고객 만들기

작업 ID:: CustomerCreate

비즈니스에 대한 새 고객을 만듭니다.

매개 변수

Name	키	형식	Description
이름 (주어진 이름)	given_name	string	고객 프로필과 연결된 지정된 이름(즉, 이름)입니다.
성	family_name	string	고객 프로필과 연결된 가족 이름(즉, 성)입니다.
이메일 주소	email_address	string	고객 프로필과 연결된 이메일 주소입니다.
회사 이름	company_name	string	고객 프로필과 연결된 비즈니스 이름입니다.
애칭	nickname	string	고객 프로필의 애칭입니다.
주소 줄 1	address_line_1	string	주소의 첫 번째 줄입니다.
주소 줄 2	address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	postal_code	string	주소의 우편 번호입니다.
국가	country	string	ISO 3166 Alpha-2 국가 코드입니다.
전화 번호	phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
참조 ID	reference_id	string	고객 프로필을 다른 시스템의 엔터티와 연결하는 데 사용되는 선택적 두 번째 ID입니다.
비고	note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
생일	birthday	string	RFC 3339 형식의 고객 프로필과 연결된 생일입니다. 연도는 선택 사항입니다. 표준 시간대와 시간은 허용되지 않습니다. 예를 들어 0000-09-21T00:00:00-00:00은 1998년 9월 21일과 1998-09-21T00:00:00:00의 생일을 나타냅니다. 이 값은 YYYY-MM-DD 형식으로 지정할 수도 있습니다.

반환

Name	경로	형식	Description
아이디	customer.id	string	Square에서 발급한 고유한 식별자입니다.
만든 위치에서	customer.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	customer.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
이름 (주어진 이름)	customer.given_name	string	고객 프로필과 연결된 지정된 이름(즉, 첫 번째)입니다.
성	customer.family_name	string	고객 프로필과 연결된 가족(즉, 마지막) 이름입니다.
이메일 주소	customer.email_address	string	고객 프로필과 연결된 이메일 주소입니다.
회사 이름	customer.company_name	string	고객 프로필과 연결된 비즈니스 이름입니다.
애칭	customer.nickname	string	고객 프로필의 애칭입니다.
주소 줄 1	customer.address.address_line_1	string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
주소 줄 2	customer.address.address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	customer.address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	customer.address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	customer.address.postal_code	string	주소의 우편 번호입니다.
국가	customer.address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
전화 번호	customer.phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
참조 ID	customer.reference_id	string	선택적 사용자 정의 참조 ID입니다.
비고	customer.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
생일	customer.birthday	string	RFC 3339 형식의 고객 프로필과 연결된 생일입니다. 연도는 선택 사항입니다. 표준 시간대와 시간은 허용되지 않습니다. 예를 들어 0000-09-21T00:00:00-00:00은 1998년 9월 21일과 1998-09-21T00:00:00:00의 생일을 나타냅니다.
구독되지 않은 전자 메일	customer.preferences.email_unsubscribed	boolean	고객이 마케팅 캠페인 전자 메일에서 구독을 취소했는지 여부를 나타냅니다. 참 값은 고객이 현재 Square 판매자 또는 모든 Square 판매자로부터 전자 메일 마케팅을 옵트아웃하도록 선택했음을 의미합니다.
만들기 원본	customer.creation_source	string	생성 원본은 고객 프로필을 만드는 데 사용되는 메서드를 나타냅니다.
버전	customer.version	integer	이 개체의 현재 버전입니다.

고객 삭제

작업 ID:: CustomerDelete

비즈니스에서 고객 프로필을 삭제합니다. 또한 이 작업은 파일의 연결된 카드의 연결을 해제합니다.

매개 변수

Name	키	필수	형식	Description
고객 ID	customer_id	True	string	고객의 식별자입니다.

반환

response: object

고객 세그먼트 검색

작업 ID:: CustomerSegmentRetrieve

특정 고객 세그먼트를 검색합니다.

매개 변수

Name	키	필수	형식	Description
세그먼트 ID	segment_id	True	string	세그먼트의 식별자입니다.

반환

Name	경로	형식	Description
아이디	segment.id	string	Square에서 발급한 고유한 식별자입니다.
이름	segment.name	string	개체의 이름입니다.
만든 위치에서	segment.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	segment.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

고객 세그먼트 나열

작업 ID:: CustomerSegmentList

비즈니스의 고객 세그먼트 목록을 검색합니다.

매개 변수

Name	키	필수	형식	Description
Cursor	cursor		string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
한계	limit		integer	응답에서 반환할 수의 상한입니다.

반환

Name	경로	형식	Description
세그먼트	segments	array of object
아이디	segments.id	string	Square에서 발급한 고유한 식별자입니다.
이름	segments.name	string	개체의 이름입니다.
만든 위치에서	segments.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	segments.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프

고객 업데이트

작업 ID:: CustomerUpdate

고객 프로필을 업데이트합니다. 특성을 변경하려면 새 값을 지정합니다. 특성을 제거하려면 값을 빈 문자열 또는 빈 개체로 지정합니다.

매개 변수

Name	키	필수	형식	Description
고객 ID	customer_id	True	string	고객의 식별자입니다.

반환

Name	경로	형식	Description
아이디	customer.id	string	Square에서 발급한 고유한 식별자입니다.
만든 위치에서	customer.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	customer.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
이름 (주어진 이름)	customer.given_name	string	고객 프로필과 연결된 지정된 이름(즉, 첫 번째)입니다.
성	customer.family_name	string	고객 프로필과 연결된 가족(즉, 마지막) 이름입니다.
이메일 주소	customer.email_address	string	고객 프로필과 연결된 이메일 주소입니다.
주소 줄 1	customer.address.address_line_1	string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
주소 줄 2	customer.address.address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	customer.address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	customer.address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	customer.address.postal_code	string	주소의 우편 번호입니다.
국가	customer.address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
참조 ID	customer.reference_id	string	선택적 사용자 정의 참조 ID입니다.
비고	customer.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
구독되지 않은 전자 메일	customer.preferences.email_unsubscribed	boolean	고객이 마케팅 캠페인 전자 메일에서 구독을 취소했는지 여부를 나타냅니다. 참 값은 고객이 현재 Square 판매자 또는 모든 Square 판매자로부터 전자 메일 마케팅을 옵트아웃하도록 선택했음을 의미합니다.
만들기 원본	customer.creation_source	string	생성 원본은 고객 프로필을 만드는 데 사용되는 메서드를 나타냅니다.
버전	customer.version	integer	이 개체의 현재 버전입니다.

고객에게 그룹 추가

작업 ID:: CustomerAddGroup

고객에게 그룹 멤버 자격을 추가합니다. 고객은 customer_id 값으로 식별되고 고객 그룹은 group_id 값으로 식별됩니다.

매개 변수

Name	키	필수	형식	Description
고객 ID	customer_id	True	string	고객의 식별자입니다.
그룹 아이디	group_id	True	string	그룹의 식별자입니다.

반환

response: object

고객에서 그룹 제거

작업 ID:: CustomerRemoveGroup

고객에서 그룹 멤버 자격을 제거합니다. 고객은 customer_id 값으로 식별되고 고객 그룹은 group_id 값으로 식별됩니다.

매개 변수

Name	키	필수	형식	Description
고객 ID	customer_id	True	string	고객의 식별자입니다.
그룹 아이디	group_id	True	string	그룹의 식별자입니다.

반환

response: object

구독 검색

작업 ID:: SubscriptionRetrieve

구독을 검색합니다.

매개 변수

Name	키	필수	형식	Description
구독 ID	subscription_id	True	string	구독의 식별자입니다.

반환

Name	경로	형식	Description
아이디	subscription.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	subscription.location_id	string	위치의 식별자입니다.
계획 ID	subscription.plan_id	string	연결된 구독 계획의 ID입니다.
고객 ID	subscription.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
시작 날짜	subscription.start_date	string	구독의 시작 날짜(YYYY-MM-DD 형식)
날짜까지 청구됨	subscription.charged_through_date	string	YYYY-MM-DD 형식으로 고객이 구독에 대해 송장을 청구할 날짜입니다.
상태	subscription.status	string	이 개체의 현재 확인 상태입니다.
청구서 ID	subscription.invoice_ids	array of string
금액	subscription.price_override_money.amount	integer	금액입니다.
통화	subscription.price_override_money.currency	string	통화입니다.
만든 위치에서	subscription.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
지급 날짜까지	subscription.paid_until_date	string	지급된 날짜입니다.
Timezone	subscription.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
이름	subscription.source.name	string	이름입니다.

구독 검색

작업 ID:: SubscriptionSearch

구독을 검색합니다. 결과는 구독 생성 날짜별로 시간순으로 정렬됩니다. 요청이 둘 이상의 위치 ID를 지정하는 경우 엔드포인트는 위치 ID를 기준으로 결과를 정렬한 다음 각 위치 내에서 만든 날짜를 기준으로 정렬합니다. 쿼리에 위치가 지정되지 않으면 모든 위치가 검색됩니다.

매개 변수

Name	키	형식
위치 ID	location_ids	array of string
고객 ID	customer_ids	array of string
원본 이름	source_names	array of string

반환

Name	경로	형식	Description
구독	subscriptions	array of object
아이디	subscriptions.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	subscriptions.location_id	string	위치의 식별자입니다.
계획 ID	subscriptions.plan_id	string	연결된 구독 플랜의 ID
고객 ID	subscriptions.customer_id	string	계정과 연결된 고객의 Square 할당 ID입니다.
시작 날짜	subscriptions.start_date	string	구독의 시작 날짜(YYYY-MM-DD 형식)
취소된 날짜	subscriptions.canceled_date	string	YYYY-MM-DD 형식의 구독 취소 날짜입니다.
날짜까지 청구됨	subscriptions.charged_through_date	string	YYYY-MM-DD 형식으로 고객이 구독에 대해 송장을 청구할 날짜입니다.
상태	subscriptions.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	subscriptions.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
카드 ID	subscriptions.card_id	string	구독에 대해 청구되는 고객 카드의 ID입니다.
지급 날짜까지	subscriptions.paid_until_date	string	지급된 날짜입니다.
Timezone	subscriptions.timezone	string	청구서에서 달력 날짜를 해석하는 데 사용되는 표준 시간대(예: due_date)입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
이름	subscriptions.source.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
세금 비율	subscriptions.tax_percentage	string	구독을 청구할 때 적용되는 세금 금액입니다.
금액	subscriptions.price_override_money.amount	integer	금액입니다.
통화	subscriptions.price_override_money.currency	string	통화입니다.
버전	subscriptions.version	integer	개체의 현재 버전입니다.
청구서 ID	subscriptions.invoice_ids	array of string

구독 다시 시작

작업 ID:: SubscriptionResume

비활성화된 구독을 다시 시작합니다.

매개 변수

Name	키	필수	형식	Description
구독 ID	subscription_id	True	string	구독의 식별자입니다.

반환

Name	경로	형식	Description
아이디	subscription.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	subscription.location_id	string	위치의 식별자입니다.
계획 ID	subscription.plan_id	string	연결된 구독 계획의 ID입니다.
고객 ID	subscription.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
상태	subscription.status	string	이 개체의 현재 확인 상태입니다.
금액	subscription.price_override_money.amount	integer	금액입니다.
통화	subscription.price_override_money.currency	string	통화입니다.
버전	subscription.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	subscription.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
Timezone	subscription.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
이름	subscription.source.name	string	이름입니다.

구독 만들기

작업 ID:: SubscriptionCreate

구독 플랜에 대한 고객의 구독을 만듭니다. 요청에서 파일에 카드를 제공하는 경우 Square는 구독에 대한 카드를 청구합니다. 그렇지 않으면 Square는 고객의 이메일 주소에 청구서를 청구합니다. 요청에 선택적 start_date 포함하지 않는 한 구독이 즉시 시작됩니다. 각 개별 구독은 특정 위치와 연결됩니다.

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
위치 ID	location_id	string	위치 식별자입니다.
계획 ID	plan_id	string	카탈로그 API를 사용하여 만든 구독 계획의 ID입니다.
고객 ID	customer_id	string	연결할 고객의 ID입니다.
카드 ID	card_id	string	청구할 고객 카드의 ID입니다.
시작 날짜	start_date	string	구독의 시작 날짜(YYYY-MM-DD 형식)
세금 비율	tax_percentage	string	구독을 청구할 때 추가할 세금입니다.
금액	amount	integer	tip_money 포함하지 않고 이 지불에 대해 수락할 금액입니다.
통화	currency	string	3자 ISO 4217 통화 코드입니다.
Timezone	timezone	string	구독에 대한 날짜 계산에 사용되는 표준 시간대입니다.
이름	name	string	개체의 이름입니다.

반환

Name	경로	형식	Description
아이디	subscription.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	subscription.location_id	string	위치의 식별자입니다.
계획 ID	subscription.plan_id	string	연결된 구독 계획의 ID입니다.
고객 ID	subscription.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
시작 날짜	subscription.start_date	string	구독의 시작 날짜(YYYY-MM-DD 형식)
상태	subscription.status	string	이 개체의 현재 확인 상태입니다.
세금 비율	subscription.tax_percentage	string	구독을 청구할 때 적용되는 세금 금액입니다.
금액	subscription.price_override_money.amount	integer	금액입니다.
통화	subscription.price_override_money.currency	string	통화입니다.
버전	subscription.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	subscription.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
카드 ID	subscription.card_id	string	구독에 대해 청구되는 고객 카드의 ID입니다.
Timezone	subscription.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
이름	subscription.source.name	string	이름입니다.

구독 업데이트

작업 ID:: SubscriptionUpdate

구독을 업데이트합니다. 구독 필드 값을 설정, 수정 및 지울 수 있습니다.

매개 변수

Name	키	필수	형식	Description
구독 ID	subscription_id	True	string	구독의 식별자입니다.
버전	version		integer	이 개체의 현재 버전입니다.
세금 비율	tax_percentage		string	구독을 청구할 때 적용되는 세금 금액입니다.
금액	amount		integer	금액입니다.
통화	currency		string	통화입니다.

반환

Name	경로	형식	Description
아이디	subscription.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	subscription.location_id	string	위치의 식별자입니다.
계획 ID	subscription.plan_id	string	연결된 구독 계획의 ID입니다.
고객 ID	subscription.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
상태	subscription.status	string	이 개체의 현재 확인 상태입니다.
금액	subscription.price_override_money.amount	integer	금액입니다.
통화	subscription.price_override_money.currency	string	통화입니다.
버전	subscription.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	subscription.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
Timezone	subscription.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
이름	subscription.source.name	string	이름입니다.

구독 이벤트 나열

작업 ID:: SubscriptionListEvents

특정 구독에 대한 모든 이벤트를 나열합니다.

매개 변수

Name	키	필수	형식	Description
구독 ID	subscription_id	True	string	구독의 식별자입니다.

반환

Name	경로	형식	Description
구독 이벤트	subscription_events	array of object
아이디	subscription_events.id	string	Square에서 발급한 고유한 식별자입니다.
구독 이벤트 유형	subscription_events.subscription_event_type	string	구독 이벤트의 유형입니다.
개시 날짜	subscription_events.effective_date	string	구독 이벤트가 적용된 날짜(YYYY-MM-DD 형식)입니다.
계획 ID	subscription_events.plan_id	string	연결된 구독 플랜의 ID

구독 취소

작업 ID:: SubscriptionCancel

canceled_date 필드를 활성 청구 기간의 끝으로 설정합니다. 이 날짜 이후에 상태가 ACTIVE에서 CANCELED로 변경됩니다.

매개 변수

Name	키	필수	형식	Description
구독 ID	subscription_id	True	string	구독의 식별자입니다.

반환

Name	경로	형식	Description
아이디	subscription.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	subscription.location_id	string	위치의 식별자입니다.
계획 ID	subscription.plan_id	string	연결된 구독 계획의 ID입니다.
고객 ID	subscription.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
카드 ID	subscription.card_id	string	구독에 대해 청구되는 고객 카드의 ID입니다.
시작 날짜	subscription.start_date	string	구독의 시작 날짜(YYYY-MM-DD 형식)
취소된 날짜	subscription.canceled_date	string	YYYY-MM-DD 형식의 구독 취소 날짜입니다.
지급 날짜까지	subscription.paid_until_date	string	지급된 날짜입니다.
상태	subscription.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	subscription.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
버전	subscription.version	integer	이 개체의 현재 버전입니다.
Timezone	subscription.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
이름	subscription.source.name	string	이름입니다.

복제 순서(베타)

작업 ID:: OrderClone

기존 순서를 복제하여 DRAFT 상태에서 새 순서를 만듭니다. 새로 만든 주문에는 원래 주문에서 복사한 핵심 필드(예: 품목, 세금 및 할인)만 있습니다.

매개 변수

Name	키	형식	Description
주문 ID	order_id	string	주문 식별자입니다.
버전	version	integer	버전입니다.
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.

반환

Name	경로	형식	Description
아이디	order.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	order.location_id	string	위치의 식별자입니다.
줄 항목	order.line_items	array of object
UID	order.line_items.uid	string	정사각형으로 생성된 ID입니다.
이름	order.line_items.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
수량	order.line_items.quantity	string	물리적 개수의 영향을 받는 항목 수를 10진수 문자열로 지정합니다. 이 숫자는 소수점 이후 최대 5자리를 지원할 수 있습니다.
적용된 세금	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	정사각형 할당 ID입니다.
세금 UID	order.line_items.applied_taxes.tax_uid	string	이 적용된 세금이 나타내는 세금의 UID입니다.
금액	order.line_items.applied_taxes.applied_money.amount	integer	금액입니다.
통화	order.line_items.applied_taxes.applied_money.currency	string	통화입니다.
적용된 할인	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	정사각형 할당 ID입니다.
할인 UID	order.line_items.applied_discounts.discount_uid	string	적용된 할인이 나타내는 할인의 uid입니다.
금액	order.line_items.applied_discounts.applied_money.amount	integer	금액입니다.
통화	order.line_items.applied_discounts.applied_money.currency	string	통화입니다.
금액	order.line_items.base_price_money.amount	integer	금액입니다.
통화	order.line_items.base_price_money.currency	string	통화입니다.
금액	order.line_items.gross_sales_money.amount	integer	금액입니다.
통화	order.line_items.gross_sales_money.currency	string	통화입니다.
금액	order.line_items.total_tax_money.amount	integer	금액입니다.
통화	order.line_items.total_tax_money.currency	string	통화입니다.
금액	order.line_items.total_discount_money.amount	integer	금액입니다.
통화	order.line_items.total_discount_money.currency	string	통화입니다.
금액	order.line_items.total_money.amount	integer	금액입니다.
통화	order.line_items.total_money.currency	string	통화입니다.
금액	order.line_items.variation_total_price_money.amount	integer	금액입니다.
통화	order.line_items.variation_total_price_money.currency	string	통화입니다.
카탈로그 개체 ID	order.line_items.catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
변형 이름	order.line_items.variation_name	string	이 줄 항목에 적용된 변형의 이름입니다.
한정자	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	정사각형 할당 ID입니다.
카탈로그 개체 ID	order.line_items.modifiers.catalog_object_id	string	카탈로그 개체 ID입니다.
이름	order.line_items.modifiers.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
금액	order.line_items.modifiers.base_price_money.amount	integer	금액입니다.
통화	order.line_items.modifiers.base_price_money.currency	string	통화입니다.
금액	order.line_items.modifiers.total_price_money.amount	integer	금액입니다.
통화	order.line_items.modifiers.total_price_money.currency	string	통화입니다.
세금	order.taxes	array of object
UID	order.taxes.uid	string	정사각형으로 생성된 ID입니다.
이름	order.taxes.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
유형	order.taxes.type	string	형식을 나타냅니다.
백분율	order.taxes.percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
금액	order.taxes.applied_money.amount	integer	금액입니다.
통화	order.taxes.applied_money.currency	string	통화입니다.
Scope	order.taxes.scope	string	현재 수준을 나타냅니다.
할인	order.discounts	array of object
UID	order.discounts.uid	string	정사각형으로 생성된 ID입니다.
카탈로그 개체 ID	order.discounts.catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
이름	order.discounts.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
유형	order.discounts.type	string	형식을 나타냅니다.
백분율	order.discounts.percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
금액	order.discounts.applied_money.amount	integer	금액입니다.
통화	order.discounts.applied_money.currency	string	통화입니다.
Scope	order.discounts.scope	string	현재 수준을 나타냅니다.
금액	order.discounts.amount_money.amount	integer	금액입니다.
통화	order.discounts.amount_money.currency	string	통화입니다.
만든 위치에서	order.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	order.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
주	order.state	string	현재 상태입니다.
버전	order.version	integer	이 개체의 현재 버전입니다.
참조 ID	order.reference_id	string	선택적 사용자 정의 참조 ID입니다.
금액	order.total_money.amount	integer	금액입니다.
통화	order.total_money.currency	string	통화입니다.
금액	order.total_tax_money.amount	integer	금액입니다.
통화	order.total_tax_money.currency	string	통화입니다.
금액	order.total_discount_money.amount	integer	금액입니다.
통화	order.total_discount_money.currency	string	통화입니다.
금액	order.total_tip_money.amount	integer	금액입니다.
통화	order.total_tip_money.currency	string	통화입니다.
금액	order.total_service_charge_money.amount	integer	금액입니다.
통화	order.total_service_charge_money.currency	string	통화입니다.
금액	order.net_amounts.total_money.amount	integer	금액입니다.
통화	order.net_amounts.total_money.currency	string	통화입니다.
금액	order.net_amounts.tax_money.amount	integer	금액입니다.
통화	order.net_amounts.tax_money.currency	string	통화입니다.
금액	order.net_amounts.discount_money.amount	integer	금액입니다.
통화	order.net_amounts.discount_money.currency	string	통화입니다.
금액	order.net_amounts.tip_money.amount	integer	금액입니다.
통화	order.net_amounts.tip_money.currency	string	통화입니다.
금액	order.net_amounts.service_charge_money.amount	integer	금액입니다.
통화	order.net_amounts.service_charge_money.currency	string	통화입니다.
이름	order.source.name	string	이름입니다.

분쟁 검색

작업 ID:: DisputeRetrieve

특정 분쟁에 대한 세부 정보를 반환합니다.

매개 변수

Name	키	필수	형식	Description
분쟁 ID	dispute_id	True	string	분쟁의 식별자입니다.

반환

Name	경로	형식	Description
아이디	dispute.id	string	Square에서 발급한 고유한 식별자입니다.
금액	dispute.amount_money.amount	integer	금액입니다.
통화	dispute.amount_money.currency	string	통화입니다.
이유	dispute.reason	string	이 개체의 이유입니다.
주	dispute.state	string	현재 상태입니다.
기한	dispute.due_at	string	다음 작업이 기한인 시간(RFC 3339 형식)입니다.
이의 제기 지불	dispute.disputed_payments	array of object
결제 아이디	dispute.disputed_payments.payment_id	string	정사각형으로 생성된 결제의 고유 ID입니다.
카드 브랜드	dispute.card_brand	string	카드의 브랜드입니다.
만든 위치에서	dispute.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	dispute.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
브랜드 분쟁 ID	dispute.brand_dispute_id	string	카드 브랜드에서 생성한 카드 브랜드 시스템의 분쟁 ID입니다.

분쟁 나열

작업 ID:: DisputeList

특정 계정과 관련된 분쟁 목록을 반환합니다.

매개 변수

Name	키	형식	Description
Cursor	cursor	string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
States	states	string	분쟁은 결과를 필터링하는 상태를 지정합니다. 지정하지 않으면 엔드포인트는 열려 있는 모든 분쟁을 반환합니다(분쟁 상태가 INQUIRY_CLOSED, WON 또는 LOST가 아님).
위치 ID	location_id	string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.

반환

Name	경로	형식	Description
분쟁	disputes	array of object
아이디	disputes.id	string	Square에서 발급한 고유한 식별자입니다.
금액	disputes.amount_money.amount	integer	금액입니다.
통화	disputes.amount_money.currency	string	통화입니다.
이유	disputes.reason	string	카드 소유자가 은행과 분쟁을 시작한 분쟁 이유입니다.
주	disputes.state	string	현재 상태입니다.
기한	disputes.due_at	string	다음 작업이 기한인 시간(RFC 3339 형식)입니다.
이의 제기 지불	disputes.disputed_payments	array of object
결제 아이디	disputes.disputed_payments.payment_id	string	분쟁 중인 결제의 제곱 생성 고유 ID입니다.
카드 브랜드	disputes.card_brand	string	분쟁 지불에 사용되는 카드 브랜드입니다.
만든 위치에서	disputes.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	disputes.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
브랜드 분쟁 ID	disputes.brand_dispute_id	string	카드 브랜드에서 생성한 카드 브랜드 시스템의 분쟁 ID입니다.
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

분쟁 수락

작업 ID:: DisputeAccept

분쟁의 손실을 수락합니다. Square는 분쟁 금액을 카드 소유자에게 반환하고 분쟁 상태를 ACCEPTED로 업데이트합니다. 제곱은 판매자의 광장 계정에서 분쟁 금액을 차변합니다. Square 계정에 충분한 자금이 없는 경우 Square는 연결된 은행 계좌를 인출합니다.

매개 변수

Name	키	필수	형식	Description
분쟁 ID	dispute_id	True	string	분쟁의 식별자입니다.

반환

Name	경로	형식	Description
아이디	dispute.id	string	Square에서 발급한 고유한 식별자입니다.
금액	dispute.amount_money.amount	integer	금액입니다.
통화	dispute.amount_money.currency	string	통화입니다.
이유	dispute.reason	string	이 개체의 이유입니다.
주	dispute.state	string	현재 상태입니다.
기한	dispute.due_at	string	다음 작업이 기한인 시간(RFC 3339 형식)입니다.
이의 제기 지불	dispute.disputed_payments	array of object
결제 아이디	dispute.disputed_payments.payment_id	string	정사각형으로 생성된 결제의 고유 ID입니다.
카드 브랜드	dispute.card_brand	string	카드의 브랜드입니다.
만든 위치에서	dispute.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	dispute.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
브랜드 분쟁 ID	dispute.brand_dispute_id	string	카드 브랜드에서 생성한 카드 브랜드 시스템의 분쟁 ID입니다.

분쟁 증거 검색

작업 ID:: DisputeRetrieveEvidence

요청 URL 경로의 증명 정보 ID로 지정된 증명 정보 메타데이터를 반환합니다. 나중에 참조하려면 업로드한 증거의 복사본을 유지해야 합니다. 증거를 업로드한 후에는 다운로드할 수 없습니다.

매개 변수

Name	키	필수	형식	Description
분쟁 ID	dispute_id	True	string	분쟁의 식별자입니다.
증거 ID	evidence_id	True	string	증거의 식별자입니다.

반환

Name	경로	형식	Description
아이디	evidence.id	string	Square에서 발급한 고유한 식별자입니다.
분쟁 ID	evidence.dispute_id	string	증거가 연관된 분쟁의 ID입니다.
Filename	evidence.evidence_file.filename	string	분쟁 증거 파일은 application/pdf, image/heic, image/heif, image/jpeg, image/png 또는 image/tiff 형식이어야 합니다.
파일 형식	evidence.evidence_file.filetype	string	파일 확장명을 포함하는 파일 이름입니다.
증거 유형	evidence.evidence_type	string	pf 증명 유형입니다.
에서 업로드됨	evidence.uploaded_at	string	다음 작업이 기한인 시간(RFC 3339 형식)입니다.

분쟁 증거 나열

작업 ID:: DisputeListEvidence

분쟁과 관련된 증거 목록을 반환합니다.

매개 변수

Name	키	필수	형식	Description
분쟁 ID	dispute_id	True	string	분쟁의 식별자입니다.

반환

Name	경로	형식	Description
Evidence	evidence	array of object
아이디	evidence.id	string	Square에서 발급한 고유한 식별자입니다.
분쟁 ID	evidence.dispute_id	string	증거가 연관된 분쟁의 ID입니다.
증거 텍스트	evidence.evidence_text	string	원시 텍스트입니다.
증거 유형	evidence.evidence_type	string	증거의 유형입니다.
에서 업로드됨	evidence.uploaded_at	string	다음 작업이 기한인 시간(RFC 3339 형식)입니다.
증거 ID	evidence.evidence_id	string	증명 정보의 사각형 생성 ID입니다.
Filename	evidence.evidence_file.filename	string	파일 확장명을 포함한 파일 이름
파일 형식	evidence.evidence_file.filetype	string	분쟁 증거 파일은 application/pdf, image/heic, image/heif, image/jpeg, image/png 또는 image/tiff 형식이어야 합니다.
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

분쟁 증거 삭제

작업 ID:: DisputeDeleteEvidence

분쟁에서 지정된 증거를 제거합니다.

매개 변수

Name	키	필수	형식	Description
분쟁 ID	dispute_id	True	string	분쟁의 식별자입니다.
증거 ID	evidence_id	True	string	증거의 식별자입니다.

반환

response: object

분쟁 증거 텍스트 만들기

작업 ID:: DisputeCreateEvidenceText

분쟁 챌린지의 증거로 사용할 텍스트를 업로드합니다.

매개 변수

Name	키	필수	형식	Description
분쟁 ID	dispute_id	True	string	분쟁의 식별자입니다.
증거 유형	evidence_type		string	업로드하는 증거의 유형입니다.
증거 텍스트	evidence_text		string	증명 정보 문자열입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.

반환

Name	경로	형식	Description
아이디	evidence.id	string	Square에서 발급한 고유한 식별자입니다.
분쟁 ID	evidence.dispute_id	string	증거가 연관된 분쟁의 ID입니다.
증거 텍스트	evidence.evidence_text	string	원시 텍스트입니다.
증거 유형	evidence.evidence_type	string	pf 증명 유형입니다.
에서 업로드됨	evidence.uploaded_at	string	다음 작업이 기한인 시간(RFC 3339 형식)입니다.

순서 검색

작업 ID:: OrderRetrieve

ID별로 주문을 검색합니다.

매개 변수

Name	키	필수	형식	Description
주문 ID	order_id	True	string	주문의 식별자입니다.

반환

Name	경로	형식	Description
아이디	order.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	order.location_id	string	위치의 식별자입니다.
줄 항목	order.line_items	array of object
UID	order.line_items.uid	string	정사각형으로 생성된 ID입니다.
수량	order.line_items.quantity	string	물리적 개수의 영향을 받는 항목 수를 10진수 문자열로 지정합니다. 이 숫자는 소수점 이후 최대 5자리를 지원할 수 있습니다.
이름	order.line_items.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
금액	order.line_items.base_price_money.amount	integer	금액입니다.
통화	order.line_items.base_price_money.currency	string	통화입니다.
금액	order.line_items.gross_sales_money.amount	integer	금액입니다.
통화	order.line_items.gross_sales_money.currency	string	통화입니다.
금액	order.line_items.total_tax_money.amount	integer	금액입니다.
통화	order.line_items.total_tax_money.currency	string	통화입니다.
금액	order.line_items.total_discount_money.amount	integer	금액입니다.
통화	order.line_items.total_discount_money.currency	string	통화입니다.
금액	order.line_items.total_money.amount	integer	금액입니다.
통화	order.line_items.total_money.currency	string	통화입니다.
금액	order.line_items.variation_total_price_money.amount	integer	금액입니다.
통화	order.line_items.variation_total_price_money.currency	string	통화입니다.
적용된 할인	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	정사각형 할당 ID입니다.
할인 UID	order.line_items.applied_discounts.discount_uid	string	적용된 할인이 나타내는 할인의 uid입니다.
금액	order.line_items.applied_discounts.applied_money.amount	integer	금액입니다.
통화	order.line_items.applied_discounts.applied_money.currency	string	통화입니다.
할인	order.discounts	array of object
UID	order.discounts.uid	string	정사각형으로 생성된 ID입니다.
이름	order.discounts.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
백분율	order.discounts.percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
금액	order.discounts.applied_money.amount	integer	금액입니다.
통화	order.discounts.applied_money.currency	string	통화입니다.
유형	order.discounts.type	string	형식을 나타냅니다.
Scope	order.discounts.scope	string	현재 수준을 나타냅니다.
만든 위치에서	order.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	order.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
주	order.state	string	현재 상태입니다.
버전	order.version	integer	이 개체의 현재 버전입니다.
금액	order.total_tax_money.amount	integer	금액입니다.
통화	order.total_tax_money.currency	string	통화입니다.
금액	order.total_discount_money.amount	integer	금액입니다.
통화	order.total_discount_money.currency	string	통화입니다.
금액	order.total_tip_money.amount	integer	금액입니다.
통화	order.total_tip_money.currency	string	통화입니다.
금액	order.total_money.amount	integer	금액입니다.
통화	order.total_money.currency	string	통화입니다.
금액	order.total_service_charge_money.amount	integer	금액입니다.
통화	order.total_service_charge_money.currency	string	통화입니다.
금액	order.net_amounts.total_money.amount	integer	금액입니다.
통화	order.net_amounts.total_money.currency	string	통화입니다.
금액	order.net_amounts.tax_money.amount	integer	금액입니다.
통화	order.net_amounts.tax_money.currency	string	통화입니다.
금액	order.net_amounts.discount_money.amount	integer	금액입니다.
통화	order.net_amounts.discount_money.currency	string	통화입니다.
금액	order.net_amounts.tip_money.amount	integer	금액입니다.
통화	order.net_amounts.tip_money.currency	string	통화입니다.
금액	order.net_amounts.service_charge_money.amount	integer	금액입니다.
통화	order.net_amounts.service_charge_money.currency	string	통화입니다.

순서 계산(베타)

작업 ID:: OrderCalculate

애플리케이션에서 주문을 만들지 않고 주문 가격을 미리 볼 수 있습니다.

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
위치 ID	location_id	string	위치의 식별자입니다.
이름	name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
백분율	percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
Scope	scope	string	현재 수준을 나타냅니다.
이름	name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
수량	quantity	string	물리적 개수의 영향을 받는 항목 수를 10진수 문자열로 지정합니다. 이 숫자는 소수점 이후 최대 5자리를 지원할 수 있습니다.
금액	amount	integer	금액입니다.
통화	currency	string	통화입니다.

반환

Name	경로	형식	Description
위치 ID	order.location_id	string	위치의 식별자입니다.
줄 항목	order.line_items	array of object
UID	order.line_items.uid	string	정사각형으로 생성된 ID입니다.
수량	order.line_items.quantity	string	물리적 개수의 영향을 받는 항목 수를 10진수 문자열로 지정합니다. 이 숫자는 소수점 이후 최대 5자리를 지원할 수 있습니다.
이름	order.line_items.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
금액	order.line_items.base_price_money.amount	integer	금액입니다.
통화	order.line_items.base_price_money.currency	string	통화입니다.
금액	order.line_items.gross_sales_money.amount	integer	금액입니다.
통화	order.line_items.gross_sales_money.currency	string	통화입니다.
금액	order.line_items.total_tax_money.amount	integer	금액입니다.
통화	order.line_items.total_tax_money.currency	string	통화입니다.
금액	order.line_items.total_discount_money.amount	integer	금액입니다.
통화	order.line_items.total_discount_money.currency	string	통화입니다.
금액	order.line_items.total_money.amount	integer	금액입니다.
통화	order.line_items.total_money.currency	string	통화입니다.
금액	order.line_items.variation_total_price_money.amount	integer	금액입니다.
통화	order.line_items.variation_total_price_money.currency	string	통화입니다.
적용된 할인	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	정사각형 할당 ID입니다.
할인 UID	order.line_items.applied_discounts.discount_uid	string	적용된 할인이 나타내는 할인의 uid입니다.
금액	order.line_items.applied_discounts.applied_money.amount	integer	금액입니다.
통화	order.line_items.applied_discounts.applied_money.currency	string	통화입니다.
할인	order.discounts	array of object
UID	order.discounts.uid	string	정사각형으로 생성된 ID입니다.
이름	order.discounts.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
백분율	order.discounts.percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
금액	order.discounts.applied_money.amount	integer	금액입니다.
통화	order.discounts.applied_money.currency	string	통화입니다.
유형	order.discounts.type	string	형식을 나타냅니다.
Scope	order.discounts.scope	string	현재 수준을 나타냅니다.
만든 위치에서	order.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	order.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
주	order.state	string	현재 상태입니다.
버전	order.version	integer	이 개체의 현재 버전입니다.
금액	order.total_tax_money.amount	integer	금액입니다.
통화	order.total_tax_money.currency	string	통화입니다.
금액	order.total_discount_money.amount	integer	금액입니다.
통화	order.total_discount_money.currency	string	통화입니다.
금액	order.total_tip_money.amount	integer	금액입니다.
통화	order.total_tip_money.currency	string	통화입니다.
금액	order.total_money.amount	integer	금액입니다.
통화	order.total_money.currency	string	통화입니다.
금액	order.total_service_charge_money.amount	integer	금액입니다.
통화	order.total_service_charge_money.currency	string	통화입니다.
금액	order.net_amounts.total_money.amount	integer	금액입니다.
통화	order.net_amounts.total_money.currency	string	통화입니다.
금액	order.net_amounts.tax_money.amount	integer	금액입니다.
통화	order.net_amounts.tax_money.currency	string	통화입니다.
금액	order.net_amounts.discount_money.amount	integer	금액입니다.
통화	order.net_amounts.discount_money.currency	string	통화입니다.
금액	order.net_amounts.tip_money.amount	integer	금액입니다.
통화	order.net_amounts.tip_money.currency	string	통화입니다.
금액	order.net_amounts.service_charge_money.amount	integer	금액입니다.
통화	order.net_amounts.service_charge_money.currency	string	통화입니다.

인벤토리 물리적 개수 검색

작업 ID:: InventoryRetrievePhysicalCount

제공된 physical_count_id InventoryPhysicalCount 개체를 반환합니다.

매개 변수

Name	키	필수	형식	Description
실제 개수 ID	physical_count_id	True	string	실제 개수의 식별자입니다.

반환

Name	경로	형식	Description
아이디	count.id	string	Square에서 발급한 고유한 식별자입니다.
참조 ID	count.reference_id	string	선택적 사용자 정의 참조 ID입니다.
카탈로그 개체 ID	count.catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
카탈로그 개체 형식	count.catalog_object_type	string	추적할 CatalogObject의 형식입니다.
주	count.state	string	현재 상태입니다.
위치 ID	count.location_id	string	위치의 식별자입니다.
수량	count.quantity	string	10진수 문자열로 조정의 영향을 받는 항목 수입니다. 소수점 이후 최대 5자리 숫자를 지원할 수 있습니다.
제품	count.source.product	string	애플리케이션의 제품 유형입니다.
애플리케이션 ID	count.source.application_id	string	애플리케이션에 할당된 읽기 전용 정사각형 ID입니다.
이름	count.source.name	string	이름입니다.
직원 ID	count.employee_id	string	Employee의 Square 생성 ID입니다.
발생 날짜	count.occurred_at	string	인벤토리 조정이 수행된 시기를 나타내는 클라이언트에서 생성된 RFC 3339 형식 타임스탬프입니다. 인벤토리 조정 업데이트의 경우 occurred_at 타임스탬프는 요청 시간을 기준으로 24시간 이상 또는 이후 버전일 수 없습니다.
만든 위치에서	count.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

인벤토리 수 검색

작업 ID:: InventoryRetrieveCount

지정된 위치 집합에서 지정된 CatalogObject의 현재 계산 재고 수를 검색합니다.

매개 변수

Name	키	필수	형식	Description
카탈로그 개체 ID	catalog_object_id	True	string	카탈로그 개체의 식별자입니다.
위치 ID	location_ids		string	쉼표로 구분된 목록으로 조회할 위치 ID입니다. 빈 목록은 모든 위치를 쿼리합니다.
Cursor	cursor		string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.

반환

Name	경로	형식	Description
계산	counts	array of object
카탈로그 개체 ID	counts.catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
카탈로그 개체 형식	counts.catalog_object_type	string	추적할 CatalogObject의 형식입니다.
주	counts.state	string	현재 상태입니다.
위치 ID	counts.location_id	string	위치의 식별자입니다.
수량	counts.quantity	string	10진수 문자열로 예상되는 수의 영향을 받는 항목 수입니다. 소수점 이후 최대 5자리 숫자를 지원할 수 있습니다.
계산 시	counts.calculated_at	string	예상 수에 영향을 주는 가장 최근의 물리적 개수 또는 조정이 수신되는 시기를 나타내는 RFC 3339 형식 타임스탬프입니다.

인벤토리 전송 검색(베타)

작업 ID:: InventoryRetrieveTransfer

제공된 transfer_id InventoryTransfer 개체를 반환합니다.

매개 변수

Name	키	필수	형식	Description
이전 ID	transfer_id	True	string	전송의 식별자입니다.

반환

Name	경로	형식	Description
아이디	transfer.id	string	Square에서 발급한 고유한 식별자입니다.
카탈로그 개체 ID	transfer.catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
카탈로그 개체 형식	transfer.catalog_object_type	string	추적할 CatalogObject의 형식입니다.
만든 위치에서	transfer.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
직원 ID	transfer.employee_id	string	Employee의 Square 생성 ID입니다.
위치 ID에서	transfer.from_location_id	string	전송 전에 관련 항목 수량을 추적한 위치의 정사각형 생성 ID입니다.
위치 ID로	transfer.to_location_id	string	전송 후 관련 항목 수량을 추적한 위치의 Square 생성 ID입니다.
발생 날짜	transfer.occurred_at	string	인벤토리 조정이 수행된 시기를 나타내는 클라이언트에서 생성된 RFC 3339 형식 타임스탬프입니다. 인벤토리 조정 업데이트의 경우 occurred_at 타임스탬프는 요청 시간을 기준으로 24시간 이상 또는 이후 버전일 수 없습니다.
수량	transfer.quantity	string	10진수 문자열로 조정의 영향을 받는 항목 수입니다. 소수점 이후 최대 5자리 숫자를 지원할 수 있습니다.
참조 ID	transfer.reference_id	string	선택적 사용자 정의 참조 ID입니다.
제품	transfer.source.product	string	애플리케이션의 제품 유형입니다.
애플리케이션 ID	transfer.source.application_id	string	애플리케이션에 할당된 읽기 전용 정사각형 ID입니다.
이름	transfer.source.name	string	이름입니다.
주	transfer.state	string	현재 상태입니다.

인벤토리 조정 검색

작업 ID:: InventoryRetrieveAdjustment

제공된 adjustment_id InventoryAdjustment 개체를 반환합니다.

매개 변수

Name	키	필수	형식	Description
조정 ID	adjustment_id	True	string	조정의 식별자입니다.

반환

Name	경로	형식	Description
아이디	adjustment.id	string	Square에서 발급한 고유한 식별자입니다.
참조 ID	adjustment.reference_id	string	선택적 사용자 정의 참조 ID입니다.
상태에서	adjustment.from_state	string	조정 전 관련 항목 수량의 인벤토리 상태입니다.
To State	adjustment.to_state	string	조정 후 관련 항목 수량의 인벤토리 상태입니다.
위치 ID	adjustment.location_id	string	위치의 식별자입니다.
카탈로그 개체 ID	adjustment.catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
카탈로그 개체 형식	adjustment.catalog_object_type	string	추적할 CatalogObject의 형식입니다.
수량	adjustment.quantity	string	10진수 문자열로 조정의 영향을 받는 항목 수입니다. 소수점 이후 최대 5자리 숫자를 지원할 수 있습니다.
금액	adjustment.total_price_money.amount	integer	금액입니다.
통화	adjustment.total_price_money.currency	string	통화입니다.
발생 날짜	adjustment.occurred_at	string	인벤토리 조정이 수행된 시기를 나타내는 클라이언트에서 생성된 RFC 3339 형식 타임스탬프입니다. 인벤토리 조정 업데이트의 경우 occurred_at 타임스탬프는 요청 시간을 기준으로 24시간 이상 또는 이후 버전일 수 없습니다.
만든 위치에서	adjustment.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
제품	adjustment.source.product	string	애플리케이션의 제품 유형입니다.
애플리케이션 ID	adjustment.source.application_id	string	애플리케이션에 할당된 읽기 전용 정사각형 ID입니다.
이름	adjustment.source.name	string	이름입니다.
직원 ID	adjustment.employee_id	string	Employee의 Square 생성 ID입니다.

일괄 처리 검색 인벤토리 수

작업 ID:: InventoryBatchRetrieveCounts

요청된 위치에서 제공된 CatalogObjects의 현재 개수를 반환합니다.

매개 변수

Name	키	형식	Description
카탈로그 개체 ID	catalog_object_ids	array of string
위치 ID	location_ids	array of string
업데이트 후	updated_after	string	RFC 3339 타임스탬프에 지정된 시간 이후의 calculated_at 값으로 결과를 반환하는 필터입니다.

반환

Name	경로	형식	Description
계산	counts	array of object
카탈로그 개체 ID	counts.catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
카탈로그 개체 형식	counts.catalog_object_type	string	추적할 CatalogObject의 형식입니다.
주	counts.state	string	현재 상태입니다.
위치 ID	counts.location_id	string	위치의 식별자입니다.
수량	counts.quantity	string	10진수 문자열로 예상되는 수의 영향을 받는 항목 수입니다. 소수점 이후 최대 5자리 숫자를 지원할 수 있습니다.
계산 시	counts.calculated_at	string	예상 수에 영향을 주는 가장 최근의 물리적 개수 또는 조정이 수신되는 시기를 나타내는 RFC 3339 형식 타임스탬프입니다.

일괄 처리 검색 주문

작업 ID:: OrderBatchRetrieve

ID로 주문 집합을 검색합니다. 지정된 주문 ID가 없으면 오류를 생성하는 대신 ID가 무시됩니다.

매개 변수

Name	키	필수	형식	Description
위치 ID	location_id		string	위치 식별자입니다.
주문 ID	order_ids		array of string

반환

Name	경로	형식	Description
주문	orders	array of object
아이디	orders.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	orders.location_id	string	위치의 식별자입니다.
참조 ID	orders.reference_id	string	고객 프로필을 다른 시스템의 엔터티와 연결하는 데 사용되는 선택적 두 번째 ID입니다.
줄 항목	orders.line_items	array of object
UID	orders.line_items.uid	string	청구서에 있는 결제 요청의 Square 생성 ID입니다.
이름	orders.line_items.name	string	사람이 읽을 수 있는 이름입니다.
수량	orders.line_items.quantity	string	구매한 수량으로, 10진수로 형식이 지정됩니다.
금액	orders.line_items.base_price_money.amount	integer	금액입니다.
통화	orders.line_items.base_price_money.currency	string	통화입니다.
금액	orders.line_items.total_money.amount	integer	금액입니다.
통화	orders.line_items.total_money.currency	string	통화입니다.
금액	orders.total_money.amount	integer	금액입니다.
통화	orders.total_money.currency	string	통화입니다.

일괄 처리 변경 인벤토리

작업 ID:: InventoryBatchChange

제공된 항목 수량에 조정 및 개수를 적용합니다. 성공: 요청에서 참조되는 모든 개체에 대해 현재 계산된 개수를 반환합니다.

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
유형	type	string	이 개체의 형식입니다.
참조 ID	reference_id	string	이 카드를 외부 시스템의 다른 엔터티와 연결하는 선택적 사용자 정의 참조 ID입니다.
카탈로그 개체 ID	catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
주	state	string	항목의 관련 수량에 대한 현재 인벤토리 상태입니다.
위치 ID	location_id	string	이 입찰의 일부를 받는 받는 사람(가맹점 이외의)의 위치 ID입니다.
수량	quantity	string	물리적 개수의 영향을 받는 항목 수를 10진수 문자열로 지정합니다. 이 숫자는 소수점 이후 최대 5자리를 지원할 수 있습니다.
직원 ID	employee_id	string	실제 개수를 담당하는 직원의 Square 생성 ID입니다.
발생 날짜	occurred_at	string	물리적 개수를 검사한 시기를 나타내는 클라이언트에서 생성된 RFC 3339 형식 타임스탬프입니다. 물리적 개수 업데이트의 경우 occurred_at 타임스탬프는 요청 시간을 기준으로 24시간 이상 또는 이후 버전일 수 없습니다.
변경되지 않은 개수 무시	ignore_unchanged_counts	boolean	수량이 마지막 물리적 개수 이후 변경되지 않은 경우 현재 물리적 개수를 무시해야 하는지 여부를 나타냅니다.

반환

Name	경로	형식	Description
계산	counts	array of object
카탈로그 개체 ID	counts.catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
카탈로그 개체 형식	counts.catalog_object_type	string	추적할 CatalogObject의 형식입니다.
주	counts.state	string	현재 상태입니다.
위치 ID	counts.location_id	string	위치의 식별자입니다.
수량	counts.quantity	string	10진수 문자열로 예상되는 수의 영향을 받는 항목 수입니다. 소수점 이후 최대 5자리 숫자를 지원할 수 있습니다.
계산 시	counts.calculated_at	string	예상 수에 영향을 주는 가장 최근의 물리적 개수 또는 조정이 수신되는 시기를 나타내는 RFC 3339 형식 타임스탬프입니다.

일괄 처리 삭제 카탈로그 개체

작업 ID:: CatalogBatchDelete

제공된 대상 ID 목록에 따라 CatalogItems 집합을 삭제하고 응답에서 성공적으로 삭제된 ID 집합을 반환합니다.

매개 변수

Name	키	필수	형식	Description
개체 ID	object_ids		array of string

반환

Name	경로	형식	Description
삭제된 개체 ID	deleted_object_ids	array of string
삭제됨	deleted_at	string	이 삭제의 데이터베이스 타임스탬프(RFC 3339 형식)

주문 만들기

작업 ID:: OrderCreate

구매 제품 및 구매에 적용할 설정에 대한 정보를 포함할 수 있는 새 주문을 만듭니다.

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
참조 ID	reference_id	string	선택적 사용자 정의 참조 ID입니다.
위치 ID	location_id	string	위치의 식별자입니다.
이름	name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
수량	quantity	string	물리적 개수의 영향을 받는 항목 수를 10진수 문자열로 지정합니다. 이 숫자는 소수점 이후 최대 5자리를 지원할 수 있습니다.
금액	amount	integer	금액입니다.
통화	currency	string	통화입니다.
카탈로그 개체 ID	catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
카탈로그 개체 ID	catalog_object_id	string	카탈로그 개체 ID입니다.
할인 UID	discount_uid	string	적용된 할인이 나타내는 할인의 uid입니다.
UID	uid	string	정사각형으로 생성된 ID입니다.
이름	name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
백분율	percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
Scope	scope	string	현재 수준을 나타냅니다.
UID	uid	string	정사각형으로 생성된 ID입니다.
이름	name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
백분율	percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
Scope	scope	string	현재 수준을 나타냅니다.
카탈로그 개체 ID	catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
금액	amount	integer	금액입니다.
통화	currency	string	통화입니다.

반환

Name	경로	형식	Description
아이디	order.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	order.location_id	string	위치의 식별자입니다.
줄 항목	order.line_items	array of object
UID	order.line_items.uid	string	정사각형으로 생성된 ID입니다.
이름	order.line_items.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
수량	order.line_items.quantity	string	물리적 개수의 영향을 받는 항목 수를 10진수 문자열로 지정합니다. 이 숫자는 소수점 이후 최대 5자리를 지원할 수 있습니다.
적용된 세금	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	정사각형 할당 ID입니다.
세금 UID	order.line_items.applied_taxes.tax_uid	string	이 적용된 세금이 나타내는 세금의 UID입니다.
금액	order.line_items.applied_taxes.applied_money.amount	integer	금액입니다.
통화	order.line_items.applied_taxes.applied_money.currency	string	통화입니다.
적용된 할인	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	정사각형 할당 ID입니다.
할인 UID	order.line_items.applied_discounts.discount_uid	string	적용된 할인이 나타내는 할인의 uid입니다.
금액	order.line_items.applied_discounts.applied_money.amount	integer	금액입니다.
통화	order.line_items.applied_discounts.applied_money.currency	string	통화입니다.
금액	order.line_items.base_price_money.amount	integer	금액입니다.
통화	order.line_items.base_price_money.currency	string	통화입니다.
금액	order.line_items.gross_sales_money.amount	integer	금액입니다.
통화	order.line_items.gross_sales_money.currency	string	통화입니다.
금액	order.line_items.total_tax_money.amount	integer	금액입니다.
통화	order.line_items.total_tax_money.currency	string	통화입니다.
금액	order.line_items.total_discount_money.amount	integer	금액입니다.
통화	order.line_items.total_discount_money.currency	string	통화입니다.
금액	order.line_items.total_money.amount	integer	금액입니다.
통화	order.line_items.total_money.currency	string	통화입니다.
금액	order.line_items.variation_total_price_money.amount	integer	금액입니다.
통화	order.line_items.variation_total_price_money.currency	string	통화입니다.
카탈로그 개체 ID	order.line_items.catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
변형 이름	order.line_items.variation_name	string	이 줄 항목에 적용된 변형의 이름입니다.
한정자	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	정사각형 할당 ID입니다.
카탈로그 개체 ID	order.line_items.modifiers.catalog_object_id	string	카탈로그 개체 ID입니다.
이름	order.line_items.modifiers.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
금액	order.line_items.modifiers.base_price_money.amount	integer	금액입니다.
통화	order.line_items.modifiers.base_price_money.currency	string	통화입니다.
금액	order.line_items.modifiers.total_price_money.amount	integer	금액입니다.
통화	order.line_items.modifiers.total_price_money.currency	string	통화입니다.
세금	order.taxes	array of object
UID	order.taxes.uid	string	정사각형으로 생성된 ID입니다.
이름	order.taxes.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
유형	order.taxes.type	string	형식을 나타냅니다.
백분율	order.taxes.percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
금액	order.taxes.applied_money.amount	integer	금액입니다.
통화	order.taxes.applied_money.currency	string	통화입니다.
Scope	order.taxes.scope	string	현재 수준을 나타냅니다.
할인	order.discounts	array of object
UID	order.discounts.uid	string	정사각형으로 생성된 ID입니다.
카탈로그 개체 ID	order.discounts.catalog_object_id	string	추적 중인 CatalogObject의 사각형 생성 ID입니다.
이름	order.discounts.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
유형	order.discounts.type	string	형식을 나타냅니다.
백분율	order.discounts.percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
금액	order.discounts.applied_money.amount	integer	금액입니다.
통화	order.discounts.applied_money.currency	string	통화입니다.
Scope	order.discounts.scope	string	현재 수준을 나타냅니다.
금액	order.discounts.amount_money.amount	integer	금액입니다.
통화	order.discounts.amount_money.currency	string	통화입니다.
만든 위치에서	order.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	order.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
주	order.state	string	현재 상태입니다.
버전	order.version	integer	이 개체의 현재 버전입니다.
참조 ID	order.reference_id	string	선택적 사용자 정의 참조 ID입니다.
금액	order.total_money.amount	integer	금액입니다.
통화	order.total_money.currency	string	통화입니다.
금액	order.total_tax_money.amount	integer	금액입니다.
통화	order.total_tax_money.currency	string	통화입니다.
금액	order.total_discount_money.amount	integer	금액입니다.
통화	order.total_discount_money.currency	string	통화입니다.
금액	order.total_tip_money.amount	integer	금액입니다.
통화	order.total_tip_money.currency	string	통화입니다.
금액	order.total_service_charge_money.amount	integer	금액입니다.
통화	order.total_service_charge_money.currency	string	통화입니다.
금액	order.net_amounts.total_money.amount	integer	금액입니다.
통화	order.net_amounts.total_money.currency	string	통화입니다.
금액	order.net_amounts.tax_money.amount	integer	금액입니다.
통화	order.net_amounts.tax_money.currency	string	통화입니다.
금액	order.net_amounts.discount_money.amount	integer	금액입니다.
통화	order.net_amounts.discount_money.currency	string	통화입니다.
금액	order.net_amounts.tip_money.amount	integer	금액입니다.
통화	order.net_amounts.tip_money.currency	string	통화입니다.
금액	order.net_amounts.service_charge_money.amount	integer	금액입니다.
통화	order.net_amounts.service_charge_money.currency	string	통화입니다.
이름	order.source.name	string	이름입니다.

주문 업데이트(베타)

작업 ID:: OrderUpdate

필드를 추가, 바꾸기 또는 삭제하여 열린 순서를 업데이트합니다. COMPLETED 또는 CANCELED 상태의 주문은 업데이트할 수 없습니다.

매개 변수

Name	키	필수	형식	Description
주문 ID	order_id	True	string	주문의 식별자입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
버전	version		integer	이 개체의 현재 버전입니다.
UID	uid		string	정사각형으로 생성된 ID입니다.
수량	quantity		string	물리적 개수의 영향을 받는 항목 수를 10진수 문자열로 지정합니다. 이 숫자는 소수점 이후 최대 5자리를 지원할 수 있습니다.
이름	name		string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
금액	amount		integer	금액입니다.
통화	currency		string	통화입니다.
지울 필드	fields_to_clear		array of string

반환

Name	경로	형식	Description
버전	order.version	integer	이 개체의 현재 버전입니다.
통화	order.total_money.currency	string	통화입니다.
금액	order.total_money.amount	integer	금액입니다.
이름	order.source.name	string	이름입니다.
줄 항목	order.line_items	array of object
통화	order.line_items.total_tax_money.currency	string	통화입니다.
금액	order.line_items.total_tax_money.amount	integer	금액입니다.
금액	order.line_items.total_money.amount	integer	금액입니다.
통화	order.line_items.total_money.currency	string	통화입니다.
금액	order.line_items.gross_sales_money.amount	integer	금액입니다.
통화	order.line_items.gross_sales_money.currency	string	통화입니다.
금액	order.line_items.base_price_money.amount	integer	금액입니다.
통화	order.line_items.base_price_money.currency	string	통화입니다.
수량	order.line_items.quantity	string	물리적 개수의 영향을 받는 항목 수를 10진수 문자열로 지정합니다. 이 숫자는 소수점 이후 최대 5자리를 지원할 수 있습니다.
통화	order.line_items.total_discount_money.currency	string	통화입니다.
금액	order.line_items.total_discount_money.amount	integer	금액입니다.
이름	order.line_items.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
UID	order.line_items.uid	string	정사각형으로 생성된 ID입니다.
금액	order.line_items.variation_total_price_money.amount	integer	금액입니다.
통화	order.line_items.variation_total_price_money.currency	string	통화입니다.
주	order.state	string	현재 상태입니다.
금액	order.total_service_charge_money.amount	integer	금액입니다.
통화	order.total_service_charge_money.currency	string	통화입니다.
아이디	order.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	order.location_id	string	위치의 식별자입니다.
금액	order.total_tax_money.amount	integer	금액입니다.
통화	order.total_tax_money.currency	string	통화입니다.
만든 위치에서	order.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
금액	order.total_discount_money.amount	integer	금액입니다.
통화	order.total_discount_money.currency	string	통화입니다.
통화	order.net_amounts.service_charge_money.currency	string	통화입니다.
금액	order.net_amounts.service_charge_money.amount	integer	금액입니다.
금액	order.net_amounts.total_money.amount	integer	금액입니다.
통화	order.net_amounts.total_money.currency	string	통화입니다.
통화	order.net_amounts.discount_money.currency	string	통화입니다.
금액	order.net_amounts.discount_money.amount	integer	금액입니다.
통화	order.net_amounts.tax_money.currency	string	통화입니다.
금액	order.net_amounts.tax_money.amount	integer	금액입니다.
업데이트 날짜	order.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

주문 지불(베타)

작업 ID:: OrderPay

하나 이상의 승인된 결제를 사용하여 주문을 지불하거나 총 0으로 주문을 정정합니다. 요청에 나열된 payment_ids 합계는 주문 합계와 같아야 합니다. 총 금액이 0인 주문은 요청에 빈 payment_ids 배열을 지정하여 지불된 것으로 표시할 수 있습니다.

매개 변수

Name	키	필수	형식	Description
주문 ID	order_id	True	string	주문의 식별자입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
결제 ID	payment_ids		array of string

반환

Name	경로	형식	Description
아이디	order.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	order.location_id	string	위치의 식별자입니다.
줄 항목	order.line_items	array of object
UID	order.line_items.uid	string	정사각형으로 생성된 ID입니다.
수량	order.line_items.quantity	string	물리적 개수의 영향을 받는 항목 수를 10진수 문자열로 지정합니다. 이 숫자는 소수점 이후 최대 5자리를 지원할 수 있습니다.
이름	order.line_items.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
금액	order.line_items.base_price_money.amount	integer	금액입니다.
통화	order.line_items.base_price_money.currency	string	통화입니다.
금액	order.line_items.gross_sales_money.amount	integer	금액입니다.
통화	order.line_items.gross_sales_money.currency	string	통화입니다.
금액	order.line_items.total_tax_money.amount	integer	금액입니다.
통화	order.line_items.total_tax_money.currency	string	통화입니다.
금액	order.line_items.total_discount_money.amount	integer	금액입니다.
통화	order.line_items.total_discount_money.currency	string	통화입니다.
금액	order.line_items.total_money.amount	integer	금액입니다.
통화	order.line_items.total_money.currency	string	통화입니다.
만든 위치에서	order.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	order.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
버전	order.version	integer	이 개체의 현재 버전입니다.
금액	order.total_tax_money.amount	integer	금액입니다.
통화	order.total_tax_money.currency	string	통화입니다.
금액	order.total_discount_money.amount	integer	금액입니다.
통화	order.total_discount_money.currency	string	통화입니다.
금액	order.total_money.amount	integer	금액입니다.
통화	order.total_money.currency	string	통화입니다.
닫힘	order.closed_at	string	ISO 8601 형식으로 닫힌 시간입니다.
헬멧	order.tenders	array of object
아이디	order.tenders.id	string	개체의 식별자입니다.
위치 ID	order.tenders.location_id	string	이 입찰의 일부를 받는 받는 사람(가맹점 이외의)의 위치 ID입니다.
트랜잭션 ID	order.tenders.transaction_id	string	입찰 관련 트랜잭션의 ID입니다.
만든 위치에서	order.tenders.created_at	string	만들어진 타임스탬프(RFC 3339 형식)입니다.
금액	order.tenders.amount_money.amount	integer	금액입니다.
통화	order.tenders.amount_money.currency	string	통화입니다.
유형	order.tenders.type	string	형식을 나타냅니다.
상태	order.tenders.card_details.status	string	신용 카드 결제의 현재 상태(예: 권한 부여됨 또는 캡처됨)
카드 브랜드	order.tenders.card_details.card.card_brand	string	카드의 브랜드입니다.
last_4	order.tenders.card_details.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
Exp 월	order.tenders.card_details.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	order.tenders.card_details.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
지문	order.tenders.card_details.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
Entry 메서드	order.tenders.card_details.entry_method	string	트랜잭션에 대한 카드의 세부 정보를 입력하는 데 사용되는 메서드입니다.
결제 아이디	order.tenders.payment_id	string	정사각형으로 생성된 결제의 고유 ID입니다.
금액	order.total_service_charge_money.amount	integer	금액입니다.
통화	order.total_service_charge_money.currency	string	통화입니다.
금액	order.net_amounts.total_money.amount	integer	금액입니다.
통화	order.net_amounts.total_money.currency	string	통화입니다.
금액	order.net_amounts.tax_money.amount	integer	금액입니다.
통화	order.net_amounts.tax_money.currency	string	통화입니다.
금액	order.net_amounts.discount_money.amount	integer	금액입니다.
통화	order.net_amounts.discount_money.currency	string	통화입니다.
금액	order.net_amounts.tip_money.amount	integer	금액입니다.
통화	order.net_amounts.tip_money.currency	string	통화입니다.
금액	order.net_amounts.service_charge_money.amount	integer	금액입니다.
통화	order.net_amounts.service_charge_money.currency	string	통화입니다.
이름	order.source.name	string	이름입니다.
주	order.state	string	현재 상태입니다.

증거 제출

작업 ID:: EvidenceSubmit

카드 소유자의 은행에 증거를 제출합니다. 증거를 제출하기 전에 Square는 사용 가능한 모든 증거를 컴파일합니다. 여기에는 CreateDisputeEvidenceFile 및 CreateDisputeEvidenceText 엔드포인트를 사용하여 업로드된 증거와 사용 가능한 경우 Square에서 자동으로 제공하는 증명 정보가 포함됩니다.

매개 변수

Name	키	필수	형식	Description
분쟁 ID	dispute_id	True	string	분쟁의 식별자입니다.

반환

Name	경로	형식	Description
아이디	dispute.id	string	Square에서 발급한 고유한 식별자입니다.
금액	dispute.amount_money.amount	integer	금액입니다.
통화	dispute.amount_money.currency	string	통화입니다.
이유	dispute.reason	string	이 개체의 이유입니다.
주	dispute.state	string	현재 상태입니다.
기한	dispute.due_at	string	다음 작업이 기한인 시간(RFC 3339 형식)입니다.
이의 제기 지불	dispute.disputed_payments	array of object
결제 아이디	dispute.disputed_payments.payment_id	string	정사각형으로 생성된 결제의 고유 ID입니다.
카드 브랜드	dispute.card_brand	string	카드의 브랜드입니다.
만든 위치에서	dispute.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	dispute.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
브랜드 분쟁 ID	dispute.brand_dispute_id	string	카드 브랜드에서 생성한 카드 브랜드 시스템의 분쟁 ID입니다.

지불 환불 나열

작업 ID:: RefundList

요청을 하는 계정에 대한 환불 목록을 검색합니다. 결과는 결국 일관되며, 새로운 환불 또는 환불 변경 내용이 표시되기까지 몇 초 정도 걸릴 수 있습니다.

매개 변수

Name	키	형식	Description
시작 시간	begin_time	string	opened_at 쿼리의 포괄 시작 시간(ISO 8601 형식)입니다.
종료 시간	end_time	string	opened_at 쿼리의 전용 종료 날짜(ISO 8601 형식)입니다.
정렬 순서	sort_order	string	지정된 순서로 카드를 만든 시점을 기준으로 반환된 목록을 정렬합니다.
Cursor	cursor	string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
위치 ID	location_id	string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.
상태	status	string	지정한 경우 지정된 상태와 일치하는 개체만 반환합니다.
원본 유형	source_type	string	제공된 경우 지정된 원본 형식의 환불만 반환됩니다.
한계	limit	integer	응답에서 반환할 수의 상한입니다.

반환

Name	경로	형식	Description
환불	refunds	array of object
아이디	refunds.id	string	Square에서 발급한 고유한 식별자입니다.
상태	refunds.status	string	이 개체의 현재 확인 상태입니다.
금액	refunds.amount_money.amount	integer	금액입니다.
통화	refunds.amount_money.currency	string	통화입니다.
결제 아이디	refunds.payment_id	string	결제의 ID입니다.
주문 ID	refunds.order_id	string	주문의 ID입니다.
만든 위치에서	refunds.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	refunds.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
처리 요금	refunds.processing_fee	array of object
유효 날짜	refunds.processing_fee.effective_at	string	수수료가 적용되는 시기의 타임스탬프(RFC 3339 형식)입니다.
유형	refunds.processing_fee.type	string	이 개체의 형식입니다.
금액	refunds.processing_fee.amount_money.amount	integer	금액입니다.
통화	refunds.processing_fee.amount_money.currency	string	통화입니다.
위치 ID	refunds.location_id	string	위치의 식별자입니다.
이유	refunds.reason	string	카드 소유자가 은행과 분쟁을 시작한 분쟁 이유입니다.
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

청구서 가져오기

작업 ID:: InvoiceGet

청구서 ID로 청구서를 검색합니다.

매개 변수

Name	키	필수	형식	Description
송장 ID	invoice_id	True	string	청구서의 식별자입니다.

반환

Name	경로	형식	Description
아이디	invoice.id	string	Square에서 발급한 고유한 식별자입니다.
버전	invoice.version	integer	이 개체의 현재 버전입니다.
위치 ID	invoice.location_id	string	위치의 식별자입니다.
주문 ID	invoice.order_id	string	주문의 ID입니다.
결제 요청	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	정사각형으로 생성된 ID입니다.
요청 유형	invoice.payment_requests.request_type	string	결제 요청 유형을 식별합니다. 이 유형은 지불 요청 금액이 결정되는 방법을 정의합니다.
기한	invoice.payment_requests.due_date	string	YYYY-MM-DD 형식의 지불 요청 기한입니다.
팁 사용	invoice.payment_requests.tipping_enabled	boolean	true로 설정하면 고객이 팁을 지불할 수 있는 장소를 제공합니다.
미리 알림	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	정사각형 할당 ID입니다.
예약된 상대 날짜	invoice.payment_requests.reminders.relative_scheduled_days	integer	미리 알림을 보낼 때 결제 요청이 due_date 전(음수) 또는 이후(양수) 일 수입니다.
Message	invoice.payment_requests.reminders.message	string	메시지입니다.
상태	invoice.payment_requests.reminders.status	string	현재 상태입니다.
금액	invoice.payment_requests.computed_amount_money.amount	integer	금액입니다.
통화	invoice.payment_requests.computed_amount_money.currency	string	통화입니다.
금액	invoice.payment_requests.total_completed_amount_money.amount	integer	금액입니다.
통화	invoice.payment_requests.total_completed_amount_money.currency	string	통화입니다.
자동 결제 원본	invoice.payment_requests.automatic_payment_source	string	자동 결제에 대한 결제 방법입니다.
청구서 번호	invoice.invoice_number	string	사용자에게 친숙한 청구서 번호입니다. 값은 위치 내에서 고유합니다. 청구서를 만들 때 제공되지 않으면 Square에서 값을 할당합니다.
제목	invoice.title	string	제목입니다.
Description	invoice.description	string	설명입니다.
예약됨	invoice.scheduled_at	string	처리가 예약된 타임스탬프(RFC 3339 형식)입니다.
상태	invoice.status	string	이 개체의 현재 확인 상태입니다.
Timezone	invoice.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
만든 위치에서	invoice.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	invoice.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
고객 ID	invoice.primary_recipient.customer_id	string	주문과 연결된 고객의 ID입니다.
이름 (주어진 이름)	invoice.primary_recipient.given_name	string	받는 사람의 이름(즉, 첫 번째)입니다.
성	invoice.primary_recipient.family_name	string	받는 사람의 가족(즉, 성)입니다.
이메일 주소	invoice.primary_recipient.email_address	string	받는 사람의 전자 메일 주소입니다.
전화 번호	invoice.primary_recipient.phone_number	string	받는 사람의 전화 번호입니다.
Card	invoice.accepted_payment_methods.card	boolean	신용 카드 또는 직불 카드 결제가 허용되는지 여부를 나타냅니다.
정사각형 기프트 카드	invoice.accepted_payment_methods.square_gift_card	boolean	Square 기프트 카드 결제가 허용되는지 여부를 나타냅니다.
은행 계좌	invoice.accepted_payment_methods.bank_account	boolean	은행 송금 결제가 허용되는지 여부를 나타냅니다.
사용자 지정 필드	invoice.custom_fields	array of object
라벨	invoice.custom_fields.label	string	사용자 지정 필드의 레이블 또는 제목입니다.
가치	invoice.custom_fields.value	string	사용자 정의 필드의 텍스트입니다.
배치	invoice.custom_fields.placement	string	청구서에 있는 사용자 지정 필드의 위치입니다.
배달 방법	invoice.delivery_method	string	Square에서 고객에게 송장, 미리 알림 및 영수증을 보내는 데 사용하는 배달 방법입니다. 청구서가 게시된 후 Square는 지정된 경우 즉시 또는 scheduled_at 날짜에 배달 방법 및 지불 요청 설정에 따라 청구서를 처리합니다.
판매 또는 서비스 날짜	invoice.sale_or_service_date	string	판매 날짜 또는 서비스가 렌더링되는 날짜(YYYY-MM-DD 형식)입니다. 이 필드는 청구서에 표시되는 과거 또는 이후 날짜를 지정하는 데 사용할 수 있습니다.

청구서 검색

작업 ID:: InvoiceSearch

필터에 지정된 위치에서 청구서를 검색합니다.

매개 변수

Name	키	형식	Description
위치 ID	location_ids	array of string
고객 ID	customer_ids	array of string
분야	field	string	하나 이상의 고객 특성을 정렬 키로 사용하여 검색된 고객 프로필을 정렬합니다.
순서	order	string	정렬 필드 값에 따라 결과를 정렬해야 하는 순서를 나타냅니다. 문자열은 표준 알파벳 비교를 사용하여 순서를 결정합니다.
한계	limit	integer	반환할 청구서의 최대 수입니다(최대 한도인 200개). 제공되지 않은 경우 서버는 기본 한도인 100개의 청구서를 사용합니다.

반환

Name	경로	형식	Description
송장	invoices	array of object
아이디	invoices.id	string	Square에서 발급한 고유한 식별자입니다.
버전	invoices.version	integer	개체의 현재 버전입니다.
위치 ID	invoices.location_id	string	위치의 식별자입니다.
주문 ID	invoices.order_id	string	주문의 ID입니다.
결제 요청	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	청구서에 있는 결제 요청의 Square 생성 ID입니다.
요청 유형	invoices.payment_requests.request_type	string	결제 요청 유형을 식별합니다. 이 유형은 지불 요청 금액이 결정되는 방법을 정의합니다.
기한	invoices.payment_requests.due_date	string	결제 요청에 대한 기한(청구서의 표준 시간대)(YYYY-MM-DD 형식)입니다.
팁 사용	invoices.payment_requests.tipping_enabled	boolean	true로 설정하면 Square 호스팅 송장 페이지(청구서의 public_url 필드)에서 고객이 팁을 지불할 수 있는 장소를 제공합니다.
미리 알림	invoices.payment_requests.reminders	array of object	미리 알림
UID	invoices.payment_requests.reminders.uid	string	InvoicePaymentRequest 내에서 미리 알림을 고유하게 식별하는 Square 할당 ID입니다.
예약된 상대 날짜	invoices.payment_requests.reminders.relative_scheduled_days	integer	미리 알림을 보낼 때 결제 요청이 due_date 전(음수) 또는 이후(양수) 일 수입니다.
Message	invoices.payment_requests.reminders.message	string	미리 알림 메시지입니다.
상태	invoices.payment_requests.reminders.status	string	미리 알림의 상태입니다.
금액	invoices.payment_requests.computed_amount_money.amount	integer	금액입니다.
통화	invoices.payment_requests.computed_amount_money.currency	string	통화입니다.
금액	invoices.payment_requests.total_completed_amount_money.amount	integer	금액입니다.
통화	invoices.payment_requests.total_completed_amount_money.currency	string	통화입니다.
자동 결제 원본	invoices.payment_requests.automatic_payment_source	string	자동 결제에 대한 결제 방법입니다.
요청된 백분율	invoices.payment_requests.percentage_requested	string	지불 요청의 금액을 백분율로 지정합니다.
카드 ID	invoices.payment_requests.card_id	string	결제 요청에 대해 청구할 파일의 신용 카드 또는 직불 카드 ID입니다.
청구서 번호	invoices.invoice_number	string	사용자에게 친숙한 청구서 번호입니다.
제목	invoices.title	string	청구서의 제목입니다.
Description	invoices.description	string	설명입니다.
예약됨	invoices.scheduled_at	string	청구서 처리가 예약된 타임스탬프(RFC 3339 형식)입니다. 청구서가 게시된 후 Square는 배달 방법 및 결제 요청 설정에 따라 지정된 날짜에 청구서를 처리합니다.
상태	invoices.status	string	이 개체의 현재 확인 상태입니다.
Timezone	invoices.timezone	string	청구서에서 달력 날짜를 해석하는 데 사용되는 표준 시간대(예: due_date)입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
만든 위치에서	invoices.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	invoices.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
고객 ID	invoices.primary_recipient.customer_id	string	카드와 연결할 고객의 ID입니다.
이름 (주어진 이름)	invoices.primary_recipient.given_name	string	받는 사람의 이름(즉, 첫 번째)입니다.
성	invoices.primary_recipient.family_name	string	받는 사람의 가족(즉, 성)입니다.
이메일 주소	invoices.primary_recipient.email_address	string	받는 사람의 전자 메일 주소입니다.
전화 번호	invoices.primary_recipient.phone_number	string	받는 사람의 전화 번호입니다.
Card	invoices.accepted_payment_methods.card	boolean	신용 카드 또는 직불 카드 결제가 허용되는지 여부를 나타냅니다.
정사각형 기프트 카드	invoices.accepted_payment_methods.square_gift_card	boolean	Square 기프트 카드 결제가 허용되는지 여부를 나타냅니다.
은행 계좌	invoices.accepted_payment_methods.bank_account	boolean	은행 송금 결제가 허용되는지 여부를 나타냅니다.
사용자 지정 필드	invoices.custom_fields	array of object
라벨	invoices.custom_fields.label	string	사용자 지정 필드의 레이블 또는 제목입니다.
가치	invoices.custom_fields.value	string	사용자 정의 필드의 텍스트입니다.
배치	invoices.custom_fields.placement	string	청구서에 있는 사용자 지정 필드의 위치
배달 방법	invoices.delivery_method	string	Square에서 고객에게 송장, 미리 알림 및 영수증을 보내는 데 사용하는 배달 방법입니다.
판매 또는 서비스 날짜	invoices.sale_or_service_date	string	판매 날짜 또는 서비스가 렌더링되는 날짜(YYYY-MM-DD 형식)입니다. 이 필드는 청구서에 표시되는 과거 또는 이후 날짜를 지정하는 데 사용할 수 있습니다.
공용 URL	invoices.public_url	string	Square 호스팅 송장 페이지의 URL입니다. PublishInvoice 엔드포인트를 사용하여 청구서를 게시한 후 Square는 청구서 페이지를 호스트하고 응답에서 페이지 URL을 반환합니다.
금액	invoices.next_payment_amount_money.amount	integer	금액입니다.
통화	invoices.next_payment_amount_money.currency	string	통화입니다.
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

청구서 게시

작업 ID:: InvoicePublish

지정된 초안 청구서를 게시합니다. 청구서가 게시된 후 Square는 청구서 구성에 따라 후속 작업을 수행합니다. 예를 들어 Square는 고객의 전자 메일 주소로 청구서를 보내거나, 파일에서 고객의 카드를 청구하거나, 아무 작업도 수행하지 않습니다. Square는 또한 Square 호스팅 송장 페이지에서 청구서를 사용할 수 있도록 합니다.

매개 변수

Name	키	필수	형식	Description
송장 ID	invoice_id	True	string	청구서의 식별자입니다.
버전	version		integer	버전입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.

반환

Name	경로	형식	Description
아이디	invoice.id	string	Square에서 발급한 고유한 식별자입니다.
버전	invoice.version	integer	이 개체의 현재 버전입니다.
위치 ID	invoice.location_id	string	위치의 식별자입니다.
주문 ID	invoice.order_id	string	주문의 ID입니다.
결제 요청	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	정사각형으로 생성된 ID입니다.
요청 유형	invoice.payment_requests.request_type	string	결제 요청 유형을 식별합니다. 이 유형은 지불 요청 금액이 결정되는 방법을 정의합니다.
기한	invoice.payment_requests.due_date	string	YYYY-MM-DD 형식의 지불 요청 기한입니다.
팁 사용	invoice.payment_requests.tipping_enabled	boolean	true로 설정하면 고객이 팁을 지불할 수 있는 장소를 제공합니다.
미리 알림	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	정사각형 할당 ID입니다.
예약된 상대 날짜	invoice.payment_requests.reminders.relative_scheduled_days	integer	미리 알림을 보낼 때 결제 요청이 due_date 전(음수) 또는 이후(양수) 일 수입니다.
Message	invoice.payment_requests.reminders.message	string	메시지입니다.
상태	invoice.payment_requests.reminders.status	string	현재 상태입니다.
금액	invoice.payment_requests.computed_amount_money.amount	integer	금액입니다.
통화	invoice.payment_requests.computed_amount_money.currency	string	통화입니다.
금액	invoice.payment_requests.total_completed_amount_money.amount	integer	금액입니다.
통화	invoice.payment_requests.total_completed_amount_money.currency	string	통화입니다.
자동 결제 원본	invoice.payment_requests.automatic_payment_source	string	자동 결제에 대한 결제 방법입니다.
청구서 번호	invoice.invoice_number	string	사용자에게 친숙한 청구서 번호입니다. 값은 위치 내에서 고유합니다. 청구서를 만들 때 제공되지 않으면 Square에서 값을 할당합니다.
제목	invoice.title	string	제목입니다.
Description	invoice.description	string	설명입니다.
예약됨	invoice.scheduled_at	string	처리가 예약된 타임스탬프(RFC 3339 형식)입니다.
상태	invoice.status	string	이 개체의 현재 확인 상태입니다.
Timezone	invoice.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
만든 위치에서	invoice.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	invoice.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
고객 ID	invoice.primary_recipient.customer_id	string	주문과 연결된 고객의 ID입니다.
이름 (주어진 이름)	invoice.primary_recipient.given_name	string	받는 사람의 이름(즉, 첫 번째)입니다.
성	invoice.primary_recipient.family_name	string	받는 사람의 가족(즉, 성)입니다.
이메일 주소	invoice.primary_recipient.email_address	string	받는 사람의 전자 메일 주소입니다.
전화 번호	invoice.primary_recipient.phone_number	string	받는 사람의 전화 번호입니다.
공용 URL	invoice.public_url	string	Square 호스팅 송장 페이지의 URL입니다. PublishInvoice 엔드포인트를 사용하여 청구서를 게시한 후 Square는 청구서 페이지를 호스트하고 응답에서 페이지 URL을 반환합니다.
Card	invoice.accepted_payment_methods.card	boolean	신용 카드 또는 직불 카드 결제가 허용되는지 여부를 나타냅니다.
정사각형 기프트 카드	invoice.accepted_payment_methods.square_gift_card	boolean	Square 기프트 카드 결제가 허용되는지 여부를 나타냅니다.
은행 계좌	invoice.accepted_payment_methods.bank_account	boolean	은행 송금 결제가 허용되는지 여부를 나타냅니다.
사용자 지정 필드	invoice.custom_fields	array of object
라벨	invoice.custom_fields.label	string	사용자 지정 필드의 레이블 또는 제목입니다.
가치	invoice.custom_fields.value	string	사용자 정의 필드의 텍스트입니다.
배치	invoice.custom_fields.placement	string	청구서에 있는 사용자 지정 필드의 위치입니다.
배달 방법	invoice.delivery_method	string	Square에서 고객에게 송장, 미리 알림 및 영수증을 보내는 데 사용하는 배달 방법입니다. 청구서가 게시된 후 Square는 지정된 경우 즉시 또는 scheduled_at 날짜에 배달 방법 및 지불 요청 설정에 따라 청구서를 처리합니다.
판매 또는 서비스 날짜	invoice.sale_or_service_date	string	판매 날짜 또는 서비스가 렌더링되는 날짜(YYYY-MM-DD 형식)입니다. 이 필드는 청구서에 표시되는 과거 또는 이후 날짜를 지정하는 데 사용할 수 있습니다.

청구서 나열

작업 ID:: InvoiceList

지정된 위치에 대한 청구서 목록을 반환합니다.

매개 변수

Name	키	형식	Description
위치 ID	location_id	string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.
Cursor	cursor	string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
한계	limit	integer	응답에서 반환할 수의 상한입니다.

반환

Name	경로	형식	Description
송장	invoices	array of object
아이디	invoices.id	string	Square에서 발급한 고유한 식별자입니다.
버전	invoices.version	integer	개체의 현재 버전입니다.
위치 ID	invoices.location_id	string	위치의 식별자입니다.
주문 ID	invoices.order_id	string	주문의 ID입니다.
결제 요청	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	청구서에 있는 결제 요청의 Square 생성 ID입니다.
요청 유형	invoices.payment_requests.request_type	string	결제 요청 유형을 식별합니다. 이 유형은 지불 요청 금액이 결정되는 방법을 정의합니다.
기한	invoices.payment_requests.due_date	string	결제 요청에 대한 기한(청구서의 표준 시간대)(YYYY-MM-DD 형식)입니다.
팁 사용	invoices.payment_requests.tipping_enabled	boolean	true로 설정하면 Square 호스팅 송장 페이지(청구서의 public_url 필드)에서 고객이 팁을 지불할 수 있는 장소를 제공합니다.
미리 알림	invoices.payment_requests.reminders	array of object	미리 알림
UID	invoices.payment_requests.reminders.uid	string	InvoicePaymentRequest 내에서 미리 알림을 고유하게 식별하는 Square 할당 ID입니다.
예약된 상대 날짜	invoices.payment_requests.reminders.relative_scheduled_days	integer	미리 알림을 보낼 때 결제 요청이 due_date 전(음수) 또는 이후(양수) 일 수입니다.
Message	invoices.payment_requests.reminders.message	string	미리 알림 메시지입니다.
상태	invoices.payment_requests.reminders.status	string	미리 알림의 상태입니다.
금액	invoices.payment_requests.computed_amount_money.amount	integer	금액입니다.
통화	invoices.payment_requests.computed_amount_money.currency	string	통화입니다.
금액	invoices.payment_requests.total_completed_amount_money.amount	integer	금액입니다.
통화	invoices.payment_requests.total_completed_amount_money.currency	string	통화입니다.
자동 결제 원본	invoices.payment_requests.automatic_payment_source	string	자동 결제에 대한 결제 방법입니다.
요청된 백분율	invoices.payment_requests.percentage_requested	string	지불 요청의 금액을 백분율로 지정합니다.
카드 ID	invoices.payment_requests.card_id	string	결제 요청에 대해 청구할 파일의 신용 카드 또는 직불 카드 ID입니다.
청구서 번호	invoices.invoice_number	string	사용자에게 친숙한 청구서 번호입니다.
제목	invoices.title	string	청구서의 제목입니다.
Description	invoices.description	string	설명입니다.
예약됨	invoices.scheduled_at	string	청구서 처리가 예약된 타임스탬프(RFC 3339 형식)입니다. 청구서가 게시된 후 Square는 배달 방법 및 결제 요청 설정에 따라 지정된 날짜에 청구서를 처리합니다.
상태	invoices.status	string	이 개체의 현재 확인 상태입니다.
Timezone	invoices.timezone	string	청구서에서 달력 날짜를 해석하는 데 사용되는 표준 시간대(예: due_date)입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
만든 위치에서	invoices.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	invoices.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
고객 ID	invoices.primary_recipient.customer_id	string	카드와 연결할 고객의 ID입니다.
이름 (주어진 이름)	invoices.primary_recipient.given_name	string	받는 사람의 이름(즉, 첫 번째)입니다.
성	invoices.primary_recipient.family_name	string	받는 사람의 가족(즉, 성)입니다.
이메일 주소	invoices.primary_recipient.email_address	string	받는 사람의 전자 메일 주소입니다.
전화 번호	invoices.primary_recipient.phone_number	string	받는 사람의 전화 번호입니다.
Card	invoices.accepted_payment_methods.card	boolean	신용 카드 또는 직불 카드 결제가 허용되는지 여부를 나타냅니다.
정사각형 기프트 카드	invoices.accepted_payment_methods.square_gift_card	boolean	Square 기프트 카드 결제가 허용되는지 여부를 나타냅니다.
은행 계좌	invoices.accepted_payment_methods.bank_account	boolean	은행 송금 결제가 허용되는지 여부를 나타냅니다.
사용자 지정 필드	invoices.custom_fields	array of object
라벨	invoices.custom_fields.label	string	사용자 지정 필드의 레이블 또는 제목입니다.
가치	invoices.custom_fields.value	string	사용자 정의 필드의 텍스트입니다.
배치	invoices.custom_fields.placement	string	청구서에 있는 사용자 지정 필드의 위치
배달 방법	invoices.delivery_method	string	Square에서 고객에게 송장, 미리 알림 및 영수증을 보내는 데 사용하는 배달 방법입니다.
판매 또는 서비스 날짜	invoices.sale_or_service_date	string	판매 날짜 또는 서비스가 렌더링되는 날짜(YYYY-MM-DD 형식)입니다. 이 필드는 청구서에 표시되는 과거 또는 이후 날짜를 지정하는 데 사용할 수 있습니다.
공용 URL	invoices.public_url	string	Square 호스팅 송장 페이지의 URL입니다. PublishInvoice 엔드포인트를 사용하여 청구서를 게시한 후 Square는 청구서 페이지를 호스트하고 응답에서 페이지 URL을 반환합니다.
금액	invoices.next_payment_amount_money.amount	integer	금액입니다.
통화	invoices.next_payment_amount_money.currency	string	통화입니다.
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

청구서 만들기

작업 ID:: InvoiceCreate

Orders API를 사용하여 만든 주문에 대한 초안 청구서를 만듭니다. 초안 청구서는 계정에 남아 있으며 아무런 조치도 취하지 않습니다. Square에서 처리하려면 먼저 청구서를 게시해야 합니다(고객의 전자 메일 주소로 보내거나 파일에서 고객의 카드를 청구).

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
위치 ID	location_id	string	위치의 식별자입니다.
주문 ID	order_id	string	주문의 ID입니다.
예약됨	scheduled_at	string	처리가 예약된 타임스탬프(RFC 3339 형식)입니다.
고객 ID	customer_id	string	주문과 연결된 고객의 ID입니다.
배달 방법	delivery_method	string	Square에서 고객에게 송장, 미리 알림 및 영수증을 보내는 데 사용하는 배달 방법입니다. 청구서가 게시된 후 Square는 지정된 경우 즉시 또는 scheduled_at 날짜에 배달 방법 및 지불 요청 설정에 따라 청구서를 처리합니다.
요청 유형	request_type	string	결제 요청 유형을 식별합니다. 이 유형은 지불 요청 금액이 결정되는 방법을 정의합니다.
기한	due_date	string	YYYY-MM-DD 형식의 지불 요청 기한입니다.
팁 사용	tipping_enabled	boolean	true로 설정하면 고객이 팁을 지불할 수 있는 장소를 제공합니다.
자동 결제 원본	automatic_payment_source	string	자동 결제에 대한 결제 방법입니다.
Message	message	string	메시지입니다.
예약된 상대 날짜	relative_scheduled_days	integer	미리 알림을 보낼 때 결제 요청이 due_date 전(음수) 또는 이후(양수) 일 수입니다.
청구서 번호	invoice_number	string	사용자에게 친숙한 청구서 번호입니다. 값은 위치 내에서 고유합니다. 청구서를 만들 때 제공되지 않으면 Square에서 값을 할당합니다.
제목	title	string	제목입니다.
Description	description	string	설명입니다.
Card	card	boolean	신용 카드 또는 직불 카드 결제가 허용되는지 여부를 나타냅니다.
정사각형 기프트 카드	square_gift_card	boolean	Square 기프트 카드 결제가 허용되는지 여부를 나타냅니다.
은행 계좌	bank_account	boolean	은행 송금 결제가 허용되는지 여부를 나타냅니다.
라벨	label	string	사용자 지정 필드의 레이블 또는 제목입니다.
가치	value	string	사용자 정의 필드의 텍스트입니다.
배치	placement	string	청구서에 있는 사용자 지정 필드의 위치입니다.
판매 또는 서비스 날짜	sale_or_service_date	string	판매 날짜 또는 서비스가 렌더링되는 날짜(YYYY-MM-DD 형식)입니다. 이 필드는 청구서에 표시되는 과거 또는 이후 날짜를 지정하는 데 사용할 수 있습니다.

반환

Name	경로	형식	Description
아이디	invoice.id	string	Square에서 발급한 고유한 식별자입니다.
버전	invoice.version	integer	이 개체의 현재 버전입니다.
위치 ID	invoice.location_id	string	위치의 식별자입니다.
주문 ID	invoice.order_id	string	주문의 ID입니다.
결제 요청	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	정사각형으로 생성된 ID입니다.
요청 유형	invoice.payment_requests.request_type	string	결제 요청 유형을 식별합니다. 이 유형은 지불 요청 금액이 결정되는 방법을 정의합니다.
기한	invoice.payment_requests.due_date	string	YYYY-MM-DD 형식의 지불 요청 기한입니다.
팁 사용	invoice.payment_requests.tipping_enabled	boolean	true로 설정하면 고객이 팁을 지불할 수 있는 장소를 제공합니다.
미리 알림	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	정사각형 할당 ID입니다.
예약된 상대 날짜	invoice.payment_requests.reminders.relative_scheduled_days	integer	미리 알림을 보낼 때 결제 요청이 due_date 전(음수) 또는 이후(양수) 일 수입니다.
Message	invoice.payment_requests.reminders.message	string	메시지입니다.
상태	invoice.payment_requests.reminders.status	string	현재 상태입니다.
금액	invoice.payment_requests.computed_amount_money.amount	integer	금액입니다.
통화	invoice.payment_requests.computed_amount_money.currency	string	통화입니다.
금액	invoice.payment_requests.total_completed_amount_money.amount	integer	금액입니다.
통화	invoice.payment_requests.total_completed_amount_money.currency	string	통화입니다.
자동 결제 원본	invoice.payment_requests.automatic_payment_source	string	자동 결제에 대한 결제 방법입니다.
청구서 번호	invoice.invoice_number	string	사용자에게 친숙한 청구서 번호입니다. 값은 위치 내에서 고유합니다. 청구서를 만들 때 제공되지 않으면 Square에서 값을 할당합니다.
제목	invoice.title	string	제목입니다.
Description	invoice.description	string	설명입니다.
예약됨	invoice.scheduled_at	string	처리가 예약된 타임스탬프(RFC 3339 형식)입니다.
상태	invoice.status	string	이 개체의 현재 확인 상태입니다.
Timezone	invoice.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
만든 위치에서	invoice.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	invoice.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
고객 ID	invoice.primary_recipient.customer_id	string	주문과 연결된 고객의 ID입니다.
이름 (주어진 이름)	invoice.primary_recipient.given_name	string	받는 사람의 이름(즉, 첫 번째)입니다.
성	invoice.primary_recipient.family_name	string	받는 사람의 가족(즉, 성)입니다.
이메일 주소	invoice.primary_recipient.email_address	string	받는 사람의 전자 메일 주소입니다.
전화 번호	invoice.primary_recipient.phone_number	string	받는 사람의 전화 번호입니다.
Card	invoice.accepted_payment_methods.card	boolean	신용 카드 또는 직불 카드 결제가 허용되는지 여부를 나타냅니다.
정사각형 기프트 카드	invoice.accepted_payment_methods.square_gift_card	boolean	Square 기프트 카드 결제가 허용되는지 여부를 나타냅니다.
은행 계좌	invoice.accepted_payment_methods.bank_account	boolean	은행 송금 결제가 허용되는지 여부를 나타냅니다.
사용자 지정 필드	invoice.custom_fields	array of object
라벨	invoice.custom_fields.label	string	사용자 지정 필드의 레이블 또는 제목입니다.
가치	invoice.custom_fields.value	string	사용자 정의 필드의 텍스트입니다.
배치	invoice.custom_fields.placement	string	청구서에 있는 사용자 지정 필드의 위치입니다.
배달 방법	invoice.delivery_method	string	Square에서 고객에게 송장, 미리 알림 및 영수증을 보내는 데 사용하는 배달 방법입니다. 청구서가 게시된 후 Square는 지정된 경우 즉시 또는 scheduled_at 날짜에 배달 방법 및 지불 요청 설정에 따라 청구서를 처리합니다.
판매 또는 서비스 날짜	invoice.sale_or_service_date	string	판매 날짜 또는 서비스가 렌더링되는 날짜(YYYY-MM-DD 형식)입니다. 이 필드는 청구서에 표시되는 과거 또는 이후 날짜를 지정하는 데 사용할 수 있습니다.

청구서 삭제

작업 ID:: InvoiceDelete

지정된 청구서를 삭제합니다. 청구서가 삭제되면 관련 주문 상태가 CANCELED로 변경됩니다. 초안 청구서만 삭제할 수 있습니다(처리가 예약된 송장을 포함하여 게시된 청구서는 삭제할 수 없음).

매개 변수

Name	키	필수	형식	Description
송장 ID	invoice_id	True	string	청구서의 식별자입니다.
버전	version		integer	삭제할 청구서의 버전입니다.

반환

response: object

청구서 업데이트

작업 ID:: InvoiceUpdate

필드를 수정하거나 필드를 지우거나 둘 다 사용하여 청구서를 업데이트합니다.

매개 변수

Name	키	필수	형식	Description
송장 ID	invoice_id	True	string	청구서의 식별자입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
UID	uid		string	정사각형으로 생성된 ID입니다.
팁 사용	tipping_enabled		boolean	true로 설정하면 고객이 팁을 지불할 수 있는 장소를 제공합니다.
지울 필드	fields_to_clear		array of string

반환

Name	경로	형식	Description
아이디	invoice.id	string	Square에서 발급한 고유한 식별자입니다.
버전	invoice.version	integer	이 개체의 현재 버전입니다.
위치 ID	invoice.location_id	string	위치의 식별자입니다.
주문 ID	invoice.order_id	string	주문의 ID입니다.
결제 요청	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	정사각형으로 생성된 ID입니다.
요청 유형	invoice.payment_requests.request_type	string	결제 요청 유형을 식별합니다. 이 유형은 지불 요청 금액이 결정되는 방법을 정의합니다.
기한	invoice.payment_requests.due_date	string	YYYY-MM-DD 형식의 지불 요청 기한입니다.
팁 사용	invoice.payment_requests.tipping_enabled	boolean	true로 설정하면 고객이 팁을 지불할 수 있는 장소를 제공합니다.
금액	invoice.payment_requests.computed_amount_money.amount	integer	금액입니다.
통화	invoice.payment_requests.computed_amount_money.currency	string	통화입니다.
금액	invoice.payment_requests.total_completed_amount_money.amount	integer	금액입니다.
통화	invoice.payment_requests.total_completed_amount_money.currency	string	통화입니다.
자동 결제 원본	invoice.payment_requests.automatic_payment_source	string	자동 결제에 대한 결제 방법입니다.
청구서 번호	invoice.invoice_number	string	사용자에게 친숙한 청구서 번호입니다. 값은 위치 내에서 고유합니다. 청구서를 만들 때 제공되지 않으면 Square에서 값을 할당합니다.
제목	invoice.title	string	제목입니다.
Description	invoice.description	string	설명입니다.
예약됨	invoice.scheduled_at	string	처리가 예약된 타임스탬프(RFC 3339 형식)입니다.
상태	invoice.status	string	이 개체의 현재 확인 상태입니다.
Timezone	invoice.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
만든 위치에서	invoice.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	invoice.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
고객 ID	invoice.primary_recipient.customer_id	string	주문과 연결된 고객의 ID입니다.
이름 (주어진 이름)	invoice.primary_recipient.given_name	string	받는 사람의 이름(즉, 첫 번째)입니다.
성	invoice.primary_recipient.family_name	string	받는 사람의 가족(즉, 성)입니다.
이메일 주소	invoice.primary_recipient.email_address	string	받는 사람의 전자 메일 주소입니다.
전화 번호	invoice.primary_recipient.phone_number	string	받는 사람의 전화 번호입니다.
금액	invoice.next_payment_amount_money.amount	integer	금액입니다.
통화	invoice.next_payment_amount_money.currency	string	통화입니다.
Card	invoice.accepted_payment_methods.card	boolean	신용 카드 또는 직불 카드 결제가 허용되는지 여부를 나타냅니다.
정사각형 기프트 카드	invoice.accepted_payment_methods.square_gift_card	boolean	Square 기프트 카드 결제가 허용되는지 여부를 나타냅니다.
은행 계좌	invoice.accepted_payment_methods.bank_account	boolean	은행 송금 결제가 허용되는지 여부를 나타냅니다.
사용자 지정 필드	invoice.custom_fields	array of object
라벨	invoice.custom_fields.label	string	사용자 지정 필드의 레이블 또는 제목입니다.
가치	invoice.custom_fields.value	string	사용자 정의 필드의 텍스트입니다.
배치	invoice.custom_fields.placement	string	청구서에 있는 사용자 지정 필드의 위치입니다.
배달 방법	invoice.delivery_method	string	Square에서 고객에게 송장, 미리 알림 및 영수증을 보내는 데 사용하는 배달 방법입니다. 청구서가 게시된 후 Square는 지정된 경우 즉시 또는 scheduled_at 날짜에 배달 방법 및 지불 요청 설정에 따라 청구서를 처리합니다.
판매 또는 서비스 날짜	invoice.sale_or_service_date	string	판매 날짜 또는 서비스가 렌더링되는 날짜(YYYY-MM-DD 형식)입니다. 이 필드는 청구서에 표시되는 과거 또는 이후 날짜를 지정하는 데 사용할 수 있습니다.

청구서 취소

작업 ID:: InvoiceCancel

청구서를 취소합니다. 판매자는 취소된 청구서에 대한 결제를 수집할 수 없습니다.

매개 변수

Name	키	필수	형식	Description
송장 ID	invoice_id	True	string	청구서의 식별자입니다.
버전	version		integer	버전입니다.

반환

Name	경로	형식	Description
아이디	invoice.id	string	Square에서 발급한 고유한 식별자입니다.
버전	invoice.version	integer	이 개체의 현재 버전입니다.
위치 ID	invoice.location_id	string	위치의 식별자입니다.
주문 ID	invoice.order_id	string	주문의 ID입니다.
결제 요청	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	정사각형으로 생성된 ID입니다.
요청 유형	invoice.payment_requests.request_type	string	결제 요청 유형을 식별합니다. 이 유형은 지불 요청 금액이 결정되는 방법을 정의합니다.
기한	invoice.payment_requests.due_date	string	YYYY-MM-DD 형식의 지불 요청 기한입니다.
팁 사용	invoice.payment_requests.tipping_enabled	boolean	true로 설정하면 고객이 팁을 지불할 수 있는 장소를 제공합니다.
미리 알림	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	정사각형 할당 ID입니다.
예약된 상대 날짜	invoice.payment_requests.reminders.relative_scheduled_days	integer	미리 알림을 보낼 때 결제 요청이 due_date 전(음수) 또는 이후(양수) 일 수입니다.
Message	invoice.payment_requests.reminders.message	string	메시지입니다.
상태	invoice.payment_requests.reminders.status	string	현재 상태입니다.
금액	invoice.payment_requests.computed_amount_money.amount	integer	금액입니다.
통화	invoice.payment_requests.computed_amount_money.currency	string	통화입니다.
금액	invoice.payment_requests.total_completed_amount_money.amount	integer	금액입니다.
통화	invoice.payment_requests.total_completed_amount_money.currency	string	통화입니다.
자동 결제 원본	invoice.payment_requests.automatic_payment_source	string	자동 결제에 대한 결제 방법입니다.
청구서 번호	invoice.invoice_number	string	사용자에게 친숙한 청구서 번호입니다. 값은 위치 내에서 고유합니다. 청구서를 만들 때 제공되지 않으면 Square에서 값을 할당합니다.
제목	invoice.title	string	제목입니다.
Description	invoice.description	string	설명입니다.
예약됨	invoice.scheduled_at	string	처리가 예약된 타임스탬프(RFC 3339 형식)입니다.
상태	invoice.status	string	이 개체의 현재 확인 상태입니다.
Timezone	invoice.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
만든 위치에서	invoice.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	invoice.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
고객 ID	invoice.primary_recipient.customer_id	string	주문과 연결된 고객의 ID입니다.
이름 (주어진 이름)	invoice.primary_recipient.given_name	string	받는 사람의 이름(즉, 첫 번째)입니다.
성	invoice.primary_recipient.family_name	string	받는 사람의 가족(즉, 성)입니다.
이메일 주소	invoice.primary_recipient.email_address	string	받는 사람의 전자 메일 주소입니다.
전화 번호	invoice.primary_recipient.phone_number	string	받는 사람의 전화 번호입니다.
Card	invoice.accepted_payment_methods.card	boolean	신용 카드 또는 직불 카드 결제가 허용되는지 여부를 나타냅니다.
정사각형 기프트 카드	invoice.accepted_payment_methods.square_gift_card	boolean	Square 기프트 카드 결제가 허용되는지 여부를 나타냅니다.
은행 계좌	invoice.accepted_payment_methods.bank_account	boolean	은행 송금 결제가 허용되는지 여부를 나타냅니다.
사용자 지정 필드	invoice.custom_fields	array of object
라벨	invoice.custom_fields.label	string	사용자 지정 필드의 레이블 또는 제목입니다.
가치	invoice.custom_fields.value	string	사용자 정의 필드의 텍스트입니다.
배치	invoice.custom_fields.placement	string	청구서에 있는 사용자 지정 필드의 위치입니다.
배달 방법	invoice.delivery_method	string	Square에서 고객에게 송장, 미리 알림 및 영수증을 보내는 데 사용하는 배달 방법입니다. 청구서가 게시된 후 Square는 지정된 경우 즉시 또는 scheduled_at 날짜에 배달 방법 및 지불 요청 설정에 따라 청구서를 처리합니다.
판매 또는 서비스 날짜	invoice.sale_or_service_date	string	판매 날짜 또는 서비스가 렌더링되는 날짜(YYYY-MM-DD 형식)입니다. 이 필드는 청구서에 표시되는 과거 또는 이후 날짜를 지정하는 데 사용할 수 있습니다.

카드 검색

작업 ID:: CardRetrieve

특정 카드에 대한 세부 정보를 검색합니다.

매개 변수

Name	키	필수	형식	Description
카드 ID	card_id	True	string	카드의 식별자입니다.

반환

Name	경로	형식	Description
아이디	card.id	string	Square에서 발급한 고유한 식별자입니다.
주소 줄 1	card.billing_address.address_line_1	string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
주소 줄 2	card.billing_address.address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	card.billing_address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	card.billing_address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	card.billing_address.postal_code	string	주소의 우편 번호입니다.
국가	card.billing_address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
지문	card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
빈	card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
카드 브랜드	card.card_brand	string	카드의 브랜드입니다.
카드 종류	card.card_type	string	카드의 유형입니다.
카드 소유자 이름	card.cardholder_name	string	카드 소유자의 이름입니다.
고객 ID	card.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
활성화됨	card.enabled	boolean	사용 여부입니다.
Exp 월	card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
마지막 4	card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
선불 유형	card.prepaid_type	string	카드가 선불인지 여부를 나타냅니다.
참조 ID	card.reference_id	string	선택적 사용자 정의 참조 ID입니다.
버전	card.version	integer	이 개체의 현재 버전입니다.

카드 나열

작업 ID:: CardList

요청을 만드는 계정이 소유한 카드 목록을 검색합니다.

매개 변수

Name	키	형식	Description
Cursor	cursor	string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
고객 ID	customer_id	string	제공된 고객과 연결된 카드로 결과를 제한합니다. 기본적으로 판매자가 소유한 모든 카드가 반환됩니다.
사용 안 함 포함	include_disabled	boolean	사용할 수 없는 카드가 포함되어 있습니다. 기본적으로 판매자가 소유한 모든 사용 가능한 카드가 반환됩니다.
참조 ID	reference_id	string	제공된 reference_id 연결된 카드로 결과를 제한합니다.
정렬 순서	sort_order	string	지정된 순서로 카드를 만든 시점을 기준으로 반환된 목록을 정렬합니다.

반환

Name	경로	형식	Description
Cards	cards	array of object
아이디	cards.card.id	string	개체의 식별자입니다.
주소 줄 1	cards.card.billing_address.address_line_1	string	address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
주소 줄 2	cards.card.billing_address.address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	cards.card.billing_address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	cards.card.billing_address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	cards.card.billing_address.postal_code	string	주소의 우편 번호입니다.
국가	cards.card.billing_address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
지문	cards.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
빈	cards.card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
카드 브랜드	cards.card.card_brand	string	카드의 브랜드입니다.
카드 종류	cards.card.card_type	string	카드의 유형입니다.
카드 소유자 이름	cards.card.cardholder_name	string	카드 소유자의 이름입니다.
고객 ID	cards.card.customer_id	string	카드와 연결할 고객의 ID입니다.
활성화됨	cards.card.enabled	boolean	개체를 사용할 수 있는지 여부를 나타냅니다.
만료 월	cards.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
만료 연도	cards.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
마지막 4	cards.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
선불 유형	cards.card.prepaid_type	string	카드가 선불인지 여부를 나타냅니다.
참조 ID	cards.card.reference_id	string	이 카드를 외부 시스템의 다른 엔터티와 연결하는 선택적 사용자 정의 참조 ID입니다.
버전	cards.card.version	integer	카드의 현재 버전 번호입니다. 각 카드 업데이트가 증가합니다. 요청의 버전이 카드의 현재 버전과 일치하지 않는 한 기존 Card 개체를 업데이트하는 요청은 거부됩니다.

카드 만들기

작업 ID:: CardCreate

기존 가맹점에 파일의 카드를 추가합니다.

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	idempotency 키입니다.
원본 ID	source_id	string	원본의 식별자입니다.
주소 줄 1	address_line_1	string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
주소 줄 2	address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	postal_code	string	주소의 우편 번호입니다.
국가	country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
카드 소유자 이름	cardholder_name	string	카드 소유자의 이름입니다.
고객 ID	customer_id	string	고객을 나타내는 이 개체의 ID입니다.
참조 ID	reference_id	string	선택적 사용자 정의 참조 ID입니다.

반환

Name	경로	형식	Description
아이디	card.id	string	Square에서 발급한 고유한 식별자입니다.
주소 줄 1	card.billing_address.address_line_1	string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
주소 줄 2	card.billing_address.address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	card.billing_address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	card.billing_address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	card.billing_address.postal_code	string	주소의 우편 번호입니다.
국가	card.billing_address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
지문	card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
빈	card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
카드 브랜드	card.card_brand	string	카드의 브랜드입니다.
카드 종류	card.card_type	string	카드의 유형입니다.
카드 소유자 이름	card.cardholder_name	string	카드 소유자의 이름입니다.
고객 ID	card.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
활성화됨	card.enabled	boolean	사용 여부입니다.
Exp 월	card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
마지막 4	card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
선불 유형	card.prepaid_type	string	카드가 선불인지 여부를 나타냅니다.
참조 ID	card.reference_id	string	선택적 사용자 정의 참조 ID입니다.
버전	card.version	integer	이 개체의 현재 버전입니다.

카드 사용 안 함

작업 ID:: CardDisable

카드를 사용하지 않도록 설정하여 추가 업데이트 또는 요금을 방지합니다. 이미 사용하지 않도록 설정된 카드를 사용하지 않도록 설정할 수 있지만 아무런 효과가 없습니다.

매개 변수

Name	키	필수	형식	Description
카드 ID	card_id	True	string	카드의 식별자입니다.

반환

Name	경로	형식	Description
아이디	card.id	string	Square에서 발급한 고유한 식별자입니다.
주소 줄 1	card.billing_address.address_line_1	string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
주소 줄 2	card.billing_address.address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	card.billing_address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	card.billing_address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	card.billing_address.postal_code	string	주소의 우편 번호입니다.
국가	card.billing_address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
지문	card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
빈	card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
카드 브랜드	card.card_brand	string	카드의 브랜드입니다.
카드 종류	card.card_type	string	카드의 유형입니다.
카드 소유자 이름	card.cardholder_name	string	카드 소유자의 이름입니다.
고객 ID	card.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
활성화됨	card.enabled	boolean	사용 여부입니다.
Exp 월	card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
마지막 4	card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
선불 유형	card.prepaid_type	string	카드가 선불인지 여부를 나타냅니다.
참조 ID	card.reference_id	string	선택적 사용자 정의 참조 ID입니다.
버전	card.version	integer	이 개체의 현재 버전입니다.

카탈로그 개체 검색

작업 ID:: CatalogRetrieve

제공된 ID에 따라 단일 CatalogItem을 CatalogObject로 반환합니다. 반환된 개체에는 CatalogItemVariation 자식, CatalogModifierList 개체에 대한 참조 및 해당 개체에 적용되는 CatalogTax 개체의 ID를 비롯한 모든 관련 CatalogItem 정보가 포함됩니다.

매개 변수

Name	키	필수	형식	Description
오브젝트 ID	object_id	True	string	개체의 식별자입니다.
관련 개체 포함	include_related_objects		boolean	true이면 응답에 요청된 개체와 관련된 추가 개체가 포함됩니다. 응답의 개체 필드에 CatalogItem이 포함된 경우 연결된 CatalogCategory, CatalogTax, CatalogImage 및 CatalogModifierList 개체가 응답의 related_objects 필드에 반환됩니다. 응답의 개체 필드에 CatalogItemVariation이 포함되어 있으면 해당 부모 CatalogItem이 응답의 related_objects 필드에 반환됩니다.

반환

Name	경로	형식	Description
유형	object.type	string	이 개체의 형식입니다.
아이디	object.id	string	Square에서 발급한 고유한 식별자입니다.
업데이트 날짜	object.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
버전	object.version	integer	이 개체의 현재 버전입니다.
삭제됨	object.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
present_at_all_locations	object.present_at_all_locations	boolean	true이면 이 개체는 absent_at_location_ids 필드에 지정된 위치를 제외한 모든 위치(이후 위치 포함)에 있습니다. false이면 이 개체는 present_at_location_ids 필드에 지정된 위치를 제외하고 이후 위치와 같은 위치에 없습니다. 지정하지 않으면 기본값은 true입니다.
이름	object.item_data.name	string	이름입니다.
Description	object.item_data.title	string	항목의 설명입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
범주 ID	object.item_data.category_id	string	항목 범주의 ID(있는 경우)입니다.
세금 ID	object.item_data.tax_ids	array of string
Variations	object.item_data.variations	array of object
유형	object.item_data.variations.type	string	이 개체의 형식입니다.
아이디	object.item_data.variations.id	string	카탈로그에서 이 개체를 참조할 식별자입니다.
업데이트 날짜	object.item_data.variations.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프입니다.
버전	object.item_data.variations.version	integer	개체의 버전입니다. 개체를 업데이트할 때 제공된 버전은 데이터베이스의 버전과 일치해야 합니다. 그렇지 않으면 쓰기가 충돌하는 것으로 거부됩니다.
삭제됨	object.item_data.variations.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
모든 위치에 있음	object.item_data.variations.present_at_all_locations	boolean	true이면 이 개체는 absent_at_location_ids 필드에 지정된 위치를 제외한 모든 위치(이후 위치 포함)에 있습니다. false이면 이 개체는 present_at_location_ids 필드에 지정된 위치를 제외하고 이후 위치와 같은 위치에 없습니다. 지정하지 않으면 기본값은 true입니다.
항목 ID	object.item_data.variations.item_variation_data.item_id	string	이 항목 변형과 연결된 CatalogItem의 ID입니다.
이름	object.item_data.variations.item_variation_data.name	string	항목 변형의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
서수	object.item_data.variations.item_variation_data.ordinal	integer	이 항목 변형을 표시해야 하는 순서입니다. 이 값은 읽기 전용입니다. 쓰기 시 부모 CatalogItem 내의 각 항목 변형에 대한 서수는 항목 변형의 위치에 따라 설정됩니다. 읽기 시 값이 순차적이거나 고유하지는 않습니다.
가격 책정 유형	object.item_data.variations.item_variation_data.pricing_type	string	판매 시 항목 변형의 가격이 고정되었는지 또는 결정되는지 여부를 나타냅니다.
금액	object.item_data.variations.item_variation_data.price_money.amount	integer	금액입니다.
통화	object.item_data.variations.item_variation_data.price_money.currency	string	통화입니다.

카탈로그 개체 검색

작업 ID:: CatalogSearch

지정된 쿼리 필터 중 하나 이상에 대해 항목 또는 항목 변형에 대한 사용자 지정 특성 값을 제외하고 지원되는 검색 특성 값을 일치시켜 모든 형식의 CatalogObject를 검색합니다.

매개 변수

Name	키	형식	Description
개체 형식	object_types	array of string
특성 이름	attribute_name	string	검색할 특성의 이름입니다.
특성 접두사	attribute_prefix	string	검색 특성 값의 원하는 접두사입니다.
한계	limit	integer	단일 페이지에서 반환할 결과 수에 대한 제한입니다. 제한은 권고입니다. 구현은 더 많거나 적은 결과를 반환할 수 있습니다. 제공된 제한이 음수, 0 또는 최대 제한인 1,000보다 높은 경우 무시됩니다.

반환

Name	경로	형식	Description
개체	objects	array of object
유형	objects.type	string	이 개체의 형식입니다.
아이디	objects.id	string	Square에서 발급한 고유한 식별자입니다.
업데이트 날짜	objects.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
버전	objects.version	integer	개체의 현재 버전입니다.
삭제됨	objects.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
모든 위치에 있음	objects.present_at_all_locations	boolean	true이면 이 개체는 absent_at_location_ids 필드에 지정된 위치를 제외한 모든 위치(이후 위치 포함)에 있습니다. false이면 이 개체는 present_at_location_ids 필드에 지정된 위치를 제외하고 이후 위치와 같은 위치에 없습니다. 지정하지 않으면 기본값은 true입니다.
이름	objects.item_data.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
Description	objects.item_data.title	string	항목의 설명입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
범주 ID	objects.item_data.category_id	string	항목 범주의 ID(있는 경우)입니다.
제품 유형	objects.item_data.product_type	string	제품 유형은 지정된 제품 유형을 가진 항목 또는 항목 변형을 반환하기 위해 식을 쿼리합니다.
세금 ID	objects.item_data.tax_ids	array of string
Variations	objects.item_data.variations	array of object
유형	objects.item_data.variations.type	string	이 개체의 형식입니다. 각 개체 형식에는 아래의 해당 *_data 필드 내에서 구조화된 형식으로 표현되는 예상 속성이 있습니다.
아이디	objects.item_data.variations.id	string	이 개체를 참조할 식별자입니다.
업데이트 날짜	objects.item_data.variations.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
버전	objects.item_data.variations.version	integer	개체의 버전입니다. 개체를 업데이트할 때 제공된 버전은 데이터베이스의 버전과 일치해야 합니다. 그렇지 않으면 쓰기가 충돌하는 것으로 거부됩니다.
삭제됨	objects.item_data.variations.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
모든 위치에 있음	objects.item_data.variations.present_at_all_locations	boolean	present_at_all_locations false인 경우에도 개체가 있는 위치 목록입니다. 여기에는 비활성화된 위치가 포함될 수 있습니다.
항목 ID	objects.item_data.variations.item_variation_data.item_id	string	이 항목 변형이 있는 개체의 ID입니다.
이름	objects.item_data.variations.item_variation_data.name	string	이 항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
서수	objects.item_data.variations.item_variation_data.ordinal	integer	이 항목 변형을 표시해야 하는 순서입니다. 이 값은 읽기 전용입니다.
금액	objects.item_data.variations.item_variation_data.price_money.amount	integer	통화로 표시된 통화의 가장 작은 교단에 있는 금액입니다. 예를 들어 통화가 USD인 경우 금액은 센트 단위입니다. 금액은 양수 또는 음수일 수 있습니다. 특정 사례에서 기호의 의미를 확인하려면 특정 필드 설명을 참조하세요.
통화	objects.item_data.variations.item_variation_data.price_money.currency	string	ISO 4217 형식의 통화 형식입니다. 예를 들어 미국 달러의 통화 코드는 USD입니다.
가격 책정 유형	objects.item_data.variations.item_variation_data.pricing_type	string	판매 시 항목 변형의 가격이 고정되었는지 또는 결정되는지 여부를 나타냅니다.
가시성	objects.item_data.visibility	string	표시 유형입니다.

카탈로그 개체 삭제

작업 ID:: CatalogDelete

제공된 ID에 따라 단일 CatalogObject를 삭제하고 응답에서 성공적으로 삭제된 ID 집합을 반환합니다. 삭제는 대상 개체의 모든 자식도 삭제되는 연속 이벤트입니다. 예를 들어 CatalogItem을 삭제하면 CatalogItemVariation 자식도 모두 삭제됩니다.

매개 변수

Name	키	필수	형식	Description
오브젝트 ID	object_id	True	string	개체의 식별자입니다.

반환

Name	경로	형식	Description
삭제된 개체 ID	deleted_object_ids	array of string
삭제됨	deleted_at	string	이 삭제의 데이터베이스 타임스탬프(RFC 3339 형식)

카탈로그 나열

작업 ID:: CatalogList

카탈로그에 원하는 형식 집합의 모든 개체(예: 모든 CatalogItem 및 CatalogTax 개체)가 포함된 CatalogObjects 목록을 반환합니다. ListCatalog는 삭제된 카탈로그 항목을 반환하지 않습니다.

매개 변수

Name	키	필수	형식	Description
Cursor	cursor		integer	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
유형	types		string	검색할 개체 형식의 선택적 대/소문자를 구분하지 않는 쉼표로 구분된 목록입니다. 유효한 값은 ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST 또는 IMAGE를 포함하여 CatalogObjectType 열거형에 정의됩니다. 지정되지 않은 경우 작업은 요청을 만드는 데 사용되는 Square API 버전에서 모든 형식의 개체를 반환합니다.

반환

Name	경로	형식	Description
개체	objects	array of object
유형	objects.type	string	이 개체의 형식입니다.
아이디	objects.id	string	Square에서 발급한 고유한 식별자입니다.
업데이트 날짜	objects.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
버전	objects.version	integer	개체의 현재 버전입니다.
삭제됨	objects.is_deleted	boolean	true이면 개체가 데이터베이스에서 삭제되었습니다. 삽입할 새 개체의 경우 false여야 합니다. 삭제되면 updated_at 필드는 삭제 시간과 같습니다.
모든 위치에 있음	objects.present_at_all_locations	boolean	true이면 이 개체는 absent_at_location_ids 필드에 지정된 위치를 제외한 모든 위치(이후 위치 포함)에 있습니다. false이면 이 개체는 present_at_location_ids 필드에 지정된 위치를 제외하고 이후 위치와 같은 위치에 없습니다. 지정하지 않으면 기본값은 true입니다.
이름	objects.category_data.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
이름	objects.tax_data.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
계산 단계	objects.tax_data.calculation_phase	string	납부액의 소계 또는 합계를 기준으로 세금이 계산되는지 여부입니다.
포함 유형	objects.tax_data.inclusion_type	string	세금이 ADDITIVE인지 아니면 INCLUSIVE인지 여부입니다.
백분율	objects.tax_data.percentage	string	'.'을 10진수 구분 기호로 사용하고 '%' 기호 없이 사용하는 10진수 형식의 백분율입니다. 값 7.5는 7.5%해당합니다.
활성화됨	objects.tax_data.enabled	boolean	개체를 사용할 수 있는지 여부를 나타냅니다.

카탈로그 정보

작업 ID:: CatalogInfo

BatchUpsertCatalogObjects 엔드포인트에서 사용할 수 있는 일괄 처리 크기 제한과 같은 Square Catalog API에 대한 정보를 검색합니다.

반환

Name	경로	형식	Description
Batch당 Batch Upsert 최대 개체 수	limits.batch_upsert_max_objects_per_batch	integer	/v2/catalog/batch-upsert 요청에서 단일 일괄 처리 내에 나타날 수 있는 최대 개체 수입니다.
Batch Upsert Max Total Objects	limits.batch_upsert_max_total_objects	integer	/v2/catalog/batch-upsert 요청의 모든 일괄 처리에 나타날 수 있는 최대 개체 수입니다.
Batch 검색 최대 개체 ID	limits.batch_retrieve_max_object_ids	integer	/v2/catalog/batch-retrieve 요청에 나타날 수 있는 최대 개체 ID 수입니다.
최대 페이지 제한 검색	limits.search_max_page_limit	integer	/v2/catalog/search 응답의 페이지에서 반환될 수 있는 최대 결과 수입니다.
일괄 처리 삭제 최대 개체 ID	limits.batch_delete_max_object_ids	integer	단일 /v2/catalog/batch-delete 요청에 포함될 수 있는 최대 개체 ID 수입니다.
항목 세금 최대 항목 ID 업데이트	limits.update_item_taxes_max_item_ids	integer	단일 /v2/catalog/update-item-taxes 요청에 포함될 수 있는 최대 항목 ID 수입니다.
사용하도록 항목 세금 최대 세금 업데이트	limits.update_item_taxes_max_taxes_to_enable	integer	단일 /v2/catalog/update-item-tax 요청에 포함될 수 있는 사용할 최대 세금 ID 수입니다.
사용하지 않도록 항목 세금 최대 세금 업데이트	limits.update_item_taxes_max_taxes_to_disable	integer	단일 /v2/catalog/update-item-tax 요청에 포함될 수 있는 비활성화할 최대 세금 ID 수입니다.
업데이트 항목 한정자 목록 최대 항목 ID	limits.update_item_modifier_lists_max_item_ids	integer	단일 /v2/catalog/update-item-tax 요청에 포함될 수 있는 비활성화할 최대 세금 ID 수입니다.
사용하도록 항목 한정자 목록 최대 한정자 목록 업데이트	limits.update_item_modifier_lists_max_modifier_lists_to_enable	integer	단일 /v2/catalog/update-item-modifier-lists 요청에 포함될 수 있는 사용하도록 설정할 최대 한정자 목록 ID 수입니다.
사용하지 않도록 항목 한정자 목록 최대 한정자 목록 업데이트	limits.update_item_modifier_lists_max_modifier_lists_to_disable	integer	단일 /v2/catalog/update-item-modifier-lists 요청에 포함될 수 있는 사용하지 않도록 설정할 최대 한정자 목록 ID 수입니다.

터미널 체크 아웃 가져오기

작업 ID:: TerminalGetCheckout

checkout_id 터미널 체크 아웃 요청을 검색합니다.

매개 변수

Name	키	필수	형식	Description
체크 아웃 ID	checkout_id	True	string	체크 아웃의 식별자입니다.

반환

Name	경로	형식	Description
아이디	checkout.id	string	Square에서 발급한 고유한 식별자입니다.
금액	checkout.amount_money.amount	integer	금액입니다.
통화	checkout.amount_money.currency	string	통화입니다.
참조 ID	checkout.reference_id	string	선택적 사용자 정의 참조 ID입니다.
비고	checkout.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
디바이스 ID	checkout.device_options.device_id	string	이 TerminalCheckout에 대한 디바이스의 고유 ID입니다.
팁 허용	checkout.device_options.tip_settings.allow_tipping	boolean	이 체크 아웃에 팁이 사용되는지 여부를 나타냅니다. 기본값은 false입니다.
영수증 화면 건너뛰기	checkout.device_options.skip_receipt_screen	boolean	영수증 화면을 건너뛰도록 디바이스에 지시합니다. 기본값은 false입니다.
상태	checkout.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	checkout.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	checkout.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
앱 아이디	checkout.app_id	string	체크 아웃을 만든 애플리케이션의 ID입니다.
최종 기한 기간	checkout.deadline_duration	string	RFC 3339 기간이 지나면 체크 아웃이 자동으로 취소됩니다. PENDING인 TerminalCheckout은 자동으로 취소되며 취소 사유가 TIMED_OUT. 기본값: 생성 후 5분

터미널 체크 아웃 검색

작업 ID:: TerminalSearchCheckouts

요청을 만드는 계정에서 만든 터미널 체크 아웃 요청의 필터링된 목록을 검색합니다.

매개 변수

Name	키	필수	형식	Description
한계	limit		integer	단일 페이지에서 반환할 결과 수에 대한 제한입니다. 제한은 권고입니다. 구현은 더 많거나 적은 결과를 반환할 수 있습니다. 제공된 제한이 음수, 0 또는 최대 제한인 1,000보다 높은 경우 무시됩니다.
상태	status		string	현재 상태입니다.

반환

Name	경로	형식	Description
체크 아웃	checkouts	array of object
아이디	checkouts.id	string	Square에서 발급한 고유한 식별자입니다.
금액	checkouts.amount_money.amount	integer	금액입니다.
통화	checkouts.amount_money.currency	string	통화입니다.
참조 ID	checkouts.reference_id	string	고객 프로필을 다른 시스템의 엔터티와 연결하는 데 사용되는 선택적 두 번째 ID입니다.
비고	checkouts.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
디바이스 ID	checkouts.device_options.device_id	string	이 TerminalCheckout에 대한 디바이스의 고유 ID입니다.
팁 허용	checkouts.device_options.tip_settings.allow_tipping	boolean	이 체크 아웃에 팁이 사용되는지 여부를 나타냅니다. 기본값은 false입니다.
영수증 화면 건너뛰기	checkouts.device_options.skip_receipt_screen	boolean	영수증 화면을 건너뛰도록 디바이스에 지시합니다. 기본값은 false입니다.
상태	checkouts.status	string	이 개체의 현재 확인 상태입니다.
결제 ID	checkouts.payment_ids	array of string
만든 위치에서	checkouts.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	checkouts.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
앱 아이디	checkouts.app_id	string	체크 아웃을 만든 애플리케이션의 ID입니다.
최종 기한 기간	checkouts.deadline_duration	string	RFC 3339 기간이 지나면 체크 아웃이 자동으로 취소됩니다. PENDING인 TerminalCheckout은 자동으로 취소되며 취소 사유가 TIMED_OUT. 기본값: 생성 후 5분
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

터미널 체크 아웃 만들기

작업 ID:: TerminalCreateCheckout

터미널 체크 아웃 요청을 만들고 지정된 디바이스로 보내 요청된 금액에 대한 결제를 수행합니다.

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
금액	amount	integer	금액입니다.
통화	currency	string	통화입니다.
참조 ID	reference_id	string	선택적 사용자 정의 참조 ID입니다.
디바이스 ID	device_id	string	이 TerminalCheckout에 대한 디바이스의 고유 ID입니다.
비고	note	string	고객 프로필과 연결된 사용자 지정 메모입니다.

반환

Name	경로	형식	Description
아이디	checkout.id	string	Square에서 발급한 고유한 식별자입니다.
금액	checkout.amount_money.amount	integer	금액입니다.
통화	checkout.amount_money.currency	string	통화입니다.
참조 ID	checkout.reference_id	string	선택적 사용자 정의 참조 ID입니다.
비고	checkout.note	string	고객 프로필과 연결된 사용자 지정 메모입니다.
디바이스 ID	checkout.device_options.device_id	string	이 TerminalCheckout에 대한 디바이스의 고유 ID입니다.
팁 허용	checkout.device_options.tip_settings.allow_tipping	boolean	이 체크 아웃에 팁이 사용되는지 여부를 나타냅니다. 기본값은 false입니다.
영수증 화면 건너뛰기	checkout.device_options.skip_receipt_screen	boolean	영수증 화면을 건너뛰도록 디바이스에 지시합니다. 기본값은 false입니다.
상태	checkout.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	checkout.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	checkout.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
앱 아이디	checkout.app_id	string	체크 아웃을 만든 애플리케이션의 ID입니다.
최종 기한 기간	checkout.deadline_duration	string	RFC 3339 기간이 지나면 체크 아웃이 자동으로 취소됩니다. PENDING인 TerminalCheckout은 자동으로 취소되며 취소 사유가 TIMED_OUT. 기본값: 생성 후 5분
결제 유형	checkout.payment_type	string	터미널에서 캡처해야 하는 결제 유형입니다. 기본값은 CARD_PRESENT.

터미널 체크 아웃 취소

작업 ID:: TerminalCancelCheckout

요청 상태가 허용하는 경우 터미널 체크 아웃 요청을 취소합니다.

매개 변수

Name	키	필수	형식	Description
체크 아웃 ID	checkout_id	True	string	체크 아웃의 식별자입니다.

반환

Name	경로	형식	Description
아이디	checkout.id	string	Square에서 발급한 고유한 식별자입니다.
금액	checkout.amount_money.amount	integer	금액입니다.
통화	checkout.amount_money.currency	string	통화입니다.
참조 ID	checkout.reference_id	string	선택적 사용자 정의 참조 ID입니다.
디바이스 ID	checkout.device_options.device_id	string	이 TerminalCheckout에 대한 디바이스의 고유 ID입니다.
팁 허용	checkout.device_options.tip_settings.allow_tipping	boolean	이 체크 아웃에 팁이 사용되는지 여부를 나타냅니다. 기본값은 false입니다.
영수증 화면 건너뛰기	checkout.device_options.skip_receipt_screen	boolean	영수증 화면을 건너뛰도록 디바이스에 지시합니다. 기본값은 false입니다.
상태	checkout.status	string	이 개체의 현재 확인 상태입니다.
취소 이유	checkout.cancel_reason	string	취소된 트랜잭션의 이유입니다.
만든 위치에서	checkout.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	checkout.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
앱 아이디	checkout.app_id	string	체크 아웃을 만든 애플리케이션의 ID입니다.
최종 기한 기간	checkout.deadline_duration	string	RFC 3339 기간이 지나면 체크 아웃이 자동으로 취소됩니다. PENDING인 TerminalCheckout은 자동으로 취소되며 취소 사유가 TIMED_OUT. 기본값: 생성 후 5분

터미널 환불 검색

작업 ID:: TerminalSearchRefunds

요청을 만드는 판매자가 만든 Interac 터미널 환불 요청의 필터링된 목록을 검색합니다.

매개 변수

Name	키	필수	형식	Description
한계	limit		integer	단일 페이지에서 반환할 결과 수에 대한 제한입니다. 제한은 권고입니다. 구현은 더 많거나 적은 결과를 반환할 수 있습니다. 제공된 제한이 음수, 0 또는 최대 제한인 1,000보다 높은 경우 무시됩니다.
상태	status		string	현재 상태입니다.

반환

Name	경로	형식	Description
환불	refunds	array of object
아이디	refunds.id	string	Square에서 발급한 고유한 식별자입니다.
환불 ID	refunds.refund_id	string	Square에서 생성한 이 환불의 고유 ID입니다.
결제 아이디	refunds.payment_id	string	결제의 ID입니다.
금액	refunds.amount_money.amount	integer	금액입니다.
통화	refunds.amount_money.currency	string	통화입니다.
이유	refunds.reason	string	카드 소유자가 은행과 분쟁을 시작한 분쟁 이유입니다.
디바이스 ID	refunds.device_id	string	이 코드를 사용한 디바이스의 고유 ID입니다. 디바이스가 페어링될 때 채워집니다.
최종 기한 기간	refunds.deadline_duration	string	RFC 3339 기간이 지나면 체크 아웃이 자동으로 취소됩니다. PENDING인 TerminalCheckout은 자동으로 취소되며 취소 사유가 TIMED_OUT. 기본값: 생성 후 5분
상태	refunds.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	refunds.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	refunds.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
앱 아이디	refunds.app_id	string	체크 아웃을 만든 애플리케이션의 ID입니다.
카드 브랜드	refunds.card.card_brand	string	카드의 브랜드입니다.
마지막 4	refunds.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
만료 월	refunds.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
만료 연도	refunds.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
지문	refunds.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
카드 종류	refunds.card.card_type	string	카드의 유형입니다.
빈	refunds.card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
주문 ID	refunds.order_id	string	주문의 ID입니다.
위치 ID	refunds.location_id	string	위치의 식별자입니다.

터미널 환불 만들기

작업 ID:: TerminalCreateRefund

Square 터미널에서 완료된 Interac 결제를 환불해 달라는 요청을 만듭니다.

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
금액	amount	integer	금액입니다.
통화	currency	string	통화입니다.
디바이스 ID	device_id	string	이 TerminalRefund에 대한 디바이스의 고유 ID입니다.
이유	reason	string	이 개체의 이유입니다.
결제 아이디	payment_id	string	결제의 고유 ID입니다.

반환

Name	경로	형식	Description
아이디	refund.id	string	Square에서 발급한 고유한 식별자입니다.
결제 아이디	refund.payment_id	string	결제의 고유 ID입니다.
금액	refund.amount_money.amount	integer	금액입니다.
통화	refund.amount_money.currency	string	통화입니다.
이유	refund.reason	string	이 개체의 이유입니다.
디바이스 ID	refund.device_id	string	이 TerminalRefund에 대한 디바이스의 고유 ID입니다.
최종 기한 기간	refund.deadline_duration	string	RFC 3339 기간이 지나면 체크 아웃이 자동으로 취소됩니다. PENDING인 TerminalCheckout은 자동으로 취소되며 취소 사유가 TIMED_OUT. 기본값: 생성 후 5분
상태	refund.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	refund.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	refund.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
앱 아이디	refund.app_id	string	체크 아웃을 만든 애플리케이션의 ID입니다.
카드 브랜드	refund.card.card_brand	string	카드의 브랜드입니다.
last_4	refund.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
Exp 월	refund.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	refund.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
지문	refund.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
카드 종류	refund.card.card_type	string	카드의 유형입니다.
빈	refund.card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
주문 ID	refund.order_id	string	주문의 ID입니다.
위치 ID	refund.location_id	string	위치의 식별자입니다.

터미널 환불 받기

작업 ID:: TerminalGetRefund

ID별로 Interac 터미널 환불 개체를 검색합니다.

매개 변수

Name	키	필수	형식	Description
터미널 환불 ID	terminal_refund_id	True	string	터미널 환불의 식별자입니다.

반환

Name	경로	형식	Description
아이디	refund.id	string	Square에서 발급한 고유한 식별자입니다.
환불 ID	refund.refund_id	string	Square에서 생성한 이 환불의 고유 ID입니다.
결제 아이디	refund.payment_id	string	결제의 고유 ID입니다.
금액	refund.amount_money.amount	integer	금액입니다.
통화	refund.amount_money.currency	string	통화입니다.
이유	refund.reason	string	이 개체의 이유입니다.
디바이스 ID	refund.device_id	string	이 TerminalRefund에 대한 디바이스의 고유 ID입니다.
최종 기한 기간	refund.deadline_duration	string	RFC 3339 기간이 지나면 체크 아웃이 자동으로 취소됩니다. PENDING인 TerminalCheckout은 자동으로 취소되며 취소 사유가 TIMED_OUT. 기본값: 생성 후 5분
상태	refund.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	refund.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	refund.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
앱 아이디	refund.app_id	string	체크 아웃을 만든 애플리케이션의 ID입니다.
카드 브랜드	refund.card.card_brand	string	카드의 브랜드입니다.
last_4	refund.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
Exp 월	refund.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	refund.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
지문	refund.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
카드 종류	refund.card.card_type	string	카드의 유형입니다.
빈	refund.card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
주문 ID	refund.order_id	string	주문의 ID입니다.
위치 ID	refund.location_id	string	위치의 식별자입니다.

터미널 환불 취소

작업 ID:: TerminalCancelRefund

요청 상태가 허용하는 경우 환불 요청 ID로 Interac 터미널 환불 요청을 취소합니다.

매개 변수

Name	키	필수	형식	Description
터미널 환불 ID	terminal_refund_id	True	string	터미널 환불의 식별자입니다.

반환

Name	경로	형식	Description
아이디	refund.id	string	Square에서 발급한 고유한 식별자입니다.
결제 아이디	refund.payment_id	string	결제의 고유 ID입니다.
금액	refund.amount_money.amount	integer	금액입니다.
통화	refund.amount_money.currency	string	통화입니다.
이유	refund.reason	string	이 개체의 이유입니다.
디바이스 ID	refund.device_id	string	이 TerminalRefund에 대한 디바이스의 고유 ID입니다.
최종 기한 기간	refund.deadline_duration	string	RFC 3339 기간이 지나면 체크 아웃이 자동으로 취소됩니다. PENDING인 TerminalCheckout은 자동으로 취소되며 취소 사유가 TIMED_OUT. 기본값: 생성 후 5분
상태	refund.status	string	이 개체의 현재 확인 상태입니다.
취소 이유	refund.cancel_reason	string	취소된 트랜잭션의 이유입니다.
만든 위치에서	refund.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	refund.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
앱 아이디	refund.app_id	string	체크 아웃을 만든 애플리케이션의 ID입니다.
카드 브랜드	refund.card.card_brand	string	카드의 브랜드입니다.
last_4	refund.card.last_4	string	카드 번호의 마지막 4자리 숫자입니다.
Exp 월	refund.card.exp_month	integer	1에서 12 사이의 정수로 연결된 카드의 만료 월입니다.
Exp Year	refund.card.exp_year	integer	카드 만료 날짜의 4자리 연도입니다.
지문	refund.card.fingerprint	string	단일 애플리케이션 내의 여러 위치에서 카드를 식별하기 위해 카드 번호에 따라 Square 할당 식별자로 사용됩니다.
카드 종류	refund.card.card_type	string	카드의 유형입니다.
빈	refund.card.bin	string	BIN(은행 식별 번호)으로 알려진 카드 번호의 처음 6자리 숫자입니다.
주문 ID	refund.order_id	string	주문의 ID입니다.
위치 ID	refund.location_id	string	위치의 식별자입니다.

항목 세금 업데이트

작업 ID:: CatalogUpdateTaxes

전체 항목에서 upsert를 수행할 필요 없이 대상 CatalogItem에 적용되는 CatalogTax 개체를 업데이트합니다.

매개 변수

Name	키	형식
항목 ID	item_ids	array of string
사용할 세금	taxes_to_enable	array of string
사용하지 않도록 설정할 세금	taxes_to_disable	array of string

반환

Name	경로	형식	Description
업데이트 날짜	updated_at	string	이 업데이트의 데이터베이스 타임스탬프(RFC 3339 형식)입니다.

항목 한정자 목록 업데이트

작업 ID:: CatalogUpdateModifier

전체 항목에서 upsert를 수행하지 않고도 대상 CatalogItem에 적용되는 CatalogModifierList 개체를 업데이트합니다.

매개 변수

Name	키	형식
항목 ID	item_ids	array of string
사용하도록 설정할 한정자 목록	modifier_lists_to_enable	array of string
사용하지 않도록 설정할 한정자 목록	modifier_lists_to_disable	array of string

반환

Name	경로	형식	Description
업데이트 날짜	updated_at	string	이 업데이트의 데이터베이스 타임스탬프(RFC 3339 형식)입니다.

환불 결제

작업 ID:: RefundPayment

결제를 환불합니다. 전체 지불 금액 또는 일부를 환불할 수 있습니다. 이 엔드포인트를 사용하여 카드 결제를 환불하거나 현금 또는 외부 결제의 환불을 기록할 수 있습니다.

매개 변수

Name	키	형식	Description
Idempotency 키	idempotency_key	string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
결제 아이디	payment_id	string	환불되는 결제의 고유 ID입니다.
금액	amount	integer	tip_money 포함하지 않고 이 지불에 대해 수락할 금액입니다.
통화	currency	string	3자 ISO 4217 통화 코드입니다.
금액	amount	integer	tip_money 포함하지 않고 이 지불에 대해 수락할 금액입니다.
통화	currency	string	3자 ISO 4217 통화 코드입니다.
이유	reason	string	환불 사유에 대한 설명입니다.

반환

Name	경로	형식	Description
아이디	refund.id	string	Square에서 발급한 고유한 식별자입니다.
상태	refund.status	string	이 개체의 현재 확인 상태입니다.
금액	refund.amount_money.amount	integer	금액입니다.
통화	refund.amount_money.currency	string	통화입니다.
결제 아이디	refund.payment_id	string	결제의 고유 ID입니다.
주문 ID	refund.order_id	string	주문의 ID입니다.
만든 위치에서	refund.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	refund.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
금액	refund.app_fee_money.amount	integer	금액입니다.
통화	refund.app_fee_money.currency	string	통화입니다.
위치 ID	refund.location_id	string	위치의 식별자입니다.
이유	refund.reason	string	이 개체의 이유입니다.

정의

객체

'object' 형식입니다.

다음을 통해 공유

정사각형 결제(독립 게시자)(미리 보기)

제한 한도

동작

Apple Pay 도메인 등록

매개 변수

반환

Batch upsert 카탈로그 개체

매개 변수

반환

Batch 인벤토리 변경 내용 검색

매개 변수

반환

Batch 카탈로그 개체 검색

매개 변수

반환

idempotency 키로 결제 취소

매개 변수

반환

Upsert 카탈로그 개체

매개 변수

반환

검색 주문

매개 변수

반환

결제 나열

매개 변수

반환

결제 만들기

매개 변수

반환

결제 받기

매개 변수

반환

결제 업데이트

매개 변수

반환

결제 완료

매개 변수

반환

결제 취소

매개 변수

반환

결제 환불 받기

매개 변수

반환

고객 검색

매개 변수

반환

고객 검색

매개 변수

반환

고객 그룹 검색

매개 변수

반환

고객 그룹 나열

반환

고객 그룹 만들기

매개 변수

반환

고객 그룹 삭제

매개 변수

반환

고객 그룹 업데이트

매개 변수

반환

고객 나열

매개 변수

반환

고객 만들기

매개 변수

반환

고객 삭제

매개 변수

반환

고객 세그먼트 검색

매개 변수

반환

고객 세그먼트 나열

매개 변수