Get payment order

GET 
/openapi/2025-06/shoplazza-payment/payment-orders/:id

Returns the details of a single payment order identified by its unique ID.

Request

Path Parameters

id stringrequired

Payment order ID

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

payment_order object

Detailed information of the payment order

idstring

Payment order ID

fee_details object

Breakdown of transaction fees charged on this payment order

trans_fee_amountstring

Transaction fee amount charged on the payment order

fee_currencystring

Currency code of the transaction fee (e.g., USD, EUR)

foreign_settlement_feestring

Foreign settlement fee charged when settling across regions or currencies

created_atstring

Time when the payment order was created (e.g., 2018-11-02T12:30:10Z)

finished_atstring

Time when the payment order reached its final state (e.g., 2018-11-02T12:30:10Z)

payment_statusstring

Current payment status of the order:

• succeeded: payment completed successfully and funds are confirmed
• failed: payment failed and funds were not processed
• requires_action: additional action required to complete the payment (e.g., 3D Secure verification)
• init: payment order created but not yet processed
• canceled: payment order canceled; funds were not processed or have been returned
• processing: payment is being processed; final result pending

payment_methodstring

Payment method used for the order (e.g., credit card, PayPal)

card_brandstring

Brand of the credit card used for the payment (e.g., Visa, Mastercard)

pay_currencystring

Currency in which the shopper paid (e.g., USD, EUR)

pay_mountstring

Amount paid by the shopper in pay_currency

converted_amountstring

Payment amount converted into the store's base currency

reserve_amountstring

Reserve amount

order_idstring

Identifier of the order this payment is associated with

fee_amountstring

Total service charge amount for this payment order

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "payment_order": {
      "id": "string",
      "fee_details": {
        "trans_fee_amount": "string",
        "fee_currency": "string",
        "foreign_settlement_fee": "string"
      },
      "created_at": "string",
      "finished_at": "string",
      "payment_status": "string",
      "payment_method": "string",
      "card_brand": "string",
      "pay_currency": "string",
      "pay_mount": "string",
      "converted_amount": "string",
      "reserve_amount": "string",
      "order_id": "string",
      "fee_amount": "string"
    }
  }
}