Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?

Approving Settlements

The request below (https://developers.finixpayments.com/#create-a-batch-settlement) will be deprecated once v2 is enabled and will return a 422 if called.

curl https://finix.sandbox-payments-api.com/identities/IDsvaStRzJJwDe3YGTJ49P4P/settlements \
    -H "Content-Type: application/vnd.json+api" \
    -u  USgiRYX5qFyB2YgX1Hbo6CrA:711ff8b3-1d9b-4580-a6cd-9635894e36bc \
    -d '
    {
        "currency": "USD",
        "processor": "DUMMY_V1",
        "tags": {
            "Internal Daily Settlement ID": "21DFASJSAKAS"
        }
    }'

v2 URL: https://finix.sandbox-payments-api.com/review_queue?entity_type=SETTLEMENT&outcome=PENDING

You'll notice the entity_type in v2 returns SETTLEMENT_V2.

Updated Attributes

Field Notes
entity_type Value is now SETTLEMENT_V2
{
  "id": "RKmsSJXZhTzoR36yVKNt7wj9",
  "tags": {},
  "review_type": "CREATED",
  "entity_type": "SETTLEMENT_V2",
  "outcome": "ACCEPTED",
  "application": "APfNCxyMBNV7S2xtfNr55Y2a",
  "reviewed_by": "USfQ68GFZQ4mj2PPeWoz6q9F",
  "entity_id": "ST7kqGey1Wuh4YpSsC9K9juJ",
  "created_at": "2020-01-11T18:15:48.25Z",
  "updated_at": "2020-01-16T18:51:15.06Z",
  "completed_at": "2020-01-16T18:51:15.00Z",
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/review_queue/RKmsSJXZhTzoR36yVKNt7wj9"
    },
    "application": {
      "href": "https://finix.sandbox-payments-api.com/applications/APfNCxyMBNV7S2xtfNr55Y2a"
    },
    "settlement": {
      "href": "https://finix.sandbox-payments-api.com/settlements/ST7kqGey1Wuh4YpSsC9K9juJ"
    },
    "review_by": {
      "href": "https://finix.sandbox-payments-api.com/users/USfQ68GFZQ4mj2PPeWoz6q9F"
    }
  }
}

v1 URL: https://finix.sandbox-payments-api.com/review_queue?entity_type=SETTLEMENT&outcome=PENDING

{
  "_embedded" : {
    "review_queue_items" : [ {
      "id" : "RKjzzhjjP9yUSBWFoH21M4HA",
      "tags" : { },
      "review_type" : "CREATED",
      "entity_type" : "SETTLEMENT",
      "outcome" : "PENDING",
      "application" : "APnXHnAPjYcwNrrqnaDkcate",
      "reviewed_by" : "USPcLcTCcA4qpNxzdPEUhEh",
      "entity_id" : "ST4TrFihJAVUCvJCFP67Hbdy",
      "created_at" : "2019-05-18T19:03:20.51Z",
      "updated_at" : "2019-12-16T19:22:33.69Z",
      "completed_at" : "2019-12-16T19:22:06.88Z",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/review_queue/RKjzzhjjP9yUSBWFoH21M4HA"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APnXHnAPjYcwNrrqnaDkcate"
        },
        "settlement" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST4TrFihJAVUCvJCFP67Hbdy"
        },
        "review_by" : {
          "href" : "https://finix.sandbox-payments-api.com/users/USPcLcTCcA4qpNxzdPEUhEh"
        }
      }
    },
 "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 42246
  }
}

Fetch Settlement

The identity key has been removed from response. In addition, the v2 response has additional details on the settlement breakdown, specifically information on the amount and count.

v2: URL: https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST4cN1ZN7DApQT8rCnfApJY1

Removed Attributes

Field Notes
type
funds_flow
identity
destination This information is now stored in /funding_instructions
Links: Identity

Updated Attributes

Field Notes
processor_type In v1 it's processor
total_fees Replaced total_fee_amount
total_fee Replaced with total_fee_amount
application_id In v1 it's application

New Attributes

