Store payment profile

curl --request POST \
  --url https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "123 Main St",
  "city": "Austin",
  "state": "TX",
  "zip": "73301",
  "save_payment_method": true,
  "is_terms_accepted": true,
  "basis_theory_response": {
    "id": "token_intent_card",
    "type": "card"
  },
  "first_name": "<string>",
  "last_name": "<string>"
}
'

import requests

url = "https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile"

payload = {
    "address": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "zip": "73301",
    "save_payment_method": True,
    "is_terms_accepted": True,
    "basis_theory_response": {
        "id": "token_intent_card",
        "type": "card"
    },
    "first_name": "<string>",
    "last_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address: '123 Main St',
    city: 'Austin',
    state: 'TX',
    zip: '73301',
    save_payment_method: true,
    is_terms_accepted: true,
    basis_theory_response: {id: 'token_intent_card', type: 'card'},
    first_name: '<string>',
    last_name: '<string>'
  })
};

fetch('https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'address' => '123 Main St',
    'city' => 'Austin',
    'state' => 'TX',
    'zip' => '73301',
    'save_payment_method' => true,
    'is_terms_accepted' => true,
    'basis_theory_response' => [
        'id' => 'token_intent_card',
        'type' => 'card'
    ],
    'first_name' => '<string>',
    'last_name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile"

	payload := strings.NewReader("{\n  \"address\": \"123 Main St\",\n  \"city\": \"Austin\",\n  \"state\": \"TX\",\n  \"zip\": \"73301\",\n  \"save_payment_method\": true,\n  \"is_terms_accepted\": true,\n  \"basis_theory_response\": {\n    \"id\": \"token_intent_card\",\n    \"type\": \"card\"\n  },\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"123 Main St\",\n  \"city\": \"Austin\",\n  \"state\": \"TX\",\n  \"zip\": \"73301\",\n  \"save_payment_method\": true,\n  \"is_terms_accepted\": true,\n  \"basis_theory_response\": {\n    \"id\": \"token_intent_card\",\n    \"type\": \"card\"\n  },\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"123 Main St\",\n  \"city\": \"Austin\",\n  \"state\": \"TX\",\n  \"zip\": \"73301\",\n  \"save_payment_method\": true,\n  \"is_terms_accepted\": true,\n  \"basis_theory_response\": {\n    \"id\": \"token_intent_card\",\n    \"type\": \"card\"\n  },\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "data": {
    "payment_setup": {
      "can_setup": true,
      "requires_payment_profile": true,
      "accepted_negotiation": {
        "id": 123,
        "negotiation_type_label": "<string>",
        "installment_type_label": "<string>",
        "offer_accepted": true,
        "counter_offer_accepted": true,
        "payment_profile_id": 123,
        "one_time_settlement": "<string>",
        "negotiate_amount": "<string>",
        "monthly_amount": "<string>",
        "no_of_installments": 123,
        "last_month_amount": "<string>",
        "first_pay_date": "2023-12-25",
        "counter_one_time_amount": "<string>",
        "counter_monthly_amount": "<string>",
        "counter_no_of_installments": 123,
        "counter_last_month_amount": "<string>",
        "counter_first_pay_date": "2023-12-25"
      },
      "amount_due": "650.00",
      "first_payment_date": "2023-12-25",
      "terms_and_conditions": "<p>Payment terms and conditions...</p>",
      "can_use_helping_hand": true,
      "billing_profile": {
        "first_name": "Jane",
        "last_name": "Consumer",
        "address": "123 Main St",
        "city": "Austin",
        "state": "TX",
        "zip": "73301"
      },
      "supported_payment_methods": [
        {
          "label": "Card"
        }
      ],
      "saved_payment_profiles": [
        {
          "id": 123,
          "method_label": "Card",
          "label": "Card ending in 4242",
          "last_four_digit": "<string>",
          "account_number_last_four": "<string>",
          "expiration_month": "<string>",
          "expiration_year": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "address": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "is_saved_for_future_use": true
        }
      ],
      "selected_payment_profile": {
        "id": 123,
        "method_label": "Card",
        "label": "Card ending in 4242",
        "last_four_digit": "<string>",
        "account_number_last_four": "<string>",
        "expiration_month": "<string>",
        "expiration_year": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "is_saved_for_future_use": true
      },
      "schedule": [
        {
          "id": 123,
          "schedule_date": "2023-12-25",
          "amount": "650.00",
          "payment_profile": {
            "id": 123,
            "method_label": "Card",
            "label": "Card ending in 4242",
            "last_four_digit": "<string>",
            "account_number_last_four": "<string>",
            "expiration_month": "<string>",
            "expiration_year": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "address": "<string>",
            "city": "<string>",
            "state": "<string>",
            "zip": "<string>",
            "is_saved_for_future_use": true
          }
        }
      ]
    },
    "next_action": {
      "label": "<string>"
    },
    "account": {
      "id": 123,
      "identity": {
        "account_name": "<string>",
        "account_number": "<string>",
        "member_account_number": "<string>",
        "reference_number": "<string>",
        "statement_id_number": "<string>",
        "subclient_account_number": "<string>",
        "consumer_name": "<string>",
        "last4ssn": "<string>"
      },
      "display": {
        "state": {
          "label": "<string>",
          "card_label": "<string>",
          "priority": 123
        },
        "condition": {
          "label": "<string>"
        },
        "view_flags": {
          "is_installment_payment_plan": true,
          "is_scheduled_settlement": true,
          "is_agreed_installment_payment_plan": true,
          "is_agreed_settlement": true,
          "is_cancelled_plan": true,
          "is_declined_closed_negotiation": true,
          "is_pending_settlement_offer": true,
          "is_counter_settlement_offer": true,
          "is_active_installment_offer": true,
          "is_returned_notice_response": true,
          "is_creditor_removed_dispute_no_pay": true,
          "is_no_pay_creditor_removed": true
        },
        "amounts": {
          "payoff_balance": "2125.00",
          "settlement_payoff_balance": "1750.00",
          "current_balance": "2500.00",
          "original_balance": "2500.00",
          "my_settlement_offer": "100.00",
          "creditor_settlement_offer": "490.00",
          "active_installment_payoff_balance": "2125.00"
        },
        "balance_items": [
          {
            "key": "payoff_balance",
            "label": "Payoff Balance",
            "amount": "2125.00",
            "amount_label": "$2,125.00"
          }
        ],
        "offer_summary_items": [
          {
            "key": "payoff_balance",
            "label": "Payoff Balance",
            "amount": "2125.00",
            "amount_label": "$2,125.00"
          }
        ],
        "payment_plan_meta_items": [
          {
            "key": "next_due_date",
            "label": "Next Due Date",
            "value": "Jun 15, 2026"
          }
        ],
        "settlement_schedule_date": "<string>",
        "available_actions": [
          {
            "key": "manage_plan",
            "label": "Manage Plan"
          }
        ]
      },
      "status": {
        "value": "payment_accepted",
        "label": "Payment Plan"
      },
      "hold_reason": "Need a short break from payments.",
      "flags": {
        "payment_setup": true,
        "offer_accepted": true,
        "counter_offer": true,
        "has_failed_payment": true,
        "custom_offer": true,
        "membership_active_account": true
      },
      "dates": {
        "placement_date": "2023-12-25",
        "expiry_date": "2023-12-25",
        "restart_date": "2023-12-25",
        "last_login_at": "2023-11-07T05:31:56Z",
        "disputed_at": "2023-11-07T05:31:56Z",
        "cancelled_at": "2023-11-07T05:31:56Z",
        "deactivated_at": "2023-11-07T05:31:56Z"
      },
      "company": {
        "id": 123,
        "company_name": "<string>",
        "about_us": "<p>ABC Collections works with consumers on flexible repayment options.</p>"
      },
      "subclient": {
        "id": 123,
        "subclient_name": "<string>",
        "unique_identification_number": "<string>"
      },
      "reason_label": "<string>",
      "balances": "<unknown>",
      "offer_summary_items": [
        "<unknown>"
      ],
      "payment_plan_meta_items": [
        "<unknown>"
      ],
      "active_negotiation": {
        "id": 123,
        "negotiation_type_label": "<string>",
        "active_negotiation": true,
        "offer_accepted": true,
        "offer_accepted_at": "2023-11-07T05:31:56Z",
        "counter_offer_accepted": true,
        "first_pay_date": "2023-12-25",
        "monthly_amount": "<string>",
        "no_of_installments": 123,
        "last_month_amount": "<string>",
        "one_time_settlement": "<string>",
        "negotiate_amount": "<string>",
        "counter_one_time_amount": "<string>",
        "counter_negotiate_amount": "<string>",
        "counter_monthly_amount": "<string>",
        "counter_no_of_installments": 123,
        "counter_first_pay_date": "2023-12-25",
        "consumer_offer_sent_at": "2023-11-07T05:31:56Z",
        "creditor_counter_offer_sent_at": "2023-11-07T05:31:56Z",
        "last_offer_type": "<string>"
      },
      "scheduled_payment": {
        "id": 123,
        "date": "2023-12-25",
        "amount": "<string>",
        "status": "<string>"
      },
      "notice_response": {
        "id": 123,
        "account_name": "<string>",
        "account_number": "<string>",
        "notice_balance": "<string>",
        "status": 123,
        "status_label": "<string>",
        "reason_label": "<string>",
        "sender_detail": {
          "id": 123,
          "sender": {
            "id": 123,
            "company_name": "Acme Collections",
            "company_phone": "(900) 509-1111",
            "company_email": "jsmith@example.com",
            "company_address1": "<string>",
            "company_address2": "<string>",
            "company_city": "<string>",
            "company_state": "<string>",
            "company_zip": "<string>",
            "company_url": "<string>"
          }
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "payment_profile": {
      "id": 123,
      "method_label": "Card",
      "label": "Card ending in 4242",
      "last_four_digit": "<string>",
      "account_number_last_four": "<string>",
      "expiration_month": "<string>",
      "expiration_year": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "is_saved_for_future_use": true
    }
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "code": "profile_incomplete",
  "message": "Please complete your communication profile before viewing accounts.",
  "required_steps": [
    "profile_communication"
  ]
}

{
  "message": "<string>",
  "errors": {}
}

POST

accounts

{consumer}

payment-setup

payment-profile

Store payment profile

curl --request POST \
  --url https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "123 Main St",
  "city": "Austin",
  "state": "TX",
  "zip": "73301",
  "save_payment_method": true,
  "is_terms_accepted": true,
  "basis_theory_response": {
    "id": "token_intent_card",
    "type": "card"
  },
  "first_name": "<string>",
  "last_name": "<string>"
}
'

import requests

url = "https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile"

payload = {
    "address": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "zip": "73301",
    "save_payment_method": True,
    "is_terms_accepted": True,
    "basis_theory_response": {
        "id": "token_intent_card",
        "type": "card"
    },
    "first_name": "<string>",
    "last_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address: '123 Main St',
    city: 'Austin',
    state: 'TX',
    zip: '73301',
    save_payment_method: true,
    is_terms_accepted: true,
    basis_theory_response: {id: 'token_intent_card', type: 'card'},
    first_name: '<string>',
    last_name: '<string>'
  })
};

fetch('https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'address' => '123 Main St',
    'city' => 'Austin',
    'state' => 'TX',
    'zip' => '73301',
    'save_payment_method' => true,
    'is_terms_accepted' => true,
    'basis_theory_response' => [
        'id' => 'token_intent_card',
        'type' => 'card'
    ],
    'first_name' => '<string>',
    'last_name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile"

	payload := strings.NewReader("{\n  \"address\": \"123 Main St\",\n  \"city\": \"Austin\",\n  \"state\": \"TX\",\n  \"zip\": \"73301\",\n  \"save_payment_method\": true,\n  \"is_terms_accepted\": true,\n  \"basis_theory_response\": {\n    \"id\": \"token_intent_card\",\n    \"type\": \"card\"\n  },\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"123 Main St\",\n  \"city\": \"Austin\",\n  \"state\": \"TX\",\n  \"zip\": \"73301\",\n  \"save_payment_method\": true,\n  \"is_terms_accepted\": true,\n  \"basis_theory_response\": {\n    \"id\": \"token_intent_card\",\n    \"type\": \"card\"\n  },\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.consumer.younegotiate.com/accounts/{consumer}/payment-setup/payment-profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"123 Main St\",\n  \"city\": \"Austin\",\n  \"state\": \"TX\",\n  \"zip\": \"73301\",\n  \"save_payment_method\": true,\n  \"is_terms_accepted\": true,\n  \"basis_theory_response\": {\n    \"id\": \"token_intent_card\",\n    \"type\": \"card\"\n  },\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "data": {
    "payment_setup": {
      "can_setup": true,
      "requires_payment_profile": true,
      "accepted_negotiation": {
        "id": 123,
        "negotiation_type_label": "<string>",
        "installment_type_label": "<string>",
        "offer_accepted": true,
        "counter_offer_accepted": true,
        "payment_profile_id": 123,
        "one_time_settlement": "<string>",
        "negotiate_amount": "<string>",
        "monthly_amount": "<string>",
        "no_of_installments": 123,
        "last_month_amount": "<string>",
        "first_pay_date": "2023-12-25",
        "counter_one_time_amount": "<string>",
        "counter_monthly_amount": "<string>",
        "counter_no_of_installments": 123,
        "counter_last_month_amount": "<string>",
        "counter_first_pay_date": "2023-12-25"
      },
      "amount_due": "650.00",
      "first_payment_date": "2023-12-25",
      "terms_and_conditions": "<p>Payment terms and conditions...</p>",
      "can_use_helping_hand": true,
      "billing_profile": {
        "first_name": "Jane",
        "last_name": "Consumer",
        "address": "123 Main St",
        "city": "Austin",
        "state": "TX",
        "zip": "73301"
      },
      "supported_payment_methods": [
        {
          "label": "Card"
        }
      ],
      "saved_payment_profiles": [
        {
          "id": 123,
          "method_label": "Card",
          "label": "Card ending in 4242",
          "last_four_digit": "<string>",
          "account_number_last_four": "<string>",
          "expiration_month": "<string>",
          "expiration_year": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "address": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "is_saved_for_future_use": true
        }
      ],
      "selected_payment_profile": {
        "id": 123,
        "method_label": "Card",
        "label": "Card ending in 4242",
        "last_four_digit": "<string>",
        "account_number_last_four": "<string>",
        "expiration_month": "<string>",
        "expiration_year": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "is_saved_for_future_use": true
      },
      "schedule": [
        {
          "id": 123,
          "schedule_date": "2023-12-25",
          "amount": "650.00",
          "payment_profile": {
            "id": 123,
            "method_label": "Card",
            "label": "Card ending in 4242",
            "last_four_digit": "<string>",
            "account_number_last_four": "<string>",
            "expiration_month": "<string>",
            "expiration_year": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "address": "<string>",
            "city": "<string>",
            "state": "<string>",
            "zip": "<string>",
            "is_saved_for_future_use": true
          }
        }
      ]
    },
    "next_action": {
      "label": "<string>"
    },
    "account": {
      "id": 123,
      "identity": {
        "account_name": "<string>",
        "account_number": "<string>",
        "member_account_number": "<string>",
        "reference_number": "<string>",
        "statement_id_number": "<string>",
        "subclient_account_number": "<string>",
        "consumer_name": "<string>",
        "last4ssn": "<string>"
      },
      "display": {
        "state": {
          "label": "<string>",
          "card_label": "<string>",
          "priority": 123
        },
        "condition": {
          "label": "<string>"
        },
        "view_flags": {
          "is_installment_payment_plan": true,
          "is_scheduled_settlement": true,
          "is_agreed_installment_payment_plan": true,
          "is_agreed_settlement": true,
          "is_cancelled_plan": true,
          "is_declined_closed_negotiation": true,
          "is_pending_settlement_offer": true,
          "is_counter_settlement_offer": true,
          "is_active_installment_offer": true,
          "is_returned_notice_response": true,
          "is_creditor_removed_dispute_no_pay": true,
          "is_no_pay_creditor_removed": true
        },
        "amounts": {
          "payoff_balance": "2125.00",
          "settlement_payoff_balance": "1750.00",
          "current_balance": "2500.00",
          "original_balance": "2500.00",
          "my_settlement_offer": "100.00",
          "creditor_settlement_offer": "490.00",
          "active_installment_payoff_balance": "2125.00"
        },
        "balance_items": [
          {
            "key": "payoff_balance",
            "label": "Payoff Balance",
            "amount": "2125.00",
            "amount_label": "$2,125.00"
          }
        ],
        "offer_summary_items": [
          {
            "key": "payoff_balance",
            "label": "Payoff Balance",
            "amount": "2125.00",
            "amount_label": "$2,125.00"
          }
        ],
        "payment_plan_meta_items": [
          {
            "key": "next_due_date",
            "label": "Next Due Date",
            "value": "Jun 15, 2026"
          }
        ],
        "settlement_schedule_date": "<string>",
        "available_actions": [
          {
            "key": "manage_plan",
            "label": "Manage Plan"
          }
        ]
      },
      "status": {
        "value": "payment_accepted",
        "label": "Payment Plan"
      },
      "hold_reason": "Need a short break from payments.",
      "flags": {
        "payment_setup": true,
        "offer_accepted": true,
        "counter_offer": true,
        "has_failed_payment": true,
        "custom_offer": true,
        "membership_active_account": true
      },
      "dates": {
        "placement_date": "2023-12-25",
        "expiry_date": "2023-12-25",
        "restart_date": "2023-12-25",
        "last_login_at": "2023-11-07T05:31:56Z",
        "disputed_at": "2023-11-07T05:31:56Z",
        "cancelled_at": "2023-11-07T05:31:56Z",
        "deactivated_at": "2023-11-07T05:31:56Z"
      },
      "company": {
        "id": 123,
        "company_name": "<string>",
        "about_us": "<p>ABC Collections works with consumers on flexible repayment options.</p>"
      },
      "subclient": {
        "id": 123,
        "subclient_name": "<string>",
        "unique_identification_number": "<string>"
      },
      "reason_label": "<string>",
      "balances": "<unknown>",
      "offer_summary_items": [
        "<unknown>"
      ],
      "payment_plan_meta_items": [
        "<unknown>"
      ],
      "active_negotiation": {
        "id": 123,
        "negotiation_type_label": "<string>",
        "active_negotiation": true,
        "offer_accepted": true,
        "offer_accepted_at": "2023-11-07T05:31:56Z",
        "counter_offer_accepted": true,
        "first_pay_date": "2023-12-25",
        "monthly_amount": "<string>",
        "no_of_installments": 123,
        "last_month_amount": "<string>",
        "one_time_settlement": "<string>",
        "negotiate_amount": "<string>",
        "counter_one_time_amount": "<string>",
        "counter_negotiate_amount": "<string>",
        "counter_monthly_amount": "<string>",
        "counter_no_of_installments": 123,
        "counter_first_pay_date": "2023-12-25",
        "consumer_offer_sent_at": "2023-11-07T05:31:56Z",
        "creditor_counter_offer_sent_at": "2023-11-07T05:31:56Z",
        "last_offer_type": "<string>"
      },
      "scheduled_payment": {
        "id": 123,
        "date": "2023-12-25",
        "amount": "<string>",
        "status": "<string>"
      },
      "notice_response": {
        "id": 123,
        "account_name": "<string>",
        "account_number": "<string>",
        "notice_balance": "<string>",
        "status": 123,
        "status_label": "<string>",
        "reason_label": "<string>",
        "sender_detail": {
          "id": 123,
          "sender": {
            "id": 123,
            "company_name": "Acme Collections",
            "company_phone": "(900) 509-1111",
            "company_email": "jsmith@example.com",
            "company_address1": "<string>",
            "company_address2": "<string>",
            "company_city": "<string>",
            "company_state": "<string>",
            "company_zip": "<string>",
            "company_url": "<string>"
          }
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "payment_profile": {
      "id": 123,
      "method_label": "Card",
      "label": "Card ending in 4242",
      "last_four_digit": "<string>",
      "account_number_last_four": "<string>",
      "expiration_month": "<string>",
      "expiration_year": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "is_saved_for_future_use": true
    }
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "code": "profile_incomplete",
  "message": "Please complete your communication profile before viewing accounts.",
  "required_steps": [
    "profile_communication"
  ]
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

consumer

integer

required

Consumer account ID.

Body

application/json

address

string

required

Maximum string length: 255

Example:

"123 Main St"

city

string

required

Maximum string length: 255

Example:

"Austin"

state

string

required

Example:

"TX"

zip

string

required

Maximum string length: 10

Example:

"73301"

method

enum<string> | null

required

Available options:

cc,

ach,

null

save_payment_method

boolean

required

Saves the profile for future use when no active saved profile already exists for that method.

is_terms_accepted

boolean

required

Must be true.

basis_theory_response

object

required

Basis Theory token intent payload generated by the frontend tokenization flow. The backend verifies this id and converts it to a token when the profile must be reusable.

Show child attributes

first_name

string | null

Maximum string length: 255

last_name

string | null

Maximum string length: 255

account_type

enum<string> | null

Required for ACH profiles.

Available options:

checking,

savings,

null

Response

Payment profile stored.

message

string

required

Examples:

"Payment profile stored."

"Payment setup completed."

"Settlement payment processed."

data

object

required

Show child attributes

Last modified on July 19, 2026

Show payment setup Confirm payment setup

Get Started

Superadmin API

Creditor API

Consumer API

EcoMail Hub API

Store payment profile

Authorizations

Path Parameters

Body

Response