Skip to content

Latest commit

 

History

History
410 lines (377 loc) · 11.2 KB

settlement.md

File metadata and controls

410 lines (377 loc) · 11.2 KB
Raw

Settlements

Fetch all settlements

options:= map[string]interface{}{
  "count": 10,
  "skip": 1,
}
body, err := client.Settlement.All(options, nil)

Parameters:

Name Type Description
from timestamp timestamp after which the settlement were created
to timestamp timestamp before which the settlement were created
count integer number of settlements to fetch (default: 10)
skip integer number of settlements to be skipped (default: 0)

Response:

{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "id": "setl_DGlQ1Rj8os78Ec",
      "entity": "settlement",
      "amount": 9973635,
      "status": "processed",
      "fees": 471699,
      "tax": 42070,
      "utr": "1568176960vxp0rj",
      "created_at": 1568176960
    }
  ]
}

Fetch a settlement

body, err := client.Settlement.Fetch("<settlementId>", nil, nil)

Parameters:

Name Type Description
settlementId* string The id of the settlement to be fetched

Response:

{
    "id": "setl_DGlQ1Rj8os78Ec",
    "entity": "settlement",
    "amount": 9973635,
    "status": "processed",
    "fees": 471699,
    "tax": 42070,
    "utr": "1568176960vxp0rj",
    "created_at": 1568176960
}

Settlement report

data:= map[string]interface{}{
    "year": 2018,
    "month": 2,
}
body, err := client.Settlement.Reports(data, nil)

Parameters:

Name Type Description
year* integer The year the settlement was received in the YYYY format. For example, 2020
month* integer The month the settlement was received in the MM format. For example, 09
day integer The date the settlement was received in the DD format. For example, 01
count integer number of settlements to fetch (default: 10)
skip integer number of settlements to be skipped (default: 0)

Response:

{
  "entity": "collection",
  "count": 4,
  "items": [
    {
      "entity_id": "pay_DEXrnipqTmWVGE",
      "type": "payment",
      "debit": 0,
      "credit": 97100,
      "amount": 100000,
      "currency": "INR",
      "fee": 2900,
      "tax": 0,
      "on_hold": false,
      "settled": true,
      "created_at": 1567692556,
      "settled_at": 1568176960,
      "settlement_id": "setl_DGlQ1Rj8os78Ec",
      "posted_at": null,
      "credit_type": "default",
      "description": "Recurring Payment via Subscription",
      "notes": "{}",
      "payment_id": null,
      "settlement_utr": "1568176960vxp0rj",
      "order_id": "order_DEXrnRiR3SNDHA",
      "order_receipt": null,
      "method": "card",
      "card_network": "MasterCard",
      "card_issuer": "KARB",
      "card_type": "credit",
      "dispute_id": null
    },
    {
      "entity_id": "rfnd_DGRcGzZSLyEdg1",
      "type": "refund",
      "debit": 242500,
      "credit": 0,
      "amount": 242500,
      "currency": "INR",
      "fee": 0,
      "tax": 0,
      "on_hold": false,
      "settled": true,
      "created_at": 1568107224,
      "settled_at": 1568176960,
      "settlement_id": "setl_DGlQ1Rj8os78Ec",
      "posted_at": null,
      "credit_type": "default",
      "description": null,
      "notes": "{}",
      "payment_id": "pay_DEXq1pACSqFxtS",
      "settlement_utr": "1568176960vxp0rj",
      "order_id": "order_DEXpmZgffXNvuI",
      "order_receipt": null,
      "method": "card",
      "card_network": "MasterCard",
      "card_issuer": "KARB",
      "card_type": "credit",
      "dispute_id": null
    },
    {
      "entity_id": "trf_DEUoCEtdsJgvl7",
      "type": "transfer",
      "debit": 100296,
      "credit": 0,
      "amount": 100000,
      "currency": "INR",
      "fee": 296,
      "tax": 46,
      "on_hold": false,
      "settled": true,
      "created_at": 1567681786,
      "settled_at": 1568176960,
      "settlement_id": "setl_DGlQ1Rj8os78Ec",
      "posted_at": null,
      "credit_type": "default",
      "description": null,
      "notes": null,
      "payment_id": "pay_DEApNNTR6xmqJy",
      "settlement_utr": "1568176960vxp0rj",
      "order_id": null,
      "order_receipt": null,
      "method": null,
      "card_network": null,
      "card_issuer": null,
      "card_type": null,
      "dispute_id": null
    },
    {
      "entity_id": "adj_EhcHONhX4ChgNC",
      "type": "adjustment",
      "debit": 0,
      "credit": 1012,
      "amount": 1012,
      "currency": "INR",
      "fee": 0,
      "tax": 0,
      "on_hold": false,
      "settled": true,
      "created_at": 1567681786,
      "settled_at": 1568176960,
      "settlement_id": "setl_DGlQ1Rj8os78Ec",
      "posted_at": null,
      "description": "test reason",
      "notes": null,
      "payment_id": null,
      "settlement_utr": null,
      "order_id": null,
      "order_receipt": null,
      "method": null,
      "card_network": null,
      "card_issuer": null,
      "card_type": null,
      "dispute_id": null
    }
  ]
}