Field Type Notes
total_fee_amount integer
status string Returns the state of the settlements. Status flows in this order PENDING -> AWAITING_APPROVAL -> APPROVED
transfer_debit_count integer
transfer_credit_count integer
fee_count integer
reverse_count integer
dispute_debit_count integer
dispute_credit_count integer
adjustment_debit_count integer
adjustment_credit_count integer
funded boolean A boolean flag to indicate if the that settlement has been funded. It's a temporary implementation for now, it checks if status = APPROVED. In the future we we'll make more descriptive callouts based on the status of the individual funding instructions
exception boolean When a PayFac removes transfers from a bath settlement, they will get placed into a new settlement with exception marked as true
Link: merchant
{
  "id": "ST7Gjs781tAFEcnZfZZiyL3i",
  "status": "AWAITING_APPROVAL",
  "merchant_id": "MUeujyMxn5ywP75coXUj7KMY",
  "application_id": "APm1JsBtoTDWiEGBhfzyf6qU",
  "currency": "USD",
  "total_amount": 0,
  "total_fee_amount": 272,
  "net_amount": -272,
  "transfer_debit_count": 0,
  "transfer_credit_count": 0,
  "fee_count": 3,
  "reverse_count": 0,
  "dispute_debit_count": 0,
  "dispute_credit_count": 0,
  "adjustment_debit_count": 0,
  "adjustment_credit_count": 0,
  "processor_type": "DUMMY_V1",
  "funded": false,
  "exception": false,
  "created_at": "2019-12-13T02:21:03.68Z",
  "updated_at": "2019-12-13T19:15:30.53Z",
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST7Gjs781tAFEcnZfZZiyL3i"
    },
    "merchant": {
      "href": "https://finix.sandbox-payments-api.com/merchants/MUeujyMxn5ywP75coXUj7KMY"
    },
    "application": {
      "href": "https://finix.sandbox-payments-api.com/applications/APm1JsBtoTDWiEGBhfzyf6qU"
    },
    "funding_transfers": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST7Gjs781tAFEcnZfZZiyL3i/funding_transfers"
    },
    "transfers": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST7Gjs781tAFEcnZfZZiyL3i/transfers"
    },
    "fees": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST7Gjs781tAFEcnZfZZiyL3i/transfers?type=FEE"
    },
    "reversals": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST7Gjs781tAFEcnZfZZiyL3i/transfers?type=REVERSE"
    },
    "credits": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST7Gjs781tAFEcnZfZZiyL3i/transfers?type=CREDIT"
    },
    "debits": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST7Gjs781tAFEcnZfZZiyL3i/transfers?type=DEBIT"
    },
    "disputes": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST7Gjs781tAFEcnZfZZiyL3i/transfers?type=DISPUTE"
    }
  }
}

v1 URL: https://finix.sandbox-payments-api.com/settlements/ST4cN1ZN7DApQT8rCnfApJY1

{
  "id" : "STjudb9GiKJcsefU56cW2wwF",
  "application" : "APiwqrQ7wxQQ6AgJtKz8ibC7",
  "tags" : {
    "Internal Daily Settlement ID" : "21DFASJSAKAS"
  },
  "identity" : "IDrE9ezGKCZhFN7NCigZ3TbC",
  "currency" : "USD",
  "merchant_id" : "MUsDAChQcLnYmkzKc3xJ8Pek",
  "created_at" : "2019-12-17T20:35:13.14Z",
  "updated_at" : "2019-12-17T20:35:13.22Z",
  "processor" : "DUMMY_V1",
  "type" : "MERCHANT",
  "funds_flow" : "NET",
  "total_amount" : 1203021,
  "total_fees" : 209194,
  "total_fee" : 209194,
  "net_amount" : 993827,
  "destination" : null,
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF"
    },
    "application" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/APiwqrQ7wxQQ6AgJtKz8ibC7"
    },
    "identity" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDrE9ezGKCZhFN7NCigZ3TbC"
    },
    "funding_transfers" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/funding_transfers"
    },
    "transfers" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers"
    },
    "fees" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers?type=fee"
    },
    "reversals" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers?type=reverse"
    },
    "credits" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers?type=credit"
    },
    "debits" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers?type=debit"
    },
    "disputes" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers?type=dispute"
    }
  }
}

List Settlement

Attributes in the response have changed. Please see below for comparison.

v2: https://finix.sandbox-payments-api.com/settlement/v1/settlements

Removed Attributes

Field
type
funds_flow
identity
destination
Links: Identity

Updated Attributes

Field Notes
processor_type In v1 it's processor
total_fees Replaced total_fee_amount
total_fee Replaced with total_fee_amount
application_id In v1 it's application

New Attributes

Field Type Notes
total_fee_amount integer
status string Returns the state of the settlements. Status flows in this order PENDING -> AWAITING_APPROVAL -> APPROVED
transfer_debit_count integer
transfer_credit_count integer
fee_count integer
reverse_count integer
dispute_debit_count integer
dispute_credit_count integer
adjustment_debit_count integer
adjustment_credit_count integer
funded boolean A boolean flag to indicate if the that settlement has been funded. It's a temporary implementation for now, it checks if status = APPROVED. In the future we we'll make more descriptive callouts based on the status of the individual funding instructions
exception boolean When a PayFac removes transfers from a bath settlement, they will get placed into a new settlement with exception marked as true
Link: merchant
{
  "_embedded": {
    "settlements": [
      {
        "id": "STwFu4rZ1oDHKjhHSgdkg1wU",
        "status": "AWAITING_APPROVAL",
        "merchant_id": "MU6aY9iyFT5ECgf1NvyMpUak",
        "application_id": "APm1JsBtoTDWiEGBhfzyf6qU",
        "currency": "USD",
        "total_amount": 18000,
        "total_fee_amount": 1188,
        "net_amount": 16812,
        "transfer_debit_count": 6,
        "transfer_credit_count": 0,
        "fee_count": 18,
        "reverse_count": 0,
        "dispute_debit_count": 0,
        "dispute_credit_count": 0,
        "adjustment_debit_count": 0,
        "adjustment_credit_count": 0,
        "processor_type": "DUMMY_V1",
        "funded": false,
        "exception": false,
        "created_at": "2020-01-07T13:59:49.83Z",
        "updated_at": "2020-01-07T18:15:46.98Z",
        "_links": {
          "self": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU"
          },
          "merchant": {
            "href": "https://finix.sandbox-payments-api.com/merchants/MU6aY9iyFT5ECgf1NvyMpUak"
          },
          "application": {
            "href": "https://finix.sandbox-payments-api.com/applications/APm1JsBtoTDWiEGBhfzyf6qU"
          },
          "funding_transfers": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/funding_transfers"
          },
          "transfers": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers"
          },
          "fees": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=FEE"
          },
          "reversals": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=REVERSE"
          },
          "credits": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=CREDIT"
          },
          "debits": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=DEBIT"
          },
          "disputes": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=DISPUTE"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page": {
    "offset": 0,
    "limit": 20,
    "count": 13
  }
}

