Requiresorderaccess scope. For more info, refer to:access scope
Transaction Properties
Field | Type | Desc |
|---|---|---|
id | string | |
order_id | string | Order ID |
payment_channel | string | Payment channel
|
message | string | JSON returned by payment provider with additional information about transaction success or failure reason |
created_at | string | The |
test | boolean | Whether it's a test order |
error_code | string | Error code |
amount | string | Transaction amount |
currency | string | Transaction currency |
trade_id | string | The unique identifier for the transaction provided by the payment provider. This ID is generated and maintained by the payment service (e.g., PayPal, Stripe) to track the transaction on their side. |
payment_details | PaymentDetails | Payment details |
PaymentDetails
| Field | Type | Desc |
|---|---|---|
| card_number | string | Credit card number, showing only the first 6 and last 4 digits |
| card_month | string | Credit card expiration month |
| card_year | string | Credit card expiration year |
| card_first_name | string | Cardholder's first name |
| card_last_name | string | Cardholder's last name |
| card_first_six | string | First 6 digits of the card number |
| card_last_four | string | Last 4 digits of the card number |
| avs_result_code | string | Address Verification System response code |
| cvv_result_code | string | Response code from the credit card company indicating if the customer correctly entered the card's security code or CVV |
Field Introduction: Transaction Status
1. status
statusThe status field indicates the current transaction status. Below are the possible values:
authorized- The transaction has been authorized but not yet completed.void- The transaction has been canceled.processing- The transaction is currently being processed.success- The transaction was successfully completed.error- The transaction failed due to an error.refunding- A refund for the transaction is in progress.refunded- The transaction has been successfully refunded.refund_failed- The refund attempt for the transaction has failed.expire- The transaction has expired.
Example
{
"id": "2150768865",
"order_id": "633130-00000007",
"payment_channel": "bogus",
"message": "",
"created_at": "2024-04-19 09:54:03",
"test": true,
"error_code": "",
"amount": "109.9000",
"currency": "CNY",
"trade_id": "test_633130-00000007",
"status": "success",
"payment_details": {
"card_number": "420000******0000",
"card_month": "01",
"card_year": "27",
"card_first_name": "ryan",
"card_last_name": "zhang",
"card_first_fix": "420000",
"card_last_four": "0000",
"avs_result_code": "",
"cvv_result_code": ""
},
"payment_name": ""
}