Downloading the Credit Card Disbursement Balance Statement File

Scenario

Merchants can download their credit card disbursement statement in CSV format.

Step 1. Merchant: Transmit the credit card disbursement details and category to ECPay via POST (HTTP Method) for inquiry.
Step 2. ECPay : Upon receiving merchant’s credit card disbursement inquiry and checking details, return a CSV file for the merchant to download.

API URLS

Production :https://payment.ecPay.com.tw/CreditDetail/FundingReconDetail
Stage: This API can not be used because no real authorizations can be provided.

HTTPS Transfer Protocol

Content Type ：application/x-www-form-urlencoded
HTTP Method ：POST

Merchant return parameter description

MerchantID String(10)
Required

PayDateType String(10)
Required

Search date category.
The date category to be inquired

fund: Check settlement date
close: Check capture date
enter: Check appropriation date

StartDate String(10)
Required

Query start date.
The start date of the query Date format is “yyyy-MM-dd“.

Special Note：The search date must be after 14:00 on the bank’s working day to find the information.
Ex: 1/16 and 1/17 are bank holidays, data for 1/15~1/17 can only be found after 14:00 on 1/18; the search date must be 1/18.

EndDate String(10)
Required

Query end date.
The end date of the query Date format is “yyyy-MM-dd“.

CheckMacValue String
Required

Checksum.
Please refer to the Appendix Checksum Mechanism.

Response CSV File Format Details (Chinese only)

序號 String

授權單號 String

授權碼 String

訂單編號 String

交易日期 String

The default format is yyyyMMdd

請款日期 String

The default format is yyyyMMdd

交易金額 Int

In the case of a refund, this amount will be negative.

服務費(%數) Int

撥款金額 Int

Special Note：Credit card funding information for today’s orders will only be available after 14:00 on the next day. Credit card funding is only available on bank working days, not on holidays or non-working days.

YAML

The provided YAML file is used to define information such as the configuration, structure, operations, and infrastructure management of the API, making it easier for developers to understand and use the API.

				
					openapi: 3.1.0
info:
  title: ECPay Credit Card Disbursement Reconciliation API
  version: 1.0.0
  description: API for downloading CSV files of credit card disbursement reconciliation details.
servers:
  - url: https://payment.ecpay.com.tw
    description: Production Environment
paths:
  /CreditDetail/FundingReconDetail:
    post:
      summary: Download credit card disbursement reconciliation file
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                MerchantID:
                  type: string
                  description: Merchant ID provided by ECPay
                PayDateType:
                  type: string
                  description: Date type for query
                  enum:
                    - fund
                    - close
                    - enter
                StartDate:
                  type: string
                  description: Start date of the query (yyyy-MM-dd)
                EndDate:
                  type: string
                  description: End date of the query (yyyy-MM-dd)
                CharSet:
                  type: string
                  description: File encoding format
                  enum:
                    - 1
                    - 2
                CheckMacValue:
                  type: string
                  description: CheckMacValue for data verification
              required:
                - MerchantID
                - PayDateType
                - StartDate
                - EndDate
                - CheckMacValue
      responses:
        '200':
          description: Successful response
          content:
            text/csv:
              schema:
                type: string
                description:  |
                      CSV 格式如下:
                      ```
                      序號 , 授權單號 , 授權碼 , 訂單編號 , 交易日期 , 請款日期 , 交易金額 , 服務費(%數) , 撥款金額

                      ```

Green World