v1: https://finix.sandbox-payments-api.com/settlements

{
  "_embedded" : {
    "settlements" : [ {
      "id" : "STjudb9GiKJcsefU56cW2wwF",
      "application" : "APiwqrQ7wxQQ6AgJtKz8ibC7",
      "tags" : {
        "Internal Daily Settlement ID" : "21DFASJSAKAS"
      },
      "identity" : "IDrE9ezGKCZhFN7NCigZ3TbC",
      "currency" : "USD",
      "merchant_id" : "MUsDAChQcLnYmkzKc3xJ8Pek",
      "created_at" : "2019-12-17T20:35:13.14Z",
      "updated_at" : "2019-12-17T20:35:14.60Z",
      "processor" : "DUMMY_V1",
      "type" : "MERCHANT",
      "funds_flow" : "NET",
      "total_amount" : 1203021,
      "total_fees" : 209194,
      "total_fee" : 209194,
      "net_amount" : 993827,
      "destination" : "PIvazDG7dTqVMipA5ZcpwbNa",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APiwqrQ7wxQQ6AgJtKz8ibC7"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDrE9ezGKCZhFN7NCigZ3TbC"
        },
        "funding_transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/funding_transfers"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers"
        },
        "fees" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers?type=fee"
        },
        "reversals" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers?type=reverse"
        },
        "credits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers?type=credit"
        },
        "debits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers?type=debit"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STjudb9GiKJcsefU56cW2wwF/transfers?type=dispute"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 1
  }
}

List Funding Transfers in a Batch Settlement

v2 URL: https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST4BibQK9o7xnrJmjHzMvudk/funding_transfers

Removed Attributes

Field
state
trace_id
source
destination
ready_to_settle_at
fee
statement_descriptor
messages
raw
idempotency_id
merchant_identity
subtype

New Attributes

