Finix Payments Settlements API
{'$ref': 'api-descriptions/tags/settlements.md'}
OpenAPI Specification
openapi: 3.0.2
info:
title: Finix Authorizations Settlements API
description:
$ref: api-descriptions/main.md
contact:
name: Finix
url: https://finix.com
email: support@finixpayments.com
version: '2022-02-01'
servers:
- description: Sandbox server to be used for testing and development
url: https://finix.sandbox-payments-api.com
security:
- BasicAuth: []
tags:
- name: Settlements
description:
$ref: api-descriptions/tags/settlements.md
paths:
/identities/{identity_id}/settlements:
parameters:
- description: 'ID of the `Identity` for the merchant you want to settle. '
required: true
in: path
name: identity_id
schema:
type: string
post:
description: "Close the currently accruing `settlement`. \n\nFinix, by default, creates accruing `settlements` then closes them based on your payout configurations. Use this endpoint to manually close the currently accruing settlement.\n\nThe closed `Settlement` will not accrue any further transactions and gets immediately submitted for approval.\n- This endpoint is only available to Finix Core customers. If you have any questions, please contact the [Finix Support Team.](mailto:support@finixpayments.com)\n- Any refunded `Transfers` get included in `Settlements` as a deduction.\n- **PENDING** `Transfers` don't get included in `Settlements`. \n- The `total_amount` minus the `total_fee` equals the `net_amount`. The `net_amount` is the amount in cents that gets deposited into the seller's bank account.\n\nRelated Guides: [Accruing Settlements](/guides/payouts/accruing-settlements/#closing-an-accruing-settlement)"
summary: Close Current Active Settlement
operationId: createIdentitySettlement
requestBody:
$ref: '#/components/requestBodies/CreateIdentitySettlementRequest'
responses:
'201':
$ref: '#/components/responses/Settlement'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/ErrorMerchantIdentityDisabled'
x-internal: false
x-java-method-name: create
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/settlements/closesettlement.md
tags:
- Settlements
x-python-method-name: create
/settlements:
get:
tags:
- Settlements
description: 'Retrieve a list of `Settlements`.
'
summary: List All Settlements
operationId: listSettlements
parameters:
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryAmountFilter'
- $ref: '#/components/parameters/QueryAmountGtFilter'
- $ref: '#/components/parameters/QueryAmountGteFilter'
- $ref: '#/components/parameters/QueryAmountLtFilter'
- $ref: '#/components/parameters/QueryAmountLteFilter'
- $ref: '#/components/parameters/QueryStatus'
- schema:
type: string
in: query
name: transfer_id
description: 'Filter by a `transfer_id` a `Settlement` has accrued. Please note this filter is only available for non-versioned requests, or requests using `-H ''Finix-Version: 2018-01-01''`. We''re actively working on making this filter available for later versions. For more details, see [Versioning](/guides/developers/versioning/).'
- schema:
type: string
in: query
name: funding_transfer_id
description: Filter by a `funding_transfer` a `Settlement` has created.
responses:
'200':
$ref: '#/components/responses/SettlementsList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: list
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: "curl \"https://finix.sandbox-payments-api.com/settlements/\" \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/settlements/{settlement_id}:
parameters:
- description: ID of `Settlement` object.
required: true
in: path
name: settlement_id
schema:
type: string
get:
tags:
- Settlements
description: Retreive the details of a `Settlement`.
summary: Fetch a Settlement
operationId: getSettlement
responses:
'200':
$ref: '#/components/responses/Settlement'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: "curl \"https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1\" \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
put:
summary: Close a Settlement
operationId: closesettlements
responses:
'201':
$ref: '#/components/responses/Settlement'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorUnauthorized'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
description: "Close an accruing `settlement`.\n\nFinix, by default, creates accruing `settlements` then closes them based on your payout configurations. Use this endpoint to manually close a specific `settlement`.\n\nThe closed `Settlement` will not accrue any further transactions and gets immediately submitted for approval.\n- This endpoint is only available to Finix Core customers. If you have any questions, please contact the [Finix Support Team](mailto:support@finixpayments.com).\n- Any refunded `Transfers` get included in `Settlements` as a deduction. \n- **PENDING** `Transfers` don't get included in `Settlements`.\n- The `total_amount` minus the `total_fee` equals the `net_amount`. The `net_amount` is the amount in cents that gets deposited into the seller's bank account."
requestBody:
$ref: '#/components/requestBodies/CloseSettlement'
x-java-method-name: put
tags:
- Settlements
parameters:
- schema:
type: string
default: '2018-01-01'
example: '2022-02-01'
in: header
name: Finix-Version
description: Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/)
x-python-method-name: put
/settlements/{settlement_id}/funding_transfers:
parameters:
- description: ID of `Settlement` object.
required: true
in: path
name: settlement_id
schema:
type: string
get:
tags:
- Settlements
description: List the funding `Transfers` that were created when a `Settlement` was approved that have `type` **CREDIT** or **DEBIT**.
summary: List Settlement Funding Transfers
operationId: listSettlementFundingTransfers
responses:
'200':
$ref: '#/components/responses/TransfersList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: listFundingTransfers
x-group-parameters: true
parameters:
- $ref: '#/components/parameters/QueryLimit'
x-codeSamples:
- lang: cURL
label: curl
source: "curl \"https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers\" \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list_funding_transfers
x-returns-list: true
/settlements/{settlement_id}/transfers:
parameters:
- description: ID of `Settlement` object.
required: true
in: path
name: settlement_id
schema:
type: string
delete:
tags:
- Settlements
description: 'Remove a `Transfer` that makes up a `Settlement`.
As long as the `Settlement` hasn''t been funded, you can remove the `Transfer` or an array of `Transfers`, along with its corresponding `fee` from the encompassing `Settlement`.
- Funding `transfers` can''t be deleted.
> Per the JSON API for deleting a resource, our API doesn''t have a response body when removing a `Transfer` from a `Settlement`.'
summary: Delete Settlement Transfers
operationId: removeSettlementTransfers
responses:
'204':
$ref: '#/components/responses/NoContent'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/Error422InvalidField'
x-internal: false
x-java-method-name: removeTransfersFromSettlement
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/settlements/deletesettlement.md
requestBody:
$ref: '#/components/requestBodies/RemoveSettlementTransfer'
x-python-method-name: remove_transfers_from_settlement
get:
description: Retrieve a list of every `Transfer` in a `Settlement` that has `type` **DEBIT** or **REFUND**.
summary: List all Transfers in a Settlement
operationId: listSettlementTransfers
responses:
'200':
$ref: '#/components/responses/TransfersList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-internal: false
x-java-method-name: listTransfersBySettlementId
x-group-parameters: true
tags:
- Settlements
parameters:
- $ref: '#/components/parameters/QueryLimit'
x-codeSamples:
- lang: cURL
label: curl
source: "curl \"https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers\" \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list_transfers_by_settlement_id
x-returns-list: true
components:
responses:
Error422InvalidField:
description: Invalid field
content:
application/json:
schema:
$ref: '#/components/schemas/Error422InvalidFieldList'
Error406NotAcceptable:
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/Error406NotAcceptable'
examples: {}
ErrorUnprocessableEntity:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorGeneric'
ErrorMerchantIdentityDisabled:
description: Merchant identity disabled error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorGeneric'
ErrorNotFound:
description: Object does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/Error404NotFoundList'
NoContent:
description: No content
TransfersList:
description: List of Transfer objects
content:
application/json:
schema:
$ref: '#/components/schemas/TransfersList'
examples:
List of Transfers:
value:
_embedded:
transfers:
- id: TRvQN3v5mhA2Ttc78hzjLV3j
created_at: '2022-10-11T03:25:04.79Z'
updated_at: '2022-10-11T03:25:04.79Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 13243
amount_requested: 13243
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: 'FALSE'
failure_code: null
failure_message: null
fee: 0
fee_type: CARD_BASIS_POINTS
idempotency_id: null
merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
messages: []
raw: null
ready_to_settle_at: '2022-10-11T03:25:05.32Z'
security_code_verification: null
source: null
state: SUCCEEDED
statement_descriptor: null
subtype: PLATFORM_FEE
tags: {}
trace_id: 611dcc5f-0622-4ec7-8c8b-b08896456d62
type: FEE
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
href: https://finix.sandbox-payments-api.com/transfers/TRvQN3v5mhA2Ttc78hzjLV3j
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM
payment_instruments:
href: https://finix.sandbox-payments-api.com/transfers/TRvQN3v5mhA2Ttc78hzjLV3j/payment_instruments
parent:
href: https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- id: TR34MdY6eagpEqhtTaP8EBCR
created_at: '2022-10-10T06:32:04.58Z'
updated_at: '2022-10-10T06:32:04.58Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 19
amount_requested: 19
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: 'FALSE'
failure_code: null
failure_message: null
fee: 0
fee_type: CARD_BASIS_POINTS
idempotency_id: null
merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
messages: []
raw: null
ready_to_settle_at: '2022-10-10T06:32:05.05Z'
security_code_verification: null
source: null
state: SUCCEEDED
statement_descriptor: null
subtype: PLATFORM_FEE
tags: {}
trace_id: a79105c7-8b93-4c36-8734-83f02ca0686c
type: FEE
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
href: https://finix.sandbox-payments-api.com/transfers/TR34MdY6eagpEqhtTaP8EBCR
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM
payment_instruments:
href: https://finix.sandbox-payments-api.com/transfers/TR34MdY6eagpEqhtTaP8EBCR/payment_instruments
parent:
href: https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
_links:
self:
href: https://finix.sandbox-payments-api.com/transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc
next:
href: https://finix.sandbox-payments-api.com/transfers?offset=20&limit=20&sort=created_at,desc&sort=id,desc
last:
href: https://finix.sandbox-payments-api.com/transfers?offset=23980&limit=20&sort=created_at,desc&sort=id,desc
page:
limit: 100
next_cursor: TRvynw5NU1Uo6TB5USyhbzCx
List of Settlement Funding Transfers:
value:
_embedded:
transfers:
- id: TRkwxPhCf3qChKFEVGhDjr76
created_at: '2022-08-12T21:46:12.97Z'
updated_at: '2022-08-12T21:47:06.65Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 102
amount_requested: 102
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: PIrFpayBAQcqK35HMQgRfaqD
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
ready_to_settle_at: null
security_code_verification: null
source: null
state: FAILED
statement_descriptor: null
subtype: SETTLEMENT_PLATFORM
tags: {}
trace_id: d4a6df17-f581-42d0-ac70-ad6770acd5c4
type: CREDIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
href: https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
payment_instruments:
href: https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/payment_instruments
reversals:
href: https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/reversals
fees:
href: https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/fees
disputes:
href: https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/disputes
destination:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIrFpayBAQcqK35HMQgRfaqD
- id: TRxb61dJ6PvGcvyS2L2B9SZE
created_at: '2022-08-12T21:46:12.98Z'
updated_at: '2022-08-12T21:47:05.26Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 2
amount_requested: 2
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
ready_to_settle_at: null
security_code_verification: null
source: PIm8mdyYcEnYAZLLyw8g59Pw
state: SUCCEEDED
statement_descriptor: null
subtype: SETTLEMENT_MERCHANT
tags: {}
trace_id: e192bc39-0909-4da9-b4c2-022a84ae3984
type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
href: https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
payment_instruments:
href: https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/payment_instruments
reversals:
href: https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/reversals
fees:
href: https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/fees
disputes:
href: https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/disputes
source:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIm8mdyYcEnYAZLLyw8g59Pw
_links:
self:
href: https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc
page:
limit: 100
next_cursor: TRvynw5NU1Uo6TB5USyhbzCx
List of Settlement Transfers:
value:
_embedded:
transfers:
- id: TR8yiKY6ju988aUZhfqJFjag
created_at: '2022-08-12T16:56:01.90Z'
updated_at: '2022-08-12T16:56:01.90Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: 'FALSE'
failure_code: null
failure_message: null
fee: 0
fee_type: CARD_FIXED
idempotency_id: null
merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
messages: []
raw: null
ready_to_settle_at: '2022-08-12T22:15:02.69Z'
security_code_verification: null
source: null
state: SUCCEEDED
statement_descriptor: null
subtype: PLATFORM_FEE
tags: {}
trace_id: 272fe816-2dd1-46ed-a7e7-9041d7a8f0ff
type: FEE
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
href: https://finix.sandbox-payments-api.com/transfers/TR8yiKY6ju988aUZhfqJFjag
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM
payment_instruments:
href: https://finix.sandbox-payments-api.com/transfers/TR8yiKY6ju988aUZhfqJFjag/payment_instruments
parent:
href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- id: TRm9ppvqX43CbwmNzhckf2gb
created_at: '2022-08-12T16:55:47.66Z'
updated_at: '2022-08-12T16:56:02.19Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: 'FALSE'
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
ready_to_settle_at: '2022-08-12T04:00:00.00Z'
security_code_verification: null
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags: {}
trace_id: 381f1f6f-492b-4101-9a57-40001a59813a
type: DEBIT
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg
payment_instruments:
href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/payment_instruments
reversals:
href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/reversals
fees:
href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/fees
disputes:
href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/disputes
source:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
- id: TRwgubpxAJWbaDZE1kKP6SSi
created_at: '2022-08-12T16:56:01.90Z'
updated_at: '2022-08-12T16:56:01.90Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 2
amount_requested: 2
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: 'FALSE'
failure_code: null
failure_message: null
fee: 0
fee_type: CARD_BASIS_POINTS
idempotency_id: null
merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
messages: []
raw: null
ready_to_settle_at: '2022-08-12T22:15:02.69Z'
security_code_verification: null
source: null
state: SUCCEEDED
statement_descriptor: null
subtype: PLATFORM_FEE
tags: {}
trace_id: 5e2dbd9c-1ad1-4e36-8d16-cfedd3bce385
type: FEE
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
href: https://finix.sandbox-payments-api.com/transfers/TRwgubpxAJWbaDZE1kKP6SSi
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM
payment_instruments:
href: https://finix.sandbox-payments-api.com/transfers/TRwgubpxAJWbaDZE1kKP6SSi/payment_instruments
parent:
href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8
_links:
self:
href: https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc
page:
limit: 100
next_cursor: TRvynw5NU1Uo6TB5USyhbzCx
List of Split Transfer Fees:
value:
_embedded:
transfers:
- id: TRf75ZVCM1M4eVojmVYGUnuQ
created_at: '2023-07-19T02:30:17.43Z'
updated_at: '2023-07-19T02:30:17.43Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 30
amount_requested: 30
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: 'FALSE'
failure_code: null
failure_message: null
fee: 0
fee_type: CARD_FIXED
idempotency_id: null
merchant: MU4jpoNGRkAyjBxumZhGa6Hc
merchant_identity: IDhCtMvcteDx37eD9m4rmdKd
messages: []
raw: null
ready_to_settle_at: '2023-07-19T07:30:01.27Z'
receipt_last_printed_at: null
security_code_verification: null
source: null
split_transfers: null
state: SUCCEEDED
statement_descriptor: null
subtype: PLATFORM_FEE
tags: {}
trace_id: 2c56f4f0-1f48-451c-9498-199daaff2e39
type: FEE
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
href: https://finix.sandbox-payments-api.com/transfers/TRf75ZVCM1M4eVojmVYGUnuQ
parent:
href: https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDhCtMvcteDx37eD9m4rmdKd
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finix-payments/refs/heads/main/openapi/finix-payments-settlements-api-openapi.yml