페이팔

• style string

  페이팔 버튼 커스텀마이징

  페이팔 결제 버튼을 커스텀마이징 할 경우 자세한 내용은 페이팔에서 제공하는 문서(https://developer.paypal.com/sdk/js/reference/#link-style)를 참고하세요.

  • layout string

    페이팔 버튼 렌더링 방향

    • hotizontal 적용 시 버튼이 최대 2개까지 밖에 렌더링 되지 않습니다. 때문에 페이팔에서는 layout을 horizontal이 아닌 vertical로 설정하도록 권고하고 있습니다.
    • 페이팔 버튼은 기본적으로 vertical(수직)로 렌더링 됩니다.

    예시 코드
    PortOne.loadPaymentUI(
      {
        //...중략
        bypass: {
          paypal_v2: {
            style: {
              //...중략
              layout: "horizontal",
            },
          },
        },
      }, //콜백 함수
    );

    

    

  • color string

    페이팔 버튼 색상

    • gold, blue, silver, white, black 중 선택할 수 있습니다.
    • 기본적으로는 gold로 표시됩니다.

  • height number

    페이팔 버튼 크기

    크기 변경은 25~55 사이의 값으로만 지정할 수 있습니다.

  • shape string

    페이팔 버튼 모양

    rect(사각 모양)과 pill(둥근 모양) 중에 선택할 수 있으며, 기본적으로 rect 모양으로 표시됩니다.

  • label string

    페이팔 버튼 라벨

    • paypal, checkout, buynow, pay, installment 중 선택할 수 있습니다.
    • 기본적으로 paypal로 표시됩니다.
    • installment는 결제 국가가 MX혹은 BR인 경우에만 유효합니다.

  • period string

    페이팔 버튼에 할부 결제 표시

    label 파라미터가 installment인 경우 버튼에 표시됩니다.

  • tagline boolean

    페이팔 버튼에 제공되는 추가 설명

    해당 파라미터를 사용하시기 위해서는 layout 파라미터를 horizontal로 지정해야 사용하실 수 있습니다.

• enable-funding string

  렌더링할 페이팔 결제 버튼 지정

  결제 버튼 종류를 comma(,) separated string으로 지정하여 결제창을 호출하는 경우 해당 버튼을 포함하여 렌더링됩니다.

  예시 코드
  PortOne.loadPaymentUI(
    {
      // ...중략
      bypass: {
        paypal_v2: {
          "enable-funding": "paylater,card",
        },
      },
    }, //콜백 함수
  );

  

  

  

  

• disable-funding string

  렌더링에서 제외할 페이팔 결제 버튼 지정

  • 결제 버튼 종류를 comma(,) separated string으로 지정하여 결제창을 호출하는 경우 해당 버튼을 제외하고 렌더링됩니다.
  • 사용 가능한 버튼 종류는 enable-funding에서 제공하는 버튼 종류와 동일합니다.

  

  

• purchase_units object[]

  페이팔 주문 상세 정보

  • 각각의 element에 배송 정보를 담을 수 있습니다.
  • 포트원을 통해 페이팔을 연동하는 고객사는 purchase_units의 길이가 항상 0 또는 1이어야 합니다.

• shipping object

  상품 배송지 정보

  • address object

    상품 수령 주소

    • 결제창 호출 시 기본적으로 구매자가 페이팔에 가입할 때 입력한 배송주소를 렌더링합니다.
    • purchase_units\[]에 입력 된 배송 정보는 결제창에 호출 시 대체로 자동 완성되지만, 페이팔 회원으로 결제할 때와 비회원으로 결제할 때 각각 다른 정책이 적용됩니다.
    • 주문할 때 입력한 주소로 override하고 싶을 때 purchase_units\[].shipping.address에 override할 주소를 입력한 후 결제 요청해야 합니다. 단, 주소가 유효하지 않거나 address_line_1을 입력하지 않은 경우엔 override가 되지 않을 수 있습니다.

    • address_line_1 *string

      도로명 주소, ex) 200 N Spring St

    • address_line_2 string

      번지 혹은 건물 호수, ex) Los Angeles City Hall 1

    • admin_area_1 string

      주와 같은 큰 단위의 주소, ex) CA, NY

      • country(UK)
      • state(US)
      • province(Canada)
      • 특별시/광역시/도(Korea)

    • admin_area_2 string

      도시, 마을 등 중간 단위의 주소, ex) Los Angeles

    • postal_code string

      우편 번호

    • country_code * string

      국가 코드, ex) KR

    예시 1) 페이팔 회원으로 결제 시 shipping.address 정보를 입력하지 않은 경우

    

    예시 2) 페이팔 회원으로 결제 시 shipping.address 정보를 입력한 경우

    PortOne.loadPaymentUI(
      {
        bypass: {
          paypal_v2: {
            // ...중략
            purchase_units: [
              {
                shipping: {
                  address: {
                    // 상품 수령 주소
                    address_line_1: "세종대로 110", // 도로명 주소
                    address_line_2: "서울특별시청", // 아파트 동 호수
                    admin_area_1: "서울특별시", // 주(CA, NY)
                    admin_area_2: "중구", // 시(Los Angeles, New York)
                    postal_code: "04524", // 상품 수령지 우편번호
                    country_code: "KR", // [필수 입력] 상품 수령지 국가 코드
                  },
                  name: {
                    full_name: "홍길동", // 상품 수령인 이름
                  },
                },
              },
            ],
          },
        },
      }, // 콜백 함수
    );

    

    예시 3) shipping.address의 국가 정보와 구매자의 접속 국가가 일치하지 않은 경우

    페이팔 결제창에 렌더링 되는 주소 형식은 구매자의 접속 국가에 따라 결정됩니다. 배송 주소의 국가와 구매자의 접속 국가를 다른 경우, 국가 간 주소 체계가 달라 정상적으로 자동입력 되지 않을 수 있습니다.

    