Field Type Notes
name string Possible values: COMBINED_PLATFORM_FEES_DISPUTES_AND_ADJUSTMENTS, MERCHANT_FUNDING_INSTRUCTION, and APPLICATION_FUNDING_INSTRUCTION. Please note, these values are freeform descriptive names and are subject to change.
level string Possible values: PLATFORM, APPLICATION, MERCHANT
Links: Adding Merchant (e.g. MUxxx) and Destination link in next sprint
{
  "_embedded": {
    "transfers": [
      {
        "id": "TRr7wjfGwuFwePrJdsrpPHyx",
        "name": "COMBINED_PLATFORM_FEES_DISPUTES_AND_ADJUSTMENTS",
        "amount": 20370,
        "currency": "USD",
        "level": "PLATFORM",
        "type": "CREDIT",
        "created_at": "2019-12-18T07:31:42.76Z",
        "updated_at": "2019-12-18T07:31:42.76Z",
        "_links": {
          "transfers": {
            "href": "https://finix.sandbox-payments-api.com/transfers/TRr7wjfGwuFwePrJdsrpPHyx"
          }
        }
      },
      {
        "id": "TR5omLxjAr2YRQ5LSmNrduFZ",
        "name": "MERCHANT_FUNDING_INSTRUCTION",
        "amount": 679623,
        "currency": "USD",
        "level": "MERCHANT",
        "type": "CREDIT",
        "created_at": "2019-12-04T05:08:59.42Z",
        "updated_at": "2019-12-06T01:13:17.67Z",
        "_links": {
          "transfers": {
            "href": "https://finix.sandbox-payments-api.com/transfers/TR5omLxjAr2YRQ5LSmNrduFZ"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STnDjZ56PTVoymdKZNKjTVqk/funding_transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page": {
    "offset": 0,
    "limit": 20,
    "count": 2
  }
}

v1 URL: https://finix.sandbox-payments-api.com/settlements/STvH5Gzahmmvt5MENwCQB3bA/funding_transfers

{
  "_embedded" : {
    "transfers" : [ {
      "id" : "TRh8myZzU6gsdqyr3TKYSa5H",
      "amount" : 1361907,
      "tags" : {
        "Internal Daily Settlement ID" : "21DFASJSAKAS"
      },
      "state" : "PENDING",
      "trace_id" : "e5069892-71bc-4abb-b4fd-1c76bde5497c",
      "currency" : "USD",
      "application" : "AP66yCMRLXGbyzCZ7UYso6W7",
      "source" : null,
      "destination" : "PI6gUDQ1txsRfkhipRx4yFsn",
      "ready_to_settle_at" : null,
      "fee" : 0,
      "statement_descriptor" : null,
      "type" : "CREDIT",
      "messages" : [ ],
      "raw" : null,
      "created_at" : "2019-08-15T16:08:35.54Z",
      "updated_at" : "2019-08-15T16:08:36.45Z",
      "idempotency_id" : null,
      "merchant_identity" : "IDsvaStRzJJwDe3YGTJ49P4P",
      "subtype" : "SETTLEMENT_MERCHANT",
      "_links" : {
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/AP66yCMRLXGbyzCZ7UYso6W7"
        },
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRh8myZzU6gsdqyr3TKYSa5H"
        },
        "payment_instruments" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRh8myZzU6gsdqyr3TKYSa5H/payment_instruments"
        },
        "merchant_identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDsvaStRzJJwDe3YGTJ49P4P"
        },
        "reversals" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRh8myZzU6gsdqyr3TKYSa5H/reversals"
        },
        "fees" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRh8myZzU6gsdqyr3TKYSa5H/fees"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRh8myZzU6gsdqyr3TKYSa5H/disputes"
        },
        "destination" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PI6gUDQ1txsRfkhipRx4yFsn"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STrw6K1i1jC8iEYjtVrra38J/funding_transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 1
  }
}

View Items in Settlement

This response does not include as much detailed information about the individual entry in the response. If you want to fetch full details use the /transfers/{ID} API call.

Attributes in the response have changed. Please see below for comparison.

v2 URL: https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST4cN1ZN7DApQT8rCnfApJY1/transfers

Removed Attributes

Field
state
trace_id
source
destination
ready_to_settle_at
fee
statement_descriptor
messages
raw
idempotency_id
merchant_identity
subtype

Updated Attributes

Field Notes
amount Now includes option for fractional basis points

New Attributes

Field Type Notes
settlement_id string
entry_type string TRANSFER, REVERSE, DISPUTE_TRANSFER, FEE, ADJUSTMENT
settlement_entry_id string Settlement entries is a wrapper object that stores a relation to the item that that was added to the settlement. From a settlement_entry you can get the entry_type (Transfer) and entry_id (TR1234) and then you could fetch the top level object using the find by ID call
{
  "_embedded": {
    "settlement_entries": [
      {
        "id": "TRfbUUkTbC82RKjBVFmJT348",
        "settlement_id": "ST4cN1ZN7DApQT8rCnfApJY1",
        "entry_type": "FEE",
        "amount": 11.000000000000,
        "currency": "USD",
        "settlement_entry_id": "SE4CBvWyztEwLmsPrtbj7s8R",
        "created_at": "2019-12-20T02:26:23.00Z",
        "updated_at": "2019-12-20T02:26:23.00Z",
        "_links": {
          "self": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/ST4cN1ZN7DApQT8rCnfApJY1/transfers/TRfbUUkTbC82RKjBVFmJT348"
          }
        }
      },
      {
        "id": "TR6dsdsJwwiwPzhjCC8FNWAw",
        "settlement_id": "ST4cN1ZN7DApQT8rCnfApJY1",
        "entry_type": "FEE",
        "amount": 145.000000000000,
        "currency": "USD",
        "settlement_entry_id": "SE4CghTqR5ZTWYWrzqde2cqE",
        "created_at": "2019-12-20T02:26:22.92Z",
        "updated_at": "2019-12-20T02:26:22.92Z",
        "_links": {
          "self": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/ST4cN1ZN7DApQT8rCnfApJY1/transfers/TR6dsdsJwwiwPzhjCC8FNWAw"
          }
        }
      },
      {
        "id": "TRcJo26Ta6ZNUm3FKvpaWuEr",
        "settlement_id": "ST4cN1ZN7DApQT8rCnfApJY1",
        "entry_type": "TRANSFER",
        "amount": 4000.000000000000,
        "currency": "USD",
        "settlement_entry_id": "SE4BUi8pWqseoVd7enCqxvhz",
        "created_at": "2019-12-20T02:26:22.83Z",
        "updated_at": "2019-12-20T02:26:22.83Z",
        "_links": {
          "self": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/ST4cN1ZN7DApQT8rCnfApJY1/transfers/TRcJo26Ta6ZNUm3FKvpaWuEr"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST4cN1ZN7DApQT8rCnfApJY1/transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    },
    "next": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST4cN1ZN7DApQT8rCnfApJY1/transfers?offset=20&limit=20&sort=created_at,desc&sort=id,desc"
    },
    "last": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/ST4cN1ZN7DApQT8rCnfApJY1/transfers?offset=20&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page": {
    "offset": 0,
    "limit": 20,
    "count": 28
  }
}

v1 URL: https://finix.sandbox-payments-api.com/settlements/STvH5Gzahmmvt5MENwCQB3bA/transfers

{
  "_embedded" : {
    "transfers" : [ {
      "id" : "TRmUvEhufwxBfBtDYLwaxp3w",
      "amount" : 52036,
      "tags" : {
        "TransactionSource" : "PayLink",
        "UserId" : "22de927d-b38c-4b36-8235-d4bc2ea48e28",
        "CustomerId" : "18014",
        "MerchantId" : "33866",
        "OrderId" : "15216",
        "CustomerIdentity" : "IDs8Six44tRoWTmgPk7kQVVn"
      },
      "state" : "SUCCEEDED",
      "trace_id" : "23e875ab-b719-4f1a-a76b-3cbdc131d221",
      "currency" : "USD",
      "application" : "AP5BgJWFoQAjCADF549xcD4s",
      "source" : "PIiQZ2LnAci8Xvmuu8Qpb7n",
      "destination" : null,
      "ready_to_settle_at" : "2020-01-02T15:19:58.42Z",
      "fee" : 0,
      "statement_descriptor" : "KBG*JVNP9AYOTSUOIVTDP",
      "type" : "DEBIT",
      "messages" : [ ],
      "raw" : null,
      "created_at" : "2020-01-02T14:30:35.89Z",
      "updated_at" : "2020-01-02T14:31:02.61Z",
      "idempotency_id" : null,
      "merchant_identity" : "IDfhU3SD7RLAHDwZ1eK2pCtx",
      "subtype" : "API",
      "_links" : {
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/AP5BgJWFoQAjCADF549xcD4s"
        },
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRmUvEhufwxBfBtDYLwaxp3w"
        },
        "merchant_identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDfhU3SD7RLAHDwZ1eK2pCtx"
        },
        "payment_instruments" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRmUvEhufwxBfBtDYLwaxp3w/payment_instruments"
        },
        "reversals" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRmUvEhufwxBfBtDYLwaxp3w/reversals"
        },
        "fees" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRmUvEhufwxBfBtDYLwaxp3w/fees"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRmUvEhufwxBfBtDYLwaxp3w/disputes"
        },
        "source" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIiQZ2LnAci8Xvmuu8Qpb7n"
        },
        "fee_profile" : {
          "href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPeg3ZV9vNnFSjiiyWKe8USF"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/ST4fDTYmUPFHQvkUBYu9AyR1/transfers?type=debit&offset=0&limit=20&sort=created_at,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 1
  }
}

