English

简体中文

English

简体中文

Appearance

About Pay Transaction ​

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

Payment is a core component of Genstore's transaction processing. It provides complete payment and refund information query capabilities. Through this module, merchants can track payment and refund status, platform transaction IDs, and processing timestamps to ensure precise transaction monitoring.

Core Concepts

  • Payment Record: Transaction documentation containing payment status, processing time, and platform-generated transaction ID.
  • Refund Record: Refund documentation containing refund status, processing time, and platform-generated refund ID.
  • ID System:
    • Internal Transaction ID: Genstore's internal identifier for payments and refunds.
    • Platform Transaction ID: Transaction reference number generated by external payment platforms.
    • Order/Refund ID: Reference number from the merchant's business system.

Core Features

  • Query Payment: Retrieve payment details through internal payment transaction ID, including payment order status, platform transaction ID, and payment success time, among other information.
  • Query Refund: Retrieve refund details through internal refund transaction ID, including payment order status, platform transaction ID, and payment success time, among other information.

Use Cases

  • Payment Tracking: Merchants can monitor payment status in real-time to confirm transaction completion.
  • Refund Monitoring: Operations teams can track refund progress to ensure timely processing.
  • Transaction Reconciliation: Finance teams can reconcile transactions with external payment platforms using platform transaction IDs.

Endpoints

GET /api/202412/payment/{paymentId}: Get payment

Pay Transaction Object ​

The payment transaction object.

Properties ​

paymentobject
- Hide child properties
channelTrxNostring
Outer channel transaction number.
paymentIdstring
The unique identifier of the payment.
outOrderNostring
The order no corresponding to the transaction.
successPaymentTimestring
Payment success time, format YYYY-MM-DDThh:mm:ssTZD ISO-8601.
statusstring
Payment status. Enumeration values: 1 - process; 2 - success; 3 - auth_void; 4 - auth_success; 9 - failure.
currencystring
The ISO 4217 currency code of the transaction.
amountnumber
The gross amount of the transaction.
feenumber
The total amount of fees.
netnumber
The net amount of the transaction.
bash
{
  "payment": {
    "successPaymentTime": "2019-06-28T18:03:50+01:00",
    "amount": "123.23",
    "channelTrxNo": "0SX593062F1597043",
    "paymentId": "PI0020241010151755224",
    "fee": "5.01",
    "currency": "USD",
    "net": "118.22",
    "outOrderNo": "101010101000000000136",
    "status": "1"
  }
}

GET Get payment ​

Query payment information.

Access scope

Requires ANY of the following access scopes: write_payments_transaction read_payments_transaction

Endpoint

GET /api/202412/payment/{paymentId} 

Request Params

paymentIdstring
The unique identifier of the payment.

Response Data

paymentobject
The payment information.
- Hide child properties
channelTrxNostring
Outer channel transaction number.
paymentIdstring
The unique identifier of the payment.
outOrderNostring
The order no corresponding to the transaction.
successPaymentTimestring
Payment success time, format YYYY-MM-DDThh:mm:ssTZD ISO-8601.
statusstring
Payment status. Enumeration values: 1 - process; 2 - success; 3 - auth_void; 4 - auth_success; 9 - failure.
currencystring
The ISO 4217 currency code of the transaction.
amountnumber
The gross amount of the transaction.
feenumber
The total amount of fees.
netnumber
The net amount of the transaction.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/payment/{paymentId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "payment": {
    "successPaymentTime": "2019-06-28T18:03:50+01:00",
    "amount": "123.23",
    "channelTrxNo": "0SX593062F1597043",
    "paymentId": "PI0020241010151755224",
    "fee": "5.01",
    "currency": "USD",
    "net": "118.22",
    "outOrderNo": "101010101000000000136",
    "status": "1"
  }
}