Create Disbursement

Create a new Disbursement request to create the person, account, instrument and move funds.

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

program guid

disbursement_type
required
string (DisbursementType)

Disbursement Type

Enum: "CARD" "OUTSIDEINSTRUMENT" "USERSELECT" "CHECK" "ACCOUNT"
required
object (PersonDTO)
object (DisbursementOutsideInstrument)

Disbursement Outside Instrument

required
object (DisbursementTransferRequest)

Disbursement Transfer Request

object (CardFulfillment)

Data related to the fulfillment/embossing file.

user_guid
string <uuid>

user guid

company_guid
string <uuid>

company guid

source_code
string or null

source code

Responses
201

Request created and queued for processing

400

Bad request

401

Unauthorized

404

Account not found

500

Server Error

post/api/{version}/disbursements
Request samples
application/json
{
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "disbursement_type": "CARD",
  • "person_details": {
    • "identifications": [
      • {
        • "govt_id_type": "NOTPROVIDED",
        • "govt_id_number": "string"
        }
      ],
    • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
    • "birth_date": "string",
    • "email": "string",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "additional_data": {
      • "property1": "string",
      • "property2": "string"
      },
    • "mobile_number": "string",
    • "home_number": "string",
    • "office_number": "string",
    • "base_address": {
      • "city": "string",
      • "country": "str",
      • "address_line1": "string",
      • "address_line2": "string",
      • "postal_code": "string",
      • "state": "string"
      },
    • "mailing_address": {
      • "city": "string",
      • "country": "str",
      • "address_line1": "string",
      • "address_line2": "string",
      • "postal_code": "string",
      • "state": "string"
      },
    • "billing_address": {
      • "city": "string",
      • "country": "str",
      • "address_line1": "string",
      • "address_line2": "string",
      • "postal_code": "string",
      • "state": "string"
      },
    • "nationality": "str",
    • "ip_address": "string",
    • "person_status": "INCOMPLETE",
    • "client_reference_id": "string",
    • "verfication_mode": "string",
    • "verfication_level": "string",
    • "person_forget_mode": "string",
    • "person_forget_mode_date": "string",
    • "market_notification_optin": "string",
    • "market_notification_optin_date": "string",
    • "address_lat": 0,
    • "address_lon": 0,
    • "contact_type": "string",
    • "profile_dd_mode": "string",
    • "request_code": "string",
    • "wallet_id": "string",
    • "title": "string",
    • "mask_govt_id_number": "string",
    • "comments": "string",
    • "jurisdiction_state": "string",
    • "jurisdiction_country": "str",
    • "beneficial_ownership": 100,
    • "person_relations": [
      • {
        • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
        • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
        • "person_relationship": "string",
        • "sys_utcinserted": "2019-08-24T14:15:22Z",
        • "sys_utcupdated": "2019-08-24T14:15:22Z"
        }
      ],
    • "mask_account_number": "string",
    • "ledger_balance": 0,
    • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f"
    },
  • "instrument_details": {
    • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
    • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
    • "instrument_country": "string",
    • "instrument_type": "BANKDDA",
    • "instrument_name": "string",
    • "instrument_settlement_currency": "str",
    • "instrument_category": "INDIVIDUAL",
    • "instrument_usage": "string",
    • "mask_account_number": "string",
    • "account_details": {
      • "card_account": {
        • "card_number": "stringstrings",
        • "expiration_date": "stri",
        • "verification_code": "strin",
        • "expiry_status": "string"
        },
      • "bank_account": {
        • "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"
          }
        }
      },
    • "outside_iin": "string",
    • "financial_inst_name": "string",
    • "external_proxy_number": "string",
    • "instrument_verification_method": "BANK",
    • "instrument_status": "ACTIVE",
    • "acknowledgement": {
      • "tc_version": "string",
      • "acknowledgement_date": "string",
      • "ip_address": "string"
      },
    • "sys_utcinserted": "2019-08-24T14:15:22Z",
    • "base_outside_instrument_guid": "d06e7842-2b65-4e80-a035-958d85404833",
    • "instrument_ownership": "SELF",
    • "status_reason": "string"
    },
  • "transfer_details": {
    • "client_reference_id": "string",
    • "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"
      },
    • "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"
      },
    • "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"
      },
    • "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"
        }
      }
    },
  • "card_details": {
    • "issuance_type": "FULL",
    • "fourth_line": "string",
    • "iin_brand": "VISA",
    • "fulfillment_order_info": {
      • "package_guid": "bbcfa7f4-7eee-4d1b-9f7d-736ad8949479",
      • "third_line": "string",
      • "fourth_line": "string",
      • "shipping_method": "STDMAIL",
      • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
      • "order_type": "DTC",
      • "signature_required": true,
      • "tracking_number": "string",
      • "discretionary_track_data": "string",
      • "order_status": "string",
      • "pin_mailer_flag": true,
      • "message_1": "string",
      • "message_2": "string",
      • "message_3": "string",
      • "message_4": "string",
      • "message_5": "string",
      • "message_6": "string",
      • "message_7": "string",
      • "message_8": "string",
      • "digital_package_guid": "a05ed577-3f52-4584-a35b-7241dbf7341c",
      • "fleet_card": {
        • "assignment_type": "DRIVER",
        • "restriction": "NONE",
        • "product_prompts": "ID_ODOMETER"
        }
      }
    },
  • "user_guid": "2c9a19c5-ac85-4da0-8708-2b80265927da",
  • "company_guid": "e7c8755b-aece-46c7-a1c9-897cfb55ba0c",
  • "source_code": "string"
}
Response samples
application/json
{
  • "payment_guid": "ca76c87d-c08b-46dc-a069-5abd4a4ab259",
  • "disbursementDTO": {
    • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
    • "disbursement_type": "CARD",
    • "person_details": {
      • "identifications": [
        • {
          • "govt_id_type": "NOTPROVIDED",
          • "govt_id_number": "string"
          }
        ],
      • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
      • "birth_date": "string",
      • "email": "string",
      • "first_name": "string",
      • "middle_name": "string",
      • "last_name": "string",
      • "additional_data": {
        • "property1": "string",
        • "property2": "string"
        },
      • "mobile_number": "string",
      • "home_number": "string",
      • "office_number": "string",
      • "base_address": {
        • "city": "string",
        • "country": "str",
        • "address_line1": "string",
        • "address_line2": "string",
        • "postal_code": "string",
        • "state": "string"
        },
      • "mailing_address": {
        • "city": "string",
        • "country": "str",
        • "address_line1": "string",
        • "address_line2": "string",
        • "postal_code": "string",
        • "state": "string"
        },
      • "billing_address": {
        • "city": "string",
        • "country": "str",
        • "address_line1": "string",
        • "address_line2": "string",
        • "postal_code": "string",
        • "state": "string"
        },
      • "nationality": "str",
      • "ip_address": "string",
      • "person_status": "INCOMPLETE",
      • "client_reference_id": "string",
      • "verfication_mode": "string",
      • "verfication_level": "string",
      • "person_forget_mode": "string",
      • "person_forget_mode_date": "string",
      • "market_notification_optin": "string",
      • "market_notification_optin_date": "string",
      • "address_lat": 0,
      • "address_lon": 0,
      • "contact_type": "string",
      • "profile_dd_mode": "string",
      • "request_code": "string",
      • "wallet_id": "string",
      • "title": "string",
      • "mask_govt_id_number": "string",
      • "comments": "string",
      • "jurisdiction_state": "string",
      • "jurisdiction_country": "str",
      • "beneficial_ownership": 100,
      • "person_relations": [
        • {
          • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
          • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
          • "person_relationship": "string",
          • "sys_utcinserted": "2019-08-24T14:15:22Z",
          • "sys_utcupdated": "2019-08-24T14:15:22Z"
          }
        ],
      • "mask_account_number": "string",
      • "ledger_balance": 0,
      • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f"
      },
    • "instrument_details": {
      • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
      • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
      • "instrument_country": "string",
      • "instrument_type": "BANKDDA",
      • "instrument_name": "string",
      • "instrument_settlement_currency": "str",
      • "instrument_category": "INDIVIDUAL",
      • "instrument_usage": "string",
      • "mask_account_number": "string",
      • "account_details": {
        • "card_account": {
          • "card_number": "stringstrings",
          • "expiration_date": "stri",
          • "verification_code": "strin",
          • "expiry_status": "string"
          },
        • "bank_account": {
          • "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"
            }
          }
        },
      • "outside_iin": "string",
      • "financial_inst_name": "string",
      • "external_proxy_number": "string",
      • "instrument_verification_method": "BANK",
      • "instrument_status": "ACTIVE",
      • "acknowledgement": {
        • "tc_version": "string",
        • "acknowledgement_date": "string",
        • "ip_address": "string"
        },
      • "sys_utcinserted": "2019-08-24T14:15:22Z",
      • "base_outside_instrument_guid": "d06e7842-2b65-4e80-a035-958d85404833",
      • "instrument_ownership": "SELF",
      • "status_reason": "string"
      },
    • "transfer_details": {
      • "client_reference_id": "string",
      • "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"
        },
      • "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"
        },
      • "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"
        },
      • "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"
          }
        }
      },
    • "card_details": {
      • "issuance_type": "FULL",
      • "fourth_line": "string",
      • "iin_brand": "VISA",
      • "fulfillment_order_info": {
        • "package_guid": "bbcfa7f4-7eee-4d1b-9f7d-736ad8949479",
        • "third_line": "string",
        • "fourth_line": "string",
        • "shipping_method": "STDMAIL",
        • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
        • "order_type": "DTC",
        • "signature_required": true,
        • "tracking_number": "string",
        • "discretionary_track_data": "string",
        • "order_status": "string",
        • "pin_mailer_flag": true,
        • "message_1": "string",
        • "message_2": "string",
        • "message_3": "string",
        • "message_4": "string",
        • "message_5": "string",
        • "message_6": "string",
        • "message_7": "string",
        • "message_8": "string",
        • "digital_package_guid": "a05ed577-3f52-4584-a35b-7241dbf7341c",
        • "fleet_card": {
          • "assignment_type": "DRIVER",
          • "restriction": "NONE",
          • "product_prompts": "ID_ODOMETER"
          }
        }
      },
    • "user_guid": "2c9a19c5-ac85-4da0-8708-2b80265927da",
    • "company_guid": "e7c8755b-aece-46c7-a1c9-897cfb55ba0c",
    • "source_code": "string"
    },
  • "disbursementPayoutPreference": {
    • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
    • "payoutpreference": "string"
    }
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.