Fetch Settlements for an Identity

Attributes in the response have changed. Please see below for comparison.

v2 URL: https://finix.sandbox-payments-api.com/settlement/v1/identities/IDrPmBPMbNanihU1qqB3a5Sw/settlements

Removed Attributes

Field
type
funds_flow
identity
destination
Links: Identity

Updated Attributes

Field Notes
processor_type In v1 it's processor
total_fees Replaced total_fee_amount
total_fee Replaced with total_fee_amount
application_id In v1 it's application

New Attributes

Field Type Notes
total_fee_amount integer
status string Returns the state of the settlements. Status flows in this order PENDING -> AWAITING_APPROVAL -> APPROVED
transfer_debit_count integer
transfer_credit_count integer
fee_count integer
reverse_count integer
dispute_debit_count integer
dispute_credit_count integer
adjustment_debit_count integer
adjustment_credit_count integer
funded boolean A boolean flag to indicate if the that settlement has been funded. It's a temporary implementation for now, it checks if status = APPROVED. In the future we we'll make more descriptive callouts based on the status of the individual funding instructions
exception boolean When a PayFac removes transfers from a bath settlement, they will get placed into a new settlement with exception marked as true
Link: merchant
{
  "_embedded": {
    "settlements": [
      {
        "id": "STwFu4rZ1oDHKjhHSgdkg1wU",
        "status": "AWAITING_APPROVAL",
        "merchant_id": "MU6aY9iyFT5ECgf1NvyMpUak",
        "application_id": "APm1JsBtoTDWiEGBhfzyf6qU",
        "currency": "USD",
        "total_amount": 18000,
        "total_fee_amount": 1188,
        "net_amount": 16812,
        "transfer_debit_count": 6,
        "transfer_credit_count": 0,
        "fee_count": 18,
        "reverse_count": 0,
        "dispute_debit_count": 0,
        "dispute_credit_count": 0,
        "adjustment_debit_count": 0,
        "adjustment_credit_count": 0,
        "processor_type": "DUMMY_V1",
        "funded": false,
        "exception": false,
        "created_at": "2020-01-07T13:59:49.83Z",
        "updated_at": "2020-01-07T18:15:46.98Z",
        "_links": {
          "self": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU"
          },
          "merchant": {
            "href": "https://finix.sandbox-payments-api.com/merchants/MU6aY9iyFT5ECgf1NvyMpUak"
          },
          "application": {
            "href": "https://finix.sandbox-payments-api.com/applications/APm1JsBtoTDWiEGBhfzyf6qU"
          },
          "funding_transfers": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/funding_transfers"
          },
          "transfers": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers"
          },
          "fees": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=FEE"
          },
          "reversals": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=REVERSE"
          },
          "credits": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=CREDIT"
          },
          "debits": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=DEBIT"
          },
          "disputes": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=DISPUTE"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page": {
    "offset": 0,
    "limit": 20,
    "count": 13
  }
}

v1 URL: https://finix.sandbox-payments-api.com/identities/IDqDnooZR4evo6dcy84chG4V/settlements

