Skip to content
FlySIPFlySIP Docs

Get payment details

getPaymentInfo returns one payment, for example to check the outcome of a card payment. getPaymentsList lists the payments of your accounts and customers: card and voucher payments as well as manual balance changes.

Both methods support trusted mode with i_wholesaler, the ID of the customer that owns the payer.

Payment structure

Section titled “Payment structure”
Name Type Description
i_payment int ID of the payment. Returned by getPaymentsList only
i_account int ID of the account that made the payment. Returned by getPaymentsList only
i_customer int ID of the customer that made the payment. Returned by getPaymentsList only
payment_time string Time of the payment, UTC, in the format %H:%M:%S.000 GMT %a %b %d %Y, for example 09:57:29.000 GMT Wed Nov 18 2009
amount double Amount of the payment. A debit has a negative amount
currency string ISO 4217 code of the payer’s base currency
tx_id string Transaction ID from the payment processor
tx_error string Error message from the payment processor
tx_result int Result of the transaction, see the values of tx_result
by_credit_debit_card boolean True when the payment was made with a card through a payment processor
by_voucher boolean True when the payment was made with a top-up voucher
notes string Notes of the payment

Values of tx_result

Section titled “Values of tx_result”
Value Meaning Result in the panel
1 Successful OK
2 Failed FAIL
3 Reversed REVERSE
4 Pending, waiting for the payment processor PENDING
5 Completed COMPLETED

getPaymentInfo

Section titled “getPaymentInfo”

Returns one payment.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int one of ID of the account that made the payment
i_customer int one of ID of the customer that made the payment
i_payment int yes ID of the payment, as returned by makePayment

Returns

Section titled “Returns”
Name Type Description
result string OK
… The fields of the payment structure, except i_payment, i_account and i_customer

Example

Section titled “Example”
request
call("getPaymentInfo", {"i_account": 3092, "i_payment": 88213})
response
{
    "result": "OK",
    "payment_time": "10:15:42.000 GMT Thu Jan 15 2026",
    "amount": 20.0,
    "currency": "USD",
    "tx_id": "ch_3PqX9b2eZvKYlo2C",
    "tx_error": "",
    "tx_result": 1,
    "by_credit_debit_card": True,
    "by_voucher": False,
    "notes": "",
}

getPaymentsList

Section titled “getPaymentsList”

Lists payments. Without i_account and i_customer it lists the payments of all your accounts and customers.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int no Return only the payments of this account
i_customer int no Return only the payments of this customer
start_date string no Return payments from this time, in the payment_time format
end_date string no Return payments up to this time, in the payment_time format
type string no credit for payments that increased the balance, debit for payments that decreased it. Default: both
offset int no Skip this many payments
limit int no Return at most this many payments

Returns

Section titled “Returns”
Name Type Description
result string OK
payments array The payments, each with the fields of the payment structure

Example

Section titled “Example”
request
call("getPaymentsList", {
    "i_account": 3092,
    "start_date": "00:00:00.000 GMT Thu Jan 01 2026",
    "type": "credit",
})
response
{
    "result": "OK",
    "payments": [
        {
            "i_payment": 88213,
            "i_account": 3092,
            "i_customer": 17,
            "payment_time": "10:15:42.000 GMT Thu Jan 15 2026",
            "amount": 20.0,
            "currency": "USD",
            "tx_id": "ch_3PqX9b2eZvKYlo2C",
            "tx_error": "",
            "tx_result": 1,
            "by_credit_debit_card": True,
            "by_voucher": False,
            "notes": "",
        },
    ],
}
Section titled “Related”