Create on-demand settlement

data:= map[string]interface{}{
  "amount": 200000,
  "settle_full_balance": false,
  "description": "Need this to make vendor payments.",
  "notes": map[string]interface{}{
    "notes_key_1": "Tea, Earl Grey, Hot",
    "notes_key_2": "Tea, Earl Grey… decaf.",
  },
}
body, err := client.Settlement.CreateOnDemandSettlement(data, nil)

Parameters:

Name Type Description
amount* integer Maximum amount that can be settled
settle_full_balance* boolean true or false
description string The description may not be greater than 30 characters
notes object A key-value pair

Response:

{
  "id": "setlod_FNj7g2YS5J67Rz",
  "entity": "settlement.ondemand",
  "amount_requested": 200000,
  "amount_settled": 0,
  "amount_pending": 199410,
  "amount_reversed": 0,
  "fees": 590,
  "tax": 90,
  "currency": "INR",
  "settle_full_balance": false,
  "status": "initiated",
  "description": "Need this to make vendor payments.",
  "notes": {
    "notes_key_1": "Tea, Earl Grey, Hot",
    "notes_key_2": "Tea, Earl Grey… decaf."
  },
  "created_at": 1596771429,
  "ondemand_payouts": {
    "entity": "collection",
    "count": 1,
    "items": [
      {
        "id": "setlodp_FNj7g2cbvw8ueO",
        "entity": "settlement.ondemand_payout",
        "initiated_at": null,
        "processed_at": null,
        "reversed_at": null,
        "amount": 200000,
        "amount_settled": null,
        "fees": 590,
        "tax": 90,
        "utr": null,
        "status": "created",
        "created_at": 1596771429
      }
    ]
  }
}

Fetch all on-demand settlements

body, err := client.Settlement.FetchAllOnDemandSettlement(options, nil)

Parameters:

Name Type Description
from timestamp timestamp after which the settlements were created
to timestamp timestamp before which the settlements were created
count integer number of settlements to fetch (default: 10)
skip integer number of settlements to be skipped (default: 0)
expand[] string Pass this if you want to fetch payout details as part of the response. possible value is ondemand_payouts

Response:

{
  "entity": "collection",
  "count": 10,
  "items": [
    {
      "id": "setlod_JngXLps9eKgYIM",
      "entity": "settlement.ondemand",
      "amount_requested": 200000,
      "amount_settled": 199410,
      "amount_pending": 0,
      "amount_reversed": 0,
      "fees": 590,
      "tax": 90,
      "currency": "INR",
      "settle_full_balance": false,
      "status": "processed",
      "description": "Make vendor payments.",
      "notes": {
        "notes_key_1": "Tea, Earl Grey, Hot",
        "notes_key_2": "Tea, Earl Grey… decaf."
      },
      "created_at": 1656587511,
      "scheduled": false,
      "ondemand_payouts": {
        "entity": "collection",
        "count": 1,
        "items": [
          {
            "id": "setlodp_JngXLqBZNxBgIY",
            "entity": "settlement.ondemand_payout",
            "initiated_at": 1656587522,
            "processed_at": 1656587533,
            "reversed_at": null,
            "amount": 200000,
            "amount_settled": 199410,
            "fees": 590,
            "tax": 90,
            "utr": "7312050628",
            "status": "processed",
            "created_at": 1656587511
          }
        ]
      }
    }
  ]
}

Fetch on-demand settlement by ID

body, err := client.Settlement.FetchOnDemandSettlementById("<settlementId>", nil, nil)

Parameters:

Name Type Description
settlementId* string Settlement Id of the On-demand settlement
expand[] string Pass this if you want to fetch payout details as part of the response. possible value is ondemand_payouts

Response:

{
    "id": "setlod_JngXLps9eKgYIM",
    "entity": "settlement.ondemand",
    "amount_requested": 200000,
    "amount_settled": 199410,
    "amount_pending": 0,
    "amount_reversed": 0,
    "fees": 590,
    "tax": 90,
    "currency": "INR",
    "settle_full_balance": false,
    "status": "processed",
    "description": "Make vendor payments.",
    "notes": {
        "notes_key_1": "Tea, Earl Grey, Hot",
        "notes_key_2": "Tea, Earl Grey… decaf."
    },
    "created_at": 1656587511,
    "scheduled": false,
    "ondemand_payouts": {
        "entity": "collection",
        "count": 1,
        "items": [
            {
                "id": "setlodp_JngXLqBZNxBgIY",
                "entity": "settlement.ondemand_payout",
                "initiated_at": 1656587522,
                "processed_at": 1656587533,
                "reversed_at": null,
                "amount": 200000,
                "amount_settled": 199410,
                "fees": 590,
                "tax": 90,
                "utr": "7312050628",
                "status": "processed",
                "created_at": 1656587511
            }
        ]
    }
}

PN: * indicates mandatory fields

For reference click here