Leadspedia

Credit

Lead Contract Credit

Get Credit History

GET
/core/v2/leadDistributionContracts/getCreditHistory.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    fromDate
    Type
    date
    Required
    required
    Matching Pattern
    Match Pattern: YYYY-MM-DD
  • Name
    toDate
    Type
    date
    Required
    required
    Matching Pattern
    Match Pattern: YYYY-MM-DD
  • Name
    disposition
    Type
    enum
    Allowed values
    Allowed values: Enabled Disabled Adjustment Transfer Sale Return Price Change Refund
  • Name
    start
    Type
    integer
    Description
    Offset of the first row to return.
    Default value
    Default value: 0
  • Name
    limit
    Type
    integer
    Description
    Maximum number of rows to return. Cannot be greater than 1000.
    Default value
    Default value: 100

Request Sample

curl --request GET \
  --url https://api.leadspedia.com/core/v2/leadDistributionContracts/getCreditHistory.do \
  --header 'Authorization: Basic Og=='

Enable Credit

POST
/core/v2/leadDistributionContracts/enableCredit.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    buyerLevel
    Type
    enum
    Required
    required
    Allowed values
    Allowed values: Yes No

Request Sample

curl --request POST \
  --url https://api.leadspedia.com/core/v2/leadDistributionContracts/enableCredit.do \
  --header 'Authorization: Basic Og=='

Adjust Credit

POST
/core/v2/leadDistributionContracts/adjustCredit.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    type
    Type
    enum
    Required
    required
    Allowed values
    Allowed values: Credit Debit
  • Name
    amount
    Type
    integer
    Required
    required
  • Name
    charge
    Type
    enum
    Description
    If Yes, the default credit card of the advertiser will be charged
    Default value
    Default value: No
    Allowed values
    Allowed values: Yes No
  • Name
    transactionFee
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    transactionFeeAmount
    Type
    integer
  • Name
    transactionFeePercentage
    Type
    integer
  • Name
    generateInvoice
    Type
    enum
    Description
    If Yes and the type is Credit, an invoice will be generated
    Default value
    Default value: No
    Allowed values
    Allowed values: Yes No
  • Name
    note
    Type
    string

Request Sample

curl --request POST \
  --url https://api.leadspedia.com/core/v2/leadDistributionContracts/adjustCredit.do \
  --header 'Authorization: Basic Og=='

Update Auto Recharge Settings

POST
/core/v2/leadDistributionContracts/updateAutoRechargeSettings.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    enableAutoRecharge
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    autoChargeAmount
    Type
    integer
  • Name
    autoChargeBalance
    Type
    integer
    Description
    Credit will be auto charged when the balance falls below this amount
  • Name
    chargeTransactionFee
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    transactionFeeAmount
    Type
    integer
  • Name
    transactionFeePercentage
    Type
    integer
  • Name
    generateInvoice
    Type
    enum
    Allowed values
    Allowed values: Yes No

Request Sample

curl --request POST \
  --url https://api.leadspedia.com/core/v2/leadDistributionContracts/updateAutoRechargeSettings.do \
  --header 'Authorization: Basic Og=='