{
  "_embedded" : {
    "settlements" : [ {
      "id" : "ST5jjyx2VcTcTcv8rNSMrJ4k",
      "application" : "AP5BgJWFoQAjCADF549xcD4s",
      "tags" : {
        "LocationId" : "33709",
        "MerchantId" : "33914",
        "UserId" : "6cd03300-c1f6-4292-8f1b-905f2c736a08"
      },
      "identity" : "IDqebpBXEE9aidDXRsNa883w",
      "currency" : "USD",
      "merchant_id" : "MUkFFiXCDaLwJRB82YNB9vvo",
      "created_at" : "2020-01-02T22:55:54.15Z",
      "updated_at" : "2020-01-02T22:55:54.17Z",
      "processor" : "DUMMY_V1",
      "type" : "MERCHANT",
      "funds_flow" : "NET",
      "total_amount" : 34158,
      "total_fees" : 1021,
      "total_fee" : 1021,
      "net_amount" : 33137,
      "destination" : null,
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST5jjyx2VcTcTcv8rNSMrJ4k"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/AP5BgJWFoQAjCADF549xcD4s"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDqebpBXEE9aidDXRsNa883w"
        },
        "funding_transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST5jjyx2VcTcTcv8rNSMrJ4k/funding_transfers"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST5jjyx2VcTcTcv8rNSMrJ4k/transfers"
        },
        "fees" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST5jjyx2VcTcTcv8rNSMrJ4k/transfers?type=fee"
        },
        "reversals" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST5jjyx2VcTcTcv8rNSMrJ4k/transfers?type=reverse"
        },
        "credits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST5jjyx2VcTcTcv8rNSMrJ4k/transfers?type=credit"
        },
        "debits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST5jjyx2VcTcTcv8rNSMrJ4k/transfers?type=debit"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST5jjyx2VcTcTcv8rNSMrJ4k/transfers?type=dispute"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDqebpBXEE9aidDXRsNa883w/settlements?offset=0&limit=20&sort=created_at,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 1
  }
}

Fetch Settlements for Application

Attributes in the response have changed. Please see below for comparison.

v2 URL: https://finix.sandbox-payments-api.com/settlement/v1/applications/APm1JsBtoTDWiEGBhfzyf6qU/settlements

Removed Attributes

Field
type
funds_flow
identity
destination
Links: Identity

Updated Attributes

Field Notes
processor_type In v1 it's processor
total_fees Replaced total_fee_amount
total_fee Replaced with total_fee_amount
application_id In v1 it's application

New Attributes

Field Type Notes
total_fee_amount integer
status string Returns the state of the settlements. Status flows in this order PENDING -> AWAITING_APPROVAL -> APPROVED
transfer_debit_count integer
transfer_credit_count integer
fee_count integer
reverse_count integer
dispute_debit_count integer
dispute_credit_count integer
adjustment_debit_count integer
adjustment_credit_count integer
funded boolean A boolean flag to indicate if the that settlement has been funded. It's a temporary implementation for now, it checks if status = APPROVED. In the future we we'll make more descriptive callouts based on the status of the individual funding instructions
exception boolean When a PayFac removes transfers from a batch settlement, they will get placed into a new settlement with exception marked as true
Link: merchant
{
  "_embedded": {
    "settlements": [
      {
        "id": "STwFu4rZ1oDHKjhHSgdkg1wU",
        "status": "AWAITING_APPROVAL",
        "merchant_id": "MU6aY9iyFT5ECgf1NvyMpUak",
        "application_id": "APm1JsBtoTDWiEGBhfzyf6qU",
        "currency": "USD",
        "total_amount": 18000,
        "total_fee_amount": 1188,
        "net_amount": 16812,
        "transfer_debit_count": 6,
        "transfer_credit_count": 0,
        "fee_count": 18,
        "reverse_count": 0,
        "dispute_debit_count": 0,
        "dispute_credit_count": 0,
        "adjustment_debit_count": 0,
        "adjustment_credit_count": 0,
        "processor_type": "DUMMY_V1",
        "funded": false,
        "exception": false,
        "created_at": "2020-01-07T13:59:49.83Z",
        "updated_at": "2020-01-07T18:15:46.98Z",
        "_links": {
          "self": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU"
          },
          "merchant": {
            "href": "https://finix.sandbox-payments-api.com/merchants/MU6aY9iyFT5ECgf1NvyMpUak"
          },
          "application": {
            "href": "https://finix.sandbox-payments-api.com/applications/APm1JsBtoTDWiEGBhfzyf6qU"
          },
          "funding_transfers": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/funding_transfers"
          },
          "transfers": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers"
          },
          "fees": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=FEE"
          },
          "reversals": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=REVERSE"
          },
          "credits": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=CREDIT"
          },
          "debits": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=DEBIT"
          },
          "disputes": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=DISPUTE"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page": {
    "offset": 0,
    "limit": 20,
    "count": 13
  }
}

v1 URL: https://finix.sandbox-payments-api.com/applications/APePLVAQiR67dnCPrXwuTTsT/settlements

