Skip to main content
Version: 202201

Get Payment Order

GET 
/openapi/2024-07/shoplazza-payment/payment-orders/:id

Retrieves the details of a PaymentOrder that has previously been created

Request​

Path Parameters

    id stringrequired

    id

Responses​

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object

    Request: Retrieve payment order

    payment_order object

    Payment order details

    idstring

    Payment order ID

    fee_details object

    Fee details

    trans_fee_amountstring

    Acquiring fee amount

    fee_currencystring

    Fee currency

    foreign_settlement_feestring

    Foreign settlement fee

    created_atstring

    Creation time, in Unix timestamp

    finished_atstring

    Payment completion time, in Unix timestamp

    payment_statusstring

    Payment status (e.g., "succeeded", "failed","requires_action","init","canceled","processing") succeeded: The payment has been completed successfully, and the funds are confirmed. failed: The payment has failed, and the funds were not successfully processed. requires_action: Additional action is required to complete the payment, such as user verification (e.g., 3D authentication) or additional information. init: The payment order has been created but not yet processed. canceled: The payment order has been canceled, and no funds were processed or they have been returned. processing: The payment is currently in process, with the final result pending confirmation.

    payment_methodstring

    Payment method

    card_brandstring

    Card brand (e.g., Visa, Mastercard)

    pay_currencystring

    Transaction currency

    pay_amountstring

    Transaction amount in the original currency

    converted_amountstring

    Amount after currency conversion

    reserve_amountstring

    Frozen reserve amount

    order_idstring

    Order number