Skip to main content

SafetyPay Get Payout State Response

getPayoutStateReturn object
resultCodeinteger
Example: 0
errorCodeinteger
Example: 0
errorCodeDescriptionstringnullable
Example:
payoutState object[]
  • Array [
  • midstring

    Ten-digit merchant ID for the merchant and currency pair.

    Example: 9000000008
    currencystring

    Currency associated with the MID.

    Example: PYG
    totalPayoutAmountnumber<double>

    Total payouts executed on the MID during the current billing cycle.

    Example: 0
    totalPaymentAmountnumber<double>

    Total payments executed on the MID during the current billing cycle.

    Example: 0
    creditLinenumber<double>

    Additional payout credit line for the MID.

    Example: 10000
    totalPayoutBalancenumber<double>

    Amount that can still be paid out during the billing cycle.

    Example: 10000
    dailyPayoutLimitnumber<double>

    Maximum payout amount configured for the MID per day.

    Example: 10000
    dailyPayoutAmountnumber<double>

    Total amount paid out on the MID during the current day.

    Example: 0
    dailyPayoutBalancenumber<double>

    Amount that can still be paid out on the MID during the current day.

    Example: 10000
  • ]
  • SafetyPay Get Payout State Response
    {
    "getPayoutStateReturn": {
    "resultCode": 0,
    "errorCode": 0,
    "errorCodeDescription": "",
    "payoutState": [
    {
    "mid": "9000000008",
    "currency": "PYG",
    "totalPayoutAmount": 0,
    "totalPaymentAmount": 0,
    "creditLine": 10000,
    "totalPayoutBalance": 10000,
    "dailyPayoutLimit": 10000,
    "dailyPayoutAmount": 0,
    "dailyPayoutBalance": 10000
    }
    ]
    }
    }