• payer object

  구매자 상세정보

• tax_info object

  구매자 세금 정보

• tax_id string

  구매자 세금 ID

• tax_id_type string

  구매자 세금 유형

  브라질(에서 접속한 또는 브라질 계정으로 로그인 한) 구매자인 경우 bypass.paypal_v2.payer.tax_info 정보를 필수로 입력해야 합니다.

  예시 코드
  ({
    tax_info: {
      tax_id: "examplestring",
      tax_id_type: "BR_CPF",
    },
  });

• address object

  구매자의 결제 금액 청구지 주소 정보(billing address)

  • address_line_1 string

    도로명 주소, ex) 200 N Spring St

  • address_line_2 string

    번지 혹은 건물 호수, ex) Los Angeles City Hall 1

  • admin_area_1 string

    주와 같은 큰 단위의 주소, ex) CA, NY

    • country(UK)
    • state(US)
    • province(Canada)
    • 특별시/광역시/도(Korea)

  • admin_area_2 string

    도시, 마을 등 중간 단위의 주소, ex) Los Angeles

  • postal_code string

    우편 번호

  • country_code * string

    국가 코드, ex) KR

  페이팔 비회원 결제 시 페이팔 결제창 내 청구지 주소(billing address) 정보로 사용됩니다. 회원으로 결제하는 경우 회원 가입 시 입력한 billing address가 자동 입력되며 해당 파라미터의 정보는 무시됩니다.

  예시 1) 페이팔 회원으로 결제 시 payer.address 정보를 입력한 경우

  입력된 정보는 무시되고 페이팔 가입 시 기입한 구매자의 청구 주소가 자동 입력됩니다.

  예시 코드
  ({
    bypass: {
      paypal_v2: {
        // ...중략
        payer: {
          address: {
            address_line_1: "200 N Spring St", // 도로명 주소
            address_line_2: "Los Angeles City Hall", // 아파트 동 호수
            admin_area_1: "CA", // 주(CA, NY)
            admin_area_2: "Los Angeles", // 시(Los Angeles, New York)
            postal_code: "90012", // 상품 수령지 우편번호
            country_code: "US", // [필수 입력] 상품 수령지 국가 코드
          },
        },
      },
    },
  });

  

  예시 2) 페이팔 비회원으로 결제 시 payer.address 정보를 입력한 경우

  입력된 정보가 구매자의 청구 주소지란에 자동 입력됩니다.

  예시 코드
  ({
    bypass: {
      paypal_v2: {
        // ...중략
        payer: {
          address: {
            address_line_1: "200 N Spring St", // 도로명 주소
            address_line_2: "Los Angeles City Hall", // 아파트 동 호수
            admin_area_1: "CA", // 주(CA, NY)
            admin_area_2: "Los Angeles", // 시(Los Angeles, New York)
            postal_code: "90012", // 상품 수령지 우편번호
            country_code: "US", // [필수 입력] 상품 수령지 국가 코드
          },
        },
      },
    },
  });

  

  예시 3) 페이팔 비회원으로 결제 시 payer.address 정보 미 입력 상태이면서 shipping.address 정보를 입력한 경우

  구매자의 청구 주소(bypass.paypal_v2.payer.address)를 입력하지 않고 배송 주소(bypass.paypal_v2.pusrchase_units\[].shipping.address)만 입력한 경우 청구 주소란에 배송 주소가 자동으로 입력됩니다.

  예시 코드
  ({
    bypass: {
      paypal_v2: {
        // ...중략
        purchase_units: [
          {
            shipping: {
              address: {
                // 상품 수령 주소
                address_line_1: "세종대로 110", // 도로명 주소
                address_line_2: "서울특별시청", // 아파트 동 호수
                admin_area_1: "서울특별시", // 주(CA, NY)
                admin_area_2: "중구", // 시(Los Angeles, New York)
                postal_code: "04524", // 상품 수령지 우편번호
                country_code: "KR", // [필수 입력] 상품 수령지 국가 코드
              },
              name: {
                full_name: "홍길동", // 상품 수령인 이름
              },
            },
          },
        ],
      },
    },
  });

  

  

  예시 4) 페이팔 비회원으로 결제 시 payer.address 정보와 shipping.address 정보를 모두 입력한 경우

  구매자의 청구 주소(bypass.paypal_v2.payer.address)와 배송 주소(bypass.paypal_v2.shipping.address)를 모두 입력한 경우엔, 청구 주소와 동일한 배송주소 체크박스를 해제했을 때 하단에 렌더링 되는 배송 정보란에 배송 주소가 자동 입력됩니다.

  예시 코드
  ({
    bypass: {
      paypal_v2: {
        // ...중략
        purchase_units: [
          {
            shipping: {
              address: {
                // 상품 수령 주소
                address_line_1: "세종대로 110", // 도로명 주소
                address_line_2: "서울특별시청", // 아파트 동 호수
                admin_area_1: "서울특별시", // 주(CA, NY)
                admin_area_2: "중구", // 시(Los Angeles, New York)
                postal_code: "04524", // 상품 수령지 우편번호
                country_code: "KR", // [필수 입력] 상품 수령지 국가 코드
              },
              name: {
                full_name: "홍길동", // 상품 수령인 이름
              },
            },
          },
        ],
        payer: {
          address: {
            address_line_1: "고산자로 270", // 도로명 주소
            address_line_2: "성동구청", // 아파트 동 호수
            admin_area_1: "서울특별시", // 주(CA, NY)
            admin_area_2: "성동구", // 시(Los Angeles, New York)
            postal_code: "04750", // 상품 수령지 우편번호
            country_code: "KR", // [필수 입력] 상품 수령지 국가 코드
          },
        },
      },
    },
  });

  

  

  예시 5) payer.address의 국가 정보와 구매자의 접속 국가가 일치하지 않은 경우

  페이팔 결제창에 렌더링 되는 주소 형식은 구매자의 접속 국가에 따라 결정됩니다. 청구 주소의 국가와 구매자의 접속 국가를 다른 경우, 국가 간 주소 체계가 달라 정상적으로 자동입력 되지 않을 수 있습니다.

  

