이전으로요청 본문
요청 본문은 클라이언트가 API를 요청할 때 보내는 데이터입니다. 잽페이 API에 요청할 때는 JSON 형식을 사용하세요.
URL 인코딩
전체 요청 본문을 인코딩할 필요는 없습니다. 특수 문자가 요청 본문이나 쿼리 파라미터 값에 포함되어 있다면 URL 인코딩을 해야 합니다. 데이터를 안전하게 전송하고, 서버에서 정확하게 해석되도록 하는 중요한 단계입니다.
URL 인코딩은 웹에서 안전하게 데이터를 전송하기 위해 특정 문자를 % 기호와 두 개의 16진수 숫자로 변환하는 과정입니다. 인코딩은 데이터가 전달되는 과정에서 오류나 변조 없이 완전하고 믿을 수 있는 상태로 유지해서 웹 서버가 요청을 정확하게 해석하도록 도와줍니다.
#원본 데이터
name=John Doe&age=30
#인코딩 후
name=John%20Doe&age=30
Markdown
복사
API 요청을 할 때 데이터 전송의 정확성과 안전성을 보장하려면 URL 인코딩을 하세요. 대부분의 프로그래밍 언어 및 플랫폼에서는 URL 인코딩을 위한 내장 함수나 라이브러리를 제공합니다. 사용하는 언어에 맞는 인코딩 방법을 참조하여 API 요청을 준비하세요.
응답 본문
응답 본문은 서버가 클라이언트에 보내는 데이터입니다. 잽페이 API의 성공 여부는 HTTP 상태 코드로 전달합니다. 돌아온 HTTP 상태 코드에 따라 요청이나 에러를 처리하는 로직을 구축하세요.
모든 API 응답, 요청 본문은 JSON 형식입니다. 따라서 응답 헤더에는 다음과 같이 Content-Type이 포함됩니다.
Content-Type: application/json
Plain Text
복사
Content-Type은 HTTP 헤더 중 하나로, 클라이언트와 서버 간에 전송되는 데이터의 형식을 나타냅니다. 예를 들어, Content-Type: application/json은 요청 또는 응답 본문이 JSON 형식임을 의미하며, 서버는 이 헤더를 통해 데이터를 적절히 처리할 수 있습니다. 이를 통해 클라이언트와 서버가 데이터를 주고받을 때 형식을 명확히 하여 호환성을 보장할 수 있습니다.
응답 HTTP 상태 코드
HTTP 상태 코드 | 설명 |
200 - OK | 요청이 성공적으로 처리되었습니다. |
400 - Bad Request | 요청을 처리할 수 없습니다. 필수 파라미터를 보내지 않았거나, 파라미터 포맷이 잘못되었을 때 돌아오는 응답입니다. 요청 파라미터를 확인해주세요. |
403 - Forbidden | 시크릿 키 없이 요청했거나 사용한 시크릿 키가 잘못되었습니다. |
404 - Not Found | 요청한 리소스가 존재하지 않습니다. 요청한 API 주소를 다시 한 번 확인해보세요. |
500 - Server Error | 잽페이 서버에서 에러가 발생했습니다. |
에러 객체
요청이 정상적으로 처리되지 않으면 응답으로 HTTP 상태 코드와 함께 아래와 같은 에러 객체가 돌아옵니다.
{
"error_code": "ORDER_NOT_FOUND",
"message": "해당 tid에 대한 주문을 찾을 수 없습니다."
"version": "v1"
}
JSON
복사
•
error_code: 에러 타입을 보여주는 에러 코드입니다.
•
message: 에러 메시지입니다. 에러 발생 이유를 알려줍니다.
•
version: 현재 요청한 API의 버전을 알려줍니다.
에러 코드
API 헤더 에러
HTTP Status Code | 에러 코드 | 메시지 |
403 | INVALID_SECRET_KEY | 유효하지 않은 시크릿 키입니다. |
결제 준비
HTTP Status Code | 에러 코드 | 메시지 |
400 | MISSING_FIELDS | 모든 필드를 입력해주세요. |
400 | INVALID_PAYMENT_TYPE | 유효하지 않은 결제 유형입니다. (general 또는 corporate 값만 허용) |
409 | ORDER_ALREADY_EXISTS | 해당 order_id에 대한 중복된 주문 요청입니다. |
500 | DB_ERROR | 주문 생성 중 데이터베이스 오류가 발생했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |
500 | INTERNAL_ERROR | 결제 준비에 실패했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |
504 | NETWORK_TIMEOUT | 네트워크 타임아웃이 발생했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |
결제 승인
HTTP Status Code | 에러 코드 | 메시지 |
400 | STORE_ID_MISMATCH | 가맹점 정보가 일치하지 않습니다. |
400 | ORDER_ID_MISMATCH | 주문 정보가 일치하지 않습니다. |
404 | USER_NOT_FOUND | 해당 user_id가 존재하지 않습니다. |
401 | INVALID_PASSWORD | 비밀번호가 일치하지 않습니다. |
404 | ORDER_NOT_FOUND | 해당 tid에 대한 주문을 찾을 수 없습니다. |
409 | ORDER_ALREADY_PROCESSED | 해당 tid에 대한 주문은 이미 처리되었거나 취소된 주문입니다. |
500 | MINTING_FAILED | 결제 과정에서 오류가 발생했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |
500 | DB_UPDATE_FAILED | 결제 승인 중 데이터베이스 업데이트에 실패했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |
500 | WEBHOOK_FAILED | 웹훅 전송 중 오류가 발생했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |
500 | INTERNAL_ERROR | 결제 승인에 실패했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |
504 | NETWORK_TIMEOUT | 웹훅 전송 중 네트워크 타임아웃이 발생했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |
결제 취소
HTTP Status Code | 에러 코드 | 메시지 |
400 | ORDER_NOT_PROCESSED | 존재하지 않는 거래 tid 입니다. |
400 | STORE_ID_MISMATCH | 가맹점 정보가 일치하지 않습니다. |
400 | ORDER_ID_MISMATCH | 주문 정보가 일치하지 않습니다. |
404 | ORDER_NOT_FOUND | 해당 tid에 대한 주문을 찾을 수 없습니다. |
409 | ORDER_ALREADY_CANCELED | 해당 tid에 대한 주문은 이미 취소되었습니다. |
500 | BURNING_FAILED | 결제 취소 중 오류가 발생했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |
500 | DB_UPDATE_FAILED | 결제 취소 중 데이터베이스 업데이트에 실패했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |
500 | INTERNAL_ERROR | 결제 취소에 실패했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |
504 | NETWORK_TIMEOUT | 네트워크 타임아웃이 발생했습니다. 다시 요청을 시도해주세요. 같은 문제가 반복된다면 고객센터에 문의해주세요. |