Schedule a payment. This endpoint can be used to create a time based schedule or conditional payment schedule
Returns the newly scheduled payment
Bad request
Unauthorized
Program not found
Server Error
{- "payer": [
- {
- "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
- "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
- "card_proxy": "string",
- "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
- "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
- "preferred_transfer_type": "string",
- "account_type": "string",
- "instrument_type": "string"
}
], - "payee": [
- {
- "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
- "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
- "card_proxy": "string",
- "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
- "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
- "preferred_transfer_type": "string",
- "account_type": "string",
- "instrument_type": "string"
}
], - "payment_amount": 0,
- "payment_base_currency": "string",
- "payment_description": "string",
- "payment_request_code": "PT_TOPUP",
- "payment_balance": 0,
- "payment_guid": "ca76c87d-c08b-46dc-a069-5abd4a4ab259",
- "payment_chain": "19e771ce-e346-4119-b133-6e58f85f159f",
- "response_code": "string",
- "reason_code": "string",
- "requestor_wallet_guid": "996c589d-2ec1-4921-a37b-692f64c4cb1c",
- "payment_due_date": "2019-08-24T14:15:22Z",
- "reference_code": "string",
- "payment_schedule": {
- "payment_schedule_type": "IMMEDIATE",
- "frequency": "DAY",
- "period_value": 0,
- "repeat_until_date": "2019-08-24T14:15:22Z",
- "payment_start_date": "2019-08-24T14:15:22Z",
- "schedule_guid": "b6f4cc4c-e025-4982-9800-846c354bc66c"
}, - "foreign_exchange_purpose_code": "EFT_TRF_SELF",
- "additional_data": {
- "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"
}
}
}, - "error_code": "string",
- "error_description": "string"
}
{- "payer": [
- {
- "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
- "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
- "card_proxy": "string",
- "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
- "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
- "preferred_transfer_type": "string",
- "account_type": "string",
- "instrument_type": "string"
}
], - "payee": [
- {
- "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
- "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
- "card_proxy": "string",
- "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
- "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
- "preferred_transfer_type": "string",
- "account_type": "string",
- "instrument_type": "string"
}
], - "payment_amount": 0,
- "payment_base_currency": "string",
- "payment_description": "string",
- "payment_request_code": "PT_TOPUP",
- "payment_balance": 0,
- "payment_guid": "ca76c87d-c08b-46dc-a069-5abd4a4ab259",
- "payment_chain": "19e771ce-e346-4119-b133-6e58f85f159f",
- "response_code": "string",
- "reason_code": "string",
- "requestor_wallet_guid": "996c589d-2ec1-4921-a37b-692f64c4cb1c",
- "payment_due_date": "2019-08-24T14:15:22Z",
- "reference_code": "string",
- "payment_schedule": {
- "payment_schedule_type": "IMMEDIATE",
- "frequency": "DAY",
- "period_value": 0,
- "repeat_until_date": "2019-08-24T14:15:22Z",
- "payment_start_date": "2019-08-24T14:15:22Z",
- "schedule_guid": "b6f4cc4c-e025-4982-9800-846c354bc66c"
}, - "foreign_exchange_purpose_code": "EFT_TRF_SELF",
- "additional_data": {
- "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"
}
}
}, - "error_code": "string",
- "error_description": "string"
}