Create transfer

Create a new transfer to move funds from one Qolo Account to another.

Following are different types of transfer supported in the platform

Account to Account - Transfer funds from one Qolo Account to another Partner to Card - Partner can transfer funds from progfund account to card using card proxy or account guid Account to External bank accounts (Add outside_instrument and then use the guid in this API) External bank accounts to Account (Add outside_instrument and then use the guid in this API) This API supports transfer with currency conversions and this api uses the exchange rates provided by our banking partner.

Request
Security:
Bearer
path Parameters
version
required
string
Request Body schema: application/json
client_reference_id
required
string non-empty

API Partner can send the transfer's unique id on their system and it can be used to fetch transfer details later

channel_type
string (ChannelType)
Enum: "NotSet" "ACH" "SameDayACH" "RTP" "Wire" "ManualWire" "CrossBorder"
transfer_type
required
string (TransferType)
Enum: "UNKNOWN" "CARDTOCARD" "PARTNERTOCARD" "CARDTOPARTNER" "PARTNERTOPARTNER" "ACCOUNTTOACCOUNT" "ACCOUNTTOBANK" "BANKTOACCOUNT" "CHECKLOAD" "CHECKUNLOAD" "CARDTOPARTNER_UNLOADTOZERO" "CCDCTOACCOUNT" "ACCOUNTTOCCDC" "ACCOUNTTOBANKREALTIME" "BANKTOACCOUNTREQUESTREALTIME" "ACCOUNTTOCHECK" "PARTNERTOCHECK"
amount
required
number <double>

Amount to transfer.

currency
required
string 3 characters

Three letter currency code

description
string or null [ 0 .. 128 ] characters

API Partner can send the transfer's description for reference

required
object (TransferDetail)
required
object (TransferDetail)
quote_reference
string or null

For cross currency transfers, quote should be created and must be passed in transfer.

object (QuoteResponse)
destination_amount
number <double>
destination_currency
string or null
memo_code
string or null <= 64 characters

Client driven code used to add more details to the transfer type.

verification_code
string or null

Verification code. This field is currently not used and cvv2 validation during the transfer is not required

object (EFTInfo)
reason_code
string or null [ 0 .. 16 ] characters

Transfer reason code used for foreign exchange

object (CheckInfo)

Check Info

schedule_date
string or null <= 10 characters

Specifies the scheduled date for the transaction. This field is applicable only when the Case Management (Maker-Checker) queue is enabled for the program. It will be ignored if the Maker-Checker capability is not configured. Date must be entered in "yyyy-MM-dd" format.

Responses
201

Returns the newly created transfer

400

Bad request

401

Unauthorized

404

Account not found

500

Server Error

post/api/{version}/transfers
Request samples
application/json
{
  • "client_reference_id": "string",
  • "channel_type": "NotSet",
  • "transfer_type": "UNKNOWN",
  • "amount": 0,
  • "currency": "str",
  • "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"
    },
  • "quote_reference": "string",
  • "quoteoutput": {
    • "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": {
      • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
      • "wallet_id": "string",
      • "card_proxy": "string"
      },
    • "fees": [
      • {
        • "name": "string",
        • "amount": 0,
        • "currency": "string"
        }
      ],
    • "conversionDetails": {
      • "reference": "string",
      • "conversion_rate": 0,
      • "from_currency": "string",
      • "to_currency": "string",
      • "from_amount": 0,
      • "to_amount": 0,
      • "expiry_seconds": 0,
      • "expiry_at": "2019-08-24T14:15:22Z"
      }
    },
  • "destination_amount": 0,
  • "destination_currency": "string",
  • "memo_code": "string",
  • "verification_code": "string",
  • "eft_info": {
    • "sec_code": "WEB",
    • "identifier_number": "string",
    • "addenda": "string",
    • "company_entry_desc": "string"
    },
  • "reason_code": "string",
  • "check_info": {
    • "template_alias": "string",
    • "payee_detail": {
      • "name": "string",
      • "address_line1": "string",
      • "address_line2": "string",
      • "city": "string",
      • "state": "string",
      • "zip": "string",
      • "country": "string"
      },
    • "ship_to_detail": {
      • "name": "string",
      • "address_line1": "string",
      • "address_line2": "string",
      • "city": "string",
      • "state": "string",
      • "zip": "string",
      • "country": "string"
      },
    • "shipping_method": "string",
    • "bulk_shipment_flag": true,
    • "return_to_detail": {
      • "name": "string",
      • "address_line1": "string",
      • "address_line2": "string",
      • "city": "string",
      • "state": "string",
      • "zip": "string",
      • "country": "string"
      },
    • "remittance_section_1": {
      • "remittance_s1_line1": "string",
      • "remittance_s1_line2": "string",
      • "remittance_s1_line3": "string",
      • "remittance_s1_line4": "string",
      • "remittance_s1_line5": "string",
      • "remittance_s1_line6": "string"
      },
    • "remittance_section_2": {
      • "remittance_s2_line1": "string",
      • "remittance_s2_line2": "string",
      • "remittance_s2_line3": "string"
      },
    • "check_stub_footer_text": "string",
    • "payer_detail": {
      • "payer_logo_file_name": "string",
      • "name": "string",
      • "address_line1": "string",
      • "address_line2": "string",
      • "city": "string",
      • "state": "string",
      • "zip": "string",
      • "country": "string"
      },
    • "check_void_after_days": 1,
    • "check_memo_line": "string",
    • "check_footer_text": "string",
    • "print_authorized_signatory1": true,
    • "print_authorized_signatory2": true,
    • "additional_detail": {
      • "check_stub_label1": "string",
      • "check_stub_label1_value": "string",
      • "check_stub_label2": "string",
      • "check_stub_label2_value": "string",
      • "check_label": "string",
      • "check_label_value": "string"
      }
    },
  • "schedule_date": "string"
}
Response samples
application/json
{
  • "txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
  • "maker_checker_request_guid": "5b4ba6ad-f9f8-4604-bc16-4d6fad04e83a",
  • "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"
      }
    ],
  • "schedule_date": "string"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.