Square API로 등록된 상품에 대한 결제 수행

18895 단어 PHP 결제 WebAPI 자바스크립트 스퀘어

Square API를 사용하여 자사 EC 사이트에 결제 기능을 구현했습니다.
Square API의 도입, 샘플의 구현에 대해서는 씨의 PHP로 Square E 상거래 결제 시도 를 참고로 했습니다.

샘플에서는 금액이 지정된 요청을 만들고 Transactions API Charge를 실행하여 결제를 수행했습니다.


\SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken($access_token);
$transactions_api = new \SquareConnect\Api\TransactionsApi();

//リクエストを作成
$request_body = array (
  "card_nonce" => $nonce,
  "amount_money" => array (
    "amount" => 100,
    "currency" => "JPY"
  ),
  "idempotency_key" => uniqid()
);

try {
  //決済実行
  $result = $transactions_api->charge($location_id, $request_body);
} catch (\SquareConnect\ApiException $e) {
  echo "Caught exception!<br/>";
  $result = $e->getResponseBody();      
}

이번에, Square 대시보드로 미리 등록되어 있는 상품에 대해 결제를 실행함으로써
대시보드상에서 재고 관리나 상위 매출 상품의 체크 등을 할 수 있도록 합니다.

상품에 대한 결제를 실행하는 흐름

샘플에서 사용하는 Transactions API, Locations API 외에도,
Catalog API, Orders API를 사용하여 결제를 실행합니다.

Square 대시 보드에 제품 등록

Catalog API의 SearchCatalogObjectsRequest를 실행하여 제품 목록을 가져옵니다.

CreateOrderRequestLineItem 만들기

Order API createOrder 실행

Order Id를 사용하여 Transactions API의 Charge를 실행합니다.

상품은 등록되어 있는 것을 전제로, 2로부터의 실장을 봐 갑니다.

2. Catalog API로 상품 리스트 취득

Catalog API의 객체를 만들고 SearchCatalogObjectRequest를 실행합니다.
여기서 1점 빠지는 포인트가, 현시점에서 Catalog API는 sandbox 환경에서의 동작에 대응하고 있지 않습니다.
그러므로 이 테스트를 할 때에는 각 환경 ID는 프로덕션의 것을 사용해 주세요.
5의 Charge까지 실행하면 당연합니다만 카드에 대해 과금이 행해져 버리기 때문에,
테스트 후 Square 대시보드에서 매출을 환불해 주십시오.


$catalog_api = new SquareConnect\Api\CatalogApi();
$body = new \SquareConnect\Model\SearchCatalogObjectsRequest();

try {
    $result = $catalog_api->searchCatalogObjects($body);
    echo "<pre>";
    print_r($result);
    echo "</pre>";
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->searchCatalogObjects: ', $e->getMessage(), PHP_EOL;
}

등록 상품 리스트(SearchCatalogObjectsResponse Object)를 취득할 수 있었습니다.
※ 하늘의 항목이 매우 많기 때문에 이번 중요하지 않은 부분에 대해서 일부 생략하고 있습니다

3. CreateOrderRequestLineItem 만들기

Orders API에 요청할 제품(LineItem)을 만듭니다.
2에서 얻은 SearchCatalogObjectsResponse Object의 variables에서 id를 추출하고,
CreateOrderRequestLineItem에 id, 개수를 설정하고 array에 저장합니다.
구입하는 상품이 복수 있는 경우는 여기에서 추가해 가게 됩니다.


$item_id = $result['objects'][0]['item_data']['variations'][0][id];
$item = new \SquareConnect\Model\CreateOrderRequestLineItem;
$item->setCatalogObjectId($item_id);
$item->setQuantity('1');

$lineItems = array();   
array_push($lineItems, $item);

4. Order API createOrder 실행

3에서 만든 LineItems와 uniqid()를 설정하여 CreateOrderRequest를 만들고,
Orders API createOrder를 실행합니다.