{
  "_embedded" : {
    "settlements" : [ {
      "id" : "STrw6K1i1jC8iEYjtVrra38J",
      "application" : "AP66yCMRLXGbyzCZ7UYso6W7",
      "tags" : {
        "Internal Daily Settlement ID" : "21DFASJSAKAS"
      },
      "identity" : "IDsvaStRzJJwDe3YGTJ49P4P",
      "currency" : "USD",
      "merchant_id" : "MUcGW9vZypLt2BTbLGjt8JQA",
      "created_at" : "2019-08-15T16:08:34.47Z",
      "updated_at" : "2019-08-15T16:08:35.31Z",
      "processor" : "DUMMY_V1",
      "type" : "MERCHANT",
      "funds_flow" : "NET",
      "total_amount" : 1513332,
      "total_fees" : 151425,
      "total_fee" : 151425,
      "net_amount" : 1361907,
      "destination" : "PI6gUDQ1txsRfkhipRx4yFsn",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STrw6K1i1jC8iEYjtVrra38J"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/AP66yCMRLXGbyzCZ7UYso6W7"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDsvaStRzJJwDe3YGTJ49P4P"
        },
        "funding_transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STrw6K1i1jC8iEYjtVrra38J/funding_transfers"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STrw6K1i1jC8iEYjtVrra38J/transfers"
        },
        "fees" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STrw6K1i1jC8iEYjtVrra38J/transfers?type=fee"
        },
        "reversals" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STrw6K1i1jC8iEYjtVrra38J/transfers?type=reverse"
        },
        "credits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STrw6K1i1jC8iEYjtVrra38J/transfers?type=credit"
        },
        "debits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STrw6K1i1jC8iEYjtVrra38J/transfers?type=debit"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STrw6K1i1jC8iEYjtVrra38J/transfers?type=dispute"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/AP66yCMRLXGbyzCZ7UYso6W7/settlements?offset=0&limit=20&sort=created_at,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 1
  }
}

Fetch Settlements for a Merchant (New API Endpoint)

v2 URL: https://finix.sandbox-payments-api.com/settlement/v1/merchants/MUeujyMxn5ywP75coXUj7KMY/settlements

{
  "_embedded": {
    "settlements": [
      {
        "id": "STwFu4rZ1oDHKjhHSgdkg1wU",
        "status": "AWAITING_APPROVAL",
        "merchant_id": "MU6aY9iyFT5ECgf1NvyMpUak",
        "application_id": "APm1JsBtoTDWiEGBhfzyf6qU",
        "currency": "USD",
        "total_amount": 18000,
        "total_fee_amount": 1188,
        "net_amount": 16812,
        "transfer_debit_count": 6,
        "transfer_credit_count": 0,
        "fee_count": 18,
        "reverse_count": 0,
        "dispute_debit_count": 0,
        "dispute_credit_count": 0,
        "adjustment_debit_count": 0,
        "adjustment_credit_count": 0,
        "processor_type": "DUMMY_V1",
        "funded": false,
        "exception": false,
        "created_at": "2020-01-07T13:59:49.83Z",
        "updated_at": "2020-01-07T18:15:46.98Z",
        "_links": {
          "self": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU"
          },
          "merchant": {
            "href": "https://finix.sandbox-payments-api.com/merchants/MU6aY9iyFT5ECgf1NvyMpUak"
          },
          "application": {
            "href": "https://finix.sandbox-payments-api.com/applications/APm1JsBtoTDWiEGBhfzyf6qU"
          },
          "funding_transfers": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/funding_transfers"
          },
          "transfers": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers"
          },
          "fees": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=FEE"
          },
          "reversals": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=REVERSE"
          },
          "credits": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=CREDIT"
          },
          "debits": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=DEBIT"
          },
          "disputes": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements/STwFu4rZ1oDHKjhHSgdkg1wU/transfers?type=DISPUTE"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v1/settlements?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page": {
    "offset": 0,
    "limit": 20,
    "count": 13
  }
}

Joined Payouts

Joined payouts allows you to combine two settlements and payout into a single set of funding instructions. ie (LITLE and VANTIV combined into just one Litle Funding Instruction)

HTTP Request

POST https://finix.sandbox-payments-api.com/settlement/v2/settlement_group_settings

Request Arguments

Field Type Description
identity_id string, required The ID of the Identity
subtype string, required Possible value: NET
primary_merchant_id string, required The Merchant that the funding instruction will go to
processor_types array, required The name of the processors that you want to combine into one funding instruction
curl https://finix.sandbox-payments-api.com/settlement/v2/settlement_group_settings \
    -H "Content-Type: application/vnd.json+api" \
    -u  USdnzVnhdpVrTbZfou92wKks:65cb610c-08de-4ab8-8920-e65a68497da7 \
    -d '{
	        "identity_id" : "IDiVbsHTMSuMMAmj8UwFaFz7",
	        "subtype" : "NET",
	        "primary_merchant_id" : "MUxusiE3wSYQjXk5cEHojpvN",
	        "processor_types" : ["DUMMY_V1", "LITLE_V1"]
        }'
{
  "id": "SSjyNfsyuQRo4axJAqAZ6Mph",
  "primary_merchant_id": "MUxusiE3wSYQjXk5cEHojpvN",
  "subtype": "NET",
  "processor_types": [
    "DUMMY_V1",
    "LITLE_V1"
  ],
  "created_at": "2020-01-09T22:58:44.69Z",
  "updated_at": "2020-01-09T22:58:44.69Z",
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v2/settlement_group_settings/SSjyNfsyuQRo4axJAqAZ6Mph"
    }
  }
}

Fetch Settlement Group Settings (Joined Payouts)

HTTP Request

GET https://finix.sandbox-payments-api.com/settlement/v2/settlement_group_settings/:SETTLEMENT_GROUP_SETTINGS_ID

