Skip to content

Download Statement

Function Description

Generate the reconciliation file for Day D at 1:00 AM on Day 1 in the Asia/Riyadh (+03,+0300) time zone:

  • File name:GCCRECO_{MERCHANT_NAME}_{MERCHANT_ID}_{YYYYMMDD}
    • MERCHANT_NAME: Merchant name
    • MERCHANT_ID: Merchant ID
    • YYYYMMDD:Transaction date(D-1)

Download Statement API

WARNING

The HTTP status code (non code) for successful file response is 200. If the file is being processed, the HTTP status code (non code) for response is 202

Request URL

  • /payee/statement

Request Method

  • GET

Request Parameters

The request parameters are as follows:

ParameterRequiredTypeDefault ValueDescription
dayNstringD-1Statement date, format: YYYY mm dd, default to the previous day

Response Parameters

The HTTP status code is 200 and returns as a file response. The file format is xlsx. Please save the file yourself;

When the HTTP status code is 202, JSON data is returned. When the HTTP status code is 202, the current request should be abandoned and the download request should be reissued after a certain delay.

Statement File Header

NameDescription
Merchant_IDMerchant ID
Merchant_NameMerchant name
Payment_IDPayment ID
Payee_UIDMerchant payment order number
Payment_MethodPayment method
Payment_Create_TimePayment creation time
Payment_Complete_TimePayment completion time
AmountTotal payment amount
FeeHandling fee
Real_AmountActual payment amount
CurrencyCurrency
Payment_StatusPayment status
Custom_IDCustomer ID
Custom_Name_ECustomer English name
Custom_Name_ACustomer Arabic name
Custom_Bank_NameCustomer bank name
Custom_Bank_CodeCustomer bank code
Custom_Card_NoCustomer's bank card number (card number is desensitized and only displays the first six and last four, with a * in the middle instead)
Custom_IbanCustomer IBAN
Custom_STCPay_AccountCustomer STCPay account