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

Method: GET

Definitions

Field	Type	Description
bank	object	Account holder's checking account or debit card information in which payouts will be sent.
type	string	Type of payout destination. Options are bank_account or debit_card.
account_number	integer	Account number associated with the account holder's checking account.
routing_number	integer	Routing number associated with the account holder's checking account.
card_number	integer	16 digit card number associated with the account holder's debit card.
expiration	integer	4 digit expiration associated with the account holder's debit card. Format: MMYY
cvv	integer	3 digit security code associated with the account holder's debit card.
kyc_status	string	Current status of identity verification for the account holder. Note: See Appendix E for definitions.
transfer	object	Details associated with the transfer of funds to the account holder.
date	string	Date of transfer to the account holder. Format: MM/dd/yyyy HH:mm
amount	decimal	The amount transferred to the account holder. Note: Currency is determined by the SKU issued.
transaction	string	Transaction note associated with the transfer.
status	string	The 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"
      }
    ]
  }
}