Finix Split Transfers API
{'$ref': 'api-descriptions/tags/split-transfers.md'}
OpenAPI Specification
openapi: 3.0.2
info:
title: Finix Authorizations Split Transfers 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: Split Transfers
description:
$ref: api-descriptions/tags/split-transfers.md
paths:
/split_transfers/{split_transfer_id}:
parameters:
- schema:
type: string
name: split_transfer_id
in: path
required: true
get:
summary: Fetch a Split Transfer
responses:
'200':
$ref: '#/components/responses/SplitTransfer'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getSplitTransfer
description: 'Fetch a `split_transfer` that was created from a split transaction.
For more information, see [Split a Transaction](/docs/guides/payments/modify/split-transactions/).'
x-jave-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: 'curl "https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'
tags:
- Split Transfers
parameters: []
x-python-method-name: get_split_transfer
/split_transfers/{split_transfer_id}/fees:
parameters:
- schema:
type: string
name: split_transfer_id
in: path
required: true
get:
summary: Fetch Split Transfer Fees
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'
operationId: getSplitTransferFees
description: 'Fetch the fees associated with a `split_transfer`.
For more information, see [Split a Transaction](/docs/guides/payments/modify/split-transactions/).'
x-jave-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: 'curl "https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q/fees" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'
tags:
- Split Transfers
parameters: []
x-python-method-name: get_split_transfer_fees
/split_transfers:
parameters: []
get:
summary: List Split Transfers
responses:
'200':
$ref: '#/components/responses/SplitTransfersList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: listSplitTransfer
description: 'Retireve a list of `split_transfers` created for a specifc split `Transfer`.
For more information, see [Split a Transaction](/docs/guides/payments/modify/split-transactions/).'
x-jave-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: 'curl "https://finix.sandbox-payments-api.com/split_transfers/split_transfers?parent_transfer_id=TRvQN3v5mhA2Ttc78hzjLV3j" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'
parameters:
- schema:
type: string
example: TRvQN3v5mhA2Ttc78hzjLV3j
pattern: TRxxxxxxxxxxxxxxxxxxxxxx
in: query
name: parent_transfer_id
description: '**ID** of the parent `Transfer` that was split.'
required: true
tags:
- Split Transfers
x-python-method-name: list_split_transfer
x-returns-list: true
components:
responses:
SplitTransfer:
description: The `split_transfer` resource that was created from a split transacion.
content:
application/json:
schema:
$ref: '#/components/schemas/SplitTransfer'
examples:
Split Transfer:
value:
id: split_transfer_7i2gxncPcfkN5rJwuhrb3q
created_at: '2023-07-19T02:30:17.10Z'
updated_at: '2023-07-19T02:30:17.10Z'
amount: 600
fee: 0
currency: USD
parent_transfer_id: TR7h8NxhCDHunLFdJ1HCLp4r
ready_to_settle_at: '2023-07-19T02:30:18.04Z'
type: DEBIT
merchant_id: MU4jpoNGRkAyjBxumZhGa6Hc
identity_id: IDhCtMvcteDx37eD9m4rmdKd
fee_profile_id: FPbDSnEPtaT8Nttxj9NJk7eC
application_id: APgPDQrLD52TYvqazjHJJchM
tags:
key: value
Split Transfer - Refund:
value:
id: split_transfer_m7Y8kgx4nunsrVbuMdedDo
created_at: '2023-07-19T03:02:03.11Z'
updated_at: '2023-07-19T03:02:03.11Z'
amount: 600
fee: 0
currency: USD
parent_transfer_id: TRm23kdc4SCxYyva47RyiZv
ready_to_settle_at: '2023-07-19T03:03:03.21Z'
type: CREDIT
merchant_id: MU4jpoNGRkAyjBxumZhGa6Hc
identity_id: IDhCtMvcteDx37eD9m4rmdKd
fee_profile_id: FPbDSnEPtaT8Nttxj9NJk7eC
application_id: APgPDQrLD52TYvqazjHJJchM
tags:
key: value
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
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
payment_instruments:
href: https://finix.sandbox-payments-api.com/transfers/TRf75ZVCM1M4eVojmVYGUnuQ/payment_instruments
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPbDSnEPtaT8Nttxj9NJk7eC
- id: TR4AyjeiKwML2rZ6fWyVaQST
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: 17
amount_requested: 17
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: 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: 48a6fa39-5639-4e2c-b316-fad2db170954
type: FEE
_links:
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
self:
href: https://finix.sandbox-payments-api.com/transfers/TR4AyjeiKwML2rZ6fWyVaQST
parent:
href: https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q
merchant_identity:
href: https://finix.sandbox-payments-api.com/identities/IDhCtMvcteDx37eD9m4rmdKd
payment_instruments:
href: https://finix.sandbox-payments-api.com/transfers/TR4AyjeiKwML2rZ6fWyVaQST/payment_instruments
fee_profile:
href: https://finix.sandbox-payments-api.com/fee_profiles/FPbDSnEPtaT8Nttxj9NJk7eC
_links:
self:
href: https://finix.sandbox-payments-api.com/split_transfers/split_transfer_7i2gxncPcfkN5rJwuhrb3q/fees
page:
limit: 100
next_cursor: TR4AyjeiKwML2rZ6fWyVaQST
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
Error406NotAcceptable:
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/Error406NotAcceptable'
examples: {}
ErrorForbidden403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error403ForbiddenList'
SplitTransfersList:
description: List of `split_transfers` created for a split `Transfer`.
content:
application/json:
schema:
$ref: '#/components/schemas/SplitTransfersList'
examples:
List of Split Transfers:
value:
_embedded:
split_transfers:
- id: split_transfer_DQrLD52TYvqazjHJJchM
created_at: '2022-10-11T03:25:04.79Z'
updated_at: '2022-10-11T03:25:04.79Z'
amount: 600
application_id: APgPDQrLD52TYvqazjHJJchM
currency: USD
identity_id: IDxxx"
merchant_id: MUxxxx1
parent_transfer_id: TRvQN3v5mhA2Ttc78hzjLV3j
ready_to_settle_at: '2022-10-11T03:25:05.32Z'
type: DEBIT
fee: null
- id: split_transfer_4MdY6eagpEqhtTaP8EBCR
created_at: '2022-10-11T03:25:04.79Z'
updated_at: '2022-10-11T03:25:04.79Z'
amount: 300
application_id: APgPDQrLD52TYvqazjHJJchM
currency: USD
identity_id: IDxxx"
merchant_id: MUxxxx1
parent_transfer_id: TRvQN3v5mhA2Ttc78hzjLV3j
ready_to_settle_at: '2022-10-11T03:25:05.32Z'
type: DEBIT
fee: null
- id: split_transfer_4MdY6eagpEqhtTaP8EBCR
created_at: '2022-10-11T03:25:04.79Z'
updated_at: '2022-10-11T03:25:04.79Z'
amount: 100
application_id: APgPDQrLD52TYvqazjHJJchM
currency: USD
identity_id: IDxxx"
merchant_id: MUxxxx1
parent_transfer_id: TRvQN3v5mhA2Ttc78hzjLV3j
ready_to_settle_at: '2022-10-11T03:25:05.32Z'
type: DEBIT
fee: null
_links:
self:
href: https://finix.sandbox-payments-api.com/split_transfers?parent_transfer_id=TRvQN3v5mhA2Ttc78hzjLV3j
next:
href: https://finix.sandbox-payments-api.com/transfers?limit=3&after_cursor=split_transfer_xxx
page:
limit: 3
next_cursor: split_transfer_xxx
ErrorNotFound:
description: Obj
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finix/refs/heads/main/openapi/finix-split-transfers-api-openapi.yml