Skip to content

`OrderPaymentList_Load`#

Description#

This function allows you to request all payment records associated with an order.

Request Body Parameters#

Parameter	Type	Description
`Order_ID`	Number	Order Id you want to load payment records from

Response Parameters#

Parameter	Type	Description
`id`	Number	Payment Record Id
`order_id`	Number	Order Number
`type`	Number	0 = declined, 1 = Legacy Authorization, 2 = Legacy Capture, 3 = Authorization, 4 = Capture, 5 = Auuthorization + Capture, 6 = Refund, 7 = VOID
`refnum`	String	Payment Reference Number. This field typically holds the auth id/code for the transaction which is used by external systems to capture/refund the transaction.
`amount`	Number	Payment Record Amount
`formatted_amount`	String	Currency Formatted Amount
`available`	Number	Amount authorized which is available for capture
`formatted_available`	String	Currency formatted amount authorized which is available for capture
`dtstamp`	Unix Timestamp	Unix Timestamp for payment record date
`expires`	Unix Timestamp	Payment Expiration date
`pay_id`	Number	Id of Payment Module used for Payment
`pay_secid`	Number	Payment Secure Id

Example Request#

{
    "Store_code": "beta",
    "Function": "OrderPaymentList_Load",
    "Order_ID": 200102
}

Example Response#

{
    "success": 1,
    "data": [
        {
            "id": 2,
            "order_id": 200102,
            "type": 1,
            "refnum": "200102",
            "amount": 7.0,
            "formatted_amount": "$7.00",
            "available": 7.0,
            "formatted_available": "$7.00",
            "dtstamp": "1536097658",
            "expires": "",
            "pay_id": 115,
            "pay_secid": 0
        },
        {
            "id": 4,
            "order_id": 200102,
            "type": 3,
            "refnum": "cj35mhgm",
            "amount": 1.0,
            "formatted_amount": "$1.00",
            "available": 1.0,
            "formatted_available": "$1.00",
            "dtstamp": "1537307983",
            "expires": "",
            "pay_id": 113,
            "pay_secid": 0
        }
    ]
}