Apply Advance

Apply Advance

Request
Security:
path Parameters
account_guid
required
string <uuid>
version
required
string
Request Body schema: application/json
request_id
required
string <uuid>

request_id provided from advance pre-calc response

progfund_account_guid
required
string <uuid>

Progfund account guid

general_account_guid
string or null <uuid>

Account for customer whose account type is GENERAL Required if more than 1 general account exists for customer

currency
string or null <= 3 characters

Currency of the Advance; Defaulted to 'USD'

outside_instrument_guid
string or null <uuid>

Outside instrument id to schedule the payments

Responses
201

Applies the advance associated with the request_id

400

Bad request

401

Unauthorized

404

Account not found

500

Server Error

post/api/{version}/advances/{account_guid}
Request samples
application/json
{
  • "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
  • "progfund_account_guid": "a0a5e3dc-a970-4577-aae9-2bd3022356d3",
  • "general_account_guid": "e9a535da-64bc-4eb6-b6ef-5891c36a8e38",
  • "currency": "str",
  • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8"
}
Response samples
application/json
{
  • "disbursement_amount_requested": 0,
  • "disbursement_fee_requested": 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"
          }
        ]
      }
    },
  • "transfers": [
    • {
      • "txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
      • "amount": 0,
      • "currency": "string",
      • "description": "string",
      • "source": {
        • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
        • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
        • "wallet_id": "string",
        • "card_proxy": "string",
        • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8"
        },
      • "destination": {
        • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
        • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
        • "wallet_id": "string",
        • "card_proxy": "string",
        • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8"
        },
      • "destination_amount": 0,
      • "destination_currency": "string",
      • "entry_date": "2019-08-24T14:15:22Z",
      • "fees": [
        • {
          • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
          • "fee_request_code": "string",
          • "fee_request_description": "string",
          • "fee_amount": 0,
          • "reverse_fee_request_code": "string",
          • "reverse_fee_request_description": "string",
          • "fee_apply_to": "string",
          • "revenue_account_guid": "be5859f8-2def-455a-a2d1-a8fb86ef9998",
          • "fee_freebie_count": 0,
          • "fee_apply_type": "string"
          }
        ]
      }
    ]
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.