curl https://finix.sandbox-payments-api.com/settlement/v2/settlement_group_settings/SSjyNfsyuQRo4axJAqAZ6Mph \
        -H "Content-Type: application/vnd.json+api" \
        -u  USdnzVnhdpVrTbZfou92wKks:65cb610c-08de-4ab8-8920-e65a68497da7 
{
  "id": "SSjyNfsyuQRo4axJAqAZ6Mph",
  "primary_merchant_id": "MUxusiE3wSYQjXk5cEHojpvN",
  "subtype": "NET",
  "processor_types": [
    "DUMMY_V1",
    "LITLE_V1"
  ],
  "created_at": "2020-01-09T22:58:44.69Z",
  "updated_at": "2020-01-09T22:58:44.69Z",
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v2/settlement_group_settings/SSjyNfsyuQRo4axJAqAZ6Mph"
    }
  }
}

Fetch Settlement Group Settings For an Identity (Joined Payouts)

HTTP Request

GET https://finix.sandbox-payments-api.com/settlement/v2/identities/:IDENTITY_ID/settlement_group_settings

curl https://finix.sandbox-payments-api.com/settlement/v2/identities/IDiVbsHTMSuMMAmj8UwFaFz7/settlement_group_settings \
     -H "Content-Type: application/vnd.json+api" \
     -u  USdnzVnhdpVrTbZfou92wKks:65cb610c-08de-4ab8-8920-e65a68497da7 
{
  "_embedded": {
    "settlement_group_settings": [
      {
        "id": "SSjyNfsyuQRo4axJAqAZ6Mph",
        "primary_merchant_id": "MUxusiE3wSYQjXk5cEHojpvN",
        "subtype": "NET",
        "processor_types": [
          "DUMMY_V1",
          "LITLE_V1"
        ],
        "created_at": "2020-01-09T22:58:44.69Z",
        "updated_at": "2020-01-09T22:58:44.69Z",
        "_links": {
          "self": {
            "href": "https://finix.sandbox-payments-api.com/settlement/v2/settlement_group_settings/SSjyNfsyuQRo4axJAqAZ6Mph"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/settlement/v2/identities/IDiVbsHTMSuMMAmj8UwFaFz7/settlement_group_settings?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page": {
    "offset": 0,
    "limit": 20,
    "count": 1
  }
}

Delete Settlement Group Settings (Joined Payouts)

If you no longer wish to group settlements issue a DELETE API call.

HTTP Request

DELETE https://finix.sandbox-payments-api.com/settlement/v2/settlement_group_settings/:SETTLEMENT_GROUP_SETTINGS_ID

curl https://finix.sandbox-payments-api.com/settlement/v2/settlement_group_settings/SSjyNfsyuQRo4axJAqAZ6Mph \
   -H "Content-Type: application/vnd.json+api" \
   -u  USdnzVnhdpVrTbZfou92wKks:65cb610c-08de-4ab8-8920-e65a68497da7 \
   -X DELETE 

Webhooks

Awaiting for Approval Settlement (v2 Settlement Engine)

{
  "type": "updated",
  "entity": "settlement_v2",
  "occurred_at": "2020-01-16T20:17:35.817",
  "_embedded": {
    "settlements_v2": [
      {
        "exception": false,
        "fee_count": 6,
        "processor_type": "DUMMY_V1",
        "created_at": "2020-01-15T01:27:04.36Z",
        "merchant_id": "MU87xmmN4pZZgm97Cok3oAp",
        "adjustment_credit_count": 0,
        "settlement_group_id": "SG5jV9hZJkp6a9i3WfJUja9q",
        "transfer_credit_count": 0,
        "adjustment_debit_count": 0,
        "transfer_debit_count": 2,
        "updated_at": "2020-01-16T20:17:08.85Z",
        "total_amount": 4000,
        "total_fee_amount": 338,
        "currency": "USD",
        "id": "ST5jVXU8pAv4CM23W1Y5bp85",
        "net_amount": 3662,
        "dispute_debit_count": 0,
        "reverse_count": 0,
        "status": "AWAITING_APPROVAL",
        "dispute_credit_count": 0
      }
    ]
  }
}

Approved Settlement (v2 Settlement Engine)

{
  "type": "updated",
  "entity": "settlement_v2",
  "occurred_at": "2020-01-16T20:17:35.817",
  "_embedded": {
    "settlements_v2": [
      {
        "exception": false,
        "fee_count": 6,
        "processor_type": "DUMMY_V1",
        "created_at": "2020-01-15T01:27:04.36Z",
        "merchant_id": "MU87xmmN4pZZgm97Cok3oAp",
        "adjustment_credit_count": 0,
        "settlement_group_id": "SG5jV9hZJkp6a9i3WfJUja9q",
        "transfer_credit_count": 0,
        "adjustment_debit_count": 0,
        "transfer_debit_count": 2,
        "updated_at": "2020-01-16T20:17:08.85Z",
        "total_amount": 4000,
        "total_fee_amount": 338,
        "currency": "USD",
        "id": "ST5jVXU8pAv4CM23W1Y5bp85",
        "net_amount": 3662,
        "dispute_debit_count": 0,
        "reverse_count": 0,
        "status": "APPROVED",
        "dispute_credit_count": 0
      }
    ]
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.