New dunning journey
POST {{connect_base_url}}/v1/dunning_journey
In addition to the basic customer object and other contextual data, you must supply:
last_payment_failure_dateaccount_balance_cents
These values repesent the date on which the most recent payment failed and total outstanding amount for the customer's account to follow up on overdue accounts.
Depending on your campaign setup, or to provide additional useful information for segmentation or messaging, you may also supply additional_attributes. You are free to name these and provide a suitable data type.
Request Body
{"customer"=>{"first_name"=>"Mister", "last_name"=>"Postman", "email_address"=>"joe@pat.com", "phone_number"=>"+27-781317144", "identifications"=>[{"type"=>"IDENTITY_DOCUMENT", "details"=>"2001014800086"}], "title"=>"Mr", "alpha2_country_code"=>"ZA", "ietf_language_code"=>"en", "allow_email"=>true, "allow_sms"=>true, "allow_whatsapp"=>true, "utc_offset"=>2, "preferred_currency_code"=>"ZAR"}, "product"=>{"reference"=>"PSP1", "status"=>"New", "inception_date"=>"2023-06-21T13:05:00.064Z", "name"=>"Postman Subscription Professional"}, "brand_name"=>"Postman", "merchant_name"=>"Revio", "first_collection_date"=>"2023-07-21T13:05:00.064Z", "first_collection_amount_cents"=>"200", "recurring_frequency"=>"Monthly", "recurring_amount_cents"=>1000, "account_balance_cents"=>2000, "days_in_arrears"=>1, "last_payment_failure_date"=>"2023-06-21T13:05:00.064Z", "whatsapp_opt_in"=>true, "test_user"=>true, "unsubscribed"=>false, "additional_attributes"=>{"attr1"=>"1213"}}