$orders_api = new SquareConnect\Api\OrdersApi();
$request = new \SquareConnect\Model\CreateOrderRequest();
$request->setIdempotencyKey(uniqid());
$request->setLineItems($lineItems);

try {
    $result = $orders_api->createOrder($location_id, $request);

}catch (Exception $e) {
    echo '<pre>';
    echo 'Exception when calling OrdersApi->createOrder:', $e->getMessage(), PHP_EOL;
}

이제 상품을 지정한 주문이 작성되었습니다.
CreateOrderResponse는 다음과 같습니다. (일부 생략)

SquareConnect\Model\CreateOrderResponse Object
(
    [order:protected] => SquareConnect\Model\Order Object
    (
    　   [id:protected] => WBOP7aUfNxFGuSZk8wsgmswFsVHZY
         [location_id:protected] => 325X8D9WZ2239
         [reference_id:protected] => 
         [line_items:protected] => Array
         (
             [0] => SquareConnect\Model\OrderLineItem Object
             (
                 [name:protected] => 塩バターパン
                 [quantity:protected] => 1
                 [note:protected] => 
                 [catalog_object_id:protected] => QBORT2E36FKXPNLY42EMWPBA
                 [variation_name:protected] => 販売価格
               　・・・(略)・・・
                 [total_money:protected] => SquareConnect\Model\Money Object
                 (
                     [amount:protected] => 160
                     [currency:protected] => JPY
                 )
            )
      )
     [total_money:protected] => SquareConnect\Model\Money Object
     (
         [amount:protected] => 160
         [currency:protected] => JPY
     )
     ・・・(略)・・・
  )
    [errors:protected] => 
)

5. Order Id를 사용하여 Transactions API Charge 실행

4의 응답에서 ChargeRequest로 지정하기 위해 Order Id와 total_money를 추출하고,
ChargeRequest를 작성합니다. 샘플에서는 $request_body로 배열을 직접 만들었지만,
이번에는 각각 값을 set하여 작성하고 있습니다.

$order_id = $result['order']['id'];
$amount_money = $result['order']['total_money']; 

$chargeRequest = new \SquareConnect\Model\ChargeRequest();
$chargeRequest->setIdempotencyKey(uniqid());
$chargeRequest->setAmountMoney($amount_money);
$chargeRequest->setCardNonce($nonce);
$chargeRequest->setOrderId($order_id);

try {
    $result = $transactions_api->charge($location_id, $chargeRequest);

} catch (\SquareConnect\ApiException $e) {
    echo "Caught exception!<br/>";
    print_r("<strong>Response body:</strong><br/>");
    echo "<pre>"; var_dump($e->getResponseBody()); echo "</pre>";
    echo "<br/><strong>Response headers:</strong><br/>";
    echo "<pre>"; var_dump($e->getResponseHeaders()); echo "</pre>";
}

charge가 성공적으로 이루어지면 다음과 같은 응답이 반환됩니다.
order_id로 올바르게 설정되었는지 확인할 수 있습니다.

Square 대시보드에서도 상품에 대한 매출이 반영되어 있는 것을 확인할 수 있었습니다.

결론

아직 일본어 문헌이 적고 Stack Overflow에서 검색하거나 참조를 번역하면서 읽고 진행하여 구현했습니다. 질문은 물론 실수 등 있으면 코멘트를 받을 수 있으면 다행입니다.

Reference

이 문제에 관하여(Square API로 등록된 상품에 대한 결제 수행), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://qiita.com/arawow/items/c96e5a5527383f8a070c

텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.

우수한 개발자 콘텐츠 발견에 전념 (Collection and Share based on the CC Protocol.)

Node.js와 express를 사용하여 간단한 WebAPI 만들기

ESS Job의 로그를 WebAPI로 취득하는 Java 프로그램

좋은 웹페이지 즐겨찾기

개발자 우수 사이트 수집

개발자가 알아야 할 필수 사이트 100선 추천 우리는 당신을 위해 100개의 자주 사용하는 개발자 학습 사이트를 정리했습니다