Account Payment

post

https://example.com/account/{accountNum}/payments

This endpoint is used to notify the agency of a consumer’s current and future-scheduled payments remitted via the Freede Platform.

Used to update the agency system of record and to comply with FDCPA regulations and state law related to post dated payment instruments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountNum

string

required

Body Params

method_id

string

Stored payment method ID to be provided if method is not

method

PaymentMethodBank | PaymentMethodCard

Payment method if method_id is not provided

payments

array of objects

required

payments*

offer_id

string

Offer ID if payment is for a settlement

consumer_ref

string

required

store_method

boolean

required

If consumer wants to store the payment method for later use

Headers

Freede-Verification-Key

string

SHA256 Hash of Token and API key

Freede-API-Version

string

Freede Agency Incoming API Version

Freede-Verification-Token

string

Token Salt

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200

401

Unauthorized

Language

Loading…

Response

Click Try It! to start a request and see the response here!