Get Payout Status

Endpoint: https://rest.virtualincentives.com/{version}/{format}/payout/{id}/status

Method: GET

Definitions

FieldTypeDescription
bankobjectAccount holder's checking account or debit card information in which payouts will be sent.
typestringType of payout destination. Options are bank_account or debit_card.
account_numberintegerAccount number associated with the account holder's checking account.
routing_numberintegerRouting number associated with the account holder's checking account.
card_numberinteger16 digit card number associated with the account holder's debit card.
expirationinteger4 digit expiration associated with the account holder's debit card.

Format: MMYY
cvvinteger3 digit security code associated with the account holder's debit card.
kyc_statusstringCurrent status of identity verification for the account holder.

Note: See Appendix E for definitions.
transferobjectDetails associated with the transfer of funds to the account holder.
datestringDate of transfer to the account holder.

Format: MM/dd/yyyy HH:mm
amountdecimalThe amount transferred to the account holder.

Note: Currency is determined by the SKU issued.
transactionstringTransaction note associated with the transfer.
statusstringThe current state of the transaction.

Note: See Appendix D for definitions.

Examples

Response XML

<payout_status>
  <bank>
    <type>debit_card</type>
    <card_number>************7900</card_number>
    <expiration>0724</expiration>
    <cvv>***</cvv>
  </bank>
  <kyc_status>Identity Verification Verified</kyc_status>
  <transfers>
    <transfer>
      <date>03/06/2023 18:29</date>
      <amount>-10.00</amount>
      <transaction>Payment to Cardholder Account Ending 7900</transaction>
      <status>COMPLETION</status>
    </transfer>
    <transfer>
      <date>03/06/2023 18:29</date>
      <amount>10.00</amount>
      <transaction>Payout from Virtual Incentives</transaction>
      <status>COMPLETION</status>
    </transfer>
  </transfers>
</payout_status>

Response JSON

{
  "payout_status": {
    "bank": {
      "type": "debit_card",
      "card_number": "************7900",
      "expiration": "0724",
      "cvv": "***"
    },
    "kyc_status": "Identity Verification Verified",
    "transfers": [
      {
        "date": "03/06/2023 18:29",
        "amount": -10.00
        "transaction": "Payment to Cardholder Account Ending 7900",
        "status": "COMPLETION"
      },
      {
        "date": "03/06/2023 18:29",
        "amount": 10.00,
        "transaction": "Payout from Virtual Incentives",
        "status": "COMPLETION"
      }
    ]
  }
}