Create Wallet

Create a wallet for person on Qolo platform. If the person is already created, send an existing Person GUID.

Request
Security:
Bearer
path Parameters
version
required
string
Request Body schema: application/json
account_currencies
Array of strings or null

List of currencies for account creation. Valid only if create_account is passed as true.

person_guid
string <uuid>

Person Guid

program_guid
string <uuid>

Program Guid

account_name
string or null

Name of account provided by the API client.

wallet_name
string or null
Responses
201

Returns the newly created Wallet

400

Bad request

401

Unauthorized

404

Program not found

500

Server Error

post/api/{version}/wallets
Request samples
application/json
{
  • "account_currencies": [
    • "string"
    ],
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "account_name": "string",
  • "wallet_name": "string"
}
Response samples
application/json
{
  • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
  • "wallet_id": "string",
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "program_name": "string",
  • "program_short_name": "string",
  • "eft_display_name": "string",
  • "sponsor_name": "string",
  • "parent_program_guid": "4c73d8e3-85f7-42e5-9a39-2376fdcc4881",
  • "top_program_guid": "c67bc77e-3255-4696-a119-8c3b1cf9b3b3",
  • "company_dba_name": "string",
  • "company_short_name": "string",
  • "account_status": "string",
  • "wallet_created": "2019-08-24T14:15:22Z",
  • "wallet_name": "string",
  • "accounts": [
    • {
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
      • "account_currency": "string",
      • "account_name": "string",
      • "account_type": "GENERAL",
      • "available_balance": 0,
      • "ledger_balance": 0,
      • "suspense_balance": 0,
      • "advance_account_details": {
        • "account": {
          • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
          • "client_reference_id": "6970735e-7ed9-436b-b2f2-f25200dba6b0",
          • "start_date": "2019-08-24T14:15:22Z",
          • "limit": 0,
          • "outstanding_balance": 0,
          • "credit_product": "string",
          • "cycle": "string",
          • "status": "string",
          • "payment_summary": {
            • "outstanding_principal": 0,
            • "disbursement_amount": 0,
            • "processing_fees": 0,
            • "carriedbalance_fees": 0,
            • "total_repayment": 0,
            • "number_of_payments": 0
            },
          • "payment_schedule": [
            • {
              • "mob": 0,
              • "date": "2019-08-24T14:15:22Z",
              • "disbursement_principal": 0,
              • "disbursement_fee": 0,
              • "total": 0,
              • "fee": 0,
              • "principal": 0,
              • "balance": 0,
              • "paid_principal": 0,
              • "paid_interest": 0,
              • "available_balance": 0,
              • "cycle": "string",
              • "type": "string",
              • "status": "string"
              }
            ],
          • "available_date_range": [
            • {
              • "name": "string",
              • "date": "2019-08-24T14:15:22Z"
              }
            ]
          }
        },
      • "account_status": "SYSTEM",
      • "last_txn_guid": "100ead98-12b5-4d05-9c0c-900006fc8694",
      • "post_date": "2019-08-24T14:15:22Z",
      • "amount": 0,
      • "mask_account_number": "string",
      • "sys_utcinserted": "2019-08-24T14:15:22Z",
      • "status_change_nonmon_detail": {
        • "nonmon_guid": "3df16cd2-de7f-4e81-936e-7604855d1fd7",
        • "txn_date": "2019-08-24T14:15:22Z",
        • "channel_name": "string",
        • "request_code": "string",
        • "reason_code": "string",
        • "response_code": "string",
        • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
        • "hash_account_number": "string",
        • "remarks": "string",
        • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
        • "journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
        • "support_user_guid": "334ad5b0-1427-4c28-aac8-2d6e9614b4d0",
        • "source_code": "string",
        • "source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
        • "reference_number": "string",
        • "outsort_guid": "eef602a5-424d-4eae-b4d8-4521969d8873",
        • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
        • "processing_start_date": "2019-08-24T14:15:22Z",
        • "processing_end_date": "2019-08-24T14:15:22Z"
        }
      }
    ],
  • "cards": [
    • {
      • "card_number": "string",
      • "card_proxy": "string",
      • "mask_card_pan": "string",
      • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
      • "wallet_id": "string",
      • "issuance_type": "FULL",
      • "base_iin": "string",
      • "card_condition": "ORIGINAL",
      • "card_status": "ACTIVE",
      • "activation_date": "2019-08-24T14:15:22Z",
      • "activation_method": "ONLOAD",
      • "expiration_date": "string",
      • "cvx2": "string",
      • "logical_expiration_date": "2019-08-24T14:15:22Z",
      • "person_card_status": "ACTIVE",
      • "card_tracking_detail": {
        • "fulfillment_house_name": "string",
        • "card_requested": "2019-08-24T14:15:22Z",
        • "card_shipment_date": "2019-08-24T14:15:22Z",
        • "card_delivery_method": "string",
        • "card_delivery_tracking_number": "string",
        • "card_package_name": "string",
        • "card_order_status": "string",
        • "digital_package_name": "string",
        • "digital_package_id": "string"
        },
      • "status_change_nonmon_detail": {
        • "nonmon_guid": "3df16cd2-de7f-4e81-936e-7604855d1fd7",
        • "txn_date": "2019-08-24T14:15:22Z",
        • "channel_name": "string",
        • "request_code": "string",
        • "reason_code": "string",
        • "response_code": "string",
        • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
        • "hash_account_number": "string",
        • "remarks": "string",
        • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
        • "journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
        • "support_user_guid": "334ad5b0-1427-4c28-aac8-2d6e9614b4d0",
        • "source_code": "string",
        • "source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
        • "reference_number": "string",
        • "outsort_guid": "eef602a5-424d-4eae-b4d8-4521969d8873",
        • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
        • "processing_start_date": "2019-08-24T14:15:22Z",
        • "processing_end_date": "2019-08-24T14:15:22Z"
        },
      • "sys_utcinserted": "2019-08-24T14:15:22Z",
      • "sys_utcupdated": "2019-08-24T14:15:22Z"
      }
    ],
  • "account_instruments": [
    • {
      • "routing_number": "string",
      • "account_instrument_guid": "e5662964-577d-4724-b8d5-e791eee05564",
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "account_info": {
        • "account_type": "DDA",
        • "account_number": "string",
        • "routing_number": "string",
        • "rtp_routing_number": "string",
        • "bank_identifier": "string",
        • "bank_dba": "string",
        • "bank_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "swift_code": "string",
        • "bank_phone": "string",
        • "description": "string",
        • "name_on_account": "string",
        • "accountholder_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "additional_data": {
          • "property1": "string",
          • "property2": "string"
          }
        },
      • "mask_account_number": "string",
      • "instrument_type": "BANKDDA",
      • "instrument_status": "ACTIVE"
      }
    ],
  • "account_shared_persons": [
    • {
      • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
      • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
      • "holder_shared_account_guid": "86478687-07a7-49d5-8d37-77d8a759f0b8",
      • "holder_wallet_guid": "56e8c513-b31c-4aa1-982a-6e4d034fae0f",
      • "relationship": "string",
      • "holder_share_status": "string",
      • "system_share_status": "string"
      }
    ]
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.