Method: remittanceStatementNotification

통합업체에 새 송금 명세서를 알립니다.

명세서 알림은 Google이 통합업체에 지불할 금액 또는 통합업체가 Google에 지불해야 하는 금액을 나타내는 새 명세서가 제출될 때마다 이루어집니다.

통합자가 성공을 반환하면 명세서 수신을 확인합니다.

requestId는 다른 곳에서 사용된 문 ID이기도 합니다. 헤더 내의 requestId와 paymentIntegratorAccountId의 조합은 멱등성 키이며 이 문을 고유하게 식별합니다.

요청을 처리하는 동안 엔드포인트에서 오류가 발생하면 이 엔드포인트의 응답 본문은 ErrorResponse 유형이어야 합니다.

요청의 예는 다음과 같습니다.


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "0123434-statement-abc",
    "requestTimestamp": "1502632800000"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "remittanceStatementSummary": {
    "statementDate": "1502607600000",
    "billingPeriod": {
      "startDate": "1502434800000",
      "endDate": "1502521199000"
    },
    "dateDue": "1503212400000",
    "currencyCode": "INR",
    "totalDueByIntegrator": "1076000000",
    "remittanceInstructions": {
      "memoLineId": "stmt-1AB-pp0-invisi"
    }
  }
}

응답의 예는 다음과 같습니다.


{
  "responseHeader": {
    "responseTimestamp": "1502632802000"
  },
  "paymentIntegratorStatementId": "334a",
  "result": "ACCEPTED"
}

HTTP 요청

POST https://www.integratorhost.example.com/v1/remittanceStatementNotification

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  }
}
필드
requestHeader

object (RequestHeader)

필수: 모든 요청의 공통 헤더입니다.
paymentIntegratorAccountId

string

필수: 이 명세서의 계약상 제약 조건을 식별하는 결제 통합업체 계정 식별자입니다.
remittanceStatementSummary

object (RemittanceStatementSummary)

필수: 이 송금 명세서의 요약입니다.

응답 본문

송금 명세서 알림 메서드의 응답 객체입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorStatementId": string,
  "result": enum (StatementNotificationResultCode)
}
필드
responseHeader

object (ResponseHeader)

필수: 모든 응답의 공통 헤더입니다.
paymentIntegratorStatementId

string

필수: 통합업체가 이 문을 알고 있는 식별자입니다. 이는 통합업체에서 생성합니다.
result

enum (StatementNotificationResultCode)

필수: 이 문 알림의 결과입니다.

RequestHeader

서버로 전송되는 모든 요청에 정의된 헤더 객체입니다.

JSON 표현 
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
필드
requestId

string

필수: 이 요청의 고유 식별자입니다.

이 문자열은 최대 길이가 100자(영문 기준)이며 'a~z', 'A~Z', '0~9', ':', '-', '_' 문자만 포함합니다.
requestTimestamp

string (int64 format)

필수: 이 요청의 타임스탬프로, 에포크 이후 경과된 밀리초로 표시됩니다. 수신자는 이 타임스탬프가 '현재'의 ±60초인지 확인해야 합니다. 이 요청 타임스탬프는 재시도 시 멱등성이 없습니다.
userLocale
(deprecated)

string

지원 중단됨: 2자 또는 3자로 된 ISO 639-2 Alpha 3 언어 코드로, 하이픈과 ISO 3166-1 Alpha-2 국가 코드(예: 'pt', 'pt-BR', 'fil', 'fil-PH')를 선택적으로 추가할 수 있습니다. 응답에서 userMessage 필드를 만드는 데 사용합니다.
protocolVersion

object (Version)

필수: 이 요청의 버전입니다.

버전

기본 a.b.c 버전 구조의 구조화된 형식인 버전 객체 동일한 번호의 메이저 버전은 호환성이 보장됩니다. 부 버전 및 버전은 예고 없이 자주 변경될 수 있습니다. 통합자는 동일한 주 버전에 대한 모든 요청을 지원해야 합니다.

JSON 표현 
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
필드
major

integer

필수: 메이저 버전입니다. 버전이 다르면 호환성 요청이 표시되어도 호환성이 보장되지 않습니다.
minor

integer

필수: 마이너 버전입니다. 중요한 버그 수정을 나타냅니다.
revision

integer

필수: 마이너 버전입니다. 사소한 버그 수정을 나타냅니다.

RemittanceStatementSummary

송금 명세서에 대한 요약 객체입니다.

JSON 표현 
{
  "statementDate": string,
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": string,
  "currencyCode": string,
  "totalDueByIntegrator": string,
  "remittanceInstructions": {
    object (RemittanceInstructions)
  }
}
필드
statementDate

string (int64 format)

필수: 이 문이 작성된 날짜 (미국/로스앤젤레스)입니다.
billingPeriod

object (BillingPeriod)

필수: 이 명세서에 포함된 결제 기간입니다.
dateDue

string (int64 format)

선택사항: 송금 기한입니다. 에포크로부터의 밀리초로 표시됩니다. 날짜입니다 (따라서 항상 청구 시간대에서 하루 중 첫 번째 밀리초에 시작됨).

이 값은 totalDueByIntegrator이 0보다 크면 설정됩니다.
currencyCode

string

필수: ISO 4217 3자리 통화 코드입니다.
totalDueByIntegrator

string (Int64Value format)

필수: 이 값은 currencyCode 통화의 마이크로 단위입니다. 이 값은 항상 양수입니다.
remittanceInstructions

object (RemittanceInstructions)

필수: 결제 방법에 대한 세부정보

BillingPeriod

이 명세서의 결제 기간입니다.

JSON 표현 
{
  "startDate": string,
  "endDate": string
}
필드
startDate

string (int64 format)

필수: 결제 기간의 시작일입니다. 에포크로부터의 밀리초로 표시됩니다. 날짜입니다 (따라서 항상 청구 시간대에서 하루 중 첫 번째 밀리초에 시작됨).

결제 기간의 첫 번째 밀리초(00:00:00.000)입니다.
endDate

string (int64 format)

필수: 결제 기간의 종료일입니다. 에포크로부터의 밀리초로 표시됩니다.

결제 기간의 마지막 날의 마지막 밀리초(23:59:59.999)입니다.

RemittanceInstructions

송금 알림 결제 방법에 대한 정보를 보유한 집입니다.

JSON 표현 
{
  "memoLineId": string
}
필드
memoLineId

string

필수: 송금 식별을 위해 결제 관련 메모 행에 필수로 입력해야 하는 식별자입니다.

ResponseHeader

서버에서 전송된 모든 응답에 정의된 헤더 객체입니다.

JSON 표현 
{
  "responseTimestamp": string
}
필드
responseTimestamp

string (int64 format)

필수: 에포크 이후 밀리초로 표시되는 이 응답의 타임스탬프입니다. 수신자는 이 타임스탬프가 '현재'의 ±60초인지 확인해야 합니다.

StatementNotificationResultCode

명령문 알림의 결과 코드입니다.

열거형
UNKNOWN_RESULT 이 기본값을 설정해서는 안 됩니다.
ACCEPTED 통합업체가 이 진술을 수락했습니다.