2. API 명세
호출 URL
구분 | URL |
---|---|
리얼 URL | https://api-partner-bill.payco.com/pgTradeCheck/download/pay |
테스트 URL | https://alpha-api-partner-bill.payco.com/pgTradeCheck/download/pay |
Version
Version | 설명 |
---|---|
1.0 (기본) | CSV 포맷의 Response 제공 |
1.1 |
Request
- Method : GET, POST
- Parameter
Name | Data Type | 예 | 설명 |
---|---|---|---|
serviceCode | String | PAY_D | 전달받을 데이터 타입 - PAY_D: 결제 일 정산 - ST_PAY_D: 정산 일 정산 (지급일) - ST_PAY_M: 정산 월 정산 (지급일) - SB_PAY_D: 정산 일 정산 (정산기준일) - SB_PAY_M: 정산 월 정산 (정산기준일) - ST_PNT_M: PAYCO 포인트 적립월 정산 |
mrcCode | String | F6FE1A | 가맹점코드 (고유 값) |
ymd | String | 20150101 | 날짜 - 데이터 형식: yyyyMMDD - 월 데이터인 경우 날짜는 01 로 입력. ( ex) 20150401) |
token | String | 대사정보 조회 API 페이지에 명시된 [접속 토큰] 값. | |
version | String | 1.0 | API 버전 (Version 참고) |
※ Request 전 대사정보 조회 API 페이지에서 ACL이 제대로 등록되어있는지 확인 후 진행한다.
Response
- 주요 Response Header
- - 응답 결과 코드와 메시지 정보는 헤더로 전달한다.
Header Name | 설명 |
---|---|
PAYCO_PgTrade_Code | 결과 코드 - 0: 성공 - 그 외: 실패 (에러코드 정의 참고) |
PAYCO_PgTrade_Message | 결과 메시지 - SUCCESS: 성공 - 그 외: 실패 (에러코드 정의 참고) |
Content-Type | text/plain;charset=UTF-8 |
※ Response Body
- CSV 포맷으로 제공되며, 각 열의 구분자는 탭(Tab)으로 한다. Body 정보의 예시는 serviceCode별 요청 결과 예시를 참고한다.
에러코드 정의
RESULT CODE | RESULT MESSAGE | 설명 |
---|---|---|
0 | SUCCESS | 성공 |
-1 | FAIL | 실패 (시스템에러) |
-2 | PARAMETER_ERROR | 파라미터 에러. 파라미터 중 잘못 된 값이 있음. |
101 | AUTH_INVALID_USER_ERROR | 허용되지 않은 사용자. ACL 확인 필요. |
109 | AUTH_INVALID_ACCESSTOKEN | 유효하지 않은 토큰으로 요청 시 발생. |
1101 | DATA_NOT_EXIST | 데이터 없음 |
API 명세 > 요청 예시 (Request Headers) > Method : GET
GET https://alpha-api-partner-bill.payco.com/pgTradeCheck/download/pay?serviceCode=PAY_D&mrcCode=S0FSJE&ymd=20150915&token=S0FSJE-10B9FFD-4797A&version=1.0 HTTP/1.1
Host: alpha-api-partner-bill.payco.com
Connection: keep-alive
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.93 Safari/537.36
Accept: */*
Accept-Encoding: gzip, deflate, sdch
Accept-Language: ko-KR,ko;q=0.8,en-US;q=0.6,en;q=0.4
API 명세 > 요청 예시 (Request Headers) > Method : POST
POST https://alpha-api-partner-bill.payco.com/pgTradeCheck/download/pay
HTTP/1.1
Host: alpha-api-partner-bill.payco.com
Connection: keep-alive
Content-Length: 84
Origin: chrome-extension://aejoelaoggembcahagimdiliamlcdmfm
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.93 Safari/537.36
Content-Type: application/x-www-form-urlencoded
Accept: */*
Accept-Encoding: gzip, deflate
Accept-Language: ko-KR,ko;q=0.8,en-US;q=0.6,en;q=0.4
mrcCode=S0FSJE&serviceCode=PAY_D&token=S0FSJE-10B9FFD-4797A&version=1.0&ymd=20150915
3. serviceCode 별 요청 결과 예시
3-1. PAY_D(결제 일정산) 열정보
Header | 설명 |
---|---|
PAYCO 승인/취소 일시 | yyyyMMddHHmmss 형식 |
PAYCO 주문번호 | 주문번호 |
가맹점주문번호 | 가맹점에서 관리하는 주문번호 |
PAYCO 결제번호 | 결제번호 |
원거래 PAYCO 결제번호 | 원거래 결제번호 |
거래 금액 | - |
결제타입코드 | 승인: PRTAPP, 취소: PRTWCNCL |
결제타입 | 승인, 취소 |
결제수단코드 | 결제수단코드 전체 항목 정보는 “PAYCO_연동_가이드_v[version].docx” 문서를 참고 |
결제수단명 | 결제타입코드에 매칭되는 결제타입명 |
주문상품명 | - |
주문인증키 | - |
3-1. serviceCode 별 요청 결과 예시 > PAY_D(결제 일정산) > 요청 결과 예시(version 1.0, 1.1)
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
PAYCO 승인/취소 일시 / PAYCO 주문번호 / 가맹점주문번호 / PAYCO 결제번호 / 원거래PAYCO 결제번호 / 거래금액 / 결제타입코드 / 결제타입 / 결제수단코드 / 결제수단명 / 주문상품명 / 주문인증키
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
20150619142854 / 201506192000188778 / 20150619-0102175 / 201506192000556218 / / 1100.0 / PRTAPP / 승인 / 31 / 신용카드 / 1100%EC%9B%90 / xCr0qqXuZFCjwTNYG3RaTNT6f1639GzUQGw09GJKKFECC
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
20150619150708 / 201506192000188789 / 20150619-0102183 / 201506192000556285 / / 1100.0 / PRTAPP / 승인 / 31 / 신용카드 / 1100%EC%9B%90 / u9OwDwtMEErbVDrOBBAAh0yfsXAAzHaZctNPBBIAAzEQJEtACC
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
20150619182214 / 201506192000188889 / 20150619-0102206 / 201506192000556548 / / 1100.0 / PRTAPP / 승인 / 31 / 신용카드 / 1100%EC%9B%90 / LSwIvpY7L0jDNtdn1J2343FASQbSKfXs4QC7260GBR0CC
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
20150619183339 / 201506192000188900 / 20150619-0102214 / 201506192000556562 / / 1100.0 / PRTAPP / 승인 / 31 / 신용카드 / 1100%EC%9B%90 / 2CkdSCV1Jj35piGAL8BBvN9oVaFJsABBIGnwouH4m4A64CC
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
3-2. ST_PAY_D (정산 일정산, 지급일) 열정보
Header | 설명 |
---|---|
지급일자 | yyyyMMdd 형식 |
PAYCO 승인/취소 일시 | yyyyMMddHHmmss 형식. |
PAYCO 구매확정일자 | yyyyMMdd 형식 |
PAYCO 정산기준일자 | 가맹점에서 관리하는 주문번호 |
결제수단코드 | 결제수단코드 전체 항목 정보는 “PAYCO_연동_가이드_v[version].docx” 문서를 참고 |
결제수단명 | 결제타입코드에 매칭되는 결제타입명 |
에스크로여부 | Y/N |
결제수단승인코드 | - |
승인사명 | - |
결제수단승인번호 | - |
PAYCO 주문번호 | 주문번호 |
가맹점주문번호 | 가맹점에서 관리하는 주문번호 |
PAYCO 결제번호 | 결제번호 |
원거래 PAYCO 결제번호 | 원거래 결제번호 |
결제타입 | 결제의 처리상태 |
취소타입 | 정상/전체취소/부분취소 |
거래금액 | - |
결제수수료 | - |
무이자할부수수료 | 무이자 할부 행사 진행시 수수료(가맹점 부담) |
카드포인트수수료 | 카드사 포인트 이용 결제시 수수료(가맹점 부담) |
부가세 | - |
정산금액 | - |
주문상품명 | - |
3-2. serviceCode 별 요청 결과 예시 > ST_PAY_D (정산 일정산, 지급일) > 요청 결과 예시(version 1.0, 1.1)
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
지급일자 / PAYCO 승인/취소 일시 / PAYCO 구매확정일자 / PAYCO 정산기준일자 / 결제수단코드 / 결제수단명 / 에스크로여부 / 결제수단승인코드 / 승인사명 / 결제수단승인번호 / PAYCO 주문번호 / 가맹점주문>번호 / PAYCO 결제번호 / 원거래 PAYCO 결제번호 / 결제타입 / 취소타입 / 거래금액 / 결제수수료 / 무이자할부수수료 / 카드포인트수수료 / 부가세 / 정산금액 / 주문상품명
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
20160405 / 20160301133354 / 20160301 / / 98 / PAYCO 포인트 / N / 2016030120406005 / / 201603012002037470 / 52821802 / 201603012002482558 / / / 승인 / 승인 / 2000.0 / 50.0 / 5.0 / / / 1945.0 / 테스트상품명
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
20160405 / 20160301133557 / 20160301 / / 98 / PAYCO 포인트 / N / 2016030120406006 / / 201603012002037470 / 52821802 / 201603012002482560 /201603012002482558 / / 취소 / 전체취소 / -2000.0 / -50.0 / -5.0 / / / -1945.0 / 테스트상품명
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
3-3. ST_PAY_M (정산 월정산, 지급일)
- ST_PAY_D (정산 일정산, 지급일)과 동일
3-4. SB_PAY_D (정산 일정산, 정산기준일)
- ST_PAY_D (정산 일정산, 지급일)과 동일
3-5. SB_PAY_M (정산 월정산, 정산기준일)
- ST_PAY_D (정산 일정산, 지급일)과 동일
3-6. ST_PNT_M (PAYCO 포인트 월적립금 정산) 열 정보
Header | 설명 |
---|---|
지급일자 | yyyyMMdd 형식 |
지급월 | yyyyMM 형식 |
적립일 | yyyyMMdd 형식 |
PAYCO 주문번호 | 주문번호 |
가맹점주문번호 | 가맹점에서 관리하는 주문번호 |
적립율 | % |
적립포인트 | - |
PAYCO 부담액 | - |
가맹점 부담액 | - |
주문상품명 | - |
3-6. serviceCode 별 요청 결과 예시 > ST_PNT_M (PAYCO 포인트 월적립금 정산) > 요청 결과 예시(version 1.0, 1.1)
----------------------------------------------------------------------------------------------------------------------------
지급일자 / 지급월 / 적립일 / PAYCO 주문번호 / 가맹점주문번호 / 적립율 / 적립포인트 / PAYCO부담액 / 가맹점 부담액
----------------------------------------------------------------------------------------------------------------------------
20150406 / 201504 / 20150318 / 201503182000160897 / 201503181734400841 / 2.0 / 1380 / 690 / 690
----------------------------------------------------------------------------------------------------------------------------
20150406 / 201504 / 20150318 / 201503182000160917 / 201503182030324869 / 2.0 / 1600 / 800 / 800
----------------------------------------------------------------------------------------------------------------------------
20150406 / 201504 / 20150318 / 201503182000160920 / 201503182044512517 / 2.0 / 3780 / 1890 / 1890
----------------------------------------------------------------------------------------------------------------------------