• style string

  페이팔 버튼 커스텀마이징

  페이팔 버튼을 커스텀마이징 할 경우 자세한 내용은 페이팔에서 제공하는 문서(https://developer.paypal.com/sdk/js/reference/#link-style)를 참고하세요.

• layout string

  페이팔 버튼 렌더링 방향

  • hotizontal 적용 시 버튼이 최대 2개까지 밖에 렌더링 되지 않습니다. 때문에 페이팔에서는 layout을 horizontal이 아닌 vertical로 설정하도록 권고하고 있습니다.
  • 페이팔 버튼은 기본적으로 vertical(수직)로 렌더링 됩니다.

  예시 코드
  PortOne.loadPaymentUI(
    {
      //...중략
      bypass: {
        paypal_v2: {
          style: {
            //...중략
            layout: "horizontal",
          },
        },
      },
    }, //콜백 함수
  );

  

  

• color string

  페이팔 버튼 색상

  • gold, blue, silver, white, black 중 선택할 수 있습니다.
  • 기본적으로는 gold로 표시됩니다.

• height number

  페이팔 버튼 크기

  크기 변경은 25~55 사이의 값으로만 지정할 수 있습니다.

• shape string

  페이팔 버튼 모양

  rect(사각 모양)과 pill(둥근 모양) 중에 선택할 수 있으며, 기본적으로 rect 모양으로 표시됩니다.

• label string

  페이팔 버튼 라벨

  • paypal, checkout, buynow, pay, installment 중 선택할 수 있습니다.
  • 기본적으로 paypal로 표시됩니다.
  • installment는 결제 국가가 MX혹은 BR인 경우에만 유효합니다.

• period string

  페이팔 버튼에 할부 결제 표시

  label:installment인 경우 버튼에 표시됩니다.

• tagline boolean

  페이팔 버튼에 제공되는 추가 설명

  해당 파라미터를 사용하시기 위해서는 bypass.paypal_v2.style.layout을 horizontal로 지정해야 사용하실 수 있습니다.

• shipping_address object

  주문 상품의 배송 주소

  • recipient_name string

    수령인 이름

  • line1 *string

    도로명 주소, ex) 200 N Spring St

  • line2 string

    번지 혹은 건물 호수, ex) Los Angeles City Hall 1

  • city *string

    도시, 마을 등 중간 단위의 주소, ex) Los Angeles

  • state string

    주와 같은 큰 단위의 주소, ex) CA, NY

    • country(UK)
    • state(US)
    • province(Canada)
    • 특별시/광역시/도(Korea)

  • postal_code string

    우편 번호

  • country_code *string

    국가 코드, ex) KR

    • 페이팔의 경우 빌링키 발급창에 기본적으로 구매자가 페이팔에 가입할 때 입력한 배송 정보가 자동으로 입력됩니다. 만약 이 배송 정보를 override하고 싶다면 shipping_address 파라미터에 override할 주소를 입력하고 shipping_address.recipient_name에 override할 수령인 이름을 입력하신 후 호출하시면 됩니다.

• 배송 정보 중 line1, city 그리고 country_code는 필수 입력해야 합니다. 전달하지 않을 경우 에러가 리턴되며 빌링키 발급창이 호출되지 않습니다.

예시 코드
PortOne.loadPaymentUI(
  {
    bypass: {
      paypal_v2: {
        shipping_address: {
          // 상품 수령 주소
          recipient_name: "홍길동", // 수령인 이름
          line1: "세종대로 110", // 도로명 주소
          line2: "서울특별시청", // 아파트 동 호수
          city: "중구", // 시(Los Angeles, New York)
          state: "서울특별시", // 주(CA, NY)
          postal_code: "04524", // 상품 수령지 우편번호
          country_code: "KR", // [필수 입력] 상품 수령지 국가 코드
        },
      },
    },
  }, // 콜백 함수
);