Skip to content

Instantly share code, notes, and snippets.

@jay-babu

jay-babu/gist:c628a8838ce332375c23b94f8da54883

Created December 8, 2023 20:45
Show Gist options
  • Save jay-babu/c628a8838ce332375c23b94f8da54883 to your computer and use it in GitHub Desktop.
Save jay-babu/c628a8838ce332375c23b94f8da54883 to your computer and use it in GitHub Desktop.
Download ZIP
finix swagger
Raw
gistfile1.txt
This file has been truncated, but you can view the full file.
openapi: 3.0.2
x-stoplight:
id: c6861590dda46
info:
title: Finix API
contact:
name: Finix
url: 'https://finix.com'
email: support@finixpayments.com
version: '2022-02-01'
x-ignoredHeaderParameters:
- Accept
- finix-apiuser-role
- date
- x-request-id
servers:
- description: Sandbox server to be used for testing and development
url: 'https://finix.sandbox-payments-api.com'
tags:
- name: Applications
x-tagGroups:
- name: MAIN RESOURCES
tags:
- Authorizations
- Compliance Forms
- Devices
- Disputes
- Fee Profiles
- Files
- Identities
- Instrument Updates
- Merchants
- Onboarding Forms
- Payment Instruments
- Settlements
- Split Transfers
- Transfers
- Users
- Webhooks
- name: CORE-PAYFAC RESOURCES
tags:
- Application Profiles
- Applications
- Balance Transfers
- Merchant Profiles
- Payout Profiles
- Verifications
- name: SUBSCRIPTION BILLING
tags:
- Subscription Schedules
- Subscription Amounts
- Subscription Enrollments
paths:
/application_profiles:
get:
tags:
- Application Profiles
description: Retrieve a list of `application_profiles`.
summary: List Application Profiles
operationId: listApplicationProfiles
responses:
'200':
$ref: '#/components/responses/ApplicationProfilesList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-internal: false
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
x-java-method-name: list
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/application-profiles/list-application-profiles.md
x-group-parameters: true
'/application_profiles/{application_profile_id}':
get:
tags:
- Application Profiles
description: Retrieve the details of an existing `application_profile`.
summary: Fetch Application Profile
operationId: getApplicationProfile
responses:
'200':
$ref: '#/components/responses/ApplicationProfile'
'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:
$ref: xcode/curl/application-profiles/fetch-application-profile.md
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/ApplicationProfileId'
put:
tags:
- Application Profiles
description: Update an existing `application_profile`.
summary: Update Application Profile
operationId: updateApplicationProfile
requestBody:
$ref: '#/components/requestBodies/UpdateApplicationProfileRequest'
responses:
'200':
$ref: '#/components/responses/ApplicationProfile'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/application-profiles/update-application-profile.md
/applications:
post:
description: |
If created successfully, a 201 response gets returned and adds a location header
to the response which refers to the new created `Application`.
summary: Create an Application
operationId: createApplication
requestBody:
$ref: '#/components/requestBodies/CreateApplicationRequest'
responses:
'201':
$ref: '#/components/responses/Application'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: create
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/applications/create-application.md
get:
tags:
- Applications
description: |-
Return a collection of `Applications`. If there are no `Applications`,
an empty collection gets returned.
summary: List Applications
operationId: listApplications
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryIdFilter'
- $ref: '#/components/parameters/QueryBeforeCursor'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryLimit'
responses:
'200':
$ref: '#/components/responses/ApplicationsList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: list
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: 'curl: list Applications'
source: |
curl "https://finix.sandbox-payments-api.com/applications" \
-H "Finix-Version: 2022-02-01" \
-u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
'/applications/{application_id}':
get:
tags:
- Applications
description: Retrieve the details of an `Application`.
summary: Fetch an Application
operationId: getApplication
responses:
'200':
$ref: '#/components/responses/Application'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-names: get
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/ApplicationId'
put:
tags:
- Applications
description: Update an existing `Application`.
summary: Update an Application
operationId: updateApplication
responses:
'200':
$ref: '#/components/responses/Application'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/applications/update-application.md
'/applications/{application_id}/processors':
get:
description: List all `Processors` enabled for an `Application`.
summary: List Application Processors
operationId: listApplicationProcessors
responses:
'200':
$ref: '#/components/responses/ProcessorsList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: listByApplicationId
x-group-parameters: true
tags:
- Processors
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/ApplicationId'
post:
tags:
- Processors
description: |
Enable a `Processor` for an `Application`. If created successfully, a
201 status is returned with a location header added to the response which refers to the
newly enabled processor.
summary: Create Application Processor
operationId: createApplicationProcessor
requestBody:
$ref: '#/components/requestBodies/CreateProcessorRequest'
responses:
'201':
$ref: '#/components/responses/Processor'
'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/Error422InvalidField'
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/processors/create-application-processor.md
'/applications/{application_id}/processors/{type}':
get:
description: Get the `Processors` for an `Application` by `type`.
summary: Fetch Application Processors
operationId: getApplicationProcessor
responses:
'200':
$ref: '#/components/responses/Processor'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
tags:
- Processors
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/applications/APdHjTsAPx81go7ekSMJqQdz/processors/DUMMY_V1" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/ApplicationId'
- description: Type of `Processor`.
required: true
in: path
name: type
schema:
type: string
'/applications/{application_id}/users':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/ApplicationId'
post:
description: |-
Creating an application user is the equivalent of provisioning API keys (i.e. credentials) for an `Application`.
> Each Application can have multiple `Users` which allows each seller to have multiple API keys that can be independently enabled and disabled. Merchants only have read access to the API.
summary: Create an Application User
operationId: createApplicationUser
requestBody:
$ref: '#/components/requestBodies/CreateUserRequest'
responses:
'201':
$ref: '#/components/responses/User'
'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'
x-internal: false
tags:
- Users
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/users/create-user.md
/authorizations:
post:
tags:
- Authorizations
description: |-
Create an `Authorization` to process a transaction.
Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/), [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/), [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/), [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/)
summary: Create an Authorization
operationId: createAuthorization
requestBody:
$ref: '#/components/requestBodies/CreateAuthorizationRequest'
responses:
'201':
$ref: '#/components/responses/Authorization'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'402':
$ref: '#/components/responses/ErrorPaymentRequired'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/Error422InvalidField'
x-java-method-name: create
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
get:
tags:
- Authorizations
description: 'Retrieve a list of `Authorizations`. '
summary: List Authorizations
operationId: listAuthorizations
parameters:
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryAmountFilter'
- $ref: '#/components/parameters/QueryAmountGtFilter'
- $ref: '#/components/parameters/QueryAmountGteFilter'
- $ref: '#/components/parameters/QueryAmountLtFilter'
- $ref: '#/components/parameters/QueryAmountLteFilter'
- $ref: '#/components/parameters/QueryBeforeCursor'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryIdempotencyIdFilter'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/TagsKey'
- $ref: '#/components/parameters/TagsValue'
- in: query
name: state
description: Filter by Transaction state.
schema:
enum:
- SUCCEEDED
- FAILED
- PENDING
- CANCELED
- $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
- $ref: '#/components/parameters/QueryTraceIdFilter'
- $ref: '#/components/parameters/QueryVoidFilter'
- in: query
name: instrument_bin
description: Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number.
schema:
type: string
- schema:
type: string
in: query
name: instrument_account_last4
description: "Filter Transactions by the last 4 digits of the bank account. The bank account last 4 are the last 4 digits of the masked number\tinstrument_account_last4=9444 BIN."
- schema:
type: string
in: query
name: instrument_brand_type
description: Filter by card brand. Available card brand types can be found in the drop-down.
- schema:
type: string
in: query
name: merchant_identity_id
description: Filter by `Identity` ID.
- schema:
type: string
in: query
name: merchant_identity_name
description: Filter Transactions by `Identity` name. The name is not case-sensitive.
- schema:
type: string
in: query
name: instrument_name
description: Filter Transactions by `Payment Instrument` name.
- schema:
type: string
in: query
name: instrument_type
description: 'Filter Transactions by `Payment Instrument` type. Available instrument types include: Bank Account or Payment Card.'
- schema:
type: string
in: query
name: merchant_id
description: Filter by `Merchant` ID.
- schema:
type: string
in: query
name: merchant_mid
description: Filter by Merchant Identification Number (MID).
- schema:
type: string
in: query
name: instrument_card_last4
description: Filter by the payment card last 4 digits.
- schema:
type: string
in: query
name: merchant_processor_id
description: Filter by `Processor` ID.
- schema:
type: string
in: query
name: type
description: Type of the `Authorization`.
- 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/)'
responses:
'200':
$ref: '#/components/responses/AuthorizationsList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'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/authorizations" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/authorizations/{authorization_id}':
get:
tags:
- Authorizations
description: Retrieve the details of a previously created `Authorization`.
summary: Fetch an Authorization
operationId: getAuthorization
responses:
'200':
$ref: '#/components/responses/Authorization'
'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/authorizations/AUsCN6f7qTLzxUD3Bp6iXQMQ" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- $ref: '#/components/parameters/AuthorizationId'
- name: Accept
in: header
schema:
type: string
default: application/hal+json
put:
tags:
- Authorizations
description: |-
Use a PUT request to capture an `Authorization`. If captured successfully, the `transfer` field of the `Authorization` will contain the ID of the `Transfer` resource that moves funds.
Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/), [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/), [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/), [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/)
summary: Capture an Authorization
operationId: captureAuthorization
requestBody:
$ref: '#/components/requestBodies/UpdateAuthorizationRequest'
responses:
'200':
$ref: '#/components/responses/AuthorizationUpdated'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/Error422InvalidField'
x-internal: false
x-java-method-name: update
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
'/authorizations/{authorization_id_void_to}':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: authorization_id_void_to
in: path
required: true
put:
tags:
- Authorizations
description: |-
Use a PUT request to void an `Authorization`. If voided successfully, funds get released and the transaction stops from completing. Additionally, voided `Authorization` can no longer be captured.
Related Guides: [Creating and Capturing an Authorization](/guides/payments/making-a-payment/creating-and-capturing-an-authorization/), [Level 2 and 3 Processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/), [In-Person Cloud Payments](/guides/payments/in-person-payments/cloud/in-person-cloud-payments/), [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/)
summary: Void an Authorization
operationId: voidAuthorization
requestBody:
$ref: '#/components/requestBodies/VoidAuthorizationRequest'
responses:
'200':
$ref: '#/components/responses/AuthorizationUpdated'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/Error422InvalidField'
x-internal: false
x-java-method-name: update
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
/balance_transfers:
post:
summary: Create a Balance Transfer
operationId: createBalanceTransfer
responses:
'201':
$ref: '#/components/responses/BalanceTransfer'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
description: Create a `balance_transfer`.
tags:
- Balance Transfers
requestBody:
$ref: '#/components/requestBodies/CreateBalanceTransferRequest'
x-internal: false
x-java-method-name: create
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/balance-transfer/create-balance-transfer.md
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
get:
summary: List Balance Transfers
operationId: listBalanceTransfers
responses:
'200':
$ref: '#/components/responses/BalanceTransferList'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
description: Not Found
'406':
$ref: '#/components/responses/Error406NotAcceptable'
description: Retrieve a list of `balance_transfers`.
parameters:
- $ref: '#/components/parameters/QueryLimit'
- schema:
type: integer
in: query
name: pageNumber
description: The page number to list.
- schema:
type: integer
in: query
name: pageSize
description: The size of the page.
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
- $ref: '#/components/parameters/QueryIdempotencyIdFilter'
- $ref: '#/components/parameters/QueryAmountFilter'
- in: query
name: description
schema:
type: string
description: Filter by the `Description` value .
- schema:
type: string
in: query
name: destination
description: Filter by the `Payment Instrument` saved in `Destination`.
- schema:
type: string
in: query
name: external_reference_id
description: Filter by the value saved in `external_reference_id`.
- schema:
type: string
in: query
name: reference_id
description: Filter by the value saved in `reference_id`.
- schema:
type: string
in: query
description: Filter by the `Payment Instrument` saved in `source`.
name: source
tags:
- Balance Transfers
x-internal: false
x-java-method-name: list
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/balance_transfers/" \
-H "Finix-Version: 2022-02-01" \
-u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99
'/balance_transfers/{balance_transfers_id}':
parameters:
- schema:
type: string
name: balance_transfers_id
in: path
required: true
description: ID of the `balance_transfer` resource.
- name: Accept
in: header
schema:
type: string
default: application/hal+json
get:
summary: Fetch a Balance Transfer
tags:
- Balance Transfers
responses:
'200':
$ref: '#/components/responses/BalanceTransfer'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getBalanceTransfers
description: Retrieve the details of a `balance_transfer`.
x-internal: false
x-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/balance_transfers/BT_9SLA5BdQs6Z3xFpmjUoqhM" \
-H "Finix-Version: 2022-02-01" \
-u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99
'/devices/{device_id}':
put:
description: |-
Initiate an action on a `Device`. Actions that are available include:
- Activating the `Device`
- Rebooting the `Device`
- Setting an idle message
- Deactivating the `Device`
You can also use a PUT request to update the `configuration_details`, `description`, `name`, and `serial_number` of the `Device`.
summary: Initiate Action on Device
operationId: updateDevice
requestBody:
$ref: '#/components/requestBodies/UpdateDeviceRequest'
responses:
'200':
$ref: '#/components/responses/Device'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
tags:
- Devices
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/)'
- name: Accept
in: header
schema:
type: string
default: application/hal+json
get:
description: Retrieve the details of an existing `Device`.
summary: Fetch a Device
operationId: getDevice
responses:
'200':
$ref: '#/components/responses/Device'
'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
parameters:
- schema:
type: boolean
in: query
name: include_connection
description: Specifies whether the connection information should be included.
x-group-parameters: true
tags:
- Devices
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f" \
-H "Finix-Version: 2022-02-01" \
-u USjHFGYvecE4LBitYG8KDE2g:b698f403-d9b7-4157-82d8-162cea8c8cc3
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of the `Device`.
required: true
in: path
name: device_id
schema:
type: string
'/devices/{device_id_connection}':
get:
description: 'To check the connection of the `Device`, include `?include_connection\=true\` at the end of the request endpoint.'
summary: Check Device Connection
operationId: getDeviceConnection
responses:
'200':
$ref: '#/components/responses/Device'
'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
parameters:
- schema:
type: boolean
in: query
name: include_connection
description: Specifies whether the connection information should be included.
required: true
x-group-parameters: true
tags:
- Devices
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f?include_connection=true" \
-H "Finix-Version: 2022-02-01" \
-u USjHFGYvecE4LBitYG8KDE2g:b698f403-d9b7-4157-82d8-162cea8c8cc3
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: device_id_connection
in: path
required: true
/disputes:
get:
tags:
- Disputes
description: Retrieve a list of `Disputes`.
summary: List Disputes
operationId: listDisputes
parameters:
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
- schema:
type: string
in: query
name: transfer_id
description: 'Filter by the ID of the `Transfer` that''s being disputed. <br><br>**Note**: If included, all other filter parameters are ignored.'
- schema:
type: string
in: query
name: adjustment_transfer_id
description: 'Filter by the ID of the adjustment `Transfer`. <br><br>**Note**: If included, all other filter parameters are ignored.'
- $ref: '#/components/parameters/QueryAmountFilter'
- $ref: '#/components/parameters/QueryAmountGteFilter'
- $ref: '#/components/parameters/QueryAmountGtFilter'
- $ref: '#/components/parameters/QueryAmountLtFilter'
- schema:
type: string
in: query
name: state
description: Filter by the state of the `Dispute`.
- schema:
type: string
in: query
name: response_state
description: Filter by the `response_state` of the `Dispute`.
- schema:
type: string
in: query
name: respond_by.lte
description: Filter where `respond_by` is before the given date.
- schema:
type: string
in: query
name: respond_by.gte
description: Filter where `respond_by` is after the given date.
- schema:
type: string
in: query
name: instrument_bin
description: Filter by the Bank Identification Number (BIN). The BIN is the first 6 digits of the masked account number.
- schema:
type: string
in: query
name: instrument_brand_type
description: Filter by the card brand used.
- in: query
name: merchant_identity_id
description: Filter by the ID of the `Identity` used by the `Merchant`.
schema:
type: string
- schema:
type: string
in: query
name: merchant_identity_name
description: Filter by the name used by the `Merchant`.
- schema:
type: string
in: query
name: instrument_name
description: Filter by the name of the `Payment Instrument`.
- schema:
type: string
in: query
name: instrument_type
description: Filter by `Payment Instrument` type.
- schema:
type: string
in: query
name: merchant_id
description: Filter by the ID of the `Merchant`.
- schema:
type: string
in: query
name: merchant_mid
description: Filter by the MID of the `Merchant`.
- schema:
type: string
in: query
name: instrument_card_last4
description: Filter by the last 4 digits of the card used.
- schema:
type: string
in: query
name: instrument_card_type
description: Filter by the card type.
- schema:
type: string
in: query
name: instrument_fingerprint
description: Filter by the fingerprint of the `Payment Instrument`.
- schema:
type: string
in: query
name: before_cursor
description: Returns every `Dispute` created before the cursor value.
- $ref: '#/components/parameters/TagsKey'
- $ref: '#/components/parameters/TagsValue'
responses:
'200':
$ref: '#/components/responses/DisputesList'
'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/disputes/" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/disputes/{dispute_id}':
get:
tags:
- Disputes
description: Retrieve the details of a previously created `Dispute`.
summary: Fetch a Dispute
operationId: getDispute
responses:
'200':
$ref: '#/components/responses/Dispute'
'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/disputes/DIs7yQRkHDdMYhurzYz72SFk" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Dispute`.
required: true
in: path
name: dispute_id
schema:
type: string
put:
summary: Update a Dispute
operationId: updateDispute
responses:
'200':
$ref: '#/components/responses/Dispute'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
description: Update `tags` on `Disputes`.
requestBody:
$ref: '#/components/requestBodies/UpdateDisputeEvidence'
x-java-method: put
tags:
- Disputes
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
'/disputes/{dispute_id}/evidence':
post:
tags:
- Disputes
description: |-
Upload a file as evidence for a `Dispute`.
- You can upload up to 8 files; the total size of the uploaded files combined cannot exceed 10 MB.
- The allowed file formats include JPG, PNG, PDF, or TIFF.
- Individual PNG and JPEG files can't exceed 50 KB; PDF and TIFF files can't exceed 1 MB.
summary: Upload Files as Dispute Evidence
operationId: createDisputeEvidence
responses:
'201':
$ref: '#/components/responses/DisputeEvidence'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/disputes/uploadevidence.md
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
requestBody:
$ref: '#/components/requestBodies/CreateDisputeEvidenceRequest'
get:
tags:
- Disputes
description: Retrieve a list of dispute evidence for a `Dispute`.
summary: List Dispute Evidence
operationId: listDisputeEvidence
responses:
'200':
$ref: '#/components/responses/DisputeEvidenceList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: listDisputeEvidenceByDisputeId
x-group-parameters: true
parameters:
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Dispute` to mange evidence for.
required: true
in: path
name: dispute_id
schema:
type: string
'/disputes/{dispute_id}/evidence/{evidence_id}':
get:
tags:
- Disputes
description: |-
Fetch evidence uploaded for a `Dispute`.
If you don't have the Finix Dashboard available, you can fetch the evidence to review the `status` of the upload to confirm the evidence got sent to the processor.
summary: Fetch Dispute Evidence
operationId: getDisputeEvidence
responses:
'200':
$ref: '#/components/responses/DisputeEvidence'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF58kdVTa5eMQUjcXH2F7DH4" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Dispute` to fetch evidence for.
required: true
in: path
name: dispute_id
schema:
type: string
- description: ID of `evidence` to fetch.
required: true
in: path
name: evidence_id
schema:
type: string
put:
summary: Update Dispute Evidence
operationId: updateDisputeEvidence
responses:
'200':
$ref: '#/components/responses/DisputeEvidence'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
description: Update tags on `Dispute` evidence.
requestBody:
$ref: '#/components/requestBodies/UpdateDisputeEvidence'
x-java-method: put
tags:
- Disputes
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
/fee_profiles:
get:
description: List all `Fee Profiles`.
summary: List Fee Profiles
operationId: listFeeProfiles
responses:
'200':
$ref: '#/components/responses/FeeProfilesList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: list
x-group-parameters: true
parameters:
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
- $ref: '#/components/parameters/QueryLimit'
tags:
- Fee Profiles
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/fee_profiles" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
post:
description: Create a `fee_profile`.
summary: Create a Fee Profile
operationId: createFeeProfile
requestBody:
$ref: '#/components/requestBodies/CreateFeeProfileRequest'
responses:
'201':
$ref: '#/components/responses/FeeProfile'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/Error422InvalidField'
x-java-method-name: create
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/fee-profiles/create-fee-profile.md
tags:
- Fee Profiles
'/fee_profiles/{fee_profile_id}':
get:
description: Get a `fee_profile`.
summary: Fetch a Fee Profile
operationId: getFeeProfile
responses:
'200':
$ref: '#/components/responses/FeeProfile'
'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
tags:
- Fee Profiles
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- required: true
in: path
name: fee_profile_id
schema:
type: string
description: The ID of the `fee_profile`.
/fees:
get:
tags:
- Fees
description: Return a collection of `fees`.
summary: List Fees
operationId: listFees
responses:
'200':
$ref: '#/components/responses/FeesList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
parameters:
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
- name: Accept
in: header
schema:
type: string
default: application/hal+json
x-java-method-name: list
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/fees" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
x-internal: true
post:
summary: Create a One-Time Fee
tags:
- Fees
operationId: create-fees
responses:
'201':
$ref: '#/components/responses/Fee'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
description: Create a custom (i.e. one time) `fee`.
requestBody:
$ref: '#/components/requestBodies/CreateFeeRequest'
x-java-method-name: create
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/fees/one-time-fee.md
x-internal: true
'/fees/{fee_id}':
get:
tags:
- Fees
description: Retrieve the details of a `fee`.
summary: Fetch a Fee
operationId: getFee
responses:
'200':
$ref: '#/components/responses/Fee'
'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/fees/FEtSD9oNjoCtJaN2C1FwhZ29" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
x-internal: true
parameters:
- $ref: '#/components/parameters/FeeId'
- name: Accept
in: header
schema:
type: string
default: application/hal+json
put:
summary: Update Fee
operationId: updateFee
responses:
'200':
$ref: '#/components/responses/Fee'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
requestBody:
$ref: '#/components/requestBodies/UpdateFeeRequest'
description: Update the details of a `fee`.
tags:
- Fees
x-java-method-name: update
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/fees/update-fee.md
x-internal: true
/identities:
post:
tags:
- Identities
description: |-
Create an `Identity` for your seller or buyer.
All fields for a buyer's `Identity` are optional.
Providing `business_type` indicates that the `Identity` is being created for a Merchant.
Related Guides: [Getting Started](/guides/getting-started/), [Onboarding](/guides/onboarding/)
summary: Create an Identity
operationId: createIdentity
requestBody:
$ref: '#/components/requestBodies/CreateIdentityRequest'
responses:
'201':
$ref: '#/components/responses/Identity'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: create
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
get:
tags:
- Identities
description: Retrieve a list of `Identities`.
summary: List Identities
operationId: listIdentities
parameters:
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryIdFilter'
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryDefaultStatementDescriptorFilter'
- $ref: '#/components/parameters/QueryBusinessName'
- $ref: '#/components/parameters/QueryBusinessType'
- $ref: '#/components/parameters/QueryEmail'
- $ref: '#/components/parameters/QueryFirstName'
- $ref: '#/components/parameters/QueryLastName'
- $ref: '#/components/parameters/QueryTitle'
- $ref: '#/components/parameters/QueryBeforeCursor'
- $ref: '#/components/parameters/TagsKey'
- $ref: '#/components/parameters/TagsValue'
responses:
'200':
$ref: '#/components/responses/IdentitiesList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'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/identities" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/identities/{identity_id}':
get:
tags:
- Identities
description: Retrieve the details of a previously created `Identity`.
summary: Fetch an Identity
operationId: getIdentity
responses:
'200':
$ref: '#/components/responses/Identity'
'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/identities/IDgWxBhfGYLLdkhxx2ddYf9K" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of the `Identity` to fetch.
required: true
in: path
name: identity_id
schema:
type: string
put:
tags:
- Identities
description: |-
Update an existing `Identity`.
If you are updating the `Identity` of a `Merchant` that’s already been onboarded, you need to [verify the merchant again](/api/tag/Merchants/#tag/Merchants/operation/createMerchantVerification).
summary: Update an Identity
operationId: updateIdentity
requestBody:
$ref: '#/components/requestBodies/UpdateIdentityRequest'
responses:
'200':
$ref: '#/components/responses/Identity'
'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'
x-java-method-name: update
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/identities/updateidentity.md
'/identities/{identity_id}/associated_identities':
post:
tags:
- Identities
description: 'Create an associated `Identity` for [every owner with 25% or more ownership](/guides/onboarding/onboarding-with-api#step-3-add-associated-identities) over the merchant.'
summary: Create an Associated Identity
operationId: createAssociatedIdentity
requestBody:
$ref: '#/components/requestBodies/CreateAssociatedIdentityRequest'
responses:
'201':
$ref: '#/components/responses/Identity'
'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'
x-java-method-name: createAssociatedIdentity
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/identities/IDgXNAaoy5d4TLkp5ze6gScA/associated_identities" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
-d '
{
"entity": {
"first_name": "John",
"last_name": "Smith",
"title": "Founder",
"dob": {
"month": 1,
"day": 1,
"year": 2013
},
"principal_percentage_ownership": 25,
"phone": "14158885080",
"personal_address": {
"city": "San Francisco",
"region": "CA",
"postal_code": "90650",
"line1": "123 Main Street",
"country": "USA"
},
"email": "john.smith@company1.com",
"tax_id": "123456789"
}
}'
get:
tags:
- Identities
description: Retrieve a list of `Associated Identities` for an `Identity`.
summary: List Associated Identities
operationId: listIdentityAssociatedIdentities
parameters:
- required: false
in: query
name: limit
schema:
type: integer
format: int64
description: The number of entries to return.
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
responses:
'200':
$ref: '#/components/responses/IdentitiesList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: listAssociatedIdentities
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/identities/IDf33pdVaTZGXVFNccdKvaPu/associated_identities" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Identity` to associate object with.
required: true
in: path
name: identity_id
schema:
type: string
'/identities/{identity_id}/merchants':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Identity` to fetch.
required: true
in: path
name: identity_id
schema:
type: string
post:
description: |-
Create a `Merchant` to start the underwriting (also called provisioning) process for your seller. `Merchants` must be created under an [`Identity`](/api/tag/Identities).
A bank account must be associated with the previously created `Identity` before a `Merchant` can be successfully onboarded and verified.
summary: Create a Merchant
operationId: createMerchant
requestBody:
$ref: '#/components/requestBodies/CreateMerchantUnderwritingRequest'
responses:
'201':
$ref: '#/components/responses/Merchant'
'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/ErrorUnprocessableEntity'
tags:
- Merchants
x-java-method-name: create
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/)'
'/identities/{identity_id}/settlements':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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`.
Finix, by default, creates accruing `settlements` then closes them based on your payout configurations. Use this endpoint to manually close the currently accruing settlement.
The closed `Settlement` will not accrue any further transactions and gets immediately submitted for approval.
- This endpoint is only available to Finix Core customers. If you have any questions, please contact the [Finix Support Team.](mailto:support@finixpayments.com)
- Any refunded `Transfers` get included in `Settlements` as a deduction.
- **PENDING** `Transfers` don't get included in `Settlements`.
- 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.
Related 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
'/identities/{identity_id}/verifications':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Identity` to verify.
required: true
in: path
name: identity_id
schema:
type: string
post:
summary: Verify an Identity
operationId: createIdentityVerification
responses:
'201':
$ref: '#/components/responses/Verification'
'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'
description: Verify an `Identity`.
requestBody:
$ref: '#/components/requestBodies/CreateVerificationRequest'
tags:
- Identities
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/identities/verifyidentity.md
x-internal: true
/merchant_profiles:
get:
tags:
- Merchant Profiles
description: Retireve a list of all `merchant_profiles`.
summary: List Merchant Profiles
operationId: listMerchantProfiles
parameters:
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryIdFilter'
- $ref: '#/components/parameters/QueryBeforeCursor'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryAfterCursor'
responses:
'200':
$ref: '#/components/responses/MerchantProfilesList'
'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/merchant_profiles" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
/merchants:
get:
tags:
- Merchants
description: 'Retrieve a list of `Merchants`. '
summary: List Merchants
operationId: listMerchants
parameters:
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryIdFilter'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
responses:
'200':
$ref: '#/components/responses/MerchantsList'
'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'
x-java-method-name: list
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/merchants" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/merchants/{merchant_id}/devices':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of the `Merchant` object.
required: true
in: path
name: merchant_id
schema:
type: string
post:
description: Create a `Device` under a `Merchant`.
summary: Create a Device
operationId: createMerchantDevice
responses:
'200':
$ref: '#/components/responses/Device'
'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'
x-internal: false
tags:
- Devices
requestBody:
$ref: '#/components/requestBodies/CreateDeviceRequest'
x-java-method-name: create
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/devices/create-device.md
'/merchants/{merchant_id}':
get:
tags:
- Merchants
description: Retrieve the details of a `Merchant`.
summary: Fetch a Merchant
operationId: getMerchant
responses:
'200':
$ref: '#/components/responses/Merchant'
'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/merchants/MUmUL7aBsHkxVLQawJxEXw6N" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Merchant`.
required: true
in: path
name: merchant_id
schema:
type: string
put:
tags:
- Merchants
description: |-
Update a `Merchant` to:
- Change the `Identity` information saved with the underlying processor
- [Enable Level 2/3 processing](/guides/payments/making-a-payment/level-2-and-level-3-processing/)
- Enable [buyer charges](/guides/payments/making-a-payment/buyer-charges/)
- Enable partial authorizations
- Disable a `Merchant` so the seller can't create new `Transfers` and `Authorizations`
summary: Update a Merchant
operationId: updateMerchant
requestBody:
$ref: '#/components/requestBodies/UpdateMerchantRequest'
responses:
'200':
$ref: '#/components/responses/MerchantUpdated'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
'/merchant_profiles/{merchant_profile_id}':
get:
tags:
- Merchant Profiles
description: Retrieve the details of a previosuly created `merchant_profile`.
summary: Fetch a Merchant Profile
operationId: getMerchantProfile
responses:
'200':
$ref: '#/components/responses/MerchantProfile'
'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/merchant_profiles/MPsdo8WPP5erWzfPwMjYjVy3" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `merchant_profile`.
required: true
in: path
name: merchant_profile_id
schema:
type: string
put:
tags:
- Merchant Profiles
description: Update a `merchant_profile`.
summary: Update a Merchant Profile
operationId: updateMerchantProfile
requestBody:
$ref: '#/components/requestBodies/UpdateMerchantProfileRequest'
responses:
'200':
$ref: '#/components/responses/MerchantProfile'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/merchant-profiles/update-merchant-profile.md
x-internal: false
'/merchants/{merchant_id}/verifications':
get:
description: Get a list of all the `Verifications` for a `Merchant` resource.
summary: List Merchant Verifications
operationId: listMerchantVerifications
parameters:
- required: false
in: query
name: limit
schema:
type: integer
format: int64
description: The number of entries to return.
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
responses:
'200':
$ref: '#/components/responses/VerificationsList'
'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: listByMerchantId
x-group-parameters: true
tags:
- Verifications
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Merchant` object.
required: true
in: path
name: merchant_id
schema:
type: string
post:
tags:
- Merchants
description: |-
Verify a `Merchant` if the `onboarding_state` for a `Merchant` returns **FAILED**, or if the correct the seller needs to update the saved in their information `Identity`.
Related Guides: [Onboarding Process](/guides/onboarding/onboarding-process/#reverify-a-merchant)
summary: Reverify a Merchant
operationId: createMerchantVerification
requestBody:
$ref: '#/components/requestBodies/CreateMerchantVerificationRequest'
responses:
'201':
$ref: '#/components/responses/MerchantPIVerification'
'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'
x-java-method-name: create
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
/payment_instruments:
post:
tags:
- Payment Instruments
description: |-
Create a `Payment Instrument` resource using a card or bank account.
- The creation of `Payment Instruments` directly via Finix's API should only be done for testing purposes. You must use [our hosted fields](/guides/payments/making-a-payment/using-hosted-fields/) or the javascript client to remain out of PCI scope.
summary: Create a Payment Instrument
operationId: createPaymentInstrument
requestBody:
$ref: '#/components/requestBodies/CreatePaymentInstrumentRequest'
responses:
'201':
$ref: '#/components/responses/PaymentInstrument'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: create
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
get:
tags:
- Payment Instruments
description: Retrieve a list of `Payment Instruments`.
summary: List Payment Instruments
operationId: listPaymentInstruments
parameters:
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryAccountLastFour'
- $ref: '#/components/parameters/QueryAccountRoutingNumber'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryApplicationFilter'
- $ref: '#/components/parameters/QueryBeforeCursor'
- $ref: '#/components/parameters/QueryBin'
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryExpirationMonth'
- $ref: '#/components/parameters/QueryExpirationYear'
- $ref: '#/components/parameters/QueryLastFour'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryName'
- $ref: '#/components/parameters/QueryOwnerIdentity'
- $ref: '#/components/parameters/QueryPaymentInstrumentType'
- $ref: '#/components/parameters/TagsKey'
- $ref: '#/components/parameters/TagsValue'
responses:
'200':
$ref: '#/components/responses/PaymentInstrumentsList'
'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/payment_instruments" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/payment_instruments/{payment_instrument_id}':
get:
tags:
- Payment Instruments
description: Retrieve the details of a `Payment Instrument`.
summary: Fetch a Payment Instrument
operationId: getPaymentInstrument
responses:
'200':
$ref: '#/components/responses/PaymentInstrument'
'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-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of object
required: true
in: path
name: payment_instrument_id
schema:
type: string
put:
tags:
- Payment Instruments
description: |-
Update a `Payment Instrument` to:
- Change the **billing address** in case the account holder moved (`instrument_type`:**PAYMENT_CARD** only).
- Disable the `Payment Instrument` resource so it can't be used in requests.
- Update the `name` on the `Payment Instrument`.
- Change the `tags`.
summary: Update a Payment Instrument
operationId: updatePaymentInstrument
requestBody:
$ref: '#/components/requestBodies/UpdatePaymentInstrumentRequest'
responses:
'200':
$ref: '#/components/responses/PaymentInstrument'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
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/)'
'/payment_instruments/{payment_instrument_id}/updates':
get:
description: |-
List the updates on a `Payment Instrument`.
When using the [account updater](/guides/payments/account-updater), `Payment Instrument` details that are updated are represented by an `Update`.
summary: List Payment Instrument Updates
operationId: listPaymentInstrumentUpdates
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- required: false
in: query
name: limit
schema:
type: integer
format: int64
description: The number of entries to return.
- required: false
in: query
name: offset
schema:
type: integer
format: int64
description: The number of items to skip before starting to collect the result set.
- required: false
in: query
name: pageSize
schema:
type: integer
format: int64
description: The size of the page.
responses:
'200':
$ref: '#/components/responses/PaymentInstrumentUpdatesList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: listUpdatesByPaymentInstrumentId
x-group-parameters: true
x-internal: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137/updates" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Payment Instrument` object.
required: true
in: path
name: payment_instrument_id
schema:
type: string
'/payment_instruments/{payment_instrument_id_verify}':
get:
tags:
- Verifications
description: List all the `Verifications` created for a `Payment Instrument`.
summary: List Payment Instrument Verifications
operationId: listPaymentInstrumentVerifications
parameters:
- required: false
in: query
name: limit
schema:
type: integer
format: int64
description: The number of entries to return.
- required: false
in: query
name: offset
schema:
type: integer
format: int64
description: The number of items to skip before starting to collect the result set.
- required: false
in: query
name: pageNumber
schema:
type: integer
format: int64
description: The page number to list.
- required: false
in: query
name: pageSize
schema:
type: integer
format: int64
description: The size of the page.
responses:
'200':
$ref: '#/components/responses/VerificationsList'
'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: listByPaymentInstrumentId
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/payment_instruments/PImc5nvdnp15atLxEBAGtxJs/verifications/" \
-H "Finix-Version: 2022-02-01" \
-u USpEbizhxFRAFT7oYgWjX87B:6d3ace2c-23f9-4e59-8b75-a1a5b8a53055
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: payment_instrument_id_verify
in: path
required: true
put:
tags:
- Payment Instruments P2C
- Payment Instruments
description: |-
Verify a `Payment Instrument` to determine CVV and AVS results.
You can also determine Push To Card eligibility for [Push To Card](/guides/push-to-card) customers.
summary: Verify a Payment Instrument
operationId: createPaymentInstrumentVerification
requestBody:
$ref: '#/components/requestBodies/CreateVerificationRequest'
responses:
'201':
$ref: '#/components/responses/Verification'
'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'
x-jave-method-name: create
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
/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.
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
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/" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/settlements/{settlement_id}':
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" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Settlement` object.
required: true
in: path
name: settlement_id
schema:
type: string
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`.
Finix, by default, creates accruing `settlements` then closes them based on your payout configurations. Use this endpoint to manually close a specific `settlement`.
The closed `Settlement` will not accrue any further transactions and gets immediately submitted for approval.
- This endpoint is only available to Finix Core customers. If you have any questions, please contact the [Finix Support Team](mailto:support@finixpayments.com).
- Any refunded `Transfers` get included in `Settlements` as a deduction.
- **PENDING** `Transfers` don't get included in `Settlements`.
- 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:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
'/settlements/{settlement_id}/funding_transfers':
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:
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryLimit'
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Settlement` object.
required: true
in: path
name: settlement_id
schema:
type: string
'/settlements/{settlement_id}/transfers':
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'
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" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Settlement` object.
required: true
in: path
name: settlement_id
schema:
type: string
/transfers:
post:
tags:
- Transfers
description: Create a `Transfer`.
summary: Create a Transfer
operationId: createTransfer
requestBody:
$ref: '#/components/requestBodies/CreateTransferRequest'
responses:
'201':
$ref: '#/components/responses/Transfer'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'402':
$ref: '#/components/responses/ErrorTransfers402'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/Error422InvalidField'
x-java-method-name: create
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
get:
tags:
- Transfers
description: Retrieve a list of `Transfers`.
summary: List Transfers
operationId: listTransfers
parameters:
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryAmountFilter'
- $ref: '#/components/parameters/QueryAmountGteFilter'
- $ref: '#/components/parameters/QueryAmountGtFilter'
- $ref: '#/components/parameters/QueryAmountLteFilter'
- $ref: '#/components/parameters/QueryAmountLtFilter'
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryIdempotencyIdFilter'
- $ref: '#/components/parameters/QueryIdFilter'
- $ref: '#/components/parameters/QuerySettlementReadyToSettleAtGteFilter'
- $ref: '#/components/parameters/QuerySettlementReadyToSettleAtLteFilter'
- in: query
name: state
description: Filter by Transaction state.
schema:
enum:
- ALL
- SUCCEEDED
- FAILED
- PENDING
- CANCELED
- $ref: '#/components/parameters/QueryStatementDescriptorFilter'
- $ref: '#/components/parameters/QueryTraceIdFilter'
- $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
- in: query
name: instrument_bin
description: Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number.
schema:
type: string
- schema:
type: string
in: query
name: instrument_account_last4
description: "Filter Transactions by the last 4 digits of the bank account. The bank account last 4 are the last 4 digits of the masked number\tinstrument_account_last4=9444 BIN."
- schema:
type: string
in: query
name: instrument_brand_type
description: Filter by card brand. Available card brand types can be found in the drop-down.
- schema:
type: string
in: query
name: merchant_identity_id
description: Filter by `Identity` ID.
- schema:
type: string
in: query
name: merchant_identity_name
description: Filter Transactions by `Identity` name. The name is not case-sensitive.
- schema:
type: string
in: query
name: instrument_name
description: Filter Transactions by `Payment Instrument` name.
- schema:
type: string
in: query
name: instrument_type
description: 'Filter Transactions by `Payment Instrument` type. Available instrument types include: Bank Account or Payment Card'
- schema:
type: string
in: query
name: merchant_id
description: Filter by `Merchant` ID.
- schema:
type: string
in: query
name: merchant_mid
description: Filter by Merchant Identification Number (MID).
- schema:
type: string
in: query
name: instrument_card_last4
description: Filter by the payment card last 4 digits.
- schema:
type: string
in: query
name: merchant_processor_id
description: Filter by `Processor` ID.
- schema:
type: string
enum:
- ALL
- DEBITS
- CREDITS
- REVERSAL
- SETTLEMENT
example: REVERSAL
in: query
name: type
description: 'Filter by `Transfer` type. Available type filters include: All, Debits, Refunds, or Credits.'
- $ref: '#/components/parameters/QueryBeforeCursor'
- $ref: '#/components/parameters/TagsKey'
- $ref: '#/components/parameters/TagsValue'
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: list
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/transfers" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/transfers/{transfer_id}':
get:
tags:
- Transfers
description: Retrieve a `Transfer`.
summary: Fetch a Transfer
operationId: getTransfer
responses:
'200':
$ref: '#/components/responses/Transfer'
'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/transfers/TRvypRNBeqM597Zi4DcqJ2Vh" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Transfer` resource.
required: true
in: path
name: transfer_id
schema:
type: string
put:
tags:
- Transfers
description: Update a `Transfer`.
summary: Update a Transfer
operationId: updateTransfer
responses:
'200':
$ref: '#/components/responses/Transfer'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
requestBody:
$ref: '#/components/requestBodies/UpdateTransferRequest'
x-java-method-name: update
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/transfers/updatetransfer.md
'/transfers/{transfer_id}/reversals':
post:
tags:
- Transfers
description: |-
Reverse a transfer with a `type` of **DEBIT**. This reversal creates a new `Transfer` resource with a `type` of **REVERSAL**.
Related Guides: [Refunding Payments](/guides/after-the-payment/refunding-and-cancelling-payments/)
summary: Refund or Reverse a Transfer
operationId: createTransferReversal
requestBody:
$ref: '#/components/requestBodies/CreateReversalRequest'
responses:
'201':
$ref: '#/components/responses/Transfer'
'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/ErrorUnprocessableEntity'
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/)'
get:
tags:
- Transfers
description: Retrieve a list of reversals for a `Transfer`.
summary: List Reversals on a Transfer
operationId: listTransferReversals
parameters:
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
- required: false
in: query
name: limit
schema:
type: integer
format: int64
description: The number of entries to return.
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
responses:
'200':
$ref: '#/components/responses/ReversalsList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: listTransfersReversals
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- description: ID of `Transfer` object.
required: true
in: path
name: transfer_id
schema:
type: string
/users:
get:
tags:
- Users
description: Retrieve a list of all `Users`.
summary: List all Users
operationId: listUsers
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
responses:
'200':
$ref: '#/components/responses/UsersList'
'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/users" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/users/{user_id}':
get:
tags:
- Users
description: Retrieve a specific user with the ID of the `User`.
summary: Fetch a User by ID
operationId: getUser
responses:
'200':
$ref: '#/components/responses/User'
'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/users/USvVu9MXHz7hVzwDXwbx3UCL" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `User` object.
required: true
in: path
name: user_id
schema:
type: string
put:
tags:
- Users
description: Update a `User` with new tags or disable the `User` and their credentials.
summary: Update a User
operationId: updateUser
responses:
'200':
$ref: '#/components/responses/User'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
requestBody:
$ref: '#/components/requestBodies/UpdateUserRequest'
x-java-method-name: update
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/users/update-user.md
/verifications:
post:
description: |-
Create a `Verification` to verify a seller's `Identity`.
Verifications can also be created directly on the resources you want to verify. For example:
- `POST /merchants/{merchant_id}/verifications`
- `POST /payment_instruments/{payment_instrument_id}/verifications`
summary: Create a Merchant Verification
operationId: createVerification
requestBody:
$ref: '#/components/requestBodies/CreateVerificationRequest'
responses:
'201':
$ref: '#/components/responses/Verification'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/Error422InvalidField'
x-java-method-name: create
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/verifications/merchant-verification.md
get:
tags:
- Verifications
description: Retrieve a list of `Verifications`.
summary: List Verifications
operationId: listVerifications
parameters:
- name: Accept
in: header
description: Body Header
schema:
type: string
default: application/hal+json
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
responses:
'200':
$ref: '#/components/responses/VerificationsList'
'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/verifications" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/verifications/{verification_id}':
get:
tags:
- Verifications
description: Retrieve the details of a `Verification`.
summary: Fetch a Verification
operationId: getVerification
responses:
'200':
$ref: '#/components/responses/Verification'
'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/verifications/VIbXwBuccEcqw7rfZneELCv4" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Verification` object.
required: true
in: path
name: verification_id
schema:
type: string
/webhooks:
post:
tags:
- Webhooks
description: Create a `Webhook` to specify an endpoint where Finix can send events.
summary: Create a Webhook
operationId: createWebhook
requestBody:
$ref: '#/components/requestBodies/CreateWebhookRequest'
responses:
'201':
$ref: '#/components/responses/Webhook'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/Error422InvalidField'
x-java-method-name: create
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
get:
tags:
- Webhooks
description: Retrieve a list of `Webhooks`.
summary: List Webhooks
operationId: listWebhooks
parameters:
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
responses:
'200':
$ref: '#/components/responses/WebhooksList'
'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/webhooks" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/webhooks/{webhook_id}':
get:
tags:
- Webhooks
description: Retrieve the details of a `Webhook`.
summary: Fetch a Webhook
operationId: getWebhook
responses:
'200':
$ref: '#/components/responses/Webhook'
'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/webhooks/WHN6HuqRqTV3mDCxoFLrRvP" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- description: ID of `Webhook` object.
required: true
in: path
name: webhook_id
schema:
type: string
put:
tags:
- Webhooks
description: |-
Update an existing `Webhook`to:
- Disable or enable an endpoint URL to recieve webhook events.
- Add [authentication to a `Webhook`](/guides/developers/webhooks/#authenticating-webhooks).
- Filter the [webhook events sent to an endpoint URL](/guides/developers/webhooks/#webhook-event-filtering).
summary: Update a Webhook
operationId: updateWebhook
requestBody:
$ref: '#/components/requestBodies/UpdateWebhookRequest'
responses:
'200':
$ref: '#/components/responses/Webhook'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
'/subscription/subscription_schedules/{subscription_schedule_id}':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: subscription_schedule_id
in: path
required: true
description: The ID of the `Subscription Schedule`.
get:
summary: Fetch a Subscription Schedule
responses:
'200':
$ref: '#/components/responses/SubscriptionSchedule'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
description: Not Found
'406':
description: Not Acceptable
operationId: getSubscriptionSchedule
description: Retrieve the details of a `subscription_schedule`
x-java-method-name: get
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
in: query
name: nickname
description: Filter by the object's `nickname`.
- schema:
type: string
in: query
name: type
description: Filter by the object's `subscription_type`.
tags:
- Subscription Schedules
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV" \
-H "Finix-Version: 2022-02-01" \
-u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
put:
summary: Update a Subscription Schedule
responses:
'200':
$ref: '#/components/responses/SubscriptionSchedule'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: updateSubscriptionSchedules
requestBody:
$ref: '#/components/requestBodies/UpdateSubscriptionScheduleRequest'
description: Update the details of a `subscription_schedule`.
x-java-method-name: update
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/subscription-schedule/update-subscription-schedule.md
tags:
- Subscription Schedules
/subscription/subscription_schedules:
get:
summary: List Subscription Schedules
operationId: listSubscriptionSchedules
description: Retrieve a list of `Subscription Schedules`.
responses:
'200':
$ref: '#/components/responses/SubscriptionSchedulesList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: list
x-group-parameters: true
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
in: query
name: nickname
description: Filter by the object's `nickname`.
- schema:
type: string
in: query
name: type
description: Filter by the object's `type`.
tags:
- Subscription Schedules
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/" \
-H "Finix-Version: 2022-02-01" \
-u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
post:
summary: Create a Subscription Schedule
tags:
- Subscription Schedules
responses:
'200':
$ref: '#/components/responses/SubscriptionSchedule'
'401':
description: Unauthorized
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: post-subscription-subscription_schedules
requestBody:
$ref: '#/components/requestBodies/CreateSubscriptionScheduleRequest'
description: Create a `subscription_schedule`.
x-java-method-name: create
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
'/subscription/subscription_schedules/{subscription_schedule_id}/subscription_amounts':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: subscription_schedule_id
in: path
required: true
description: The ID of the `Subscription Schedule`.
get:
summary: List Subscription Amounts
responses:
'200':
$ref: '#/components/responses/SubscriptionAmountsList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
description: Not Acceptable
operationId: listSubscriptionAmount
parameters:
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
- name: Accept
in: header
schema:
type: string
default: application/hal+json
description: Retrive a list of `Subscription Amounts`.
x-java-method-name: listBySubscriptionSchedule
x-group-parameters: true
tags:
- Subscription Amounts
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/" \
-H "Finix-Version: 2022-02-01" \
-u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
post:
summary: Create a Subscription Amount
tags:
- Subscription Amounts
responses:
'200':
$ref: '#/components/responses/SubscriptionAmount'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: createSubscriptionAmounts
requestBody:
$ref: '#/components/requestBodies/CreateSubscriptionAmountRequest'
description: |-
Create a `subscription_amount`.
The `Subscription Amount` is the amount to be charged to a `Merchant`. The `Subscription Amount` must be associated to a `Subscription Schedule`.
x-java-method-name: create
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/subscription-amount/create-sub-amount.md
'/subscription/subscription_schedules/{subscription_schedule_id}/subscription_amounts/{subscription_amount_id}':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: subscription_amount_id
in: path
required: true
description: The ID of the `Subscription Amount`.
- schema:
type: string
name: subscription_schedule_id
in: path
required: true
description: The ID of the `Subscription Schedule`.
get:
summary: Fetch a Subscription Amount
tags:
- Subscription Amounts
responses:
'200':
$ref: '#/components/responses/SubscriptionAmount'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getSubscriptionAmount
description: Retrieve the details of a `subscription_amount`.
x-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN" \
-H "Finix-Version: 2022-02-01" \
-u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
put:
summary: Update a Subscription Amount
operationId: updateSubscriptionAmount
responses:
'200':
$ref: '#/components/responses/SubscriptionAmount'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
tags:
- Subscription Amounts
description: Update the details of a `subscription_amount`.
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/subscription-amount/update-sub-amount.md
requestBody:
$ref: '#/components/requestBodies/UpdateSubscriptionAmountRequest'
delete:
summary: Delete a Subscription Amount
operationId: deleteSubscriptionAmount
responses:
'204':
description: No Content
'401':
$ref: '#/components/responses/ErrorNotFound'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorUnauthorized'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
tags:
- Subscription Amounts
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/subscription-amount/delete-sub-amount.md
description: |-
Delete a previously created `Subscription Amount`.
> Per the JSON API for deleting a resource, our API doesn't have a response body when removing a Subsciption Amount.
'/subscription/subscription_schedules/{subscription_schedule_id}/subscription_enrollments':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: subscription_schedule_id
in: path
required: true
description: The ID of the `subscription_schedule`.
get:
summary: List Subscription Enrollments on a Schedule
responses:
'200':
$ref: '#/components/responses/SubscriptionEnrollmentsList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
description: Forbidden
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: listSubscriptionEnrollmentsInSchedule
description: Retrieve a list of `Subscription Enrollments` for a specific `subscription_schedule`.
x-java-method-name: listBySubscriptionScheduleId
x-group-parameters: true
tags:
- Subscription Enrollments
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv/subscription_enrollments" \
-H "Finix-Version: 2022-02-01" \
-u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
post:
summary: Create a Subscription Enrollment
tags:
- Subscription Enrollments
responses:
'200':
$ref: '#/components/responses/SubscriptionEnrollment'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: createSubscriptionEnrollments
requestBody:
$ref: '#/components/requestBodies/CreateSubscriptionEnrollmentRequest'
description: |-
Create a `subscription_enrollment`.
A `subscription_enrollment` details which `Merchant` gets charged, to what schedule, and when the subscription will start. The `subscription_enrollment` must be associated with a `Subscription Schedule`.
x-java-method-name: create
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/subscription-enrollments/create-sub-enrollment.md
/subscription/subscription_enrollments:
get:
summary: List Subscription Enrollments
tags:
- Subscription Enrollments
responses:
'200':
$ref: '#/components/responses/SubscriptionEnrollmentsList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: listSubscriptionEnrollments
description: Retrieve a list of `Subscription Enrollments`.
x-java-method-name: list
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments" \
-H "Finix-Version: 2022-02-01" \
-u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
'/subscription/subscription_enrollments/{subscription_enrollment_id}':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: subscription_enrollment_id
in: path
required: true
description: The ID of the `subscription_enrollment`.
put:
summary: Update a Subscription Enrollment
tags:
- Subscription Enrollments
responses:
'200':
$ref: '#/components/responses/SubscriptionEnrollment'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: updateSubscriptionEnrollment
requestBody:
$ref: '#/components/requestBodies/UpdateSubscriptionEnrollmentRequest'
description: Update the details of a `subscription_enrollment`.
x-java-method-name: update
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/subscription-enrollments/update-sub-enrollment.md
get:
summary: Fetch a Subscription Enrollment
tags:
- Subscription Enrollments
responses:
'200':
$ref: '#/components/responses/SubscriptionEnrollment'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getSubscriptionEnrollment
description: Retrieve the details of a `subscription_enrollment`.
x-java-method-name: get
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
in: query
name: merchant
description: Filter by the object's `Merchant` ID.
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_Yxwo2Vb6oj97m3PuW9TxQ" \
-H "Finix-Version: 2022-02-01" \
-u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
delete:
summary: Delete a Subscription Enrollment
tags:
- Subscription Enrollments
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'
operationId: deleteSubscriptionEnrollment
description: |-
Remove a `subscription_enrollment`.
> Per the JSON API for deleting a resource, our API doesn't have a response body when removing a Subsciption Enrollment.
x-java-method-name: remove
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/subscription-enrollments/delete-sub-enrollment.md
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
/instrument_updates:
post:
summary: Create Instrument Updates
operationId: createPaymentInstrumentUpdate
responses:
'200':
$ref: '#/components/responses/InstrumentUpdate'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
description: 'To update the card details of your customers, create an `instrument_updates` resource. Include the `Payment Instrument` IDs you want to update in a CSV.'
requestBody:
$ref: '#/components/requestBodies/CreateInstrumentUpdateRequest'
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
tags:
- Instrument Updates
x-java-method-name: create
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/instrument-updates/create-instrument-updates.md
'/instrument_updates/{instrument_updates_id}/download':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: instrument_updates_id
in: path
required: true
description: The ID of the `instrument_updates` resource. This ID was returned when initially creating the `instrument_updates` object.
get:
summary: Download Instrument Updates
tags:
- Instrument Updates
responses:
'200':
description: "The updated `Payment Instruments` will be returned in the following comma seperated format:\n\npayment\\_instrument\\_original,\t| payment\\_instrument_new, |result\n--------------------------- | ---------------------- | -----\nPIlkNdfZibF8a7Prd2teGB1 | PI3aQGaCM5nDMjqyTXcbUJzR| CARD\\_EXPIRATION_UPDATED\nPIJPXW0HZ9lpO1nb6sog5DiX | PIdBHpy7BBSxd2z81VdKpVbT | CARD\\_NOT\\_FOUND\nPI0ovZAS9yfEtgDrZnMaiLvi | PIhXS0jXNTmklyVk91EsohuZ | CONTACT\\_CARDHOLDER\nPInOrrKY3G1U33hGYTQJ8cIY | | CLOSED\\_ACCOUNT\nPIlkAOt5kTVhuuxxbmOi9qn | | INVALID\\_CARD\nPIiRLbbG4i5daypWNzIrq2xD | | NO\\_CHANGE\\_FOUND\nPIy5llZGt6VxlDqbcTgATqeH | \t | UNKNOWN"
content:
application/json:
schema:
type: string
format: binary
examples:
Instrument Update:
value: 'payment_instrument_original,payment_instrument_new,result PIlkNdfZibF8a7Prd2teGB1,PI3aQGaCM5nDMjqyTXcbUJzR,CARD_EXPIRATION_UPDATED PIJPXW0HZ9lpO1nb6sog5DiX,PIdBHpy7BBSxd2z81VdKpVbT,CARD_NOT_FOUND PIiRLbbG4i5daypWNzIrq2xD,,NO_CHANGE_FOUND PIy5llZGt6VxlDqbcTgATqeH,,UNKNOWN'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: downloadInstrumentUpdate
description: |-
Fetch a previously created `instrument_updates` resource as a CSV.
To fetch the `instrument_updates` resource in JSON, add `?format=json` to the request endpoint.
parameters:
- $ref: '#/components/parameters/QueryFormat'
x-group-parameters: true
x-java-method-name: download
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/instrument_updates/IUd2Wzs6jxPJjteva3n19Amu/download" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
/files:
post:
summary: Create a File
operationId: createFiles
responses:
'200':
$ref: '#/components/responses/File'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/files/createfile.md
description: |-
Before uploading a file, you need to create a `File` resource.
Once created, you can [upload](/guides/onboarding/uploading-files-to-finix/#how-to-upload-a-file-to-finix) your file to the new `File` resource.
requestBody:
$ref: '#/components/requestBodies/CreateFileRequest'
tags:
- Files
x-java-method-name: create
get:
summary: List All Files
tags:
- Files
responses:
'200':
$ref: '#/components/responses/FilesList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: listFiles
description: List all the `File` resources you've created.
parameters:
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryIdFilter'
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
- $ref: '#/components/parameters/QueryBeforeCursor'
x-java-method-name: list
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/files" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/files/{file_id}':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: file_id
in: path
required: true
description: Your `File` ID.
get:
summary: Fetch a File
tags:
- Files
responses:
'200':
$ref: '#/components/responses/File'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getFile
description: Retrieve the details of a `File` resource.
x-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/files/FILE_abki8bFEjq51eZ5w2pYFik" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/files/{file_id}/external_links':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: file_id
in: path
required: true
description: Your `File` ID.
get:
summary: List All External Links
tags:
- Files
responses:
'200':
$ref: '#/components/responses/ExternalLinksList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
description: Not Acceptable
operationId: listExternalLinks
description: List the previously created `external_links` for a `File`.
parameters:
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryIdFilter'
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtGteFilter'
- $ref: '#/components/parameters/QueryUpdatedAtLteFilter'
- $ref: '#/components/parameters/QueryBeforeCursor'
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/files/FILE_abki8bFEjq51eZ5w2pYFik/external_links" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
post:
summary: Create an External Link
operationId: createExternalLink
responses:
'200':
$ref: '#/components/responses/ExternalLink'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/files/external-link.md
description: 'Create an `external_link` resource to share with users so they can upload files directly from their browser. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/).'
requestBody:
$ref: '#/components/requestBodies/CreateExternalLinkRequest'
tags:
- Files
'/files/{file_id}/upload':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: file_id
in: path
required: true
description: The ID of the `File` that was created to upload the file.
post:
summary: Upload files Directly
operationId: uploadFile
responses:
'200':
$ref: '#/components/responses/File'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
description: Upload files directly with a `multipart/form-data` request.
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
x-java-method-name: upload
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/files/uploadfile.md
tags:
- Files
requestBody:
$ref: '#/components/requestBodies/UploadFileRequest'
'/files/{file_id}/download':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: file_id
in: path
required: true
description: The ID of the `File` that was created to upload the file.
get:
summary: Download a File
tags:
- Files
responses:
'200':
$ref: '#/components/responses/FileDownload'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: downloadFile
x-java-method-name: download
description: Download a file that was uploaded to a `File` resource.
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStGPVpvKHtgA/download" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
enum:
- 'true'
- 'false'
in: query
name: stream
description: Stream the contents of the `File` so it's displayed inline in the user's web browser.
'/files/{file_id}/external_links/{external_link_id}':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: file_id
in: path
required: true
description: The ID of the `File` that has the links you want to retrieve.
- schema:
type: string
name: external_link_id
in: path
required: true
description: The ID of the `external_link` that you want to retireve.
get:
summary: Fetch an External LInk
tags:
- Files
responses:
'200':
$ref: '#/components/responses/ExternalLink'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getExternalLink
description: Fetch a previously created `external_link` resource.
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA/external_links/EL_dh5YS66GePpkeSVyL4VdBL" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
/apple_pay_sessions:
post:
summary: Create an Apple Pay Session
operationId: createApplePaySession
responses:
'200':
$ref: '#/components/responses/ApplePaySession'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
tags:
- Payment Instruments
x-java-method-name: createApplePaySession
requestBody:
$ref: '#/components/requestBodies/CreateApplePaySessionRequest'
description: |-
Create an `apple_pay_session` to process Apple Pay transactions on the web.
To create an Apple Pay Session, pass the unique `validation_url` (provided by Apple) while creating an `apple_pay_sessions` resource. Finix returns a `merchantSession` object that you can use to create a payment. For more information, see [Apple Pay](/guides/payments/alternative-payment-methods/apple-pay/).
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/payment-instruments/createapplepay.md
'/disputes/{dispute_id}/adjustment_transfers':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: dispute_id
in: path
required: true
description: ID of the `Dispute` resource.
get:
summary: Fetch Dispute Adjustment Transfers
tags:
- Disputes
responses:
'200':
$ref: '#/components/responses/AdjustmentTransfersList'
'401':
description: Unauthorized
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: listDisputesAdjustments
description: |-
List the adjustment `Transfers` for a `Dispute`. Depending on the stage of the `Dispute`, different adjustment `Transfer` subtypes can be applied.
There are four available subtypes for adjustment `Transfers` in `Disputes`: <ul><li><strong>PLATFORM\_CREDIT</strong><li><strong>MERCHANT\_DEBIT</strong><li><strong>MERCHANT\_CREDIT</strong><li><strong>PLATFORM\_DEBIT</strong></ul>
x-group-parameters: true
parameters:
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryBeforeCursor'
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/instrument_updates/{instrument_updates_id}':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
description: The ID of the `instrument_update`.
name: instrument_updates_id
in: path
required: true
get:
summary: Fetch an Instrument Update
tags:
- Instrument Updates
responses:
'200':
$ref: '#/components/responses/InstrumentUpdate'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getInstrumentUpdate
description: Fetch a specific `instrument_update` from an `instrument_updates` resource.
x-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/instrument_updates/IUp9oSWhWUF31DPrJ8CojQeQ/" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
'/compliance_forms/{compliance_forms_id}':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: compliance_forms_id
in: path
required: true
description: ID of the `compliance_form`.
get:
summary: Fetch a Compliance Form
tags:
- Compliance Forms
responses:
'200':
$ref: '#/components/responses/ComplianceForm'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: getComplianceForms
x-java-method-name: list
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/compliance-forms/fetch-compliance-form.md
description: |-
A webhook notifies you when Finix creates a `compliance_form`.
Use the ID in the webhook to fetch the `compliance_form` resource from the `/compliance_forms/:COMPLIANCE_FORM_ID:` endpoint.
put:
summary: Complete a Compliance Form
operationId: updateComplianceForms
responses:
'200':
$ref: '#/components/responses/ComplianceForm'
'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'
description: |-
As part of onboarding your users, you'll need to build a UI experience that allows users to complete the PCI `compliance_form` and download the form as a PDF if requested.
For more information, see [Managing Compliance Forms](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-compliance-forms).
tags:
- Compliance Forms
requestBody:
$ref: '#/components/requestBodies/UpdateComplianceForm'
x-java-method-name: update
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/compliance-forms/complete-compliance-form.md
/compliance_forms:
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
get:
summary: List Compliance Forms
tags:
- Compliance Forms
responses:
'200':
$ref: '#/components/responses/ComplianceFormList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: listComplianceForms
x-java-method-name: list
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/compliance-forms/list-compliance-forms.md
description: Retrieves a list of `Compliance Forms`.
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
enum:
- INCOMPLETE
- COMPLETE
in: query
name: state
description: Filter by the `state` of the `Compliance Form`.
/onboarding_forms:
post:
summary: Create an Onboarding Form
operationId: createOnboardingForm
responses:
'200':
$ref: '#/components/responses/OnboardingForm'
'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'
description: |-
Create an `onboarding_form` with the name of the processor you plan to onboard users to and the links they` get redirected to when completing or moving away from the Finix Onboarding Form.
Only **ROLE_PARTNER** credentials can be used to create an `onboarding_form`.
requestBody:
$ref: '#/components/requestBodies/CreateOnboardingFormRequest'
tags:
- Onboarding Forms
x-java-method-name: create
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/onboarding-form/create-onboarding-form.md
parameters: []
'/onboarding_forms/{onboarding_form_id}':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: onboarding_form_id
description: The id of the `onboarding_form`.
in: path
required: true
get:
summary: Fetch an Onboarding Form
operationId: getOnboardingForm
responses:
'200':
$ref: '#/components/responses/OnboardingForm'
'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'
description: Retrieve the details of an `onboarding_form`.
tags:
- Onboarding Forms
x-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/onboarding-form/fetch-onboarding-form.md
'/onboarding_forms/{onboarding_form_id}/links':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: onboarding_form_id
in: path
required: true
description: The ID of the `onboarding_form` resource.
post:
summary: Create an Onboarding Form Link
operationId: createOnboardingFormLink
responses:
'200':
$ref: '#/components/responses/OnboardingFormLink'
'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'
description: Use the `onboarding_forms` API to create a link that can return users to where they left off completing their Finix Onboarding Form.
requestBody:
$ref: '#/components/requestBodies/CreateOnboardingFormLinkRequest'
tags:
- Onboarding Forms
x-java-method-name: createLink
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/onboarding-form/onboarding-form-link.md
/payout_profiles:
get:
summary: List Payout Profiles
responses:
'200':
$ref: '#/components/responses/PayoutProfilesList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
description: Not Acceptable
'422':
$ref: '#/components/responses/Error422InvalidField'
operationId: listPayoutprofiles
description: List all `Payout Profiles`.
x-java-method-name: list
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/payout_profiles" \
-H "Finix-Version: 2022-02-01" \
-u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
tags:
- Payout Profiles
parameters:
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryLimit'
'/payout_profiles/{payout_profile_id}':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: payout_profile_id
in: path
required: true
description: ID of the `Payout Profile`.
get:
summary: Fetch a Payout Profile
responses:
'200':
$ref: '#/components/responses/PayoutProfile'
'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'
operationId: getPayoutprofile
description: Retrieve the details of a previously created `Payout Profile`.
x-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf" \
-H "Finix-Version: 2022-02-01" \
-u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
tags:
- Payout Profiles
put:
summary: Update a Payout Profile
operationId: updatePayoutProfileRequest
responses:
'200':
$ref: '#/components/responses/PayoutProfile'
'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'
description: |-
Update a `Payout Profile` to configure how fees and payouts get calculated, credited, and debited.
By default, `Merchants` get configured with daily net settlements. Payouts get submitted using the **Next-Day ACH** `rail`. Contact [Finix Support](/guides/getting-started/support-at-finix/) to configure payouts on a custom schedule.
requestBody:
$ref: '#/components/requestBodies/UpdatePayoutProfileRequest'
tags:
- Payout Profiles
x-java-method-name: update
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/payout-profile/update-payout-profile.md
'/merchants/{merchant_id}/payout_profile':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: merchant_id
in: path
required: true
description: ID of the `Merchant`.
get:
summary: Fetch Payout Profile by Merchant
responses:
'200':
$ref: '#/components/responses/PayoutProfile'
'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'
operationId: fetchPayoutProfilesbyMerchant
description: Fetch the the `Payout Profile` createrd for a specific `Merchant`.
x-java-method-name: getByMerchantId
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/merchants/MUfbbKm7vRmBX2bP92pKw9zZ/payout_profile" \
-H "Finix-Version: 2022-02-01" \
-u US4UKYcdgmg3CKPxDRyV3FtA:88214476-3d56-4708-adc2-a7f001b0d5a1
tags:
- Payout Profiles
'/disputes/{dispute_id}/submit':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: dispute_id
in: path
required: true
description: ID of `Dispute` to move forward and submit evidence.
post:
summary: Submit Dispute Evidence
operationId: submitDisputeEvidence
responses:
'200':
$ref: '#/components/responses/Dispute'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/ErrorUnprocessableEntity'
tags:
- Disputes
description: |-
You can manually submit evidence to the issuing bank to manually move a dispute forward. Use the `/disputes/DISPUTE_ID/submit` endpoint to submit evidence. Making a POST request lets the issuing bank know the seller has completed submitting evidence and is prepared to move forward with the dispute.
Related guides: [Responding to Disputes](/guides/after-the-payment/disputes/responding-disputes/).
x-java-method-name: post
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/disputes/submit-dispute-evidence.md
requestBody:
$ref: '#/components/requestBodies/SubmitDisputeEvidence'
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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/)'
'/disputes/{dispute_id}/accept':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
name: dispute_id
in: path
required: true
description: ID of `Dispute` to move forward and submit evidence.
post:
summary: Accept a Dispute
operationId: acceptDispute
responses:
'200':
$ref: '#/components/responses/Dispute'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/ErrorUnprocessableEntity'
description: |
You can accept a `Dispute` to prevent a long (and potentially expensive) process. When you accept a `Dispute`, you concede that the Dispute is not worth challenging or representing.
Related guides: [Accepting a Dispute](/guides/after-the-payment/disputes/accepting-disputes/)
x-java-method-name: post
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/disputes/accept-dispute.md
requestBody:
$ref: '#/components/requestBodies/AcceptDisputeRequest'
tags:
- Disputes
'/disputes/{dispute_id}/evidence/{evidence_id}/download':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
example: DIpCy4sZTx6im6U1ofBBPzdM
name: dispute_id
in: path
required: true
description: ID of `Dispute` to download evidence from.
- schema:
type: string
example: DFtiQ1LoNbjBTYiuuxju6tE2
name: evidence_id
in: path
required: true
description: ID of `evidence` to download.
get:
summary: Download Dispute Evidence
tags:
- Disputes
responses:
'200':
$ref: '#/components/responses/FileDownload'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
operationId: downloadDisputeEvidence
description: |-
Download a file uploaded as `Dispute Evidence`.
**Note**: The file extension included in `output` must match the extension of the original uploaded file.
x-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: |
curl "https://finix.sandbox-payments-api.com/disputes/DIpCy4sZTx6im6U1ofBBPzdM/evidence/DFtiQ1LoNbjBTYiuuxju6tE2/download" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
--output DFtiQ1LoNbjBTYiuuxju6tE2.png
parameters: []
'/split_transfers/{split_transfer_id}':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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: []
'/split_transfers/{split_transfer_id}/fees':
parameters:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- 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: []
/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:
- name: Accept
in: header
schema:
type: string
default: application/hal+json
- schema:
type: string
example: TRvQN3v5mhA2Ttc78hzjLV3j
pattern: TRxxxxxxxxxxxxxxxxxxxxxx
in: query
name: parent_transfer_id
description: '**ID** of the parent `Transfer` that was split.'
required: true
components:
headers:
date:
schema:
type: string
finix-apiuser-role:
schema:
type: string
enum:
- ROLE_ADMIN
- ROLE_PLATFORM
- ROLE_PARTNER
- ROLE_MERCHANT
version:
description: 'Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/)'
schema:
type: string
default: '2018-01-01'
example: 'Finix-Version: 2022-02-01'
x-request-id:
description: A unique ID for this specific API request attempt.
schema:
type: string
parameters:
ApplicationId:
description: ID of `Application` to use.
in: path
name: application_id
schema:
type: string
required: true
ApplicationProfileId:
description: ID of `Application` profile to use.
required: true
in: path
name: application_profile_id
schema:
type: string
AuthorizationId:
description: ID of `Authorization` to fetch.
required: true
in: path
name: authorization_id
schema:
type: string
FeeId:
description: ID of `fee` to use.
required: true
in: path
name: fee_id
schema:
type: string
QueryAmountFilter:
description: Filter by an amount equal to the given value.
in: query
name: amount
schema:
type: integer
style: form
QueryAmountGtFilter:
description: Filter by an amount greater than.
in: query
name: amount.gt
schema:
type: integer
style: form
QueryAmountGteFilter:
description: Filter by an amount greater than or equal.
in: query
name: amount.gte
schema:
type: integer
style: form
QueryAmountLtFilter:
description: Filter by an amount less than.
in: query
name: amount.lt
schema:
type: integer
style: form
QueryAmountLteFilter:
description: Filter by an amount less than or equal.
in: query
name: amount.lte
schema:
type: integer
style: form
QueryApplicationFilter:
description: Filter by `Application` ID.
in: query
name: application
schema:
type: string
style: form
QueryCreatedAtGteFilter:
description: Filter where `created_at` is after the given date.
in: query
name: created_at.gte
schema:
type: string
example: '2022-09-27T11:21:23'
style: form
QueryCreatedAtLteFilter:
description: Filter where `created_at` is before the given date.
in: query
name: created_at.lte
schema:
type: string
example: '2022-09-27T11:21:23'
style: form
QueryDefaultStatementDescriptorFilter:
description: Filter by the `default_statement_descriptor`.
in: query
name: default_statement_descriptor
schema:
type: string
style: form
QueryIdFilter:
description: Filter by `id`.
in: query
name: id
schema:
type: string
style: form
QueryIdempotencyIdFilter:
description: Filter by `idempotency_id`.
in: query
name: idempotency_id
schema:
type: string
style: form
QueryLimit:
description: The numbers of items to return.
example: 10
in: query
name: limit
schema:
type: integer
style: form
QueryOffset:
description: The number of items to skip before starting to collect the result set.
example: 20
in: query
name: offset
schema:
type: integer
style: form
QuerySettlementReadyToSettleAtGteFilter:
description: 'Filter where `ready_to_settle_at` is after the given date. Only available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).'
in: query
name: ready_to_settle_at.gte
schema:
type: string
example: '?ready_to_settle_at.gte=2023-06-28T00:00:00'
style: form
QuerySettlementReadyToSettleAtLteFilter:
description: 'Filter where `ready_to_settle_at` is before the given date. Only available on `Finix-Version: 2022-02-01`. For more details, see [Versioning](/guides/developers/versioning/).'
in: query
name: ready_to_settle_at.lte
schema:
type: string
example: '?ready_to_settle_at.lte=2023-06-28T00:00:00'
style: form
QuerySort:
description: Specify key to be used for sorting the collection.
in: query
name: sort
schema:
type: string
style: form
QueryStatementDescriptorFilter:
description: Filter by `statement_descriptor`.
in: query
name: statement_descriptor
schema:
type: integer
style: form
QueryTraceIdFilter:
description: Filter by `trace_id`.
in: query
name: trace_id
schema:
type: string
style: form
QueryUpdatedAtGteFilter:
description: Filter where `updated_at` is after the given date.
in: query
name: updated_at.gte
schema:
type: string
style: form
QueryUpdatedAtLteFilter:
description: Filter where `updated_at` is before the given date.
in: query
name: updated_at.lte
schema:
type: string
style: form
QueryVoidFilter:
description: Filter by `idempotency_id`.
in: query
name: is_void
schema:
type: string
style: form
QueryBusinessName:
name: business_name
in: query
required: false
schema:
type: string
description: Filter by the full business name. Partial business names are not supported.
QueryBusinessType:
name: business_type
in: query
required: false
schema:
type: string
description: Filter by the business type. Partial business types are not supported.
QueryEmail:
name: email
in: query
required: false
schema:
type: string
example: user@example.org
description: Filter by the email address or email domain. Partial emails are not supported.
QueryFirstName:
name: first_name
in: query
required: false
schema:
type: string
example: Daphne
description: Filter by the first name of the person associated to the `Identity`.
QueryLastName:
name: last_name
in: query
required: false
schema:
type: string
example: kline
description: Filter by the last name of the person associated to the `Identity`.
QueryTitle:
name: title
in: query
required: false
schema:
type: string
example: ceo
description: Filter by the title if available.
QueryAccountLastFour:
name: account_last4
in: query
required: false
schema:
type: string
example: '9444'
description: Filter by the last 4 digits of the account if available.
QueryAccountRoutingNumber:
name: account_routing_number
in: query
required: false
schema:
type: string
example: '9444'
description: Filter by the account routing number if available.
QueryBin:
name: bin
in: query
required: false
schema:
type: string
example: '489514'
description: Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number.
QueryExpirationMonth:
name: expiration_month
in: query
required: false
schema:
type: string
example: '1'
description: Filter by the expiration month associated with the `Payment Instrument` if applicable. This filter only applies to payment cards.
QueryExpirationYear:
name: expiration_year
in: query
required: false
schema:
type: string
example: '2022'
description: Filter by the 4 digit expiration year associated with the Payment Instrument if applicable. This filter only applies to payment cards.
QueryLastFour:
name: last4
in: query
required: false
schema:
type: string
example: '0454'
description: Filter by the last 4 digits of the `Payment Instrument` card. This filter only applies to payment cards.
QueryName:
name: name
in: query
required: false
schema:
type: string
example: john%20smith
description: Filter by the name.
QueryOwnerIdentity:
name: owner_identity_id
in: query
required: false
schema:
type: string
example: IDcWwprrKrD6cSh225JWPri3
description: Filter by the owner id of the associated `Identity`.
QueryPaymentInstrumentType:
name: type
in: query
required: false
schema:
type: string
enum:
- ALL
- BANK_ACCOUNT
- PAYMENT_CARD
example: BANK_ACCOUNT
description: Filter by the `Payment Instrument` type.
QueryAfterCursor:
name: after_cursor
in: query
required: false
schema:
type: string
description: Return every resource created after the cursor value.
QueryBeforeCursor:
name: before_cursor
in: query
required: false
schema:
type: string
description: Return every resource created before the cursor value.
QueryFormat:
name: format
in: query
required: false
schema:
type: string
example: /download?format=json
description: Specify the format you'd like to download the response in (JSON is the only other format available for download).
TagsKey:
name: tags.key
in: query
required: false
schema:
type: string
description: 'Filter by the [`key` of a `Tag`](/api/overview/#section/Tags).'
TagsValue:
name: tags.value
in: query
required: false
schema:
type: string
description: 'Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags).'
QueryStatus:
name: status
in: query
required: false
schema:
type: string
enum:
- APPROVED
- AWAITING_APPROVAL
description: 'Filter by the status of the `Settlement`. Available values include:<ul><li>**APPROVED**<li>**AWAITING_APPROVAL**.</ul> Merchants only receive payouts when `Settlements` are **APPROVED**. For more information, see [Payouts](/docs/guides/payouts/payouts/).'
requestBodies:
CreateApplicationRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateApplicationRequest'
examples:
Create an Application:
value:
entity:
business_address:
city: San Mateo
country: USA
line1: 741 Douglass St
line2: Apartment 8
postal_code: '94114'
region: CA
business_name: Finix Flowers
business_phone: +1 (408) 756-4497
business_tax_id: '123456789'
business_type: LIMITED_LIABILITY_COMPANY
dob:
day: 27
month: 5
year: 1978
doing_business_as: Finix Flowers
email: user@example.org
first_name: John
last_name: Smith
max_transaction_amount: 1200000
personal_address:
city: San Mateo
country: USA
line1: 741 Douglass St
line2: Apartment 7
postal_code: '94114'
region: CA
phone: '14158885080'
tax_id: '123456789'
tags:
application_name: Finix Flowers
user: USpbnPYf1MMaYYtBqNsNzD6T
UpdateApplicationProfileRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateApplicationProfileRequest'
CreateAuthorizationRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAuthorizationRequest'
examples:
Authorization:
value:
amount: 100
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
order_number: 21DFASJSAKAS
Authorization - 3D Secure:
value:
3d_secure_authentication:
cardholder_authentication: BwABBJQ1AgAAAAAgJDUCAAAAAAA=
electronic_commerce_indicator: AUTHENTICATED
transaction_id: EaOMucALHQqLAEGAgk
amount: 100
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
order_number: 21DFASJSAKAS
Authorization - Authorization with CVV:
value:
amount: 100
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
security_code: '022'
source: PI6QyMT6W6c62u5bY8Y17TBj
Authorization - Buyer Charges:
value:
additional_buyer_charges:
convenience_amount: 150
amount: 5200
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
test: sale
Authorization - HSA or FSA Card:
value:
amount: 950
currency: USD
hsa_fsa_payment: true
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
order_number: 21DFASJSAKAS
Authorization - Level 2 Processing:
value:
additional_purchase_data:
customer_reference_number: 321xyz
sales_tax: 200
amount: 1000
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
order_number: 21DFASJSAKAS
Authorization - Level 3 Processing:
value:
additional_purchase_data:
customer_reference_number: 321xyz
customs_duty_amount: 10
discount_amount: 100
item_data:
- amount_excluding_sales_tax: 400
amount_including_sales_tax: 500
commodity_code: 175-62-20
cost_per_unit: 500
item_description: printing paper
item_discount_amount: 100
merchant_product_code: '1149611'
quantity: 1
unit_of_measure: BX
- amount_excluding_sales_tax: 400
amount_including_sales_tax: 500
commodity_code: 207-72-54
cost_per_unit: 500
item_description: printing ink
item_discount_amount: 0
merchant_product_code: '2149612'
quantity: 1
unit_of_measure: CTN
shipping_amount: 100
amount: 1000
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
order_number: 21DFASJSAKAS
Authorization - Partial Authorization:
value:
amount: 100
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
partial_authorization: true
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
order_number: 21DFASJSAKAS
Card Present Authorization - EMV Card:
value:
amount: 150
currency: USD
device: DVsEanpBtsAVvCHbNXkFaH6f
operation_key: CARD_PRESENT_AUTHORIZATION
tags:
order_number: test123transfer
Card Present Authorization - Non-EMV Card:
value:
amount: 150
currency: USD
device: DVsEanpBtsAVvCHbNXkFaH6f
operation_key: CARD_PRESENT_DEBIT
tags:
order_number: chris123transfer
UpdateAuthorizationRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAuthorizationRequest'
examples:
Capture Authorization:
value:
capture_amount: 100
fee: 0
Capture Authorization - Level 2/3 Processing:
value:
additional_purchase_data:
item_data:
- amount_excluding_sales_tax: 400
amount_including_sales_tax: 500
commodity_code: 175-62-20
cost_per_unit: 500
item_description: printing paper
item_discount_amount: 100
merchant_product_code: '1149611'
quantity: 1
unit_of_measure: BX
- amount_excluding_sales_tax: 400
amount_including_sales_tax: 500
commodity_code: 207-72-54
cost_per_unit: 500
item_description: printing ink
item_discount_amount: 0
merchant_product_code: '2149612'
quantity: 1
unit_of_measure: CTN
customer_reference_number: 321xyz
customs_duty_amount: 10
discount_amount: 100
shipping_amount: 100
capture_amount: 100
fee: 0
Void Authorization:
value:
void_me: true
Capture Card Present Authorization:
value:
capture_amount: 150
CreateDisputeEvidenceRequest:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateDisputeEvidenceRequest'
examples:
Upload Dispute Evidence:
value:
file: '@path/to/local/file'
CreateFeeRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFeeRequest'
examples:
One-Time Fee:
value:
amount: 1000
currency: USD
fee_subtype: CUSTOM
fee_type: CUSTOM
label: April_Performance_Analytics_Fees
merchant_id: MUhQVWbSdd3Da68RKpfodqEV
settlement_delay_days: 3
CreateFeeProfileRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFeeProfileRequest'
examples:
Create a Fee Profile:
value:
ach_basis_points: 300
ach_fixed_fee: 30
application: APmuwPBaW8pVcwb4vCTHQH32
basis_points: 200
card_cross_border_basis_points: 300
card_cross_border_fixed_fee: 400
charge_interchange: false
fixed_fee: 100
tags:
app pricing: sample
UpdateFeeRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFeeRequest'
examples: {}
CreateIdentityRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateIdentityRequest'
examples:
Identity - Merchant:
value:
additional_underwriting_data:
annual_ach_volume: 200000
average_ach_transfer_amount: 200000
average_card_transfer_amount: 200000
business_description: SB3 vegan cafe
card_volume_distribution:
card_present_percentage: 30
mail_order_telephone_order_percentage: 10
ecommerce_percentage: 60
credit_check_allowed: true
credit_check_ip_address: 42.1.1.113
credit_check_timestamp: '2021-04-28T16:42:55Z'
credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
merchant_agreement_accepted: true
merchant_agreement_ip_address: 42.1.1.113
merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)
refund_policy: MERCHANDISE_EXCHANGE_ONLY
volume_distribution_by_business_type:
other_volume_percentage: 0
consumer_to_consumer_volume_percentage: 0
business_to_consumer_volume_percentage: 0
business_to_business_volume_percentage: 100
person_to_person_volume_percentage: 0
entity:
annual_card_volume: 12000000
business_address:
city: San Mateo
country: USA
region: CA
line2: Apartment 8
line1: 741 Douglass St
postal_code: '94114'
business_name: Finix Flowers
business_phone: +1 (408) 756-4497
business_tax_id: '123456789'
business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
default_statement_descriptor: Finix Flowers
dob:
year: 1978
day: 27
month: 6
doing_business_as: Finix Flowers
email: user@example.org
first_name: John
has_accepted_credit_cards_previously: true
incorporation_date:
year: 1978
day: 27
month: 6
last_name: Smith
max_transaction_amount: 1200000
ach_max_transaction_amount: 1000000
mcc: '4900'
ownership_type: PRIVATE
personal_address:
city: San Mateo
country: USA
region: CA
line2: Apartment 7
line1: 741 Douglass St
postal_code: '94114'
phone: '14158885080'
principal_percentage_ownership: 50
tax_id: '123456789'
title: CEO
url: 'https://www.finix.com'
tags:
Studio Rating: '4.7'
Identity - Buyer:
value:
entity:
phone: '7145677613'
first_name: John
last_name: Smith
email: finix_example@finix.com
personal_address:
city: San Mateo
country: USA
region: CA
line2: Apartment 7
line1: 741 Douglass St
postal_code: '94114'
tags:
key: value
description: ''
CreateIdentitySettlementRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSettlementRequest'
examples:
Create a Settlement:
value:
currency: USD
processor: DUMMY_V1
tags:
Internal Daily Settlement ID: 21DFASJSAKAS
UpdateMerchantProfileRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMerchantProfileRequest'
examples:
Update the Fee Profile for a Merchant Profile:
value:
fee_profile: FP4xXhxyFRiRePKBQXmueVTh
CreateMerchantUnderwritingRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMerchantUnderwritingRequest'
examples:
Merchant:
value:
processor: DUMMY_V1
tags:
key_2: value_2
Merchant - Card Present Enabled:
value:
gateway: TRIPOS_CLOUD_V1
processor: VANTIV_V1
tags:
key_2: value_2
CreatePaymentInstrumentRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePaymentInstrumentRequest'
descriminator:
propertyName: type
examples:
Payment Instrument - Card:
value:
address:
city: San Francisco
country: USA
line1: 900 Metro Center Blv
postal_code: '94404'
region: CA
expiration_month: 12
expiration_year: 2029
identity: IDgWxBhfGYLLdkhxx2ddYf9K
name: John Smith
number: '5200828282828210'
security_code: '022'
type: PAYMENT_CARD
Payment Instrument - Bank Account:
value:
account_number: '123123123'
account_type: SAVINGS
bank_code: '123123123'
identity: IDpYDM7J9n57q849o9E9yNrG
name: John Smith
type: BANK_ACCOUNT
Payment Instrument - Token:
value:
token: TKiMxe323RE5Dq3wLVtG8kSW
type: TOKEN
identity: IDpYDM7J9n57q849o9E9yNrG
Payment Instrument - Apple Pay:
value:
identity: IDgWxBhfGYLLdkhxx2ddYf9K
merchant_identity: IDpYDM7J9n57q849o9E9yNrG
name: John Smith
third_party_token: '{"token":{"paymentMethod":{"network":"barcode","type":"credit","displayName":""},"transactionIdentifier":"AE514ADAA44E9C3A0A862C7E4EDEE43C422556FA4748B045F1764860557E8EE6","paymentData":{"data":"IOg9H5\/hdpccvHZ03ESJwlJXFlmcnI18WXTSOHOPA82ewYoWVyEMiy63HCsdejXsHIR8a+N\/5aR24OeJrkxheck2AAl5o1LLJ7jL+75scnf7Z55uQmtVyKITTkH22LrC6E6SgMnXaefJYOTUcG1Veqb\/dXtpPzqaKACEKDkbVivpDk+A2iX5PLROFTMRgmb9a0HYwHOnVGQzXwiHkX1g6f1R4rILUyMaQ5qLxCplE1t\/guEYmkGBtOb\/v8+GRDTl8YrC1tOe\/cs4aQm4cAKJktFQUTbfAApNFBnKI06mtCM7e7qRna\/YON3gyci035jA7Zq4kBMo7rQB8puGH6dDqB\/KsPS6Ps+w688+rqEKz16YUJ\/LMCOzzBM6bCTOS6eouB1eCh3SJdm\/lmY=","signature":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID4zCCA4igAwIBAgIITDBBSVGdVDYwCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE5MDUxODAxMzI1N1oXDTI0MDUxNjAxMzI1N1owXzElMCMGA1UEAwwcZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtUFJPRDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwhV37evWx7Ihj2jdcJChIY3HsL1vLCg9hGCV2Ur0pUEbg0IO2BHzQH6DMx8cVMP36zIg1rrV1O\/0komJPnwPE6OCAhEwggINMAwGA1UdEwEB\/wQCMAAwHwYDVR0jBBgwFoAUI\/JJxE+T5O8n5sT2KGw\/orv9LkswRQYIKwYBBQUHAQEEOTA3MDUGCCsGAQUFBzABhilodHRwOi8vb2NzcC5hcHBsZS5jb20vb2NzcDA0LWFwcGxlYWljYTMwMjCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZIhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRwOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNAYDVR0fBC0wKzApoCegJYYjaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGVhaWNhMy5jcmwwHQYDVR0OBBYEFJRX22\/VdIGGiYl2L35XhQfnm1gkMA4GA1UdDwEB\/wQEAwIHgDAPBgkqhkiG92NkBh0EAgUAMAoGCCqGSM49BAMCA0kAMEYCIQC+CVcf5x4ec1tV5a+stMcv60RfMBhSIsclEAK2Hr1vVQIhANGLNQpd1t1usXRgNbEess6Hz6Pmr2y9g4CJDcgs3apjMIIC7jCCAnWgAwIBAgIISW0vvzqY2pcwCgYIKoZIzj0EAwIwZzEbMBkGA1UEAwwSQXBwbGUgUm9vdCBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwHhcNMTQwNTA2MjM0NjMwWhcNMjkwNTA2MjM0NjMwWjB6MS4wLAYDVQQDDCVBcHBsZSBBcHBsaWNhdGlvbiBJbnRlZ3JhdGlvbiBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATwFxGEGddkhdUaXiWBB3bogKLv3nuuTeCN\/EuT4TNW1WZbNa4i0Jd2DSJOe7oI\/XYXzojLdrtmcL7I6CmE\/1RFo4H3MIH0MEYGCCsGAQUFBwEBBDowODA2BggrBgEFBQcwAYYqaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZXJvb3RjYWczMB0GA1UdDgQWBBQj8knET5Pk7yfmxPYobD+iu\/0uSzAPBgNVHRMBAf8EBTADAQH\/MB8GA1UdIwQYMBaAFLuw3qFYM4iapIqZ3r6966\/ayySrMDcGA1UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkiG92NkBgIOBAIFADAKBggqhkjOPQQDAgNnADBkAjA6z3KDURaZsYb7NcNWymK\/9Bft2Q91TaKOvvGcgV5Ct4n4mPebWZ+Y1UENj53pwv4CMDIt1UQhsKMFd2xd8zg7kGf9F3wsIW2WT8ZyaYISb1T4en0bmcubCYkhYQaZDwmSHQAAMYIBjDCCAYgCAQEwgYYwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTAghMMEFJUZ1UNjANBglghkgBZQMEAgEFAKCBlTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0yMjA0MDExODE2MjJaMCoGCSqGSIb3DQEJNDEdMBswDQYJYIZIAWUDBAIBBQChCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEINpyGxYyGbl1Kj57wU\/3PijxngHUcidFy9jukG9sccOHMAoGCCqGSM49BAMCBEcwRQIhAPHvbeAIDmJKf2YGS5xcCoySSeCeFf6ThUsKE3UIPWBJAiBQIZZu4wTlZn7R16N+2iTfvuvzJKgeSv8rAs3YM6z56AAAAAAAAA==","header":{"publicKeyHash":"eOvce9ya55opFC5EXVWlLwzZRVDEY3Hgakf3+C+0zkc=","ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE3VnkF5JR9cWuYoeT68dUNp\/2\/jGaOiid19UfCV9rEkcPomrzFWEZw\/dN1uU9RTblnrIQPajFj4R2ZKIpYIlkgA==","transactionId":"ae514adaa44e9c3a0a862c7e4edee43c422556fa4748b045f1764860557e8ee6"},"version":"EC_v1"}}}'
type: APPLE_PAY
Payment Instrument - Google Pay:
value:
identity: ID78Fh8mcnnzukVzbdoyex5y
merchant_identity: IDwhCCvPwCDEmiFd8Be7pDzN
name: Finix Sandbox
third_party_token: '{"signature":"MEYCIQCYTkaEMgug7pcjzEEdbIn+R57kYO5yYc2KYj41AQQn9wIhAN1QvylvZ2XydVecfejwi2xYS9y3Y9y/MmDnRnUfNw5H","intermediateSigningKey":{"signedKey":"{\"keyValue\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE4xc3fjeM9SMTjd1TL2GQCPmgqPf2h42aM3akPh/mTUBqWEgOITruK10A02rQ+4YZOvLCpQKQZzLSAd09nctnuA\\u003d\\u003d\",\"keyExpiration\":\"1648843199734\"}","signatures":["MEQCICwCI4s5YCLu4qRCyXwSJ3qG8y3ocFtP1Mque4Uzysl8AiARoD/0qbj5W0Q2PWKpxkEnfcP+nU5kwYS8FyQ9boDTmQ\u003d\u003d"]},"protocolVersion":"ECv2","signedMessage":"{\"encryptedMessage\":\"roD4ikTpZ7Srunq+0zUnp+eiXzcuZBfIFSuZAJu1PQLXcP0RvnGDiGKtoarNCHvn+cnXsHCzIBWXMZSJ9Aglqky9VfP5a+qsXQhf5m5AFUbT2xnihtKwageGQQK6HzyjHSXXSjvuCzeo75ToOgIUxLFASZyaZ89u3Jifqhhc2c4a0Mtlx564BxXiwcxDFdtNkOle7uAIsJzsryk7Rcwgr8ZMJJM//XpvaeE5wNmkVFHUtR2uTqPm0BvkoYkFHCTRo4NHXWpxeLjXWzKGk2ELyTK1diuCa6c9ig0jO3t8BIh1cR63UeP8Ar7u5fh8C9FPPAsgPbTGLfiaRe615e4SxASgcZ4/8uWo5mikEPFqA5s2K2mid9ncXoMNYaHUc3qzJAyxHVYSd5SRNZYXHMkEcWcjnpDx+ErYjR1sMo1LMYXfrfGyZz3M69bQLKPYFe7ChjvgFI9MnfcFTNB4HAdNKMhbZT0EKinfxxGWkT7LVbGnUuqPlHp4toCe4kpbx7fulwXTj3bAFvg/qvxxwGOS38iP0HR/f+4GF0xHspqYVbdWdIJ5iJUdpBG8Nu5P56h2GEDxXMkKSmh+qbvKWlYipNNGoeg8uHc\\u003d\",\"ephemeralPublicKey\":\"BMqIyb1IyXhuZ4YpWm1PiRr74i3tCwDfQqJ1P4OZ3zK4Rq16SuwgJ605fCEvlViwSQuo2Hpv+CcR+2D3+/YrLB8\\u003d\",\"tag\":\"5K4LlTucDK7jAThbIozYtyoxX95hRNd5cJJGfxWAxw8\\u003d\"}"}'
type: GOOGLE_PAY
description: ''
CreateProcessorRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProcessorRequest'
examples:
'Enable an Application Processor ':
value:
config:
canDebitBankAccount: true
type: DUMMY_V1
UpdateProcessorRequest:
content:
application/json:
schema:
type: object
CreateReversalRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateReversalRequest'
examples:
Refund Transfer:
value:
refund_amount: 100
tags:
test: refund
Refund Transfer - Card Present:
value:
device: DVkBqa68V1ZQusodU8o6mB62
refund_amount: 150
Refund Transfer - Swiped Card:
value:
amount: 150
currency: USD
device: DVsEanpBtsAVvCHbNXkFaH6f
operation_key: CARD_PRESENT_UNREFERENCED_REFUND
tags:
test: refund
Refund Transfer - Split Transaction:
value:
refund_amount: 1000
split_transfers:
- merchant: MU4jpoNGRkAyjBxumZhGa6Hc
amount: 600
tags:
key: value
- merchant: MUeHUEPKybMjqV1STcqrFTSH
amount: 300
- merchant: MU3Gh6DT5fCBxVtWB8VJc1St
amount: 100
tags:
test: refund
CreateSettlementRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSettlementRequest'
CreateTransferRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTransferRequest'
examples:
Transfer:
value:
amount: 662154
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
test: sale
Transfer - 3D Secure:
value:
3d_secure_authentication:
cardholder_authentication: BwABBJQ1AgAAAAAgJDUCAAAAAAA=
electronic_commerce_indicator: AUTHENTICATED
transaction_id: EaOMucALHQqLAEGAgk
amount: 92169
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
test: sale
Transfer - Card Verification Checks:
value:
amount: 662154
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
security_code: '022'
source: PIe2YvpcjvoVJ6PzoRPBK137
Transfer - Buyer Charges:
value:
additional_buyer_charges:
convenience_amount: 150
amount: 5200
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
test: sale
Transfer - Debit Bank Account:
value:
amount: 6031
currency: USD
fee: 603
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIr1Ru7ewBkEYVVn7SP1u5FW
tags:
order_number: 21DFASJSAKAS
Transfer - HSA or FSA Cards:
value:
amount: 950
currency: USD
hsa_fsa_payment: true
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
order_number: 21DFASJSAKAS
Transfer - Level 2 Processing:
value:
additional_purchase_data:
customer_reference_number: 321xyz
sales_tax: 200
amount: 1000
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
test: sale
Transfer - Level 3 Processing:
value:
additional_purchase_data:
item_data:
- amount_excluding_sales_tax: 400
amount_including_sales_tax: 500
commodity_code: 175-62-20
cost_per_unit: 500
item_description: printing paper
item_discount_amount: 100
merchant_product_code: '1149611'
quantity: 1
unit_of_measure: BX
- amount_excluding_sales_tax: 400
amount_including_sales_tax: 500
commodity_code: 207-72-54
cost_per_unit: 500
item_description: printing ink
item_discount_amount: 0
merchant_product_code: '2149612'
quantity: 1
unit_of_measure: CTN
customer_reference_number: 321xyz
customs_duty_amount: 10
discount_amount: 100
shipping_amount: 100
amount: 1000
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
test: sale
Transfer - Partial Authorization:
value:
amount: 662154
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
partial_authorization: true
source: PIe2YvpcjvoVJ6PzoRPBK137
tags:
test: sale
Transfer - Split Transaction:
value:
amount: 1000
currency: USD
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
source: PIe2YvpcjvoVJ6PzoRPBK137
split_transfers:
- merchant: MUeDVrf2ahuKc9Eg5TeZugvs
amount: 600
tags:
key: value
- merchant: MUeHUEPKybMjqV1STcqrFTSH
amount: 300
- merchant: MU3Gh6DT5fCBxVtWB8VJc1St
amount: 100
tags:
test: sale
Card Present Transfer - EMV Card:
value:
amount: 150
currency: USD
device: DVsEanpBtsAVvCHbNXkFaH6f
operation_key: CARD_PRESENT_DEBIT
tags:
order_number: chris123transfer
Card Present Transfer - Manual Entry:
value:
amount: 150
currency: USD
device: DVsEanpBtsAVvCHbNXkFaH6f
device_configuration:
prompt_manual_entry: true
operation_key: CARD_PRESENT_DEBIT
tags:
order_number: chris123transfer
Card Present Transfer - Non-EMV Card:
value:
amount: 150
currency: USD
device: DVsEanpBtsAVvCHbNXkFaH6f
operation_key: CARD_PRESENT_DEBIT
tags:
order_number: chris123transfer
UpdateDeviceRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDeviceRequest'
examples:
Device - Activated (DATACAP_V1):
value:
action: ACTIVATE
Device - Activated (TRIPOS_CLOUD_V1):
value:
action: ACTIVATE
activation_code: '609732'
Reboot Device:
value:
action: REBOOT
Device - Idle Message Set:
value:
action: CREATE_IDLE_MESSAGE
idle_message: Finix Flowers
Device - Deactivated:
value:
action: DEACTIVATE
Device - Update Details:
value:
configuration:
allow_debit: true
bypass_device_on_capture: true
prompt_signature: NEVER
description: Flowers
name: Finix Flowers - triPOS
CreateUserRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserRequest'
CreateVerificationRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVerificationRequest'
examples:
Payment Instrument - Verify a Card’s CVV:
value:
merchant: MUgWbPVvtKbzjKNNGKqdQYV7
security_code: '123'
verify_payment_card: true
Payment Instrument - Verify a Card’s Address:
value:
address:
city: San Francisco
country: USA
line1: 900 Metro Center Blv
postal_code: '94404'
region: CA
merchant: MUgWbPVvtKbzjKNNGKqdQYV7
verify_payment_card: true
Payment Instrument - Verify Push-to-Card Eligibility:
value:
processor: VISA_V1
tags:
card_name: Business_Card
CreateWebhookRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWebhookRequest'
examples:
Webhook:
value:
authentication:
type: NONE
url: 'https://example.com/event_handler'
Webhook - Basic Authentication:
value:
authentication:
type: BASIC
basic:
username: basic-auth-username
password: basic-auth-password
url: 'https://example.com/event_handler'
Webhook - Bearer Token Authentication:
value:
authentication:
type: BEARER
bearer:
token: U3VwZXIgc2VjcmV0IGVuY29kZWQgdG9rZW4=
enabled: true
url: 'https://example.com/event_handler'
UpdateTransferRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTransferRequest'
examples:
example-1:
value:
tags:
test: sale
UpdateSettlementRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSettlementRequest'
CreateSubscriptionAmountRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSubscriptionAmountRequest'
examples:
Create a POS_INSTALLMENT_FEE amount:
value:
amount_type: FEE
fee_amount_data:
amount: 2500
currency: USD
label: POS_INSTALLMENT_FEE
nickname: POS_INSTALLMENT_FEE
tags:
order_number: '124'
UpdateSubscriptionAmountRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSubscriptionAmountRequest'
examples:
Update a Subscription Amount:
value:
amount_type: FEE
fee_amount_data:
amount: 2500
currency: USD
label: POS_INSTALLMENT_FEE
nickname: POS_INSTALLMENT_FEE
tags:
order_number: '124'
CreateSubscriptionScheduleRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSubscriptionScheduleRequest'
examples:
Subscription Schedule - FIXED_TIME_INTERVAL:
value:
line_item_type: FEE
nickname: Fixed_Time_Subscription_Schedule
fixed_time_interval_offset:
interval_count: 4
hourly_interval: 24
subscription_type: FIXED_TIME_INTERVAL
Subscription Schedule - PERIODIC_MONTHLY:
value:
line_item_type: FEE
period_offset:
day: 1
month: null
nickname: Monthly_Subscription_Schedule
subscription_type: PERIODIC_MONTHLY
Subscription Schedule - PERIODIC_YEARLY:
value:
line_item_type: FEE
period_offset:
day: 5
month: 1
nickname: Yearly_Subscription_Schedule
subscription_type: PERIODIC_YEARLY
UpdateSubscriptionScheduleRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSubscriptionScheduleRequest'
examples:
Update Tags:
value:
tags:
order-reference: A1B2C3D4E5
CreateSubscriptionEnrollmentRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSubscriptionEnrollmentRequest'
examples:
Example of a "Security Fee":
value:
merchant: MUucec6fHeaWo3VHYoSkUySM
nickname: Security Fee
started_at: '2022-11-11T16:50:59.891Z'
tags:
enrollment_info: Security Fee Enrollment
UpdateSubscriptionEnrollmentRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSubscriptionEnrollmentRequest'
UpdateUserRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserRequest'
examples:
Update User:
value:
tags:
card_name: New Employee
CreateDeviceRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDevice'
examples:
Create a Device:
value:
configuration:
allow_debit: true
bypass_device_on_capture: true
prompt_signature: NEVER
description: John Smith
model: MX915
name: 'Finix triPOS #1'
UpdatePaymentInstrumentRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePaymentInstrumentRequest'
examples:
Payment Instrument - Update a Card's Address:
value:
address:
city: Los Angeles
region: CA
postal_code: '90036'
line1: 270 Lincoln Center Blv
line2: Suite 1A
country: USA
merchant: MUjJUJxMKoL24H8MotYNjtZP
verify_payment_card: true
Payment Instrument - Disable a Payment Instrument:
value:
enabled: false
tags:
card_name: Personal Card
Payment Instrument - Bank Account Validation Check:
value:
attempt_bank_account_validation_check: 'true'
Payment Instrument - Update Payment Instrument Tags:
value:
tags:
card_name: Personal Card
UpdateMerchantRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMerchantRequest'
examples:
Merchant - Disable a Merchant:
value:
processing_enabled: false
Merchant - Enable Buyer Charges:
value:
convenience_charges_enabled: true
rent_surcharges_enabled: true
Merchant - Enable Level 2/3 Processing:
value:
level_two_level_three_data_enabled: true
Merchant - Enable Partial Authorizations:
value:
default_partial_authorization_enabled: true
UpdateIdentityRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateIdentityRequest'
examples:
Update an Identity:
value:
entity:
email: user@example.org
first_name: John
last_name: Smith
phone: '7145677613'
CreateAssociatedIdentityRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAssociatedIdentityRequest'
examples:
Associated Identity:
value:
entity:
dob:
day: 1
month: 1
year: 2013
email: john.smith@company1.com
first_name: John
last_name: Smith
personal_address:
city: San Francisco
country: USA
line1: 123 Main Street
postal_code: '90650'
region: CA
phone: '14158885080'
principal_percentage_ownership: 25
tax_id: '123456789'
title: Founder
CreateBalanceTransferRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBalanceTransferRequest'
examples:
Create a Balance Transfer:
value:
amount: 4000
currency: USD
description: Need to increase buffer given the high number of NSFs on merchant fee debits
destination: FOR_BENEFIT_OF_ACCOUNT
processor_type: LITLE_V1
source: OPERATING_ACCOUNT
tags:
example: documentation tag
CreateInstrumentUpdateRequest:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateInstrumentUpdateRequest'
examples:
Instrument Update Request:
value:
request: '{"merchant": "MUucec6fHeaWo3VHYoSkUySM","idempotency_id": "123xyz testing"}'
description: ''
CreateFileRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFileRequest'
examples:
Create a File:
value:
display_name: My Drivers License
linked_to: MU2n7BSovtwYsWYZF6rBnnzk
tags:
key_1: value_1
type: DRIVERS_LICENSE_FRONT
CreateExternalLinkRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateExternalLinkRequest'
examples:
Create an External Link:
value:
duration: 15
type: UPLOAD
CreateApplePaySessionRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplePaySessionRequest'
examples:
Create an Apple Pay Session:
value:
display_name: Finix Test Merchant
domain: www.finixtestmerchant.com
merchant_identity: IDmULj61C8ke6Y7qQiKENJ7
validation_url: 'https://apple-pay-gateway-cert.apple.com/paymentservices/paymentSession'
RemoveSettlementTransfer:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveSettlementTransfer'
examples:
Remove a Transfer in a Settlement:
value:
transfers:
- TRr61njQxaa7AJf6E1C3QwCc
UploadFileRequest:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/UploadFileRequest'
UpdateWebhookRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWebhookRequest'
examples:
Update Webhook:
value:
enabled: true
url: 'https://eohzjuj2prziycz.m.pipedream.net'
Filter Webhook Events:
value:
enabled_events:
- entity: merchant
types:
- created
- underwritten
- entity: transfer
types:
- created
UpdateComplianceForm:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComplianceFormRequest'
examples:
Complete Compliance Form:
value:
pci_saq_a:
ip_address: 42.1.1.113
name: John Smith
signed_at: '2022-03-18T16:42:55Z'
title: CTO
user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
CreateOnboardingFormRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOnboardingFormRequest'
examples:
Create an Onboarding Form:
value:
onboarding_data:
entity:
title: CEO
first_name: John
last_name: Smith
email: john.smith@finix.com
business_name: Finix Flowers
business_type: CORPORATION
doing_business_as: Finix Flowers
phone: '14158885080'
business_phone: '14158885080'
personal_address:
city: Seattle
country: USA
line1: 123 Boren Ave
postal_code: '98040'
region: WA
business_address:
city: Bellevue
country: USA
line1: 123 Bellevue Way
postal_code: '98039'
region: WA
dob:
day: 13
month: 4
year: 1982
incorporation_date:
day: 9
month: 3
year: 2018
mcc: '4900'
url: 'https://www.finix.com'
ownership_type: PRIVATE
default_statement_descriptor: DEMOCOMPANY
max_transaction_amount: 100000
annual_card_volume: 1000000
principal_percentage_ownership: 75
tax_id: '123456789'
business_tax_id: '123456789'
has_accepted_credit_cards_previously: false
additional_underwriting_data:
refund_policy: NO_REFUNDS
card_volume_distribution:
ecommerce_percentage: 100
card_present_percentage: 0
mail_order_telephone_order_percentage: 0
average_ach_transfer_amount: 200000
average_card_transfer_amount: 20000
annual_ach_volume: 2000000
business_description: CONSUMER
volume_distribution_by_business_type:
other_volume_percentage: 0
person_to_person_volume_percentage: 0
business_to_business_volume_percentage: 90
business_to_consumer_volume_percentage: 10
consumer_to_consumer_volume_percentage: 0
associated_entities:
- title: CFO
first_name: Alex
last_name: Smith
email: alex.smith@finix.com
phone: '14158885080'
personal_address:
city: Bellevue
country: USA
line1: 4848 84th St
postal_code: '98032'
region: WA
dob:
day: 13
month: 4
year: 1985
principal_percentage_ownership: 25
tax_id: '123456789'
payment_instruments:
name: SARAH BANKER
bank_code: '123456789'
account_number: '123456789'
account_type: CHECKING
type: BANK_ACCOUNT
max_transaction_amount: 100000
merchant_processors:
- processor: LITLE_V1
onboarding_link_details:
return_url: 'https://www.finixflowers.com/'
expired_session_url: 'https://www.finixflowers.com/login'
terms_of_service_url: 'https://www.finixflowers.com/ToS'
fee_details_url: 'https://www.finixflowers.com/fee_details'
expiration_in_minutes: 10080
CreateOnboardingFormLinkRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOnboardingFormLinkRequest'
examples:
Create an Onboarding Form Link:
value:
expiration_in_minutes: 10080
expired_session_url: 'https://www.finix.com/'
fee_details_url: 'https://www.finix.com/docs'
return_url: 'https://www.finix.com/docs'
terms_of_service_url: 'https://www.finix.com/terms-and-policies'
UpdatePayoutProfileRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePayoutProfileRequest'
examples:
Payout Profile - Gross:
value:
type: GROSS
gross:
payouts:
frequency: DAILY
submission_delay_days: '1'
payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
rail: SAME_DAY_ACH
fees:
frequency: MONTHLY
day_of_month: '1'
submission_delay_days: '3'
payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
rail: SAME_DAY_ACH
Payout Profile - Net:
value:
type: NET
net:
frequency: CONTINUOUS
submission_delay_days: '1'
payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
rail: SAME_DAY_ACH
VoidAuthorizationRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/VoidAuthorization'
examples:
Void Authorization:
value:
void_me: true
SubmitDisputeEvidence:
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitDisputeEvidence'
examples:
Example 1:
value:
note: '"Submitting Dispute Evidence: July 23rd Receipt"'
UpdateDisputeEvidence:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDisputeEvidence'
examples:
Dispute - Tags:
value:
tags:
order_number: 41BFASJSAKAS
AcceptDisputeRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/AcceptDispute'
examples:
Dispute Accepted:
value:
note: 'Accepting Dispute: Valid Reason'
CloseSettlement:
content:
application/json:
schema:
$ref: '#/components/schemas/CloseSettlement'
examples:
Close Settlement:
value:
action: STOP_ACCRUAL
CreateSplitTransferRequest:
content:
application/json:
schema:
type: object
CreateMerchantVerificationRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/MerchantPIVerification'
examples:
Merchant - Reverify a Merchant:
value: {}
responses:
Application:
description: Single application object
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
examples:
Application Created:
value:
id: APgPDQrLD52TYvqazjHJJchM
created_at: '2022-01-27T07:36:33.59Z'
updated_at: '2022-01-27T07:44:04.94Z'
card_cvv_required: false
card_expiration_date_required: true
creating_transfer_from_report_enabled: true
enabled: true
fee_ready_to_settle_upon: RECONCILIATION
name: BrainTree
owner: IDuquemzE7UkUJioGJfVKBKt
processing_enabled: true
ready_to_settle_upon: RECONCILIATION
settlement_enabled: true
settlement_funding_identifier: UNSET
tags:
application_name: BrainTree
_links:
self:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
processors:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/processors'
users:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/users'
owner_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt'
transfers:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/transfers'
disputes:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/disputes'
authorizations:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/authorizations'
settlements:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/settlements'
merchants:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/merchants'
identities:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/identities'
webhooks:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/webhooks'
reversals:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/reversals'
tokens:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/tokens'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/payment_instruments'
application_profile:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/application_profile'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
ApplicationProfile:
description: Single application_profile object
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationProfile'
examples:
Application Profile:
value:
id: PPqjTEKAmRNGLquQUeLKmXhi
created_at: '2022-01-27T07:36:33.65Z'
updated_at: '2022-01-27T07:37:38.07Z'
application: APgPDQrLD52TYvqazjHJJchM
fee_profile: FPvCQUcnsueN3Bc3zR1qCBG8
risk_profile: RPvF6X3AcLnvMby9wBkaVoBi
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/application_profiles/PPqjTEKAmRNGLquQUeLKmXhi'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
risk_profile:
href: 'https://finix.sandbox-payments-api.com/risk_profiles/RPvF6X3AcLnvMby9wBkaVoBi'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
ApplicationProfilesList:
description: List of application_profile objects
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationProfilesList'
examples:
List of Application Profiles:
value:
_embedded:
application_profiles:
- id: PPqjTEKAmRNGLquQUeLKmXhi
created_at: '2022-01-27T07:36:33.65Z'
updated_at: '2022-01-27T07:37:38.07Z'
application: APgPDQrLD52TYvqazjHJJchM
fee_profile: FPvCQUcnsueN3Bc3zR1qCBG8
risk_profile: RPvF6X3AcLnvMby9wBkaVoBi
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/application_profiles/PPqjTEKAmRNGLquQUeLKmXhi'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
risk_profile:
href: 'https://finix.sandbox-payments-api.com/risk_profiles/RPvF6X3AcLnvMby9wBkaVoBi'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/application_profiles?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 1
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
ApplicationsList:
description: List of `Applications`.
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationsList'
examples:
List of Applications:
value:
_embedded:
applications:
- id: APdoThHn4jjYUSxQf76txAgg
created_at: '2022-09-20T23:03:21.74Z'
updated_at: '2022-09-20T23:03:21.74Z'
card_cvv_required: false
card_expiration_date_required: true
creating_transfer_from_report_enabled: false
enabled: true
fee_ready_to_settle_upon: RECONCILIATION
name: Abhishek Test
owner: IDpxUfpKm1UCqtx5N4SkqVr5
processing_enabled: true
ready_to_settle_upon: RECONCILIATION
settlement_enabled: true
settlement_funding_identifier: UNSET
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg'
processors:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/processors'
users:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/users'
owner_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDpxUfpKm1UCqtx5N4SkqVr5'
transfers:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/transfers'
disputes:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/disputes'
authorizations:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/authorizations'
settlements:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/settlements'
merchants:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/merchants'
identities:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/identities'
webhooks:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/webhooks'
reversals:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/reversals'
tokens:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/tokens'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/payment_instruments'
application_profile:
href: 'https://finix.sandbox-payments-api.com/applications/APdoThHn4jjYUSxQf76txAgg/application_profile'
- id: APrpAfFbr9TqMw1FXLAD6vNg
created_at: '2022-04-29T00:48:15.01Z'
updated_at: '2022-04-29T00:48:16.56Z'
card_cvv_required: false
card_expiration_date_required: true
creating_transfer_from_report_enabled: false
enabled: true
fee_ready_to_settle_upon: RECONCILIATION
name: BrainTree
owner: IDfEzc4SsQkk1FN516DDQWuj
processing_enabled: true
ready_to_settle_upon: RECONCILIATION
settlement_enabled: true
settlement_funding_identifier: UNSET
tags:
application_name: BrainTree
_links:
self:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg'
processors:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/processors'
users:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/users'
owner_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDfEzc4SsQkk1FN516DDQWuj'
transfers:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/transfers'
disputes:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/disputes'
authorizations:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/authorizations'
settlements:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/settlements'
merchants:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/merchants'
identities:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/identities'
webhooks:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/webhooks'
reversals:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/reversals'
tokens:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/tokens'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/payment_instruments'
application_profile:
href: 'https://finix.sandbox-payments-api.com/applications/APrpAfFbr9TqMw1FXLAD6vNg/application_profile'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/applications?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/applications?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/applications?offset=110400&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 110412
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
Authorization:
description: Single Authorization object
content:
application/json:
schema:
$ref: '#/components/schemas/Authorization'
examples:
Authorization:
value:
id: AUvZbBaTJkFCbiAMrGtc66ko
created_at: '2022-10-11T02:27:39.10Z'
updated_at: '2022-10-11T02:27:39.48Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2022-10-18T02:27:39.10Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
order_number: 21DFASJSAKAS
trace_id: e1a10287-4909-4aa7-9cb7-abd069a3b833
transfer: null
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUvZbBaTJkFCbiAMrGtc66ko'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Authorization - 3D Secure:
value:
id: AUtmuV1dapVdEe16ivUEUhSE
created_at: '2022-10-11T02:28:28.50Z'
updated_at: '2022-10-11T02:28:28.66Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2022-10-18T02:28:28.50Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
order_number: 21DFASJSAKAS
trace_id: 20374045-2f90-48f4-80e0-7edf32b9e626
transfer: null
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUtmuV1dapVdEe16ivUEUhSE'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Authorization - Authorization with CVV:
value:
id: AUg5fBP1vDXcFtSdiL3e4vzp
created_at: '2022-10-11T02:32:54.64Z'
updated_at: '2022-10-11T02:32:55.05Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2022-10-18T02:32:54.64Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
security_code_verification: MATCHED
source: PI6QyMT6W6c62u5bY8Y17TBj
state: SUCCEEDED
tags: {}
trace_id: 526f28d0-73eb-46d6-b78c-aad6ab891dba
transfer: null
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUg5fBP1vDXcFtSdiL3e4vzp'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Authorization - Buyer Charges:
value:
id: AUt6moAj3sgpszzC3n9cRZKN
created_at: '2023-12-06T17:47:03.85Z'
updated_at: '2023-12-06T17:47:03.85Z'
3ds_redirect_url: null
additional_buyer_charges:
convenience_amount: 150
surcharge_amount: 0
rent_surcharge_amount: 0
additional_healthcare_data: null
additional_purchase_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 5200
amount_requested: 5200
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2023-12-13T17:47:03.85Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
receipt_last_printed_at: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
test: sale
trace_id: a81e66e9-73d4-4112-88da-8b4ac7afd381
transfer: null
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUt6moAj3sgpszzC3n9cRZKN'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Authorization - HSA or FSA Card:
value:
id: AUo8BiLgvzZzT41KBB7C8GQo
created_at: '2022-10-10T06:32:17.04Z'
updated_at: '2022-10-10T06:32:17.30Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 950
amount_requested: 950
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2022-10-17T06:32:17.04Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
order_number: 21DFASJSAKAS
trace_id: f702ed93-d38d-430d-8924-a09d946e037c
transfer: null
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUo8BiLgvzZzT41KBB7C8GQo'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Authorization - Level 2 Processing:
value:
id: AUpkH5f8YoLe2DBNKgqCua4N
created_at: '2022-10-11T02:28:59.99Z'
updated_at: '2022-10-11T02:29:00.47Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 1000
amount_requested: 1000
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2022-10-18T02:28:59.99Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
order_number: 21DFASJSAKAS
trace_id: 595ef280-35b9-4566-8884-7333739245f9
transfer: null
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUpkH5f8YoLe2DBNKgqCua4N'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Authorization - Level 3 Processing:
value:
id: AUeNCQ37HbQgVQtToJiUtxpd
created_at: '2022-10-11T02:29:36.07Z'
updated_at: '2022-10-11T02:29:36.24Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 1000
amount_requested: 1000
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2022-10-18T02:29:36.07Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
order_number: 21DFASJSAKAS
trace_id: 3ce1a866-6a38-4a3b-b993-6ac9529afa53
transfer: null
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUeNCQ37HbQgVQtToJiUtxpd'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Authorization - Partial Authorization:
value:
id: AUrBzPBRPdBC9pBtNYM4Vb2m
created_at: '2023-10-12T21:13:19.19Z'
updated_at: '2023-10-12T21:13:19.19Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
additional_purchase_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2023-10-19T21:13:19.19Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
receipt_last_printed_at: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
order_number: 21DFASJSAKAS
trace_id: 1e5b3eca-d460-4c4f-8d31-6832ae6da642
transfer: null
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUrBzPBRPdBC9pBtNYM4Vb2m'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Card Present Authorization - EMV Card:
value:
id: AUarp7Pz21Low4u2Urw5Ub4W
created_at: '2019-04-29T20:44:00.13Z'
updated_at: '2022-10-10T05:59:17.59Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 3138
amount_requested: 3138
application: APeUbTUjvYb1CdPXvNcwW1wP
card_present_details:
emv_data:
application_identifier: A0000001523010
application_label: DISCOVER
application_preferred_name: null
application_transaction_counter: '0005'
cryptogram: ARCQ F666F8891F870D33
issuer_code_table_index: null
pin_verified: false
tags: null
masked_account_number: '************0059'
name: Test Card 05
brand: DISCOVER
entry_mode: CHIP_ENTRY
payment_type: CREDIT
approval_code: '004839'
currency: USD
device: DVfKLD9GZtsjcJxLtc2yCcfd
expires_at: '2019-05-06T20:44:00.13Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MU4LYrniAvqVKUBqcATb7Y7p
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages: []
raw: null
security_code_verification: null
source: PImTHaz7XVPx4M7mhu9x8gkU
state: SUCCEEDED
tags:
TicketNumber: '45878'
trace_id: FNX35FSuraeKKJr65wkGVFJni
transfer: TRqQCAX7nYHUnkE5YPFTknqd
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUarp7Pz21Low4u2Urw5Ub4W'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRqQCAX7nYHUnkE5YPFTknqd'
device:
href: 'https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR'
Card Present Authorization - Non-EMV Card:
value:
id: AUarp7Pz21Low4u2Urw5Ub4W
created_at: '2019-04-29T20:44:00.13Z'
updated_at: '2022-10-10T05:59:17.59Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 3138
amount_requested: 3138
application: APeUbTUjvYb1CdPXvNcwW1wP
card_present_details:
emv_data:
application_identifier: A0000001523010
application_label: DISCOVER
application_preferred_name: null
application_transaction_counter: '0005'
cryptogram: ARCQ F666F8891F870D33
issuer_code_table_index: null
pin_verified: false
tags: null
masked_account_number: '************0059'
name: Test Card 05
brand: DISCOVER
entry_mode: CHIP_ENTRY
payment_type: CREDIT
approval_code: '004839'
currency: USD
device: DVfKLD9GZtsjcJxLtc2yCcfd
expires_at: '2019-05-06T20:44:00.13Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MU4LYrniAvqVKUBqcATb7Y7p
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages: []
raw: null
security_code_verification: null
source: PImTHaz7XVPx4M7mhu9x8gkU
state: SUCCEEDED
tags:
TicketNumber: '45878'
trace_id: FNX35FSuraeKKJr65wkGVFJni
transfer: TRqQCAX7nYHUnkE5YPFTknqd
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUarp7Pz21Low4u2Urw5Ub4W'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRqQCAX7nYHUnkE5YPFTknqd'
device:
href: 'https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR'
Voided Authorization:
value:
id: AUeYYckKJTrBVu1j8FYLzJ3W
created_at: '2022-10-07T18:25:23.30Z'
updated_at: '2022-10-07T18:29:59.38Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2022-10-14T18:25:23.30Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: true
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
order_number: 21DFASJSAKAS
trace_id: 560e44af-5d22-4af2-801e-03d2dad69dc7
transfer: null
void_state: SUCCEEDED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUeYYckKJTrBVu1j8FYLzJ3W'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
AuthorizationsList:
description: List of Authorization objects
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationsList'
examples:
List of Authorizations:
value:
_embedded:
authorizations:
- id: AUoCse3evsJWctBbh6hSEsZj
created_at: '2022-10-10T06:14:57.84Z'
updated_at: '2022-10-10T06:14:58.28Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 150
amount_requested: 150
application: APeUbTUjvYb1CdPXvNcwW1wP
card_present_details:
emv_data: null
masked_account_number: null
name: null
brand: null
entry_mode: null
payment_type: NONE
approval_code: null
currency: USD
device: DVsEanpBtsAVvCHbNXkFaH6f
expires_at: '2022-10-17T06:14:57.84Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages:
- LaneID 1 does not exist.
- 'Authorization AUoCse3evsJWctBbh6hSEsZj could not be submitted. Cause: LaneID 1 does not exist.'
- DECLINED
raw:
approved_amount: 0
convenience_fee_amount: 0
currency_code: None
is_approved: false
is_offline: false
payment_type: None
pin_verified: false
status_code: None
sub_total_amount: 0
tip_amount: 0
total_amount: 0
order_id: FNXhDjLCPDzR33zk8jjTicZv2
lane_id: 1
_errors:
- developer_message: "ERROR:POST error\r\nEXCEPTION: LaneID 1 does not exist.\r\n"
error_type: ''
exception_message: LaneID 1 does not exist.
exception_type_full_name: TriPos.Shared.Exceptions.PinPadNotFoundException
exception_type_short_name: PinPadNotFoundException
user_message: ''
_links: []
_processor:
logs:
- LaneID 1 does not exist.
processor_logs:
- LaneID 1 does not exist.
processor_request_failed: false
processor_request_was_approved: false
processor_response_code: Unknown
_type: authorizationResponse
_warnings: []
security_code_verification: null
source: PIg2q5tVAPcHpUpbJBNe4Vus
state: FAILED
tags:
order_number: chris123transfer
trace_id: FNXhDjLCPDzR33zk8jjTicZv2
transfer: null
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUoCse3evsJWctBbh6hSEsZj'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP'
device:
href: 'https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR'
- id: AUuRnfhaBm84RhHyonkHAUrt
created_at: '2022-08-01T22:14:13.31Z'
updated_at: '2022-08-01T22:14:13.44Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 100
amount_requested: 100
application: AP3AB2itAWrrrPVS6spvrGYp
currency: USD
expires_at: '2022-08-08T22:14:13.31Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant_identity: IDsArLxCm9QGbi2QfhaFrTED
messages: []
raw:
additional_large_number: 9223372036854776000
value: 100
order_id: e770db75-fbf6-4efb-afe7-57aedd7ac40d
security_code_verification: MATCHED
source: PIbDnouV59En1yKfYUNLTpG9
state: SUCCEEDED
tags: {}
trace_id: e770db75-fbf6-4efb-afe7-57aedd7ac40d
transfer: null
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUuRnfhaBm84RhHyonkHAUrt'
application:
href: 'https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsArLxCm9QGbi2QfhaFrTED'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/authorizations?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/authorizations?offset=633380&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 633397
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
CreatePaymentInstrumentToken:
description: Token response object
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInstrumentToken'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
Device:
description: Single Device object
content:
application/json:
schema:
$ref: '#/components/schemas/Device'
examples:
Device:
value:
id: DVsEanpBtsAVvCHbNXkFaH6f
created_at: '2019-03-01T02:27:20.366Z'
updated_at: '2022-04-05T18:48:40.383Z'
configuration_details:
allow_debit: true
check_for_duplicate_transactions: true
prompt_amount_confirmation: false
prompt_manual_entry: true
prompt_signature: AMOUNT
signature_threshold_amount: 10
bypass_device_on_capture: false
connection: OPEN
description: Mike Jones
enabled: false
idle_message: null
merchant: MUu56ZGx3Xb6U9gAqKfgNisd
model: MX915
name: Johnnys Juice Shop
serial_number: '343434343'
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd'
transfers:
href: 'https://finix.sandbox-payments-api.com/transfers'
authorizations:
href: 'https://finix.sandbox-payments-api.com/authorizations'
Device - Activated (DATACAP_V1):
value:
id: DV8EVnpCwHwB9Dk3xTysgt5d
created_at: '2022-06-06T03:59:42.415Z'
updated_at: '2022-06-06T03:59:42.420647Z'
configuration_details:
allow_debit: true
check_for_duplicate_transactions: true
prompt_amount_confirmation: true
prompt_manual_entry: false
prompt_signature: NEVER
signature_threshold_amount: 0
bypass_device_on_capture: false
connection: OPEN
description: John Smith
enabled: true
idle_message: null
merchant: MUu56ZGx3Xb6U9gAqKfgNisd
model: MX915
name: 'Finix triPOS #1'
serial_number: '111023985764'
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd'
transfers:
href: 'https://finix.sandbox-payments-api.com/transfers'
authorizations:
href: 'https://finix.sandbox-payments-api.com/authorizations'
Device - Activated (TRIPOS_CLOUD_V1):
value:
id: DV8EVnpCwHwB9Dk3xTysgt5d
created_at: '2022-06-06T03:59:42.415Z'
updated_at: '2022-06-06T03:59:42.420647Z'
configuration_details:
allow_debit: true
check_for_duplicate_transactions: true
prompt_amount_confirmation: true
prompt_manual_entry: false
prompt_signature: NEVER
signature_threshold_amount: 0
bypass_device_on_capture: false
connection: OPEN
description: John Smith
enabled: true
idle_message: null
merchant: MUu56ZGx3Xb6U9gAqKfgNisd
model: MX915
name: 'Finix triPOS #1'
serial_number: null
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd'
transfers:
href: 'https://finix.sandbox-payments-api.com/transfers'
authorizations:
href: 'https://finix.sandbox-payments-api.com/authorizations'
Device - Idle Message Set:
value:
id: DV8EVnpCwHwB9Dk3xTysgt5d
created_at: '2022-06-06T03:59:42.415Z'
updated_at: '2022-06-06T03:59:42.420647Z'
configuration_details:
allow_debit: true
check_for_duplicate_transactions: true
prompt_amount_confirmation: true
prompt_manual_entry: false
prompt_signature: NEVER
signature_threshold_amount: 0
bypass_device_on_capture: false
connection: OPEN
description: John Smith
enabled: false
idle_message: Finix Flowers
merchant: MUu56ZGx3Xb6U9gAqKfgNisd
model: MX915
name: 'Finix triPOS #1'
serial_number: null
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd'
transfers:
href: 'https://finix.sandbox-payments-api.com/transfers'
authorizations:
href: 'https://finix.sandbox-payments-api.com/authorizations'
Device - Connection Check:
value:
id: DV8EVnpCwHwB9Dk3xTysgt5d
created_at: '2022-06-06T03:59:42.415Z'
updated_at: '2022-06-06T03:59:42.420647Z'
configuration_details:
allow_debit: true
check_for_duplicate_transactions: true
prompt_amount_confirmation: true
prompt_manual_entry: false
prompt_signature: NEVER
signature_threshold_amount: 0
bypass_device_on_capture: false
connection: OPEN
description: John Smith
enabled: false
idle_message: null
merchant: MUu56ZGx3Xb6U9gAqKfgNisd
model: MX915
name: 'Finix triPOS #1'
serial_number: null
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd'
transfers:
href: 'https://finix.sandbox-payments-api.com/transfers'
authorizations:
href: 'https://finix.sandbox-payments-api.com/authorizations'
Device - Deactivated:
value:
id: DV8EVnpCwHwB9Dk3xTysgt5d
created_at: '2022-06-06T03:59:42.415Z'
updated_at: '2022-06-06T03:59:42.420647Z'
configuration_details:
allow_debit: true
check_for_duplicate_transactions: true
prompt_amount_confirmation: true
prompt_manual_entry: false
prompt_signature: NEVER
signature_threshold_amount: 0
bypass_device_on_capture: false
connection: OPEN
description: John Smith
enabled: false
idle_message: null
merchant: MUu56ZGx3Xb6U9gAqKfgNisd
model: MX915
name: 'Finix triPOS #1'
serial_number: null
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd'
transfers:
href: 'https://finix.sandbox-payments-api.com/transfers'
authorizations:
href: 'https://finix.sandbox-payments-api.com/authorizations'
Device - Update Details:
value:
id: DVsEanpBtsAVvCHbNXkFaH6f
created_at: '2019-03-01T02:27:20.366Z'
updated_at: '2022-04-05T18:48:40.383Z'
configuration_details:
allow_debit: true
check_for_duplicate_transactions: true
prompt_amount_confirmation: false
prompt_manual_entry: true
prompt_signature: NEVER
signature_threshold_amount: 10
bypass_device_on_capture: true
connection: OPEN
description: Flowers
enabled: false
idle_message: null
merchant: MUu56ZGx3Xb6U9gAqKfgNisd
model: MX915
name: Finix Flowers - triPOS
serial_number: '343434343'
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd'
transfers:
href: 'https://finix.sandbox-payments-api.com/transfers'
authorizations:
href: 'https://finix.sandbox-payments-api.com/authorizations'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
Dispute:
description: Single Dispute object
content:
application/json:
schema:
$ref: '#/components/schemas/Dispute'
examples:
Dispute:
value:
id: DIs7yQRkHDdMYhurzYz72SFk
created_at: '2022-01-27T07:43:03.74Z'
updated_at: '2022-09-16T22:21:54.75Z'
action: null
amount: 888888
application: APgPDQrLD52TYvqazjHJJchM
dispute_details:
arn: '123'
evidence_submitted: CHARGEBACK
identity: IDpYDM7J9n57q849o9E9yNrG
merchant: MUucec6fHeaWo3VHYoSkUySM
message: null
occurred_at: '2022-01-27T07:42:48.56Z'
reason: FRAUD
respond_by: '2022-02-03T07:43:03.73Z'
response_state: ACCEPTED
state: WON
tags:
order_number: 21DFASJSAKAS
transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky'
evidence:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence'
adjustment_transfers:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers'
Dispute - Inquiry:
value:
id: DIs7yQRkHDdMYhurzYz72SFk
created_at: '2022-01-27T07:43:03.74Z'
updated_at: '2022-09-16T22:21:54.75Z'
action: null
amount: 888888
application: APgPDQrLD52TYvqazjHJJchM
dispute_details:
arn: '123'
evidence_submitted: INQUIRY
identity: IDpYDM7J9n57q849o9E9yNrG
merchant: MUucec6fHeaWo3VHYoSkUySM
message: null
occurred_at: '2022-01-27T07:42:48.56Z'
reason: FRAUD
respond_by: '2022-02-03T07:43:03.73Z'
response_state: NEEDS_RESPONSE
state: INQUIRY
tags:
order_number: 21DFASJSAKAS
transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky'
evidence:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence'
adjustment_transfers:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers'
Dispute - Chargeback:
value:
id: DIs7yQRkHDdMYhurzYz72SFk
created_at: '2022-01-27T07:43:03.74Z'
updated_at: '2022-09-16T22:21:54.75Z'
action: null
amount: 888888
application: APgPDQrLD52TYvqazjHJJchM
dispute_details:
arn: '123'
evidence_submitted: CHARGEBACK
identity: IDpYDM7J9n57q849o9E9yNrG
merchant: MUucec6fHeaWo3VHYoSkUySM
message: null
occurred_at: '2022-01-27T07:42:48.56Z'
reason: FRAUD
respond_by: '2022-02-03T07:43:03.73Z'
response_state: RESPONDED
state: PENDING
tags:
order_number: 21DFASJSAKAS
transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky'
evidence:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence'
adjustment_transfers:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers'
Dispute - Accepted:
value:
id: DIs7yQRkHDdMYhurzYz72SFk
created_at: '2022-01-27T07:43:03.74Z'
updated_at: '2022-09-16T22:21:54.75Z'
action: null
amount: 888888
application: APgPDQrLD52TYvqazjHJJchM
dispute_details:
arn: '123'
evidence_submitted: INQUIRY
identity: IDpYDM7J9n57q849o9E9yNrG
merchant: MUucec6fHeaWo3VHYoSkUySM
message: null
occurred_at: '2022-01-27T07:42:48.56Z'
reason: FRAUD
respond_by: '2022-02-03T07:43:03.73Z'
response_state: ACCEPTED
state: INQUIRY
tags:
order_number: 21DFASJSAKAS
transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky'
evidence:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence'
adjustment_transfers:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers'
Dispute - Tags:
value:
id: DIs7yQRkHDdMYhurzYz72SFk
created_at: '2022-01-27T07:43:03.74Z'
updated_at: '2022-09-16T22:21:54.75Z'
action: null
amount: 888888
application: APgPDQrLD52TYvqazjHJJchM
dispute_details:
arn: '123'
evidence_submitted: CHARGEBACK
identity: IDpYDM7J9n57q849o9E9yNrG
merchant: MUucec6fHeaWo3VHYoSkUySM
message: null
occurred_at: '2022-01-27T07:42:48.56Z'
reason: FRAUD
respond_by: '2022-02-03T07:43:03.73Z'
response_state: ACCEPTED
state: WON
tags:
order_number: 41BFASJSAKAS
transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky'
evidence:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence'
adjustment_transfers:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
DisputeEvidence:
description: Single Evidence object
content:
application/json:
schema:
$ref: '#/components/schemas/DisputeEvidence'
examples:
Dispute Evidence:
value:
id: DF58kdVTa5eMQUjcXH2F7DH4
created_at: '2022-08-15T21:37:04.41Z'
updated_at: '2022-08-15T21:45:00.74Z'
application: APgPDQrLD52TYvqazjHJJchM
dispute: DIs7yQRkHDdMYhurzYz72SFk
identity: IDpYDM7J9n57q849o9E9yNrG
merchant: MUucec6fHeaWo3VHYoSkUySM
state: SUCCEEDED
tags:
file-extension: .png
content-type: image/png
file-name: test_file.png
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF58kdVTa5eMQUjcXH2F7DH4'
Dispute - Tags:
value:
id: DF58kdVTa5eMQUjcXH2F7DH4
created_at: '2022-08-15T21:37:04.41Z'
updated_at: '2022-08-15T21:45:00.74Z'
application: APgPDQrLD52TYvqazjHJJchM
dispute: DIs7yQRkHDdMYhurzYz72SFk
identity: IDpYDM7J9n57q849o9E9yNrG
merchant: MUucec6fHeaWo3VHYoSkUySM
state: SUCCEEDED
tags:
order_number: 41BFASJSAKAS
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF58kdVTa5eMQUjcXH2F7DH4'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
DisputeEvidenceList:
description: List of Evidence objects
content:
application/json:
schema:
$ref: '#/components/schemas/DisputeEvidenceList'
examples:
List of Dispute Evidence:
value:
_embedded:
evidences:
- id: DFcVgoEuDeWn4eSvdZca8Hf
created_at: '2022-10-06T20:22:54.93Z'
updated_at: '2022-10-06T20:30:00.63Z'
application: APgPDQrLD52TYvqazjHJJchM
dispute: DIs7yQRkHDdMYhurzYz72SFk
identity: IDpYDM7J9n57q849o9E9yNrG
merchant: MUucec6fHeaWo3VHYoSkUySM
state: SUCCEEDED
tags:
file-extension: .png
content-type: image/png
file-name: test_file.png
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFcVgoEuDeWn4eSvdZca8Hf'
- id: DFx3tddpTC568GjukRFGZpDp
created_at: '2022-09-14T17:36:33.84Z'
updated_at: '2022-09-14T17:45:00.51Z'
dispute: DIs7yQRkHDdMYhurzYz72SFk
state: SUCCEEDED
tags:
file-extension: .png
content-type: image/png
file-name: test_file.png
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFx3tddpTC568GjukRFGZpDp'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence?offset=1160&limit=20&sort=created_at,desc&sort=id,desc'
page:
limit: 100
next_cursor: DFs7yQRkHDdMYhurzYz72SFk
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
DisputesList:
description: List of Disputes
content:
application/json:
schema:
$ref: '#/components/schemas/DisputesList'
examples:
List of Disputes:
value:
_embedded:
disputes:
- id: DIb72obRhTmPdMG1VxDKFLrb
created_at: '2022-07-14T19:40:06.52Z'
updated_at: '2022-07-14T19:40:06.11Z'
action: null
amount: 888888
application: APgPDQrLD52TYvqazjHJJchM
dispute_details:
arn: '123'
identity: IDuqZpDw28f2KK6YuDk4jNLg
merchant: MUucec6fHeaWo3VHYoSkUySM
message: null
occurred_at: '2022-07-14T19:39:00.77Z'
reason: FRAUD
respond_by: '2022-07-21T19:40:06.51Z'
state: PENDING
tags:
test: sale
transfer: TRkhvS4GfMKxaHyBBdkPSx6g
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRkhvS4GfMKxaHyBBdkPSx6g'
evidence:
href: 'https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb/evidence'
adjustment_transfers:
href: 'https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb/adjustment_transfers'
- id: DIuk8T4ayQdmxewz8EDLHe49
created_at: '2022-06-15T16:14:03.95Z'
updated_at: '2022-06-15T16:14:03.64Z'
action: null
amount: 888888
application: APgPDQrLD52TYvqazjHJJchM
dispute_details:
arn: '123'
identity: IDpYDM7J9n57q849o9E9yNrG
message: null
occurred_at: '2022-06-15T16:13:04.09Z'
reason: FRAUD
respond_by: '2022-06-22T16:14:03.94Z'
state: PENDING
tags:
order_number: 21DFASJSAKAS
transfer: TR27JnLR2pKDXjVVcGBKrjwU
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TR27JnLR2pKDXjVVcGBKrjwU'
evidence:
href: 'https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49/evidence'
adjustment_transfers:
href: 'https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49/adjustment_transfers'
- id: DIs7yQRkHDdMYhurzYz72SFk
created_at: '2022-01-27T07:43:03.74Z'
updated_at: '2022-09-16T22:21:54.75Z'
action: null
amount: 888888
application: APgPDQrLD52TYvqazjHJJchM
dispute_details:
arn: '123'
identity: IDpYDM7J9n57q849o9E9yNrG
message: null
occurred_at: '2022-01-27T07:42:48.56Z'
reason: FRAUD
respond_by: '2022-02-03T07:43:03.73Z'
state: WON
tags:
order_number: 21DFASJSAKAS
transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky'
evidence:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence'
adjustment_transfers:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
page:
limit: 100
next_cursor: DIs7yQRkHDdMYhurzYz72SFk
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: {}
Error422InvalidField:
description: Invalid field
content:
application/json:
schema:
$ref: '#/components/schemas/Error422InvalidFieldList'
ErrorForbidden403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error403ForbiddenList'
ErrorMerchantIdentityDisabled:
description: Merchant identity disabled error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorGeneric'
ErrorMethodNotAllowed:
description: 405 - Method not allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorGeneric'
ErrorNotFound:
description: Object does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/Error404NotFoundList'
ErrorPaymentRequired:
description: Payment Required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorGeneric'
ErrorTransfers402:
description: 402 - Payment required
content:
application/json:
schema:
$ref: '#/components/schemas/Error402PaymentRequired'
ErrorUnauthorized:
description: Authentication information is missing or invalid
content:
application/json:
schema:
$ref: '#/components/schemas/Error401Unauthorized'
ErrorUnprocessableEntity:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorGeneric'
Fee:
description: Single Fee object
content:
application/json:
schema:
$ref: '#/components/schemas/Fee'
examples:
Fee:
value:
id: FEtSD9oNjoCtJaN2C1FwhZ29
created_at: '2022-08-15T23:14:03.37Z'
updated_at: '2022-08-15T23:14:03.37Z'
amount: 100
currency: USD
display_name: null
fee_subtype: PLATFORM_FEE
fee_type: CARD_FIXED
label: null
linked_id: TR7m4FqzubzFvPJf4WEmkEEv
linked_type: TRANSFER
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/fees/FEtSD9oNjoCtJaN2C1FwhZ29'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TR7m4FqzubzFvPJf4WEmkEEv'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
FeeProfile:
description: Fee profile
content:
application/json:
schema:
$ref: '#/components/schemas/FeeProfile'
examples:
Fee Profile:
value:
id: FPq6PQ9pHsab66fKMmjQ7jb5
created_at: '2022-01-27T07:37:38.66Z'
updated_at: '2022-01-27T07:37:38.66Z'
ach_basis_points: 300
ach_credit_return_fixed_fee: null
ach_debit_return_fixed_fee: null
ach_fixed_fee: 30
american_express_assessment_basis_points: null
american_express_basis_points: null
american_express_charge_interchange: null
american_express_externally_funded_basis_points: null
american_express_externally_funded_fixed_fee: null
american_express_fixed_fee: null
ancillary_fixed_fee_primary: null
ancillary_fixed_fee_secondary: null
application: APgPDQrLD52TYvqazjHJJchM
basis_points: 200
charge_interchange: false
diners_club_basis_points: null
diners_club_charge_interchange: null
diners_club_fixed_fee: null
discover_assessments_basis_points: null
discover_basis_points: null
discover_charge_interchange: null
discover_data_usage_fixed_fee: null
discover_externally_funded_basis_points: null
discover_externally_funded_fixed_fee: null
discover_fixed_fee: null
discover_network_authorization_fixed_fee: null
dispute_fixed_fee: null
dispute_inquiry_fixed_fee: null
externally_funded_basis_points: null
externally_funded_fixed_fee: null
fixed_fee: 100
jcb_basis_points: null
jcb_charge_interchange: null
jcb_fixed_fee: null
mastercard_acquirer_fees_basis_points: null
mastercard_assessments_over1k_basis_points: null
mastercard_assessments_under1k_basis_points: null
mastercard_basis_points: null
mastercard_charge_interchange: null
mastercard_fixed_fee: null
qualified_tiers: null
rounding_mode: TRANSACTION
tags: {}
visa_acquirer_processing_fixed_fee: null
visa_assessments_basis_points: null
visa_base_II_credit_voucher_fixed_fee: null
visa_base_II_system_file_transmission_fixed_fee: null
visa_basis_points: null
visa_charge_interchange: null
visa_credit_voucher_fixed_fee: null
visa_fixed_fee: null
visa_kilobyte_access_fixed_fee: null
_links:
self:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
FeeProfilesList:
description: List of fee profiles
content:
application/json:
schema:
$ref: '#/components/schemas/FeeProfilesList'
examples:
List of Fee Profiles:
value:
_embedded:
fee_profiles:
- id: FPq6PQ9pHsab66fKMmjQ7jb5
created_at: '2022-01-27T07:37:38.66Z'
updated_at: '2022-01-27T07:37:38.66Z'
ach_basis_points: 300
ach_credit_return_fixed_fee: null
ach_debit_return_fixed_fee: null
ach_fixed_fee: 30
american_express_assessment_basis_points: null
american_express_basis_points: null
american_express_charge_interchange: null
american_express_externally_funded_basis_points: null
american_express_externally_funded_fixed_fee: null
american_express_fixed_fee: null
ancillary_fixed_fee_primary: null
ancillary_fixed_fee_secondary: null
application: APgPDQrLD52TYvqazjHJJchM
basis_points: 200
charge_interchange: false
diners_club_basis_points: null
diners_club_charge_interchange: null
diners_club_fixed_fee: null
discover_assessments_basis_points: null
discover_basis_points: null
discover_charge_interchange: null
discover_data_usage_fixed_fee: null
discover_externally_funded_basis_points: null
discover_externally_funded_fixed_fee: null
discover_fixed_fee: null
discover_network_authorization_fixed_fee: null
dispute_fixed_fee: null
dispute_inquiry_fixed_fee: null
externally_funded_basis_points: null
externally_funded_fixed_fee: null
fixed_fee: 100
jcb_basis_points: null
jcb_charge_interchange: null
jcb_fixed_fee: null
mastercard_acquirer_fees_basis_points: null
mastercard_assessments_over1k_basis_points: null
mastercard_assessments_under1k_basis_points: null
mastercard_basis_points: null
mastercard_charge_interchange: null
mastercard_fixed_fee: null
qualified_tiers: null
rounding_mode: TRANSACTION
tags: {}
visa_acquirer_processing_fixed_fee: null
visa_assessments_basis_points: null
visa_base_II_credit_voucher_fixed_fee: null
visa_base_II_system_file_transmission_fixed_fee: null
visa_basis_points: null
visa_charge_interchange: null
visa_credit_voucher_fixed_fee: null
visa_fixed_fee: null
visa_kilobyte_access_fixed_fee: null
_links:
self:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
- id: FPvCQUcnsueN3Bc3zR1qCBG8
created_at: '2022-01-27T07:37:36.69Z'
updated_at: '2022-01-27T07:37:36.69Z'
ach_basis_points: 300
ach_credit_return_fixed_fee: null
ach_debit_return_fixed_fee: null
ach_fixed_fee: 30
american_express_assessment_basis_points: null
american_express_basis_points: null
american_express_charge_interchange: null
american_express_externally_funded_basis_points: null
american_express_externally_funded_fixed_fee: null
american_express_fixed_fee: null
ancillary_fixed_fee_primary: null
ancillary_fixed_fee_secondary: null
application: APgPDQrLD52TYvqazjHJJchM
basis_points: 200
charge_interchange: false
diners_club_basis_points: null
diners_club_charge_interchange: null
diners_club_fixed_fee: null
discover_assessments_basis_points: null
discover_basis_points: null
discover_charge_interchange: null
discover_data_usage_fixed_fee: null
discover_externally_funded_basis_points: null
discover_externally_funded_fixed_fee: null
discover_fixed_fee: null
discover_network_authorization_fixed_fee: null
dispute_fixed_fee: null
dispute_inquiry_fixed_fee: null
externally_funded_basis_points: null
externally_funded_fixed_fee: null
fixed_fee: 100
jcb_basis_points: null
jcb_charge_interchange: null
jcb_fixed_fee: null
mastercard_acquirer_fees_basis_points: null
mastercard_assessments_over1k_basis_points: null
mastercard_assessments_under1k_basis_points: null
mastercard_basis_points: null
mastercard_charge_interchange: null
mastercard_fixed_fee: null
qualified_tiers: null
rounding_mode: TRANSACTION
tags: {}
visa_acquirer_processing_fixed_fee: null
visa_assessments_basis_points: null
visa_base_II_credit_voucher_fixed_fee: null
visa_base_II_system_file_transmission_fixed_fee: null
visa_basis_points: null
visa_charge_interchange: null
visa_credit_voucher_fixed_fee: null
visa_fixed_fee: null
visa_kilobyte_access_fixed_fee: null
_links:
self:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/fee_profiles?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 2
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
FeesList:
description: List of Fee objects
content:
application/json:
schema:
$ref: '#/components/schemas/FeesList'
examples:
List of Fees:
value:
_embedded:
fees:
- id: FEvQN3v5mhA2Ttc78hzjLV3j
created_at: '2022-10-11T03:25:04.79Z'
updated_at: '2022-10-11T03:25:04.79Z'
amount: 13243
currency: USD
display_name: null
fee_subtype: PLATFORM_FEE
fee_type: CARD_BASIS_POINTS
label: null
linked_id: TR61nQ89c8U5i7uAvwmSuLnv
linked_type: TRANSFER
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/fees/FEvQN3v5mhA2Ttc78hzjLV3j'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv'
- id: FEkuQHsAipobyobNSizt4ySJ
created_at: '2022-10-10T05:27:04.75Z'
updated_at: '2022-10-10T05:27:04.75Z'
amount: 2
currency: USD
display_name: null
fee_subtype: PLATFORM_FEE
fee_type: CARD_BASIS_POINTS
label: null
linked_id: TR3s5fgSyEZ1SnweXKxyWJ6R
linked_type: TRANSFER
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/fees/FEkuQHsAipobyobNSizt4ySJ'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TR3s5fgSyEZ1SnweXKxyWJ6R'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/fees?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/fees?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/fees?offset=15100&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 15114
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
IdentitiesList:
description: List of Identity objects
content:
application/json:
schema:
$ref: '#/components/schemas/IdentitiesList'
examples:
List of Identities:
value:
_embedded:
identities:
- id: IDrNRsZ2miEQcmGHCpo4rBQr
created_at: '2022-08-16T18:44:27.46Z'
updated_at: '2022-08-16T18:44:27.46Z'
application: APgPDQrLD52TYvqazjHJJchM
entity:
amex_mid: null
annual_card_volume: 12000000
business_address:
line1: 741 Douglass St
line2: Apartment 8
city: San Mateo
region: CA
postal_code: '94114'
country: USA
business_name: Petes Coffee
business_phone: +1 (408) 756-4497
business_tax_id_provided: true
business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
default_statement_descriptor: Petes Coffee
discover_mid: null
dob:
day: 27
month: 6
year: 1978
doing_business_as: Petes Coffee
email: user@example.org
first_name: dwayne
has_accepted_credit_cards_previously: true
incorporation_date:
day: 27
month: 6
year: 1978
last_name: xbc
max_transaction_amount: 12000000
mcc: '4900'
ownership_type: PRIVATE
personal_address:
line1: 741 Douglass St
line2: Apartment 7
city: San Mateo
region: CA
postal_code: '94114'
country: USA
phone: '14158885080'
principal_percentage_ownership: 50
short_business_name: null
tax_authority: null
tax_id_provided: true
title: CEO
url: www.PetesCoffee.com
identity_roles: []
tags:
test_key_103: test_val_103
_links:
self:
href: 'https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr'
verifications:
href: 'https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/verifications'
merchants:
href: 'https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/merchants'
settlements:
href: 'https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/settlements'
authorizations:
href: 'https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/transfers'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/payment_instruments'
associated_identities:
href: 'https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/associated_identities'
disputes:
href: 'https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/disputes'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/identities/IDf33pdVaTZGXVFNccdKvaPu/associated_identities?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 1
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
Identity:
description: Single Identity object
content:
application/json:
schema:
$ref: '#/components/schemas/Identity'
examples:
Identity - Merchant:
value:
id: ID5ZbV3hkc7eLxNhmFjfrrYA
created_at: '2023-10-24T23:19:18.35Z'
updated_at: '2023-10-24T23:19:18.35Z'
additional_underwriting_data:
refund_policy: MERCHANDISE_EXCHANGE_ONLY
credit_check_ip_address: 42.1.1.113
card_volume_distribution:
card_present_percentage: 30
mail_order_telephone_order_percentage: 10
ecommerce_percentage: 60
average_ach_transfer_amount: 200000
average_card_transfer_amount: 200000
merchant_agreement_accepted: true
merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)
merchant_agreement_ip_address: 42.1.1.113
annual_ach_volume: 200000
credit_check_allowed: true
business_description: SB3 vegan cafe
credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
volume_distribution_by_business_type:
other_volume_percentage: 0
consumer_to_consumer_volume_percentage: 0
business_to_consumer_volume_percentage: 0
business_to_business_volume_percentage: 100
person_to_person_volume_percentage: 0
credit_check_timestamp: '2021-04-28T16:42:55Z'
merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
application: APgPDQrLD52TYvqazjHJJchM
entity:
ach_max_transaction_amount: 1000000
amex_mid: null
annual_card_volume: 12000000
business_address:
line1: 741 Douglass St
line2: Apartment 8
city: San Mateo
region: CA
postal_code: '94114'
country: USA
business_name: Finix Flowers
business_phone: +1 (408) 756-4497
business_tax_id_provided: true
business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
default_statement_descriptor: Finix Flowers
discover_mid: null
dob:
day: 27
month: 6
year: 1978
doing_business_as: Finix Flowers
email: user@example.org
first_name: John
has_accepted_credit_cards_previously: true
incorporation_date:
day: 27
month: 6
year: 1978
last_name: Smith
max_transaction_amount: 1200000
mcc: '4900'
ownership_type: PRIVATE
personal_address:
line1: 741 Douglass St
line2: Apartment 7
city: San Mateo
region: CA
postal_code: '94114'
country: USA
phone: '14158885080'
principal_percentage_ownership: 50
short_business_name: null
tax_authority: null
tax_id_provided: true
title: CEO
url: 'https://www.finix.com'
identity_roles:
- SELLER
tags:
Studio Rating: '4.7'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/identities/ID5ZbV3hkc7eLxNhmFjfrrYA'
verifications:
href: 'https://finix.sandbox-payments-api.com/identities/ID5ZbV3hkc7eLxNhmFjfrrYA/verifications'
merchants:
href: 'https://finix.sandbox-payments-api.com/identities/ID5ZbV3hkc7eLxNhmFjfrrYA/merchants'
settlements:
href: 'https://finix.sandbox-payments-api.com/identities/ID5ZbV3hkc7eLxNhmFjfrrYA/settlements'
authorizations:
href: 'https://finix.sandbox-payments-api.com/identities/ID5ZbV3hkc7eLxNhmFjfrrYA/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/identities/ID5ZbV3hkc7eLxNhmFjfrrYA/transfers'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/identities/ID5ZbV3hkc7eLxNhmFjfrrYA/payment_instruments'
associated_identities:
href: 'https://finix.sandbox-payments-api.com/identities/ID5ZbV3hkc7eLxNhmFjfrrYA/associated_identities'
disputes:
href: 'https://finix.sandbox-payments-api.com/identities/ID5ZbV3hkc7eLxNhmFjfrrYA/disputes'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
Identity - Buyer:
value:
id: IDa5PTnZACanPDci1pEEHp9t
created_at: '2023-10-24T23:19:46.39Z'
updated_at: '2023-10-24T23:19:46.39Z'
application: APgPDQrLD52TYvqazjHJJchM
entity:
ach_max_transaction_amount: 0
amex_mid: null
annual_card_volume: 0
business_address: null
business_name: null
business_phone: null
business_tax_id_provided: false
business_type: null
default_statement_descriptor: null
discover_mid: null
dob: null
doing_business_as: null
email: finix_example@finix.com
first_name: John
has_accepted_credit_cards_previously: false
incorporation_date: null
last_name: Smith
max_transaction_amount: 0
mcc: null
ownership_type: null
personal_address:
line1: 741 Douglass St
line2: Apartment 7
city: San Mateo
region: CA
postal_code: '94114'
country: USA
phone: '7145677613'
principal_percentage_ownership: null
short_business_name: null
tax_authority: null
tax_id_provided: false
title: null
url: null
identity_roles: []
tags:
key: value
_links:
self:
href: 'https://finix.sandbox-payments-api.com/identities/IDa5PTnZACanPDci1pEEHp9t'
verifications:
href: 'https://finix.sandbox-payments-api.com/identities/IDa5PTnZACanPDci1pEEHp9t/verifications'
merchants:
href: 'https://finix.sandbox-payments-api.com/identities/IDa5PTnZACanPDci1pEEHp9t/merchants'
settlements:
href: 'https://finix.sandbox-payments-api.com/identities/IDa5PTnZACanPDci1pEEHp9t/settlements'
authorizations:
href: 'https://finix.sandbox-payments-api.com/identities/IDa5PTnZACanPDci1pEEHp9t/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/identities/IDa5PTnZACanPDci1pEEHp9t/transfers'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/identities/IDa5PTnZACanPDci1pEEHp9t/payment_instruments'
associated_identities:
href: 'https://finix.sandbox-payments-api.com/identities/IDa5PTnZACanPDci1pEEHp9t/associated_identities'
disputes:
href: 'https://finix.sandbox-payments-api.com/identities/IDa5PTnZACanPDci1pEEHp9t/disputes'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
Associated Identity:
value:
id: ID8v1JtSq1mVoQRcaAb3SWHQ
created_at: '2023-01-13T07:02:49.68Z'
updated_at: '2023-01-13T07:02:49.68Z'
application: APgPDQrLD52TYvqazjHJJchM
entity:
amex_mid: null
annual_card_volume: 0
business_address: null
business_name: null
business_phone: null
business_tax_id_provided: false
business_type: null
default_statement_descriptor: null
discover_mid: null
dob: null
doing_business_as: null
email: null
first_name: null
has_accepted_credit_cards_previously: false
incorporation_date: null
last_name: null
max_transaction_amount: 0
mcc: null
ownership_type: null
personal_address: null
phone: null
principal_percentage_ownership: 25
short_business_name: null
tax_authority: null
tax_id_provided: false
title: null
url: null
tags: {}
identity_roles: []
_links:
self:
href: 'https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ'
verifications:
href: 'https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/verifications'
merchants:
href: 'https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/merchants'
settlements:
href: 'https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/settlements'
authorizations:
href: 'https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/transfers'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/payment_instruments'
associated_identities:
href: 'https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/associated_identities'
disputes:
href: 'https://finix.sandbox-payments-api.com/identities/ID8v1JtSq1mVoQRcaAb3SWHQ/disputes'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
Merchant:
description: Single Merchant object
content:
application/json:
schema:
$ref: '#/components/schemas/Merchant'
examples:
Merchant:
value:
id: MUucec6fHeaWo3VHYoSkUySM
created_at: '2022-01-27T07:36:58.19Z'
updated_at: '2022-10-06T20:25:24.06Z'
application: APgPDQrLD52TYvqazjHJJchM
card_cvv_required: false
card_expiration_date_required: true
convenience_charges_enabled: false
creating_transfer_from_report_enabled: true
default_partial_authorization_enabled: false
fee_ready_to_settle_upon: RECONCILIATION
gross_settlement_enabled: false
identity: IDpYDM7J9n57q849o9E9yNrG
level_two_level_three_data_enabled: false
mcc: '4900'
merchant_name: Bobs Burgers
merchant_profile: MPzW2oRPtkLxK3fymcMACFi
mid: FNXh6htoPnfwmgGdvaG4L67Q1
onboarding_state: APPROVED
processing_enabled: true
processor: DUMMY_V1
processor_details:
mid: FNXh6htoPnfwmgGdvaG4L67Q1
api_key: secretValue
ready_to_settle_upon: RECONCILIATION
rent_surcharges_enabled: false
settlement_enabled: true
settlement_funding_identifier: UNSET
surcharges_enabled: false
tags:
key_2: value_2
verification: VIxfDrRKZZzkCDDbeCT15oDN
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchants/MUht1bsAEcihT9HA55Tet5dk'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDoZy2xjNQyWCkN5nKZbVp6x'
verifications:
href: 'https://finix.sandbox-payments-api.com/merchants/MUht1bsAEcihT9HA55Tet5dk/verifications'
merchant_profile:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MPh4vD8hWCtqHeJ8JgG4Tsva'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
verification:
href: 'https://finix.sandbox-payments-api.com/verifications/VIr27e4C5AWxgvLnyGJmdZQe'
Merchant - Card Present Enabled:
value:
id: MUu56ZGx3Xb6U9gAqKfgNisd
created_at: '2019-03-01T01:57:19.95Z'
updated_at: '2019-05-15T18:10:03.00Z'
application: APeUbTUjvYb1CdPXvNcwW1wP
card_cvv_required: false
card_expiration_date_required: true
convenience_charges_enabled: false
creating_transfer_from_report_enabled: false
default_partial_authorization_enabled: false
fee_ready_to_settle_upon: RECONCILIATION
gross_settlement_enabled: false
identity: IDsbTBawhnLBAVeinRb84vFR
level_two_level_three_data_enabled: false
mcc: '4900'
merchant_name: Finix Flowers
merchant_profile: MPcMKhfF9rhWT2JWeUKzQVy2
mid: '4445029863321'
onboarding_state: REJECTED
processing_enabled: true
processor: VANTIV_V1
processor_details:
acceptor_id: '874767464'
default_terminal_id: X6600507601
mid: '4445029863321'
account_token: 811D0B76DEC8CCD1903D2772B68DA0CACA84BF56B5A6EE61EC05FE126EA63EF1B979A401
account_id: '1056772'
merchant_ident_string: '4445029863321'
id: '193448212'
vantiv_merchant_id: '4445029863321'
ready_to_settle_upon: RECONCILIATION
rent_surcharges_enabled: false
settlement_enabled: true
settlement_funding_identifier: UNSET
surcharges_enabled: false
tags:
key_2: value_2
verification: VImHURoSqEvAf9haPD6zeHJx
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR'
verifications:
href: 'https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd/verifications'
merchant_profile:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MPcMKhfF9rhWT2JWeUKzQVy2'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP'
verification:
href: 'https://finix.sandbox-payments-api.com/verifications/VImHURoSqEvAf9haPD6zeHJx'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
MerchantProfile:
description: Single merchant profile object
content:
application/json:
schema:
$ref: '#/components/schemas/MerchantProfile'
examples:
Merchant Profile:
value:
id: MPsdo8WPP5erWzfPwMjYjVy3
created_at: '2022-08-15T21:37:47.26Z'
updated_at: '2022-08-15T21:38:24.02Z'
application: APgPDQrLD52TYvqazjHJJchM
fee_profile: null
payout_profile: null
risk_profile: RPwAziDZginXDWuuiDSaA3wr
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MPsdo8WPP5erWzfPwMjYjVy3'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
risk_profile:
href: 'https://finix.sandbox-payments-api.com/risk_profiles/RPwAziDZginXDWuuiDSaA3wr'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
MerchantProfilesList:
description: Single merchant profile object
content:
application/json:
schema:
$ref: '#/components/schemas/MerchantProfilesList'
examples:
List of Merchant Profiles:
value:
_embedded:
merchant_profiles:
- id: MPnXB4UBGtSUfxwA41z2Hqid
created_at: '2022-10-10T05:20:18.12Z'
updated_at: '2022-10-10T05:21:01.42Z'
application: APgPDQrLD52TYvqazjHJJchM
fee_profile: null
payout_profile: PO8ki51uFGkLYaWyBVJ7oyAt
risk_profile: RPqzvQLoHk37r74aE6NZ4aXt
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MPnXB4UBGtSUfxwA41z2Hqid'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
risk_profile:
href: 'https://finix.sandbox-payments-api.com/risk_profiles/RPqzvQLoHk37r74aE6NZ4aXt'
- id: MPo85BavSYVrkDn57BLh1JTs
created_at: '2022-09-21T17:46:06.29Z'
updated_at: '2022-09-21T17:46:07.75Z'
application: APgPDQrLD52TYvqazjHJJchM
fee_profile: null
payout_profile: PO9AtdBb4FUQqbMm3SAyoX3z
risk_profile: RP5PUJVynFoHibX6eHtfebV3
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MPo85BavSYVrkDn57BLh1JTs'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
risk_profile:
href: 'https://finix.sandbox-payments-api.com/risk_profiles/RP5PUJVynFoHibX6eHtfebV3'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles?offset=1660&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 1671
MerchantsList:
description: List of Merchants objects
content:
application/json:
schema:
$ref: '#/components/schemas/MerchantsList'
examples:
List of Merchants:
value:
_embedded:
merchants:
- id: MUk3936kZweevCrjyHLN1vsu
created_at: '2022-10-10T05:20:18.12Z'
updated_at: '2022-10-10T05:21:01.42Z'
application: APgPDQrLD52TYvqazjHJJchM
card_cvv_required: false
card_expiration_date_required: true
convenience_charges_enabled: false
creating_transfer_from_report_enabled: true
default_partial_authorization_enabled: false
fee_ready_to_settle_upon: RECONCILIATION
gross_settlement_enabled: false
identity: IDx2ZETjYiWkbitkYdFt1yLF
level_two_level_three_data_enabled: false
mcc: '4900'
merchant_name: Finix Flowers
merchant_profile: MPnXB4UBGtSUfxwA41z2Hqid
mid: FNXqeJt93ojP2cn1VUYtXANCF
onboarding_state: APPROVED
processing_enabled: true
processor: DUMMY_V1
processor_details:
mid: FNXqeJt93ojP2cn1VUYtXANCF
api_key: secretValue
ready_to_settle_upon: RECONCILIATION
rent_surcharges_enabled: false
settlement_enabled: true
settlement_funding_identifier: UNSET
surcharges_enabled: false
tags:
key_2: value_2
verification: VItUgbe9V8vpgSaJAriLDxER
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchants/MUk3936kZweevCrjyHLN1vsu'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDx2ZETjYiWkbitkYdFt1yLF'
verifications:
href: 'https://finix.sandbox-payments-api.com/merchants/MUk3936kZweevCrjyHLN1vsu/verifications'
merchant_profile:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MPnXB4UBGtSUfxwA41z2Hqid'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
verification:
href: 'https://finix.sandbox-payments-api.com/verifications/VItUgbe9V8vpgSaJAriLDxER'
- id: MU951dfkbH7nqVm4G91yb2au
created_at: '2022-09-21T17:46:06.29Z'
updated_at: '2022-09-21T17:46:09.45Z'
application: APgPDQrLD52TYvqazjHJJchM
card_cvv_required: false
card_expiration_date_required: true
convenience_charges_enabled: false
creating_transfer_from_report_enabled: true
default_partial_authorization_enabled: false
fee_ready_to_settle_upon: RECONCILIATION
gross_settlement_enabled: false
identity: ID4YPdRriet29ZhaiVa6qhJ5
level_two_level_three_data_enabled: false
mcc: '4900'
merchant_name: Petes Coffee
merchant_profile: MPo85BavSYVrkDn57BLh1JTs
mid: FNXkitpwdmgMJ8Vz9FxKBCSza
onboarding_state: APPROVED
processing_enabled: true
processor: DUMMY_V1
processor_details:
mid: FNXkitpwdmgMJ8Vz9FxKBCSza
api_key: secretValue
ready_to_settle_upon: RECONCILIATION
rent_surcharges_enabled: false
settlement_enabled: true
settlement_funding_identifier: UNSET
surcharges_enabled: false
tags:
key: value_2
verification: VIrjCZHf8v8arhbgPTikKmpp
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchants/MU951dfkbH7nqVm4G91yb2au'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/ID4YPdRriet29ZhaiVa6qhJ5'
verifications:
href: 'https://finix.sandbox-payments-api.com/merchants/MU951dfkbH7nqVm4G91yb2au/verifications'
merchant_profile:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MPo85BavSYVrkDn57BLh1JTs'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
verification:
href: 'https://finix.sandbox-payments-api.com/verifications/VIrjCZHf8v8arhbgPTikKmpp'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchants?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/merchants?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/merchants?offset=1660&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 1669
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
NoContent:
description: No content
PaymentInstrument:
description: Single Payment Instrument object
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInstrument'
descriminator:
propertyName: type
examples:
Payment Instrument - Card:
value:
id: PI8uU6wfi6hqBoWmzm9L4F2b
created_at: '2022-10-11T01:42:22.32Z'
updated_at: '2022-10-11T01:42:22.32Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
enabled: true
fingerprint: FPRiCenDk2SoRng7WjQTr7RJY
identity: IDgWxBhfGYLLdkhxx2ddYf9K
instrument_type: PAYMENT_CARD
address:
line1: 900 Metro Center Blv
line2: null
city: San Francisco
region: CA
postal_code: '94404'
country: USA
address_verification: UNKNOWN
bin: '520082'
brand: MASTERCARD
card_type: DEBIT
expiration_month: 12
expiration_year: 2029
issuer_country: NON_USA
last_four: '8210'
name: John Smith
security_code_verification: UNKNOWN
tags:
card_name: Business Card
type: PAYMENT_CARD
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K'
updates:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b/updates'
Payment Instrument - Bank Account:
value:
id: PI3AbkuRR1JbT5kPiGQCXvD9
created_at: '2022-10-11T01:42:53.29Z'
updated_at: '2022-10-11T01:42:53.29Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
enabled: true
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: NOT_ATTEMPTED
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
name: John
tags:
Bank Account: Company Account
type: BANK_ACCOUNT
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG'
Payment Instrument - Token:
value:
id: PImmCg3Po7oNi7jaZcXhfkEu
created_at: '2022-10-10T05:32:17.78Z'
updated_at: '2022-10-10T05:32:17.78Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
enabled: true
fingerprint: FPRiCenDk2SoRng7WjQTr7RJY
identity: IDgWxBhfGYLLdkhxx2ddYf9K
instrument_type: PAYMENT_CARD
address:
line1: 900 Metro Center Blv
line2: null
city: San Francisco
region: CA
postal_code: '94404'
country: USA
address_verification: UNKNOWN
bin: '520082'
brand: MASTERCARD
card_type: DEBIT
expiration_month: 12
expiration_year: 2029
issuer_country: NON_USA
last_four: '8210'
name: Amy White
security_code_verification: UNKNOWN
tags:
card_name: Business Card
type: PAYMENT_CARD
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K'
updates:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/updates'
Payment Instrument - Apple Pay:
value:
id: PImE5ZhGZJNFy14DtX8wX6f6
created_at: '2022-10-10T05:36:55.27Z'
updated_at: '2022-10-10T05:36:55.27Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
enabled: true
fingerprint: FPR88YBDbK4TqYMUNU8t8fbeQ
identity: IDgWxBhfGYLLdkhxx2ddYf9K
instrument_type: APPLE_PAY
bin: '370382'
brand: AMERICAN_EXPRESS
card_type: UNKNOWN
expiration_month: 11
expiration_year: 2024
issuer_country: UNKNOWN
last_four: '8576'
name: John Smith
tags: {}
type: APPLE_PAY
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K'
Payment Instrument - Google Pay:
value:
id: PIf8dyFFcEGBqPhaG22hPyYs
created_at: '2022-10-10T05:36:55.27Z'
updated_at: '2022-10-10T05:36:55.27Z'
application: APeUfzF5qdNkBCtdgcf3333n
created_via: API
currency: USD
enabled: true
fingerprint: FPRrcobjtdU98gr4sjiqYR1Qg
identity: ID78Fh8mcnnzukVzbdoyex5y
instrument_type: GOOGLE_PAY
bin: '411111'
brand: VISA
card_type: UNKNOWN
expiration_month: 12
expiration_year: 2027
issuer_country: UNKNOWN
last_four: '1111'
name: Finix Sandbox
tags: {}
type: GOOGLE_PAY
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUfzF5qdNkBCtdgcf3333n'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/ID78Fh8mcnnzukVzbdoyex5y'
Payment Instrument - Update a Card's Address:
value:
id: PIwWisLuZNwPBoLbCgQVTCoY
created_at: '2022-08-15T23:13:06.13Z'
updated_at: '2023-02-28T21:12:29.72Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
disabled_code: null
disabled_message: null
enabled: true
fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
identity: IDgWxBhfGYLLdkhxx2ddYf9K
instrument_type: PAYMENT_CARD
address:
line1: 900 Metro Center Blv
line2: Suite 200
city: Los Angeles
region: CA
postal_code: '94404'
country: USA
address_verification: UNKNOWN
bin: '400000'
brand: VISA
card_type: UNKNOWN
expiration_month: 12
expiration_year: 2029
issuer_country: UNKNOWN
last_four: '9979'
name: Amy White
security_code_verification: UNMATCHED
tags:
card_name: Business Card
custom_key: custome value
type: PAYMENT_CARD
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K'
updates:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates'
Payment Instrument - Disable a Payment Instrument:
value:
id: PIwbvcQGrEP33HShmYM7BR8o
created_at: '2023-02-28T19:05:56.24Z'
updated_at: '2023-02-28T21:16:18.80Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
disabled_code: USER_INITIATED
disabled_message: The card has been disabled by a user.
enabled: false
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: NOT_ATTEMPTED
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
name: null
tags:
card_name: Personal Card
type: BANK_ACCOUNT
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG'
Payment Instrument - Bank Account Validation Check:
value:
id: PIpU66orYpdrPSs91fqRJd66
created_at: '2023-03-13T23:28:34.10Z'
updated_at: '2023-03-13T23:28:34.10Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
disabled_code: null
disabled_message: null
enabled: true
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: VALID
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
name: null
tags: {}
type: BANK_ACCOUNT
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG'
Payment Instrument - Update Payment Instrument Tags:
value:
id: PIwbvcQGrEP33HShmYM7BR8o
created_at: '2023-02-28T19:05:56.24Z'
updated_at: '2023-02-28T21:18:24.79Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
disabled_code: null
disabled_message: null
enabled: true
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: NOT_ATTEMPTED
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
name: null
tags:
card_name: Personal Card
type: BANK_ACCOUNT
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
PaymentInstrumentToken:
description: Token response object
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInstrumentToken'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
PaymentInstrumentUpdatesList:
description: List of Update objects
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInstrumentUpdatesList'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
PaymentInstrumentsList:
description: List of Payment Instrument objects
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInstrumentsList'
examples:
List of Payment Instruments:
value:
_embedded:
payment_instruments:
- id: PI3AbkuRR1JbT5kPiGQCXvD9
created_at: '2022-10-11T01:42:53.29Z'
updated_at: '2022-10-11T01:42:53.29Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
enabled: true
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: NOT_ATTEMPTED
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
name: John
tags:
Bank Account: Company Account
type: BANK_ACCOUNT
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG'
- id: PIrb1DcGz1qjThotDJ5KURpv
created_at: '2022-10-06T20:23:38.74Z'
updated_at: '2022-10-06T20:23:38.74Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
enabled: true
fingerprint: FPRtvYkgcwLUdjq7B4AgxKfmr
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: NOT_ATTEMPTED
bank_code: '666666666'
country: USA
masked_account_number: XXXXX3123
name: test_python
tags:
bank_account: Test Python Account
type: BANK_ACCOUNT
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/payment_instruments?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/payment_instruments?offset=14660&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 14679
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
Processor:
description: Single Processor object
content:
application/json:
schema:
$ref: '#/components/schemas/Processor'
examples:
Application Processor:
value:
id: PR9DvbgX5uuhqyKuBBD6VmFi
created_at: '2022-04-29T18:29:23.07Z'
updated_at: '2022-04-29T18:29:22.97Z'
application: APdHjTsAPx81go7ekSMJqQdz
application_config:
key1: value-1
key2: value-2
can_debit_bank_account: true
allow_split_payouts: false
ach_immediate_destination_name: null
default_currencies:
- USD
ach_settlement_delay_days: null
default_level_two_level_three_data_enabled: false
template_countries_available: []
alert_on_unknown_merchants: false
config:
key1: value-1
key2: value-2
canDebitBankAccount: true
default_merchant_profile: MPpWCidKDfKZARSJKCAW3kex
enabled: true
processor: DUMMY_V1
system_config: null
_links:
self:
href: 'https://finix.sandbox-payments-api.com/applications/APdHjTsAPx81go7ekSMJqQdz/processors/DUMMY_V1'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APdHjTsAPx81go7ekSMJqQdz'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
ProcessorsList:
description: List of Processor objects
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorsList'
examples:
List of Application Processors:
value:
_embedded:
processors:
- id: PRmr3QooJNFuehWTjsJwkWp8
created_at: '2022-09-19T01:27:07.86Z'
updated_at: '2022-09-19T01:27:07.65Z'
application: APmuwPBaW8pVcwb4vCTHQH32
application_config:
can_debit_bank_account: true
enable_pin_debit: true
ach_settlement_delay_days: null
allow_custom_billing: false
allow_partial_auth: false
allow_split_payouts: false
allow_create_credentials: false
amex_acquired: false
merchant_fraud_enabled: false
allow_debit_online: false
boarding_id: VGPG
business_type: Retail
vantiv_sftp_username: VGPGSFTP
vantiv_sftp_password: ca7Abrug
vantiv_chain_number: 0X6600
vantiv_license: VANTIV license="6ad47..."
check_for_duplicate_transactions: 'Yes'
username: FINIXNEW
password: cert1234
chargebacks_username: null
chargebacks_password: null
payfac_merchant_id: '01185553'
payfac_username: FINIXNEWMP
payfac_password: cert12mp
reports_sftp_username: username
reports_sftp_password: password
ach_immediate_destination_name: null
sftp_username: finixv12txn
sftp_password: 4J7Lp9Xq
tp_application_name: express.chris
tp_application_id: null
tp_application_version: '1.0'
tp_authorization: Version=2.0
tp_base_url: 'https://triposcert.vantiv.com/'
ep_transaction_url: null
ep_reporting_url: null
ep_services_url: null
ep_application_id: null
ep_application_name: null
ep_application_version: null
settlement_payment_type: regular
card_sale_submission_method: null
default_currencies:
- USD
vantiv_trace_id_option: null
acquiring_bin: null
default_level_two_level_three_data_enabled: false
template_countries_available: []
alert_on_unknown_merchants: false
config:
key1: value-1
key2: value-2
canDebitBankAccount: true
default_merchant_profile: MP53dza14XzW4VYqRTnQ8Bpw
enabled: true
processor: VANTIV_V1
system_config: null
_links:
self:
href: 'https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors/VANTIV_V1'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32'
- id: PRrH5Cy9ZYFUZDha4cuDgipv
created_at: '2022-04-01T20:45:28.22Z'
updated_at: '2022-04-01T20:45:28.11Z'
application: APmuwPBaW8pVcwb4vCTHQH32
application_config:
default_sender_account_number: '1415888508012'
default_sender_address_line1: 21 Broadway
default_sender_address_line2: null
default_sender_city: OFallon
default_sender_country: CRI
default_sender_country_code: CRI
default_sender_postal_code: '63368'
default_sender_first_name: Michael
default_sender_last_name: Serna
default_sender_full_name: Michael Serna
sanction_screening_override: true
card_acceptor_id: null
statement_descriptor: null
default_payment_type: P2P
default_currencies:
- CRC
configuration_templates: null
ach_settlement_delay_days: null
default_level_two_level_three_data_enabled: false
allow_split_payouts: false
alert_on_unknown_merchants: false
config: {}
default_merchant_profile: MP53dza14XzW4VYqRTnQ8Bpw
enabled: true
processor: MASTERCARD_V1
system_config: null
_links:
self:
href: 'https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors/MASTERCARD_V1'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32'
- id: PR686aPfkq2cyHGtKfsxtoib
created_at: '2021-10-04T17:46:10.09Z'
updated_at: '2021-10-04T17:46:10.00Z'
application: APmuwPBaW8pVcwb4vCTHQH32
application_config:
key1: value-1
key2: value-2
can_debit_bank_account: true
allow_split_payouts: false
ach_immediate_destination_name: null
default_currencies:
- USD
ach_settlement_delay_days: null
default_level_two_level_three_data_enabled: false
template_countries_available: []
alert_on_unknown_merchants: false
config:
key1: value-1
key2: value-2
canDebitBankAccount: true
default_merchant_profile: MPf31wi1tKdVqtrT8PFyPFSg
enabled: true
processor: DUMMY_V1
system_config: null
_links:
self:
href: 'https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors/DUMMY_V1'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 3
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
ReversalsList:
description: List of Reversals
content:
application/json:
schema:
$ref: '#/components/schemas/TransfersList'
examples:
List of Reversals on a Transfer:
value:
_embedded:
transfers:
- id: TRtLhSEAHak7isKjZu9x7Gjh
created_at: '2022-10-10T04:16:27.47Z'
updated_at: '2022-10-10T04:17:05.03Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: PIe2YvpcjvoVJ6PzoRPBK137
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-10-10T04:17:05.04Z'
security_code_verification: null
source: null
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
test: refund
trace_id: e200c5b9-3ac9-4a21-a69e-cd0ffb6c2490
type: REVERSAL
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRtLhSEAHak7isKjZu9x7Gjh'
parent:
href: 'https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP'
destination:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRtLhSEAHak7isKjZu9x7Gjh/payment_instruments'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
- id: TRrP7CFqBid1C8kYpBMbxz5q
created_at: '2022-09-09T12:32:07.42Z'
updated_at: '2022-09-09T12:32:16.39Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: PIe2YvpcjvoVJ6PzoRPBK137
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-09-09T12:32:16.40Z'
security_code_verification: null
source: null
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
test: refund
trace_id: 40087e2c-b65d-4407-a5cc-3259b788f6ac
type: REVERSAL
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRrP7CFqBid1C8kYpBMbxz5q'
parent:
href: 'https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP'
destination:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRrP7CFqBid1C8kYpBMbxz5q/payment_instruments'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP/reversals?offset=820&limit=20&sort=created_at,desc&sort=id,desc'
parent:
href: 'https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP'
page:
offset: 0
limit: 20
count: 827
unreversed_amount: 580954
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
Settlement:
description: '`Settlement` object.'
content:
application/json:
schema:
$ref: '#/components/schemas/Settlement'
examples:
Settlement:
value:
id: STvUfBLbCUsun2KFoTuxR2j1
created_at: '2022-08-09T17:06:02.99Z'
updated_at: '2022-08-09T17:15:25.60Z'
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
funds_flow: null
identity: IDuqZpDw28f2KK6YuDk4jNLg
merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs
net_amount: 2238357
payment_type: null
processor: DUMMY_V1
status: AWAITING_APPROVAL
tags: {}
total_amount: 2287662
total_fee: 49305
total_fees: 49305
type: MERCHANT_REVENUE
_links:
self:
href: 'https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
funding_transfers:
href: 'https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/funding_transfers'
transfers:
href: 'https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers'
fees:
href: 'https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers?type=fee'
reversals:
href: 'https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers?type=reverse'
credits:
href: 'https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers?type=credit'
debits:
href: 'https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers?type=debit'
disputes:
href: 'https://finix.sandbox-payments-api.com/settlements/STvUfBLbCUsun2KFoTuxR2j1/transfers?type=dispute'
Close Settlements:
value:
id: STdjQCfwwra8QBVZQhrfqdUt
created_at: '2023-06-06T22:35:07.98Z'
updated_at: '2023-06-06T22:35:16.69Z'
application: AP8Hb3WvAFQ2DUdqKJYszMo5
currency: USD
destination: null
funds_flow: null
identity: IDj6kvMbVaeSzxQK6g1eoKKo
merchant_id: MUuCjso38AtQoNgfDdmcZ8gx
net_amount: 131854
payment_type: null
processor: DUMMY_V1
status: AWAITING_APPROVAL
tags: {}
total_amount: 131854
total_fee: 0
total_fees: 0
type: MERCHANT_REVENUE
_links:
self:
href: 'https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt'
application:
href: 'https://finix.sandbox-payments-api.com/applications/AP8Hb3WvAFQ2DUdqKJYszMo5'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDj6kvMbVaeSzxQK6g1eoKKo'
funding_transfers:
href: 'https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/funding_transfers'
transfers:
href: 'https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers'
fees:
href: 'https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=fee'
reversals:
href: 'https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=reverse'
credits:
href: 'https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=credit'
debits:
href: 'https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=debit'
disputes:
href: 'https://finix.sandbox-payments-api.com/settlements/STdjQCfwwra8QBVZQhrfqdUt/transfers?type=dispute'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
SettlementsList:
description: List of `Settlement` objects
content:
application/json:
schema:
$ref: '#/components/schemas/SettlementsList'
examples:
List of Settlements:
value:
_embedded:
settlements:
- id: ST7R7mHjHq3ywG4vGa9cYe9b
created_at: '2023-07-14T09:10:02.91Z'
updated_at: '2023-07-15T07:15:58.36Z'
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
funds_flow: null
identity: IDvHGrfeVmB3i7uL78xjemNk
merchant_id: MU7cXuKj2xx41hhZZi6bZ13A
net_amount: 8329
payment_type: null
processor: DUMMY_V1
status: AWAITING_APPROVAL
tags: {}
total_amount: 9252
total_fee: 923
total_fees: 923
type: MERCHANT_REVENUE
_links:
self:
href: 'https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDvHGrfeVmB3i7uL78xjemNk'
funding_transfers:
href: 'https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/funding_transfers'
transfers:
href: 'https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers'
fees:
href: 'https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers?type=fee'
reversals:
href: 'https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers?type=reverse'
credits:
href: 'https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers?type=credit'
debits:
href: 'https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers?type=debit'
disputes:
href: 'https://finix.sandbox-payments-api.com/settlements/ST7R7mHjHq3ywG4vGa9cYe9b/transfers?type=dispute'
- id: SThN7W7iDZM4mhGXqPDaVojn
created_at: '2022-12-21T22:05:08.10Z'
updated_at: '2022-12-22T07:15:56.22Z'
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
funds_flow: null
identity: IDuqZpDw28f2KK6YuDk4jNLg
merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs
net_amount: 648211
payment_type: null
processor: DUMMY_V1
status: AWAITING_APPROVAL
tags: {}
total_amount: 661854
total_fee: 13643
total_fees: 13643
type: MERCHANT_REVENUE
_links:
self:
href: 'https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
funding_transfers:
href: 'https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/funding_transfers'
transfers:
href: 'https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers'
fees:
href: 'https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers?type=fee'
reversals:
href: 'https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers?type=reverse'
credits:
href: 'https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers?type=credit'
debits:
href: 'https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers?type=debit'
disputes:
href: 'https://finix.sandbox-payments-api.com/settlements/SThN7W7iDZM4mhGXqPDaVojn/transfers?type=dispute'
- id: STsdvwKDyZq3gwZi5upuAETj
created_at: '2022-12-21T22:00:06.57Z'
updated_at: '2022-12-22T07:15:55.04Z'
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
funds_flow: null
identity: IDvHGrfeVmB3i7uL78xjemNk
merchant_id: MU7cXuKj2xx41hhZZi6bZ13A
net_amount: 648811
payment_type: null
processor: DUMMY_V1
status: AWAITING_APPROVAL
tags: {}
total_amount: 662154
total_fee: 13343
total_fees: 13343
type: MERCHANT_REVENUE
_links:
self:
href: 'https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDvHGrfeVmB3i7uL78xjemNk'
funding_transfers:
href: 'https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/funding_transfers'
transfers:
href: 'https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers'
fees:
href: 'https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers?type=fee'
reversals:
href: 'https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers?type=reverse'
credits:
href: 'https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers?type=credit'
debits:
href: 'https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers?type=debit'
disputes:
href: 'https://finix.sandbox-payments-api.com/settlements/STsdvwKDyZq3gwZi5upuAETj/transfers?type=dispute'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/settlements/'
next:
href: 'https://finix.sandbox-payments-api.com/settlements/?after_cursor=STsdvwKDyZq3gwZi5upuAETj'
page:
limit: 100
next_cursor: STsdvwKDyZq3gwZi5upuAETj
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
Transfer:
description: Single Transfer object
content:
application/json:
schema:
$ref: '#/components/schemas/Transfer'
examples:
Transfer:
value:
id: TRhw2BGAqyFZcrjTYXq4qTvY
created_at: '2022-10-10T03:49:20.71Z'
updated_at: '2022-10-10T03:49:21.62Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 662154
amount_requested: 662154
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
ready_to_settle_at: null
security_code_verification: null
source: PIe2YvpcjvoVJ6PzoRPBK137
split_transfers: null
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
test: sale
trace_id: 9789aa49-23a5-47c5-9ca1-7492a582fcde
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhw2BGAqyFZcrjTYXq4qTvY'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhw2BGAqyFZcrjTYXq4qTvY/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhw2BGAqyFZcrjTYXq4qTvY/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhw2BGAqyFZcrjTYXq4qTvY/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhw2BGAqyFZcrjTYXq4qTvY/disputes'
source:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Transfer - 3D Secure:
value:
id: TR7QJuf7mD6vSAmwHYbhVWem
created_at: '2022-10-10T03:47:09.23Z'
updated_at: '2022-10-10T03:47:10.06Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 92169
amount_requested: 92169
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
ready_to_settle_at: null
security_code_verification: null
source: PIe2YvpcjvoVJ6PzoRPBK137
split_transfers: null
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
test: sale
trace_id: 9d8052e9-2432-4117-aa57-d5ff0a7acecc
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TR7QJuf7mD6vSAmwHYbhVWem'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TR7QJuf7mD6vSAmwHYbhVWem/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TR7QJuf7mD6vSAmwHYbhVWem/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TR7QJuf7mD6vSAmwHYbhVWem/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TR7QJuf7mD6vSAmwHYbhVWem/disputes'
source:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Transfer - Card Verification Checks:
value:
id: TR61nQ89c8U5i7uAvwmSuLnv
created_at: '2022-10-11T03:24:04.67Z'
updated_at: '2022-10-11T03:24:05.47Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 662154
amount_requested: 662154
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: PIe2YvpcjvoVJ6PzoRPBK137
split_transfers: null
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags: {}
trace_id: cc2e9d44-c87d-4cb2-bb2f-b7be2eea9afa
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TR61nQ89c8U5i7uAvwmSuLnv/disputes'
source:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Transfer - Buyer Charges:
value:
id: TR499L4F49MmgTxQTP8XNwrZ
created_at: '2023-12-06T17:51:35.95Z'
updated_at: '2023-12-06T17:51:36.98Z'
additional_buyer_charges:
convenience_amount: 150
surcharge_amount: 0
rent_surcharge_amount: 0
additional_healthcare_data: null
additional_purchase_data: null
address_verification: null
amount: 5200
amount_requested: 5200
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
parent_transfer: null
parent_transfer_trace_id: null
raw: null
ready_to_settle_at: null
receipt_last_printed_at: null
security_code_verification: null
source: PIe2YvpcjvoVJ6PzoRPBK137
split_transfers: []
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
test: sale
trace_id: 1eaaa84e-0bb2-4565-b882-33976b0ac19d
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TR499L4F49MmgTxQTP8XNwrZ'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TR499L4F49MmgTxQTP8XNwrZ/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TR499L4F49MmgTxQTP8XNwrZ/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TR499L4F49MmgTxQTP8XNwrZ/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TR499L4F49MmgTxQTP8XNwrZ/disputes'
source:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Transfer - Debit Bank Account:
value:
id: TRrfaQBfXkc4wopWK6pcrnoR
created_at: '2022-10-10T03:51:19.27Z'
updated_at: '2022-10-10T03:51:20.77Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 6031
amount_requested: 6031
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 603
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
ready_to_settle_at: null
security_code_verification: null
source: PIr1Ru7ewBkEYVVn7SP1u5FW
split_transfers: null
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
order_number: 21DFASJSAKAS
trace_id: e7f2e240-f6e5-41ef-a533-ed6c8ccf5222
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRrfaQBfXkc4wopWK6pcrnoR'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRrfaQBfXkc4wopWK6pcrnoR/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TRrfaQBfXkc4wopWK6pcrnoR/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TRrfaQBfXkc4wopWK6pcrnoR/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TRrfaQBfXkc4wopWK6pcrnoR/disputes'
source:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIr1Ru7ewBkEYVVn7SP1u5FW'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Transfer - HSA or FSA Cards:
value:
id: TR8bRJ22SBReMehVQMVAbRpr
created_at: '2022-10-10T06:31:52.37Z'
updated_at: '2022-10-10T06:31:53.12Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 950
amount_requested: 950
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: PIe2YvpcjvoVJ6PzoRPBK137
split_transfers: null
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
order_number: 21DFASJSAKAS
trace_id: ea7c2b3e-bef7-45c5-aac3-76c94e25cb65
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TR8bRJ22SBReMehVQMVAbRpr/disputes'
source:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Transfer - Level 2 Processing:
value:
id: TRfnDYRPA5cNN5nup9WWpavy
created_at: '2022-10-10T03:27:23.09Z'
updated_at: '2022-10-10T03:27:23.74Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 1000
amount_requested: 1000
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
ready_to_settle_at: null
security_code_verification: null
source: PIe2YvpcjvoVJ6PzoRPBK137
split_transfers: null
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
test: sale
trace_id: 8356c796-90ea-43ed-9dba-7a31dd5d1a1c
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRfnDYRPA5cNN5nup9WWpavy'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRfnDYRPA5cNN5nup9WWpavy/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TRfnDYRPA5cNN5nup9WWpavy/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TRfnDYRPA5cNN5nup9WWpavy/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TRfnDYRPA5cNN5nup9WWpavy/disputes'
source:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Transfer - Level 3 Processing:
value:
id: TRhNEVxYWDF97SEqBJHykPDH
created_at: '2022-10-10T03:42:15.11Z'
updated_at: '2022-10-10T03:42:15.68Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 1000
amount_requested: 1000
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
ready_to_settle_at: null
security_code_verification: null
source: PIe2YvpcjvoVJ6PzoRPBK137
split_transfers: null
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
test: sale
trace_id: ce93f81e-187d-4d2a-b387-bb316f9efa9a
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/disputes'
source:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Transfer - Partial Authorization:
value:
id: TRbBacinCABghkSScrwXPR5A
created_at: '2023-10-12T21:21:40.97Z'
updated_at: '2023-10-12T21:21:42.38Z'
additional_buyer_charges: null
additional_healthcare_data: null
additional_purchase_data: null
address_verification: null
amount: 662154
amount_requested: 662154
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
parent_transfer: null
parent_transfer_trace_id: null
raw: null
ready_to_settle_at: null
receipt_last_printed_at: null
security_code_verification: null
source: PIe2YvpcjvoVJ6PzoRPBK137
split_transfers: []
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
test: sale
trace_id: 96fa40ab-80c7-4f6b-8912-ce062e13b429
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRbBacinCABghkSScrwXPR5A'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRbBacinCABghkSScrwXPR5A/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TRbBacinCABghkSScrwXPR5A/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TRbBacinCABghkSScrwXPR5A/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TRbBacinCABghkSScrwXPR5A/disputes'
source:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Transfer - Split Transaction:
value:
id: TRmCUZEnXF3BAr4uUKG5YVcW
created_at: '2023-07-25T23:33:26.16Z'
updated_at: '2023-07-25T23:33:27.99Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 1000
amount_requested: 1000
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
ready_to_settle_at: null
receipt_last_printed_at: null
security_code_verification: null
source: PIe2YvpcjvoVJ6PzoRPBK137
split_transfers:
- split_transfer_mDDBJcdfbvZQD5KbfdnECV
- split_transfer_mDEEvWVsk3b963EhZha52k
- split_transfer_mDEEXLvLihTL24iGdLWwbb
state: SUCCEEDED
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
test: sale
trace_id: db85490a-7fbe-4e10-9edd-13e39f930ddf
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRmCUZEnXF3BAr4uUKG5YVcW'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRmCUZEnXF3BAr4uUKG5YVcW/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TRmCUZEnXF3BAr4uUKG5YVcW/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TRmCUZEnXF3BAr4uUKG5YVcW/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TRmCUZEnXF3BAr4uUKG5YVcW/disputes'
source:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Card Present Transfer - EMV Card:
value:
id: TRtC5R4pnKkLj8hcLpgFivoS
created_at: '2022-10-10T06:07:52.01Z'
updated_at: '2022-10-10T06:07:53.01Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 150
amount_requested: 150
application: APeUbTUjvYb1CdPXvNcwW1wP
card_present_details:
emv_data: null
masked_account_number: null
name: null
brand: null
entry_mode: null
payment_type: NONE
approval_code: null
currency: USD
destination: null
device: DVsEanpBtsAVvCHbNXkFaH6f
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages: null
raw: null
ready_to_settle_at: null
security_code_verification: null
source: PI64EnboFzoZNFkBUHbgVDa2
split_transfers: null
state: SUCCEEDED
statement_descriptor: FIN*GOLDS GYM
subtype: API
tags:
order_number: chris123transfer
trace_id: FNXsK76MxJWPkbGqpKymgkzK
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRtC5R4pnKkLj8hcLpgFivoS'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR'
device:
href: 'https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRtC5R4pnKkLj8hcLpgFivoS/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TRtC5R4pnKkLj8hcLpgFivoS/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TRtC5R4pnKkLj8hcLpgFivoS/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TRtC5R4pnKkLj8hcLpgFivoS/disputes'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx'
Card Present Transfer - Non-EMV Card:
value:
id: TRhzZurepF7DwpL3REV5jU2T
created_at: '2022-10-10T06:12:31.55Z'
updated_at: '2022-10-10T06:12:33.09Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 150
amount_requested: 150
application: APeUbTUjvYb1CdPXvNcwW1wP
card_present_details:
emv_data: null
masked_account_number: null
name: null
brand: null
entry_mode: null
payment_type: NONE
approval_code: null
currency: USD
destination: null
device: DVsEanpBtsAVvCHbNXkFaH6f
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages: null
raw: null
ready_to_settle_at: null
security_code_verification: null
source: PI6SBgTQipPQa3ZpDe27Fbym
split_transfers: null
state: SUCCEEDED
statement_descriptor: FIN*GOLDS GYM
subtype: API
tags:
order_number: chris123transfer
trace_id: FNXkc963gjMZh8eLfgSHWmgHz
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhzZurepF7DwpL3REV5jU2T'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR'
device:
href: 'https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhzZurepF7DwpL3REV5jU2T/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhzZurepF7DwpL3REV5jU2T/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhzZurepF7DwpL3REV5jU2T/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhzZurepF7DwpL3REV5jU2T/disputes'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx'
Card Present Transfer - Manual Entry:
value:
id: TRi5vEeiCojkBCnvq8AD3HGm
created_at: '2022-10-10T03:20:50.29Z'
updated_at: '2022-10-10T03:20:51.71Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 150
amount_requested: 150
application: APeUbTUjvYb1CdPXvNcwW1wP
card_present_details:
emv_data: null
masked_account_number: null
name: null
brand: null
entry_mode: null
payment_type: NONE
approval_code: null
currency: USD
destination: null
device: DVsEanpBtsAVvCHbNXkFaH6f
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages: null
raw: null
ready_to_settle_at: null
security_code_verification: null
source: PI9D3HHedxWzCaadkGqrX2t1
split_transfers: null
state: SUCCEEDED
statement_descriptor: FIN*GOLDS GYM
subtype: API
tags:
order_number: chris123transfer
trace_id: FNXbAn8pqY7Pb2238uTFcdAiN
type: DEBIT
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRi5vEeiCojkBCnvq8AD3HGm'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR'
device:
href: 'https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRi5vEeiCojkBCnvq8AD3HGm/payment_instruments'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TRi5vEeiCojkBCnvq8AD3HGm/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TRi5vEeiCojkBCnvq8AD3HGm/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TRi5vEeiCojkBCnvq8AD3HGm/disputes'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx'
Refund Transfer:
value:
id: TRhLCS57STJRfpw2ZoRhSHf2
created_at: '2023-09-19T20:19:58.95Z'
updated_at: '2023-09-19T20:19:59.01Z'
additional_buyer_charges: null
additional_healthcare_data: null
additional_purchase_data: null
address_verification: null
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: PIe2YvpcjvoVJ6PzoRPBK137
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
parent_transfer: TRr3Rd7Sy7zbrsWAH7Jwo7vt
parent_transfer_trace_id: null
raw: null
ready_to_settle_at: null
receipt_last_printed_at: null
security_code_verification: null
source: null
split_transfers: []
state: PENDING
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
test: refund
trace_id: 4ec8b76b-c615-455d-ba78-c03f0f480b4a
type: REVERSAL
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhLCS57STJRfpw2ZoRhSHf2'
parent:
href: 'https://finix.sandbox-payments-api.com/transfers/TRr3Rd7Sy7zbrsWAH7Jwo7vt'
destination:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRhLCS57STJRfpw2ZoRhSHf2/payment_instruments'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Refund Transfer - Card Present:
value:
id: TRpc9StVytskqYnWoF2Ho8pK
created_at: '2022-10-10T03:17:34.57Z'
updated_at: '2022-10-10T03:17:35.83Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 150
amount_requested: 150
application: APeUbTUjvYb1CdPXvNcwW1wP
card_present_details:
emv_data: null
masked_account_number: null
name: null
brand: null
entry_mode: null
payment_type: NONE
approval_code: null
currency: USD
destination: PInUwPXf1MYj7xJ8jfmdksa5
device: DVtk6E4eWHsMzgZXvFaaUigM
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages: null
raw: null
ready_to_settle_at: null
security_code_verification: null
source: null
split_transfers: null
state: SUCCEEDED
statement_descriptor: FIN*GOLDS GYM
subtype: API
tags: {}
trace_id: FNXkYuDrPQxzpNk5xtGhXSyU8
type: REVERSAL
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRpc9StVytskqYnWoF2Ho8pK'
parent:
href: 'https://finix.sandbox-payments-api.com/transfers/TRn9pzzn1NVLdwwBwVrqSwAX'
destination:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PInUwPXf1MYj7xJ8jfmdksa5'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRpc9StVytskqYnWoF2Ho8pK/payment_instruments'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx'
Refund Transfer - Split Transaction:
value:
id: TRm23kdc4SCxYyva47RyiZv
created_at: '2023-07-19T03:02:02.89Z'
updated_at: '2023-07-19T03:02:03.01Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 1000
amount_requested: 1000
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: PIe2YvpcjvoVJ6PzoRPBK137
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
ready_to_settle_at: null
receipt_last_printed_at: null
security_code_verification: null
source: null
split_transfers:
- split_transfer_m7Y8kgx4nunsrVbuMdedDo
- split_transfer_m7Yct9DmD5ctdWxDTAZjPc
- split_transfer_m7YcD9mGG92oqxPPDhE23U
state: PENDING
statement_descriptor: FNX*DUNDER MIFFLIN
subtype: API
tags:
test: refund
trace_id: d1c14ed9-1945-4cef-b0f8-c1d8ba037a86
type: REVERSAL
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRm23kdc4SCxYyva47RyiZv'
parent:
href: 'https://finix.sandbox-payments-api.com/transfers/TR7h8NxhCDHunLFdJ1HCLp4r'
destination:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRm23kdc4SCxYyva47RyiZv/payment_instruments'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
Refund Transfer - Swiped Card:
value:
id: TR3vLiG6wecEwY3TC3oQiudG
created_at: '2019-04-24T19:19:34.11Z'
updated_at: '2019-04-24T19:19:48.09Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 100
amount_requested: 100
application: APuZMfMerci2JuLUs7xWpf5G
card_present_details:
emv_data: null
masked_account_number: '************0006'
name: TEST/WORLDPAY
brand: VISA
entry_mode: SWIPED
payment_type: CREDIT
approval_code: '000019'
currency: USD
destination: PIiPybsvUSM4fN8sYaMS3qXg
device: DVsEanpBtsAVvCHbNXkFaH6f
externally_funded: UNKNOWN
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages: null
raw: null
ready_to_settle_at: null
security_code_verification: null
source: null
split_transfers: null
state: SUCCEEDED
statement_descriptor: FNXQA*FINIX FLOWERS
subtype: API
tags:
order_number: testing123
trace_id: FNXgm7zyjYEmYwUQ3fktSTkaZ
type: REVERSAL
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/payment_instruments'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR'
device:
href: 'https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f'
reversals:
href: 'https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/reversals'
fees:
href: 'https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/fees'
disputes:
href: 'https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/disputes'
destination:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIiPybsvUSM4fN8sYaMS3qXg'
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'
User:
description: Single `User` object.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
examples:
ROLE_PARTNER User:
value:
id: USvVu9MXHz7hVzwDXwbx3UCL
created_at: '2022-01-27T07:37:14.65Z'
updated_at: '2022-01-27T07:37:15.47Z'
enabled: true
identity: IDpYDM7J9n57q849o9E9yNrG
password: null
role: ROLE_MERCHANT
tags:
card_name: New Employee
_links:
self:
href: 'https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL'
applications:
href: 'https://finix.sandbox-payments-api.com/applications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
UsersList:
description: List of `User` objects.
content:
application/json:
schema:
$ref: '#/components/schemas/UsersList'
examples:
List of Users:
value:
_embedded:
users:
- id: USsRhsHYZGBPnQw8CByJyEQW
created_at: '2022-01-27T07:36:32.91Z'
updated_at: '2022-01-27T07:36:33.78Z'
enabled: true
identity: IDuquemzE7UkUJioGJfVKBKt
password: null
role: ROLE_PARTNER
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/users/USsRhsHYZGBPnQw8CByJyEQW'
applications:
href: 'https://finix.sandbox-payments-api.com/applications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
- id: USjDY98nG9tn5n271vwNcNc9
created_at: '2022-10-11T04:45:54.56Z'
updated_at: '2022-10-11T04:45:54.56Z'
enabled: true
identity: IDuquemzE7UkUJioGJfVKBKt
password: null
role: ROLE_PARTNER
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/users/USjDY98nG9tn5n271vwNcNc9'
applications:
href: 'https://finix.sandbox-payments-api.com/applications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/users?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 8
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
Verification:
description: Single Verification object
content:
application/json:
schema:
$ref: '#/components/schemas/Verification'
examples:
Payment Instrument - Verify a Card’s CVV:
value:
id: PIwWisLuZNwPBoLbCgQVTCoY
created_at: '2022-08-15T23:13:06.13Z'
updated_at: '2023-10-05T14:50:31.58Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
disabled_code: null
disabled_message: null
enabled: true
fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
identity: IDgWxBhfGYLLdkhxx2ddYf9K
instrument_type: PAYMENT_CARD
address:
line1: 900 Metro Center Blv
line2: null
city: San Francisco
region: CA
postal_code: '94404'
country: CHN
address_verification: NO_MATCH
bin: '400000'
brand: VISA
card_type: UNKNOWN
expiration_month: 12
expiration_year: 2029
issuer_country: UNKNOWN
last_four: '9979'
name: Amy White
security_code_verification: UNMATCHED
tags:
card_name: Business_Card
quote: qu`te
qu`ote: qu`te
custom_key: custome value
type: PAYMENT_CARD
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K'
updates:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates'
Payment Instrument - Verify a Card’s Address:
value:
id: PIwWisLuZNwPBoLbCgQVTCoY
created_at: '2022-08-15T23:13:06.13Z'
updated_at: '2023-10-17T23:10:09.93Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
disabled_code: null
disabled_message: null
enabled: true
fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
identity: IDgWxBhfGYLLdkhxx2ddYf9K
instrument_type: PAYMENT_CARD
address:
line1: 900 Metro Center Blv
line2: null
city: San Francisco
region: CA
postal_code: '94404'
country: USA
address_verification: UNKNOWN
bin: '400000'
brand: VISA
card_type: UNKNOWN
expiration_month: 12
expiration_year: 2029
issuer_country: UNKNOWN
last_four: '9979'
name: Amy White
security_code_verification: UNMATCHED
tags:
card_name: Business_Card
quote: qu`te
qu`ote: qu`te
custom_key: custome value
type: PAYMENT_CARD
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY'
authorizations:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers'
verifications:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K'
updates:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates'
Payment Instrument - Verify Push-to-Card Eligibility:
value:
id: VI4HPBpdRHQLR88MY3AjS366
created_at: '2023-10-31T19:00:33.66Z'
updated_at: '2023-10-31T19:00:35.25Z'
application: APgPDQrLD52TYvqazjHJJchM
identity: null
merchant: null
merchant_identity: null
messages: []
payment_instrument: PIwWisLuZNwPBoLbCgQVTCoY
payment_instrument_verification_details:
push_to_card_domestic: FAST_FUNDS
push_to_card_cross_border: FAST_FUNDS
card_type: DEBIT
billing_currency: USD
issuer_country: USA
processor: VISA_V1
raw:
validation_details:
systems_trace_audit_number: '330419210605'
error_result: null
transaction_identifier: '583304684345495'
approval_code: '226664'
action_code: '00'
response_code: V
address_verification_results: U
cvv2_result_code: M
inquiry_details:
systems_trace_audit_number: '330419210605'
error_result: null
visa_network_info:
- card_type_code: D
billing_currency_code: 320
billing_currency_minor_digits: 2
issuer_name: VISA TEST BANK S.A.
card_issuer_country_code: 320
fast_funds_indicator: B
push_funds_block_indicator: C
online_gambing_block_indicator: 'Y'
card_product_type: D
billing_currency: 320
billing_currency_code_minor_digits: 2
non_money_transfer_push_funds_domestic: 'Y'
non_money_transfer_push_funds_cross_border: 'Y'
online_gambling_push_funds_domestic: 'Y'
online_gambling_push_funds_cross_border: 'Y'
money_transfer_push_funds_domestic: 'Y'
money_transfer_push_funds_cross_border: 'Y'
non_money_transfer_fast_funds_domestic: 'Y'
non_money_transfer_fast_funds_cross_border: 'Y'
online_gambling_fast_funds_domestic: 'Y'
online_gambling_fast_funds_cross_border: 'Y'
money_transfer_fast_funds_domestic: 'Y'
money_transfer_fast_funds_cross_border: 'Y'
combo_card_range: '0'
card_platform_code: CN
issuer_country_code: 320
ppgs_network_info: []
state: SUCCEEDED
tags: {}
trace_id: '330419210605'
type: PAYMENT_INSTRUMENT
_links:
self:
href: 'https://finix.live-payments-api.com/verifications/VI4HPBpdRHQLR88MY3AjS366'
application:
href: 'https://finix.live-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
payment_instrument:
href: 'https://finix.live-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
VerificationsList:
description: List of Verification objects
content:
application/json:
schema:
$ref: '#/components/schemas/VerificationsList'
examples:
Merchant Verification:
value:
_embedded:
verifications:
- id: VInHzhoRAnAizVU7jcj2K6bX
created_at: '2022-08-15T23:12:56.40Z'
updated_at: '2022-08-15T23:12:56.85Z'
application: APgPDQrLD52TYvqazjHJJchM
identity: null
merchant: MUpaGK5dUb2Sb7aGuXhFRNbj
merchant_identity: IDgahPGJ6hangmVJwrMRyZzr
messages: []
payment_instrument: null
processor: DUMMY_V1
raw: RawDummyMerchantUnderwriteResult
state: SUCCEEDED
tags: {}
trace_id: 1c8fb49d-6f1c-40a0-8646-1bcb88047583
_links:
self:
href: 'https://finix.sandbox-payments-api.com/verifications/VInHzhoRAnAizVU7jcj2K6bX'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj'
- id: VIdS8qSW3kZbnK9AsFHJZ81U
created_at: '2022-08-15T23:12:54.32Z'
updated_at: '2022-08-15T23:12:54.65Z'
application: APgPDQrLD52TYvqazjHJJchM
identity: null
merchant: MUpaGK5dUb2Sb7aGuXhFRNbj
merchant_identity: IDgahPGJ6hangmVJwrMRyZzr
messages: []
payment_instrument: null
processor: DUMMY_V1
raw: RawDummyMerchantUnderwriteResult
state: SUCCEEDED
tags:
key: value_2
trace_id: 4d12cbe6-032d-4e9d-8291-ce16f4add412
_links:
self:
href: 'https://finix.sandbox-payments-api.com/verifications/VIdS8qSW3kZbnK9AsFHJZ81U'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 2
Payment Instrument Verification:
value:
_embedded:
verifications:
- id: VIixxYGRVewLFa3GqSzqKPbw
created_at: '2022-02-04T18:33:14.50Z'
updated_at: '2022-02-04T18:33:15.69Z'
application: AP83dL8NE1Q7KfQo9onGg76M
identity: null
merchant: null
merchant_identity: null
messages: []
payment_instrument: PImc5nvdnp15atLxEBAGtxJs
processor: VISA_V1
raw:
validation_details:
systems_trace_audit_number: '203518208518'
error_result: null
transaction_identifier: '287371129315250'
approval_code: null
action_code: '25'
response_code: '5'
address_verification_results: I
cvv2_result_code: P
inquiry_details:
systems_trace_audit_number: '203518208518'
error_result: null
visa_network_info:
- card_type_code: D
billing_currency_code: 840
billing_currency_minor_digits: 2
issuer_name: Visa Test Bank
card_issuer_country_code: 840
fast_funds_indicator: D
push_funds_block_indicator: C
online_gambing_block_indicator: 'N'
ppgs_network_info: []
state: SUCCEEDED
tags: {}
trace_id: '203518208518'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/verifications/VIixxYGRVewLFa3GqSzqKPbw'
application:
href: 'https://finix.sandbox-payments-api.com/applications/AP83dL8NE1Q7KfQo9onGg76M'
payment_instrument:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PImc5nvdnp15atLxEBAGtxJs'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PImc5nvdnp15atLxEBAGtxJs/verifications/?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 1
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
Webhook:
description: Single Webhook object
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
examples:
Webhook:
value:
id: WHg3ocwoCz9PgF4ncZTyArFJ
created_at: '2022-10-10T03:56:10.15Z'
updated_at: '2022-10-10T03:56:10.15Z'
application: APgPDQrLD52TYvqazjHJJchM
authentication:
type: NONE
enabled: true
enabled_events: []
previous_secret_expires_at: null
secret_signing_key: 3afb49c98ac08a67a58efa5580b24e5984bc36d7ebd404e875234f107deed108
url: 'https://eohzjuj2prziycz.m.pipedream.net'
_links:
self:
href: 'http://finix.sandbox-payments-api.com/webhooks/WHg3ocwoCz9PgF4ncZTyArFJ'
application:
href: 'http://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
Filter Webhook Events:
value:
id: WHtPXJnAjmusyobzpmQZeHvJ
created_at: '2022-06-05T23:29:07.99Z'
updated_at: '2022-10-10T04:36:45.88Z'
application: APgPDQrLD52TYvqazjHJJchM
authentication:
type: NONE
enabled: false
enabled_events:
- entity: merchant
types:
- created
- underwritten
- entity: transfer
types:
- created
previous_secret_expires_at: null
url: 'https://eohzjuj2prziycz.m.pipedream.net'
_links:
self:
href: 'http://finix.sandbox-payments-api.com/webhooks/WHtPXJnAjmusyobzpmQZeHvJ'
application:
href: 'http://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
WebhooksList:
description: List of Webhook objects
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksList'
examples:
List of Webhooks:
value:
_embedded:
webhooks:
- id: WHtbmULb3Y68oGfKWc9TLJnJ
created_at: '2022-09-27T18:40:29.20Z'
updated_at: '2022-09-27T18:40:29.39Z'
application: APgPDQrLD52TYvqazjHJJchM
authentication:
type: NONE
enabled: false
enabled_events: []
previous_secret_expires_at: null
url: 'https://example.com/'
_links:
self:
href: 'http://finix.sandbox-payments-api.com/webhooks/WHtbmULb3Y68oGfKWc9TLJnJ'
application:
href: 'http://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
- id: WHmnVdiaimgD8aRTVvwuTZaj
created_at: '2022-09-27T18:38:56.81Z'
updated_at: '2022-09-27T18:38:57.03Z'
application: APgPDQrLD52TYvqazjHJJchM
authentication:
type: NONE
enabled: false
enabled_events: []
previous_secret_expires_at: null
url: 'https://example.com/'
_links:
self:
href: 'http://finix.sandbox-payments-api.com/webhooks/WHmnVdiaimgD8aRTVvwuTZaj'
application:
href: 'http://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
_links:
self:
href: 'http://finix.sandbox-payments-api.com/notification/webhooks?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'http://finix.sandbox-payments-api.com/notification/webhooks?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'http://finix.sandbox-payments-api.com/notification/webhooks?offset=1360&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 1197
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
SubscriptionEnrollment:
description: Single subscription_enrollment resource
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionEnrollment'
examples:
Subscription Enrollment:
value:
id: SUBENROLLMENT_Yxwo2Vb6oj97m3PuW9TxQ
created_at: '2022-02-02T01:47:08.07Z'
updated_at: '2022-02-02T01:47:08.07Z'
created_by: USimz3zSq5R2PqiEBXY6rSiJ
ended_at: null
merchant: MU7AxBA6MkF7Tee8veith3nG
nickname: Security Fee
started_at: '2022-11-11T16:50:59.89Z'
subscription_schedule: SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv
tags:
enrollment_info: Security Fee Enrollment
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_Yxwo2Vb6oj97m3PuW9TxQ'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MU7AxBA6MkF7Tee8veith3nG'
schedule:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv'
amounts:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv/subscription_amounts'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
SubscriptionEnrollmentsList:
description: List of subscription_enrollment objects
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionEnrollmentList'
examples:
List of Subscription Enrollments:
value:
_embedded:
subscription_enrollments:
- id: SUBENROLLMENT_sJdhvD6x91qENUvnr2otgp
created_at: '2022-06-08T22:39:24.00Z'
updated_at: '2022-06-08T22:39:24.00Z'
created_by: USka4562gALVJRD471ddEmPc
ended_at: null
merchant: MUiysjyBGpiZEZYkzj7d5DhM
nickname: Vitameatavegamin Monthly
started_at: '2022-07-07T07:00:00.00Z'
subscription_schedule: SUBSCHEDULE_5GDvqCTAd6SrmWdsx4dUKx
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_sJdhvD6x91qENUvnr2otgp'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUiysjyBGpiZEZYkzj7d5DhM'
schedule:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5GDvqCTAd6SrmWdsx4dUKx'
amounts:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5GDvqCTAd6SrmWdsx4dUKx/subscription_amounts'
- id: SUBENROLLMENT_Yxwo2Vb6oj97m3PuW9TxQ
created_at: '2022-02-02T01:47:08.07Z'
updated_at: '2022-02-02T01:47:08.07Z'
created_by: USimz3zSq5R2PqiEBXY6rSiJ
ended_at: null
merchant: MU7AxBA6MkF7Tee8veith3nG
nickname: Security Fee
started_at: '2022-11-11T16:50:59.89Z'
subscription_schedule: SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv
tags:
enrollment_info: Security Fee Enrollment
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_Yxwo2Vb6oj97m3PuW9TxQ'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MU7AxBA6MkF7Tee8veith3nG'
schedule:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv'
amounts:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv/subscription_amounts'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?offset=840&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 2
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
SubscriptionAmount:
description: Single subscription_amount object
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionAmount'
examples:
Subscription Amount:
value:
id: SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN
created_at: '2022-06-24T17:15:10.68Z'
updated_at: '2022-06-24T17:15:10.68Z'
amount_type: FEE
created_by: UStxEci4vXxGDWLQhNvao7YY
fee_amount_data:
amount: 2500
currency: USD
label: POS_INSTALLMENT_FEE
nickname: POS_INSTALLMENT_FEE
subscription_schedule: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN'
schedule:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
SubscriptionAmountsList:
description: List of subscription_amount objects
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionAmountList'
examples:
List of Subscription Amounts:
value:
_embedded:
subscription_amounts:
- id: SUBAMOUNT_cTJQifghT2FLRR7ttJapXH
created_at: '2022-08-01T18:04:24.52Z'
updated_at: '2022-08-01T18:04:24.52Z'
amount_type: FEE
created_by: UStxEci4vXxGDWLQhNvao7YY
fee_amount_data:
amount: 2500
currency: USD
label: POS_INSTALLMENT_FEE
nickname: NEW_POS_INSTALLMENT_FEE
subscription_schedule: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_cTJQifghT2FLRR7ttJapXH'
schedule:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ'
- id: SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN
created_at: '2022-06-24T17:15:10.68Z'
updated_at: '2022-06-24T17:15:10.68Z'
amount_type: FEE
created_by: UStxEci4vXxGDWLQhNvao7YY
fee_amount_data:
amount: 2500
currency: USD
label: POS_INSTALLMENT_FEE
nickname: POS_INSTALLMENT_FEE
subscription_schedule: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN'
schedule:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 2
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
SubscriptionSchedule:
description: Example response
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionSchedule'
examples:
Subscription Schedule - FIXED_TIME_INTERVAL:
value:
id: SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV
created_at: '2022-08-01T17:53:54.63Z'
updated_at: '2022-08-01T17:53:54.63Z'
created_by: UStxEci4vXxGDWLQhNvao7YY
fixed_time_interval_offset:
hourly_interval: 24
interval_count: 4
line_item_type: FEE
nickname: Fixed_Time_Subscription_Schedule
period_offset: null
subscription_type: FIXED_TIME_INTERVAL
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV'
amounts:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV/subscription_amounts'
Subscription Schedule - PERIODIC_MONTHLY:
value:
id: SUBSCHEDULE_uANjZPtZGzh4MK6aFFzbC8
created_at: '2022-01-27T07:44:06.18Z'
updated_at: '2022-01-27T07:44:06.18Z'
created_by: UStxEci4vXxGDWLQhNvao7YY
fixed_time_interval_offset: null
line_item_type: FEE
nickname: Monthly_Subscription_Schedule
period_offset:
day: 1
month: null
subscription_type: PERIODIC_MONTHLY
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uANjZPtZGzh4MK6aFFzbC8'
amounts:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uANjZPtZGzh4MK6aFFzbC8/subscription_amounts'
Subscription Schedule - PERIODIC_YEARLY:
value:
id: SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru
created_at: '2022-01-27T07:44:05.81Z'
updated_at: '2022-01-27T07:44:05.81Z'
created_by: UStxEci4vXxGDWLQhNvao7YY
fixed_time_interval_offset: null
line_item_type: FEE
nickname: Yearly_Subscription_Schedule
period_offset:
day: 5
month: 1
subscription_type: PERIODIC_YEARLY
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru'
amounts:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru/subscription_amounts'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
SubscriptionSchedulesList:
description: List of subscription_schedule objects
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionSchedulesList'
examples:
List Subscription Schedules:
value:
_embedded:
subscription_schedules:
- id: SUBSCHEDULE_kfpANfUXxHyW2YBayXD39N
created_at: '2022-08-17T04:54:00.31Z'
updated_at: '2022-08-17T04:54:00.31Z'
created_by: UStxEci4vXxGDWLQhNvao7YY
fixed_time_interval_offset:
hourly_interval: 24
interval_count: 4
line_item_type: FEE
nickname: Fixed_Time_Subscription_Schedule
period_offset: null
subscription_type: FIXED_TIME_INTERVAL
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kfpANfUXxHyW2YBayXD39N'
amounts:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kfpANfUXxHyW2YBayXD39N/subscription_amounts'
- id: SUBSCHEDULE_rhbHGjhydMxsEXw4otBCFz
created_at: '2022-07-11T18:39:30.21Z'
updated_at: '2022-07-11T18:39:30.21Z'
created_by: UStxEci4vXxGDWLQhNvao7YY
fixed_time_interval_offset:
hourly_interval: 24
interval_count: 4
line_item_type: FEE
nickname: Fixed_Time_Subscription_Schedule
period_offset: null
subscription_type: FIXED_TIME_INTERVAL
tags: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_rhbHGjhydMxsEXw4otBCFz'
amounts:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_rhbHGjhydMxsEXw4otBCFz/subscription_amounts'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/subscription/subscription_schedules/?offset=60&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 2
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
BalanceTransfer:
description: Single balance_transfer object
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceTransfer'
examples:
Balance Transfer:
value:
id: BT_9SLA5BdQs6Z3xFpmjUoqhM
created_at: '2022-08-18T06:37:50.67Z'
updated_at: '2022-08-18T06:37:51.09Z'
amount: 101
currency: USD
description: setup balance transfer for testing
destination: OPERATING_ACCOUNT
external_reference_id: '84077657260162531'
processor_type: LITLE_V1
reference_id: FNX5ZJEGdPT5odwtRrvxVrYUn
source: FOR_BENEFIT_OF_ACCOUNT
state: SUCCEEDED
tags:
test_key_101: test_val_101
_links:
self:
href: 'https://finix.sandbox-payments-api.com/balance_transfers/BT_9SLA5BdQs6Z3xFpmjUoqhM'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
BalanceTransferList:
description: List of balance_transfer objects
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceTransferList'
examples:
List of Balance Transfers:
value:
_embedded:
balance_transfers:
- id: BT_jXhKj7AcdQXvCANFfuowWa
created_at: '2022-10-10T08:07:35.69Z'
updated_at: '2022-10-10T08:07:35.92Z'
amount: 22725
currency: USD
description: Test Balance Transfer
destination: FOR_BENEFIT_OF_ACCOUNT
external_reference_id: '84078027639024193'
processor_type: LITLE_V1
reference_id: FNXBHeZiCJ4C4HcgpVGT5sdb
source: OPERATING_ACCOUNT
state: SUCCEEDED
tags: null
_links:
self:
href: 'https://finix.sandbox-payments-api.com/balance_transfers/BT_jXhKj7AcdQXvCANFfuowWa'
- id: BT_qk8PK15fMsoXjZ1dP9YSwf
created_at: '2022-09-28T18:10:01.36Z'
updated_at: '2022-09-28T18:10:01.77Z'
amount: 4000
currency: USD
description: Need to increase buffer given the high number of NSFs on merchant fee debits
destination: FOR_BENEFIT_OF_ACCOUNT
external_reference_id: '83989994584237171'
processor_type: LITLE_V1
reference_id: FNXbECrND95wKrBh61D3Lrq7n
source: OPERATING_ACCOUNT
state: SUCCEEDED
tags:
example: documentation tag
_links:
self:
href: 'https://finix.sandbox-payments-api.com/balance_transfers/BT_qk8PK15fMsoXjZ1dP9YSwf'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/balance_transfers/?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
next:
href: 'https://finix.sandbox-payments-api.com/balance_transfers/?offset=20&limit=20&sort=created_at,desc&sort=id,desc'
last:
href: 'https://finix.sandbox-payments-api.com/balance_transfers/?offset=1280&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 1286
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
InstrumentUpdate:
description: Single instrument_update object
content:
application/json:
schema:
$ref: '#/components/schemas/InstrumentUpdate'
examples:
Instrument Updates:
value:
id: IUp9oSWhWUF31DPrJ8CojQeQ
created_at: '2020-12-02T03:44:42.77Z'
updated_at: '2020-12-02T03:44:42.81Z'
idempotency_id: 'F2022-08-12 15:05:19.211366'
merchant: MUvQQt3RKe7FBZ6j9eMYoo3H
state: PENDING
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payment_intrument_updates/IUp9oSWhWUF31DPrJ8CojQeQ'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
File:
description: Single File object
content:
application/json:
schema:
$ref: '#/components/schemas/File'
examples:
File - Created:
value:
id: FILE_abki8bFEjq51eZ5w2pYFik
created_at: '2022-08-16T18:50:25.770825Z'
updated_at: '2022-08-16T18:50:25.807321Z'
application_id: APgPDQrLD52TYvqazjHJJchM
display_name: license_file
extension: null
identity_id: null
linked_to: MU2n7BSovtwYsWYZF6rBnnzk
linked_type: MERCHANT
platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
status: REQUIRES_UPLOAD
tags:
test_key_100: test_val_100
type: DRIVERS_LICENSE_FRONT
File - Uploading:
value:
id: FILE_abki8bFEjq51eZ5w2pYFik
created_at: '2022-08-16T18:50:25.770825Z'
updated_at: '2022-08-16T18:50:25.807321Z'
application_id: APgPDQrLD52TYvqazjHJJchM
display_name: license_file
extension: png
identity_id: null
linked_to: MU2n7BSovtwYsWYZF6rBnnzk
linked_type: MERCHANT
platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
status: PENDING
tags:
test_key_100: test_val_100
type: DRIVERS_LICENSE_FRONT
File - Uploaded:
value:
id: FILE_abki8bFEjq51eZ5w2pYFik
created_at: '2022-08-16T18:50:25.770825Z'
updated_at: '2022-08-16T18:50:25.807321Z'
application_id: APgPDQrLD52TYvqazjHJJchM
display_name: license_file
extension: png
identity_id: null
linked_to: MU2n7BSovtwYsWYZF6rBnnzk
linked_type: MERCHANT
platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
status: UPLOADED
tags:
test_key_100: test_val_100
type: DRIVERS_LICENSE_FRONT
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
FilesList:
description: List of File objects
content:
application/json:
schema:
$ref: '#/components/schemas/FilesList'
examples:
List of Files:
value:
_embedded:
files:
- id: FILE_abki8bFEjq51eZ5w2pYFik
created_at: '2022-08-16T18:50:25.770825Z'
updated_at: '2022-08-16T18:50:25.807321Z'
application_id: APgPDQrLD52TYvqazjHJJchM
display_name: license_file
extension: png
identity_id: null
linked_to: MU2n7BSovtwYsWYZF6rBnnzk
linked_type: MERCHANT
platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
status: UPLOADED
tags:
test_key_100: test_val_100
type: DRIVERS_LICENSE_FRONT
- id: FILE_eCecW4LCMMfY7nfnBrKpX8
created_at: '2022-10-11T21:19:46.273063Z'
updated_at: '2022-10-11T21:19:46.296136Z'
application_id: APgPDQrLD52TYvqazjHJJchM
display_name: My Drivers License
extension: null
identity_id: null
linked_to: MU2n7BSovtwYsWYZF6rBnnzk
linked_type: MERCHANT
platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN
status: REQUIRES_UPLOAD
tags:
key_1: value_1
type: DRIVERS_LICENSE_FRONT
page:
limit: 10
next_cursor: FILE_abki8bFEjq51eZ5w2pYFik
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
ExternalLink:
description: Single external_link object
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalLink'
examples:
External Link:
value:
id: EL_dh5YS66GePpkeSVyL4VdBL
created_at: '2022-03-22T01:07:05.074313Z'
duration: null
expired: true
expires_at: '2022-03-22T01:22:05.070415Z'
file_id: FILE_bJecqoRPasStEPVpvKHtgA
tags: {}
type: UPLOAD
url: 'https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIACy1Tl%2BahJzC4xuMTzdUk%2BdDsFeivMG1EUNFHJKqEImAiAm%2FlrPiF1gybEdzgjEqUoftwBL2qxaMtkitWG8UxKUayr6AwghEAIaDDM3NTYzNTU3MDA3MCIM%2BY%2BRbP5bgBMV0WafKtcD7z6X%2FLEz0mkHWYo45w8MZsJRox%2BS8gvWW0ufEcmC9OcA9%2BZSfBdPb4DstQulQZA5OKJ1I2mkqo5zKGcjhQ8uVzhKCEHfdnEB3Tm06ZY4L8sF9WyOV%2FTFbAQ0JzBQw6KPM0ubC0xaNIOnDXvfdzqt7nDLx6vC7Jxo%2FnIrmD37wkFeshib5YDtuU%2F6bBmPQqXU3PgmUODfWDfNj5Bqy6JhK5dqF0S0%2F09ny86v7jNZX%2BaNHc%2FV21mYUHYNSuwyJJLoeVC001dKebzxkXkfTbrKGAxaXz%2F3gVBX4OPwrwKR1nYxly4BtRay7vF8fWIPoJdHhdxiXEHYTNyJA%2FZbeHAjXlvVvvPximI73GzPYWxDj8K7ns%2BrshCRZboISSP0okwp%2FdgMPSa%2B73Z2pUbWdZILKvblgSRitDoL1baXQLd0S22EOHQS%2FXMLIB3wMPnY5ysuMNB%2FCjGLGO%2B1%2BxldCdzMeLIXacqkDG%2BiWxQV%2FPYTzMJor%2FcjvTbTaHI8IY1OKC17Q8Cms06VF9k8%2B1En5E0qSVJDxMRZy0Hdu8BVN%2FEpZvgLlNvLFkV%2FalCjmN4OHT5AOq%2Fb6V9Am%2FbXa7Eu8Z7%2BDiwv2OGz06UwsyRSb0G5iVx57EMAz0WGMMef5JEGOqYBsiwfoTFGtG9%2Ff2ib21I0VadcpBmX90lkty7tLS8VXaDOZFY3b5KZB%2FBWvkKym2YouCgSJTuxO6P2X15NRIm2tY4v7WhsOWQONcOONhuZCsU60fvEsVJnHV46IXGRAov%2BFHqMeOChYxUHoBaDA7UEG2yoXQdeMvk89c8m47fFFKzQq5jwlL5RTC1xgL1MdUespA32Bw5oalBq6bNAPrWI7yN67T75Ng%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220322T010705Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLPYNTLOHA%2F20220322%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=1172b039bd7e807c8c111280e3af1bb289cc70560519793a5749d60ab9e57971'
user_id: USsRhsHYZGBPnQw8CByJyEQW
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
ExternalLinksList:
description: List of external_link objects
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalLinksList'
examples:
List of External Links:
value:
_embedded:
external_links:
- id: EL_sVv61JP93htzDFTtNhbsdd
created_at: '2022-05-24T06:50:51.94704Z'
duration: null
expired: true
expires_at: '2022-05-24T07:05:51.934426Z'
file_id: FILE_bJecqoRPasStEPVpvKHtgA
tags: {}
type: UPLOAD
url: 'https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEIb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJIMEYCIQCRwhQF2A0kHmtOUShU8uI2g1JRbA0fxx%2Bkl5IGtZ6ygwIhAPSKP6KEEHYHhMqD54bqT%2Fzb495zGacrdZBEcGciNfZaKtMECHAQAhoMMzc1NjM1NTcwMDcwIgyA5j6IswvJUsAaiAoqsASHRDILId%2BbaQZiUOu29lOE9FmgXlw8uxpV3IiLMWmn2l4Iq8rTdANxXRVCM%2BWrT53DiBACQrUOSrmokWHfJ0DiizxD%2Fky06kDSbiVrD%2BK9DckqiBlg84N%2F7JKqyNeQUJKrUHtDKoH%2BSM%2FYNTgur%2BaGR07as8NG8qnhO8sJela5yWugYJjw4iJoZp%2BmOn%2BVL0Ry9OjEcoKxXCBDJF8W1ppa%2BRa1zfwpufJGWZYYZUiv31pVleRuCDyVef4p8MejnzRiEHFE4TNgcPYZW%2F97KRjQ9OYWbh7ygDuki9ejVdMICywCHEGLEtP%2Fr5EIU1IjWJUt6pwkjud2hHJ18f8j5U5j%2FFQF7wiTl3FlqqnXrLSHJaVA6fyJWbCTcfR%2B3Hr%2FbTSZWZWctXHO%2ByBYR1D9z9KhD%2FwaO87k0KRBRSggiMjVsgILguTdOeggcg3XyfUg2zRj6GPQF7HfBN%2FtGYoTO7l2IR6NBB7FBiusXzJMQd7IFC8fW%2BbiFlFmZk0IlGIUJcB2cetDEGL3k7McHOx9P7ywsy0f7wGdMTS01JgSOAt9Ic0nlljKj0dItwz1f%2FCIcm1%2FWvCZ2W6g0PbtM9dDEL04j3rIBm7spqqtx8KIj2hZs3cEkp8yr%2Bx%2B%2BZRXbMUnT7zNsEGShQGDVwxKP1sA834ZhF9KkC0RdRZFqvgXnC7Sk02tqSGVIUTzcymCl2jYfgiBfolPVW7cwEoIPOv%2FNEp%2BEHWZ7eJMP%2BiAnyMnXDkaGTCL97GUBjqoAQS5iN2Njmu0X6N5249v6JJ3HaoDqIE3p3A6IjwMK%2Byyx81LLYDkZTLVjo2t9DzPLjUy5TiTGd0mNt0Gp5fJ4vo4V5T2BnRWLTxS3tCrG69lTVWBEZfg9NniNhRwRsRrwW%2B%2BeJGIdt7E7CSciDB6fknhtALrh%2FtNKgqF4ofP8QxZedsz9FICsjt1On3r1BUqBLM9gZKdDvapil9PWDJeiRr24dbivHZfYg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220524T065051Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLGNOGWHOG%2F20220524%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=8d360d38a6752dba12fbebb2a83ad5c129b5fc475bf323f169fa826c6bca1b68'
user_id: USsRhsHYZGBPnQw8CByJyEQW
- id: EL_dh5YS66GePpkeSVyL4VdBL
created_at: '2022-03-22T01:07:05.074313Z'
duration: null
expired: true
expires_at: '2022-03-22T01:22:05.070415Z'
file_id: FILE_bJecqoRPasStEPVpvKHtgA
tags: {}
type: UPLOAD
url: 'https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MU2n7BSovtwYsWYZF6rBnnzk/DRIVERS_LICENSE_FRONT/FILE_bJecqoRPasStEPVpvKHtgA/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIACy1Tl%2BahJzC4xuMTzdUk%2BdDsFeivMG1EUNFHJKqEImAiAm%2FlrPiF1gybEdzgjEqUoftwBL2qxaMtkitWG8UxKUayr6AwghEAIaDDM3NTYzNTU3MDA3MCIM%2BY%2BRbP5bgBMV0WafKtcD7z6X%2FLEz0mkHWYo45w8MZsJRox%2BS8gvWW0ufEcmC9OcA9%2BZSfBdPb4DstQulQZA5OKJ1I2mkqo5zKGcjhQ8uVzhKCEHfdnEB3Tm06ZY4L8sF9WyOV%2FTFbAQ0JzBQw6KPM0ubC0xaNIOnDXvfdzqt7nDLx6vC7Jxo%2FnIrmD37wkFeshib5YDtuU%2F6bBmPQqXU3PgmUODfWDfNj5Bqy6JhK5dqF0S0%2F09ny86v7jNZX%2BaNHc%2FV21mYUHYNSuwyJJLoeVC001dKebzxkXkfTbrKGAxaXz%2F3gVBX4OPwrwKR1nYxly4BtRay7vF8fWIPoJdHhdxiXEHYTNyJA%2FZbeHAjXlvVvvPximI73GzPYWxDj8K7ns%2BrshCRZboISSP0okwp%2FdgMPSa%2B73Z2pUbWdZILKvblgSRitDoL1baXQLd0S22EOHQS%2FXMLIB3wMPnY5ysuMNB%2FCjGLGO%2B1%2BxldCdzMeLIXacqkDG%2BiWxQV%2FPYTzMJor%2FcjvTbTaHI8IY1OKC17Q8Cms06VF9k8%2B1En5E0qSVJDxMRZy0Hdu8BVN%2FEpZvgLlNvLFkV%2FalCjmN4OHT5AOq%2Fb6V9Am%2FbXa7Eu8Z7%2BDiwv2OGz06UwsyRSb0G5iVx57EMAz0WGMMef5JEGOqYBsiwfoTFGtG9%2Ff2ib21I0VadcpBmX90lkty7tLS8VXaDOZFY3b5KZB%2FBWvkKym2YouCgSJTuxO6P2X15NRIm2tY4v7WhsOWQONcOONhuZCsU60fvEsVJnHV46IXGRAov%2BFHqMeOChYxUHoBaDA7UEG2yoXQdeMvk89c8m47fFFKzQq5jwlL5RTC1xgL1MdUespA32Bw5oalBq6bNAPrWI7yN67T75Ng%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220322T010705Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLPYNTLOHA%2F20220322%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=1172b039bd7e807c8c111280e3af1bb289cc70560519793a5749d60ab9e57971'
user_id: USsRhsHYZGBPnQw8CByJyEQW
page:
limit: 10
next_cursor: EL_dh5YS66GePpkeSVyL4VdBL
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
MerchantUpdated:
description: Single Merchant object
content:
application/json:
schema:
$ref: '#/components/schemas/Merchant'
examples:
Merchant - Disable a Merchant:
value:
id: MUeDVrf2ahuKc9Eg5TeZugvs
created_at: '2022-01-27T07:37:04.03Z'
updated_at: '2022-01-27T07:37:06.12Z'
application: APgPDQrLD52TYvqazjHJJchM
card_cvv_required: false
card_expiration_date_required: true
convenience_charges_enabled: true
creating_transfer_from_report_enabled: true
default_partial_authorization_enabled: false
fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
gateway: null
gross_settlement_enabled: false
identity: IDuqZpDw28f2KK6YuDk4jNLg
level_two_level_three_data_enabled: true
mcc: '4900'
merchant_name: Finix Flowers
merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
mid: FNXw5a7pBKHsCSgCAyQvU2soL
onboarding_state: APPROVED
processing_enabled: false
processor: DUMMY_V1
processor_details:
mid: FNXw5a7pBKHsCSgCAyQvU2soL
api_key: secretValue
ready_to_settle_upon: SUCCESSFUL_CAPTURE
rent_surcharges_enabled: true
settlement_enabled: true
settlement_funding_identifier: UNSET
surcharges_enabled: false
tags:
key_2: value_2
verification: VI5DBvVQ3ye5PcnUCSSvj84d
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
verifications:
href: 'https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs/verifications'
merchant_profile:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MP7tbAZ1RpjFycrfBVo6z4Ky'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
verification:
href: 'https://finix.sandbox-payments-api.com/verifications/VI5DBvVQ3ye5PcnUCSSvj84d'
Merchant - Enable Buyer Charges:
value:
id: MUeDVrf2ahuKc9Eg5TeZugvs
created_at: '2022-01-27T07:37:04.03Z'
updated_at: '2022-01-27T07:37:06.12Z'
application: APgPDQrLD52TYvqazjHJJchM
card_cvv_required: false
card_expiration_date_required: true
convenience_charges_enabled: true
creating_transfer_from_report_enabled: true
default_partial_authorization_enabled: false
fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
gross_settlement_enabled: false
identity: IDuqZpDw28f2KK6YuDk4jNLg
level_two_level_three_data_enabled: true
mcc: '4900'
merchant_name: Finix Flowers
merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
mid: FNXw5a7pBKHsCSgCAyQvU2soL
onboarding_state: APPROVED
processing_enabled: true
processor: DUMMY_V1
processor_details:
mid: FNXw5a7pBKHsCSgCAyQvU2soL
api_key: secretValue
ready_to_settle_upon: SUCCESSFUL_CAPTURE
rent_surcharges_enabled: true
settlement_enabled: true
settlement_funding_identifier: UNSET
surcharges_enabled: true
tags:
key_2: value_2
verification: VI5DBvVQ3ye5PcnUCSSvj84d
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
verifications:
href: 'https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs/verifications'
merchant_profile:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MP7tbAZ1RpjFycrfBVo6z4Ky'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
verification:
href: 'https://finix.sandbox-payments-api.com/verifications/VI5DBvVQ3ye5PcnUCSSvj84d'
Merchant - Enable Level 2/3 Processing:
value:
id: MUeDVrf2ahuKc9Eg5TeZugvs
created_at: '2022-01-27T07:37:04.03Z'
updated_at: '2022-01-27T07:37:06.12Z'
application: APgPDQrLD52TYvqazjHJJchM
card_cvv_required: false
card_expiration_date_required: true
convenience_charges_enabled: true
creating_transfer_from_report_enabled: true
default_partial_authorization_enabled: false
fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
gross_settlement_enabled: false
identity: IDuqZpDw28f2KK6YuDk4jNLg
level_two_level_three_data_enabled: true
mcc: '4900'
merchant_name: Finix Flowers
merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
mid: FNXw5a7pBKHsCSgCAyQvU2soL
onboarding_state: APPROVED
processing_enabled: true
processor: DUMMY_V1
processor_details:
mid: FNXw5a7pBKHsCSgCAyQvU2soL
api_key: secretValue
ready_to_settle_upon: SUCCESSFUL_CAPTURE
rent_surcharges_enabled: false
settlement_enabled: false
settlement_funding_identifier: UNSET
surcharges_enabled: false
tags:
key_2: value_2
verification: VI5DBvVQ3ye5PcnUCSSvj84d
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
verifications:
href: 'https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs/verifications'
merchant_profile:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MP7tbAZ1RpjFycrfBVo6z4Ky'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
verification:
href: 'https://finix.sandbox-payments-api.com/verifications/VI5DBvVQ3ye5PcnUCSSvj84d'
Merchant - Enable Partial Authorizations:
value:
id: MUeDVrf2ahuKc9Eg5TeZugvs
created_at: '2022-01-27T07:37:04.03Z'
updated_at: '2022-01-27T07:37:06.12Z'
application: APgPDQrLD52TYvqazjHJJchM
card_cvv_required: false
card_expiration_date_required: true
convenience_charges_enabled: true
creating_transfer_from_report_enabled: true
default_partial_authorization_enabled: true
fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE
gross_settlement_enabled: false
identity: IDuqZpDw28f2KK6YuDk4jNLg
level_two_level_three_data_enabled: true
mcc: '4900'
merchant_name: Finix Flowers
merchant_profile: MP7tbAZ1RpjFycrfBVo6z4Ky
mid: FNXw5a7pBKHsCSgCAyQvU2soL
onboarding_state: APPROVED
processing_enabled: true
processor: DUMMY_V1
processor_details:
mid: FNXw5a7pBKHsCSgCAyQvU2soL
api_key: secretValue
ready_to_settle_upon: SUCCESSFUL_CAPTURE
rent_surcharges_enabled: false
settlement_enabled: false
settlement_funding_identifier: UNSET
surcharges_enabled: false
tags:
key_2: value_2
verification: VI5DBvVQ3ye5PcnUCSSvj84d
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
verifications:
href: 'https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs/verifications'
merchant_profile:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MP7tbAZ1RpjFycrfBVo6z4Ky'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
verification:
href: 'https://finix.sandbox-payments-api.com/verifications/VI5DBvVQ3ye5PcnUCSSvj84d'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
ApplePaySession:
description: Single apple_pay_session object
content:
application/json:
schema:
$ref: '#/components/schemas/ApplePaySession'
examples:
Apple Pay Session:
value:
id: APPLEPAYSESSION_xxx
created_at: '2021-11-22T23:58:19.50Z'
updated_at: '2021-11-22T23:58:19.50Z'
session_details: '{"epochTimestamp":1640213041060,"expiresAt":1640216641060,"merchantSessionIdentifier":"SSH1524BA9006A944B8B9B8FB60227D9990_916523AAED1343F5BC5815E12BEE9250AFFDC1A17C46B0DE5A943F0F94927C24","nonce":"a5ee8554","merchantIdentifier":"23D5E1F154400B277E14CC8361878AA0AAFD46B2DF74003C7587B256269102BD","domainName":"tj.ngrok.io","displayName":"Christmas Shopping","signature":"...","operationalAnalyticsIdentifier":"Christmas Shopping:23D5E1F154400B277E14CC8361878AA0AAFD46B2DF74003C7587B256269102BD","retries":0}'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/apple_pay_sessions/APPLEPAYSESSION_xxx'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
AdjustmentTransfersList:
description: List of adjustment_transfer objects
content:
application/json:
schema:
$ref: '#/components/schemas/AdjustmentTransfersList'
examples:
List of Adjustment Transfers in a Dispute:
value:
_embedded:
transfers:
- id: TRrqiR7x5zwUPV5SpPSbKH8B
created_at: '2022-01-27T07:43:03.94Z'
updated_at: '2022-01-27T07:43:03.48Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 888888
amount_requested: 888888
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: 'FALSE'
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM
messages: []
raw: null
ready_to_settle_at: '2022-01-27T07:43:03.91Z'
security_code_verification: null
source: null
state: SUCCEEDED
statement_descriptor: null
subtype: PLATFORM_CREDIT
tags: {}
trace_id: c14d481c-60eb-4338-8331-9f34b3445710
type: DISPUTE
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRrqiR7x5zwUPV5SpPSbKH8B'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRrqiR7x5zwUPV5SpPSbKH8B/payment_instruments'
disputed_transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRrqiR7x5zwUPV5SpPSbKH8B/disputed_transfer'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8'
- id: TRw6U5auHfgKfgT4APKgkh4f
created_at: '2022-09-16T22:21:54.66Z'
updated_at: '2022-09-16T22:21:54.66Z'
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 888888
amount_requested: 888888
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
destination: null
externally_funded: 'FALSE'
failure_code: null
failure_message: null
fee: 0
idempotency_id: null
merchant_identity: IDpYDM7J9n57q849o9E9yNrG
messages: []
raw: null
ready_to_settle_at: '2022-09-16T22:21:54.81Z'
security_code_verification: null
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
statement_descriptor: null
subtype: MERCHANT_CREDIT
tags: {}
trace_id: d5416d16-df58-4c9a-9759-076cb28800d5
type: DISPUTE
_links:
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
self:
href: 'https://finix.sandbox-payments-api.com/transfers/TRw6U5auHfgKfgT4APKgkh4f'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/transfers/TRw6U5auHfgKfgT4APKgkh4f/payment_instruments'
disputed_transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRw6U5auHfgKfgT4APKgkh4f/disputed_transfer'
source:
href: 'https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137'
fee_profile:
href: 'https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc'
page:
offset: 0
limit: 20
count: 4
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
FileDownload:
description: Example response
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/FileDownload'
examples:
Download Begins:
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'
ComplianceForm:
description: Example response
content:
application/json:
schema:
$ref: '#/components/schemas/ComplianceForm'
examples:
Blank Compliance Form:
value:
id: cf_fEojUGLjwUiqNTBp68JWq8
created_at: '2022-06-22T01:20:12.439149Z'
updated_at: '2022-07-06T17:32:00.328699Z'
application_id: APdoThHn4jjYUSxQf76txAgg
compliance_form_template: cft_wua8ua1yLAcHRK9mx2mF9K
due_at: '2022-09-20T01:20:12.430835Z'
files:
signed_file: null
unsigned_file: FILE_fFGMCY4sxGYTqpjnXh54kC
linked_to: MUfnskvHiiDgP7x3TVL2LkG3
linked_type: MERCHANT
pci_saq_a:
ip_address: null
is_accepted: false
name: null
signed_at: null
title: null
user_agent: null
state: INCOMPLETE
tags: {}
type: PCI_SAQ_A
valid_from: '2022-06-22T01:20:12.978825Z'
valid_until: '2023-06-22T01:20:12.97883Z'
version: '2018.5'
Complete Compliance Form:
value:
id: cf_pqJFvPD3DXAnut1w6iNFK
created_at: '2023-07-06T22:18:19.806288Z'
updated_at: '2023-07-06T22:26:41.003926Z'
linked_to: MUqXc76t2KiqtikLni1zrMmW
linked_type: MERCHANT
application: APgix2NcQ9ETSPpVoqwSYUHx
type: PCI_SAQ_A
version: '2018.10'
valid_from: '2023-07-06T22:18:25.775726Z'
valid_until: '2024-07-05T22:18:25.77573Z'
tags: {}
pci_saq_a:
name: John Smith
signed_at: '2022-03-18T16:42:55Z'
user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
ip_address: 42.1.1.113
is_accepted: true
title: CTO
due_at: '2023-10-04T22:18:19.790434Z'
compliance_form_template: cft_k6o6W33fdwnMXNxNhe4nfN
files:
unsigned_file: FILE_AwHMYuDX7w2d8hobjkxKD
signed_file: FILE_6E9ZpgGZJGmLcj2PiZzXHB
state: COMPLETE
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
InstrumentUpdateDownload:
description: "The updated `Payment Instruments` will be returned in the following comma seperated format:\n\npayment\\_instrument\\_original,\t| payment\\_instrument_new, |result\n--------------------------- | ---------------------- | -----\nPIlkNdfZibF8a7Prd2teGB1 | PI3aQGaCM5nDMjqyTXcbUJzR| CARD\\_EXPIRATION_UPDATED\nPIJPXW0HZ9lpO1nb6sog5DiX | PIdBHpy7BBSxd2z81VdKpVbT | CARD\\_NOT\\_FOUND\nPI0ovZAS9yfEtgDrZnMaiLvi | PIhXS0jXNTmklyVk91EsohuZ | CONTACT\\_CARDHOLDER\nPInOrrKY3G1U33hGYTQJ8cIY | | CLOSED\\_ACCOUNT\nPIlkAOt5kTVhuuxxbmOi9qn | | INVALID\\_CARD\nPIiRLbbG4i5daypWNzIrq2xD | | NO\\_CHANGE\\_FOUND\nPIy5llZGt6VxlDqbcTgATqeH | \t | UNKNOWN"
content:
application/json:
schema:
$ref: '#/components/schemas/FileDownload'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
AuthorizationUpdated:
description: Single captured Authorization object
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationCaptured'
examples:
Capture Authorization:
value:
id: AUbrumLihwhdLixtbU1mfMiF
created_at: '2022-10-06T20:22:42.25Z'
updated_at: '2022-10-07T17:09:22.85Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 118
amount_requested: 118
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2022-10-13T20:22:42.25Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
test_key_101: test_val_101
trace_id: 2724719e-6cc4-4cba-a859-2e6ac0bffb9b
transfer: TRs6APHuUAvSYq2FfTDkb5d8
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUbrumLihwhdLixtbU1mfMiF'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRs6APHuUAvSYq2FfTDkb5d8'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Capture Authorization - Level 2 Processing:
value:
id: AUj9xCyjoNMxcJjaQw2GW7GZ
created_at: '2022-10-06T20:22:43.39Z'
updated_at: '2022-10-07T17:07:46.24Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 108
amount_requested: 108
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2022-10-13T20:22:43.39Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
test_key_100: test_val_100
trace_id: 20fb8474-1b04-433e-9573-d58e6fcc1586
transfer: TRmGcgUgKxqpTVC2UVKngFsv
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUj9xCyjoNMxcJjaQw2GW7GZ'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRmGcgUgKxqpTVC2UVKngFsv'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Capture Authorization - Level 3 Processing:
value:
id: AUxgS2JLMnicqNYBpsViNQUp
created_at: '2022-09-28T19:07:52.44Z'
updated_at: '2022-10-10T06:43:53.74Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2022-10-05T19:07:52.44Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
order_number: 21DFASJSAKAS
trace_id: 99df414c-7afb-4d97-b3cd-3592a37eefa8
transfer: TRskeVxUegfhhffGLFX4TEUa
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUxgS2JLMnicqNYBpsViNQUp'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRskeVxUegfhhffGLFX4TEUa'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Void Authorization:
value:
id: AUeYYckKJTrBVu1j8FYLzJ3W
created_at: '2022-10-07T18:25:23.30Z'
updated_at: '2022-10-07T18:29:59.38Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 100
amount_requested: 100
application: APgPDQrLD52TYvqazjHJJchM
currency: USD
expires_at: '2022-10-14T18:25:23.30Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: true
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg
messages: []
raw: null
security_code_verification: MATCHED
source: PIe2YvpcjvoVJ6PzoRPBK137
state: SUCCEEDED
tags:
order_number: 21DFASJSAKAS
trace_id: 560e44af-5d22-4af2-801e-03d2dad69dc7
transfer: null
void_state: SUCCEEDED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUeYYckKJTrBVu1j8FYLzJ3W'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg'
Capture Card Present Authorization - EMV Card:
value:
id: AUuCfRve8QG6G1wnPCReiLma
created_at: '2022-10-06T20:22:42.25Z'
updated_at: '2022-10-07T17:09:22.85Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: POSTAL_CODE_AND_STREET_MATCH
amount: 150
amount_requested: 118
application: APeUbTUjvYb1CdPXvNcwW1wP
card_present_details: null
currency: USD
device: DVsEanpBtsAVvCHbNXkFaH6f
expires_at: '2022-10-13T20:22:42.25Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages: []
raw: null
security_code_verification: MATCHED
source: PIjnHHLBZvRu6GPEZdFt7E2q
state: SUCCEEDED
tags:
order_number: chris123transfer
trace_id: 957ce193-b4e4-4a39-88e2-d88a019982d2
transfer: TRjiUo5CXLmaJp4k9PL7iP8z
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUuCfRve8QG6G1wnPCReiLma'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRjiUo5CXLmaJp4k9PL7iP8z'
device:
href: 'https://finix.sandbox-payments-api.com/devices/DVsEanpBtsAVvCHbNXkFaH6f'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR'
Capture Card Present Authorization - Non-EMV Card:
value:
id: AUarp7Pz21Low4u2Urw5Ub4W
created_at: '2019-04-29T20:44:00.13Z'
updated_at: '2022-10-10T05:59:17.59Z'
3ds_redirect_url: null
additional_buyer_charges: null
additional_healthcare_data: null
address_verification: null
amount: 3138
amount_requested: 3138
application: APeUbTUjvYb1CdPXvNcwW1wP
capture_amount: 150
card_present_details:
emv_data:
application_identifier: A0000001523010
application_label: DISCOVER
application_preferred_name: null
application_transaction_counter: '0005'
cryptogram: ARCQ F666F8891F870D33
issuer_code_table_index: null
pin_verified: false
tags: null
masked_account_number: '************0059'
name: Test Card 05
brand: DISCOVER
entry_mode: CHIP_ENTRY
payment_type: CREDIT
approval_code: '004839'
currency: USD
device: DVfKLD9GZtsjcJxLtc2yCcfd
expires_at: '2019-05-06T20:44:00.13Z'
failure_code: null
failure_message: null
idempotency_id: null
is_void: false
merchant: MUeDVrf2ahuKc9Eg5TeZugvs
merchant_identity: IDsbTBawhnLBAVeinRb84vFR
messages: []
raw: null
security_code_verification: null
source: PImTHaz7XVPx4M7mhu9x8gkU
state: SUCCEEDED
tags:
TicketNumber: '45878'
trace_id: FNX35FSuraeKKJr65wkGVFJni
transfer: TRqQCAX7nYHUnkE5YPFTknqd
void_state: UNATTEMPTED
_links:
self:
href: 'https://finix.sandbox-payments-api.com/authorizations/AUarp7Pz21Low4u2Urw5Ub4W'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP'
transfer:
href: 'https://finix.sandbox-payments-api.com/transfers/TRqQCAX7nYHUnkE5YPFTknqd'
device:
href: 'https://finix.sandbox-payments-api.com/devices/DVfKLD9GZtsjcJxLtc2yCcfd'
merchant_identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
OnboardingForm:
description: A single `onboarding_from` objext.
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingForm'
examples:
Onboarding Form:
value:
id: obf_cJUfiz97L8de54EwkC3Hiu
onboarding_data:
entity:
title: CEO
first_name: John
last_name: Smith
email: john.smith@finix.com
business_name: Finix Flowers
business_type: CORPORATION
doing_business_as: Finix Flowers
phone: '14158885080'
business_phone: '14158885080'
mcc: '4900'
url: 'https://www.finix.com'
ownership_type: PRIVATE
default_statement_descriptor: DEMOCOMPANY
max_transaction_amount: 100000
annual_card_volume: '1000000'
principal_percentage_ownership: '75'
tax_id: '*****6789'
business_tax_id: '*****6789'
has_accepted_credit_cards_previously: false
personal_address:
line1: 123 Boren Ave
city: Seattle
region: WA
postal_code: '98040'
country: USA
business_address:
line1: 123 Bellevue Way
city: Bellevue
region: WA
postal_code: '98039'
country: USA
dob:
day: 13
month: 4
year: 1982
incorporation_date:
day: 9
month: 3
year: 2018
associated_entities:
- title: CFO
first_name: Alex
last_name: Smith
email: alex.smith@finix.com
phone: '14158885080'
personal_address:
line1: 4848 84th St
city: Bellevue
region: WA
postal_code: '98032'
country: USA
dob:
day: 13
month: 4
year: 1985
principal_percentage_ownership: 25
tax_id: '*****6789'
payment_instruments:
name: SARAH BANKER
bank_code: '123456789'
account_number: '*****6789'
account_type: CHECKING
type: BANK_ACCOUNT
additional_underwriting_data:
refund_policy: NO_REFUNDS
average_ach_transfer_amount: 2000000
average_card_transfer_amount: 20000
annual_ach_volume: 2000000
business_description: CONSUMER
volume_distribution_by_business_type:
other_volume_percentage: 0
person_to_person_volume_percentage: 0
business_to_business_volume_percentage: 90
business_to_consumer_volume_percentage: 10
consumer_to_consumer_volume_percentage: 0
card_volume_distribution:
ecommerce_percentage: 100
card_present_percentage: 0
mail_order_telephone_order_percentage: 0
max_transaction_amount: 100000
merchant_processors:
- processor: LITLE_V1
onboarding_link_details:
return_url: 'https://www.finixflowers.com/'
expired_session_url: 'https://www.finixflowers.com/login'
fee_details_url: 'https://www.finixflowers.com/fee_details'
terms_of_service_url: 'https://www.finixflowers.com/ToS'
expiration_in_minutes: 10080
onboarding_link:
expires_at: '2023-04-06T19:16:28.387Z'
link_url: 'https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_cJUfiz97L8de54EwkC3Hiu&applicationId=APgPDQrLD52TYvqazjHJJchM...'
status: IN_PROGRESS
identity_id: null
application_id: APgPDQrLD52TYvqazjHJJchM
created_at: '2023-03-30T19:16:28.377022Z'
updated_at: '2023-03-30T19:16:28.377022Z'
tags: {}
OnboardingFormLink:
description: A link for users to return to their `onboarding_form` at any time.
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingFormLink'
examples:
Onboarding Form Link:
value:
expires_at: '2022-07-11T22:39:55.469Z'
link_url: 'https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_bXQj8iSgYwXf432yJcWbKv&applicationId=APgPDQrLD52TYvqazjHJJchM&bearerToken=eyJhbGciOiJIUzUxMiJ9.eyJvbmJvYXJkaW5nX2Zvcm1faWQiOiJvYmZfYlhRajhpU2dZd1hmNDMyeUpjV2JLdiIsImZlZV9kZXRhaWxzX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS9kb2NzIiwiZXhwaXJlZF9zZXNzaW9uX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS8iLCJpc3MiOiJodHRwczovL3d3dy5maW5peC5jb20iLCJyZXR1cm5fdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL2RvY3MiLCJleHAiOjE2NTc1NzkxOTUsImFwcGxpY2F0aW9uX2lkIjoiQVBnUERRckxENTJUWXZxYXpqSEpKY2hNIiwiaWF0IjoxNjU3NTc3Mzk1LCJtZXJjaGFudF9tYXhfdHJhbnNhY3Rpb25fYW1vdW50IjoxMDAwMDAsInRlcm1zX29mX3NlcnZpY2VfdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL3Rlcm1zLWFuZC1wb2xpY2llcyJ9.uQvwqhOxSmpX4zMSVn891ClNB_cWHmXhLfyOzRiKRoyn7VAqVOWrO8dJiY-OvN4venPWnPOxM0r3NiIyfgQv6g'
PayoutProfile:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayoutProfile'
examples:
Payout Profile - Gross:
value:
id: POmhJeq1AsfwetG8LwhA4S9U
created_at: '2022-10-25T16:54:08.20Z'
updated_at: '2022-10-25T16:54:08.20Z'
linked_id: MU6TXYpA37uM9H4GwitQr8E3
linked_type: MERCHANT
gross:
payouts:
frequency: DAILY
submission_delay_days: 1
payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
rail: SAME_DAY_ACH
fees:
frequency: MONTHLY
day_of_month: 1
submission_delay_days: 3
payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
rail: SAME_DAY_ACH
tags: {}
type: GROSS
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payout_profiles/POmhJeq1AsfwetG8LwhA4S9U'
Payout Profile - Net:
value:
id: POhiPobG6PoUteNVKpUauWVP
created_at: '2022-10-25T07:20:34.37Z'
updated_at: '2022-10-25T07:20:34.37Z'
linked_id: MU6TXYpA37uM9H4GwitQr8E3
linked_type: MERCHANT
net:
frequency: CONTINUOUS
submission_delay_days: 1
payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
rail: STANDARD
tags: {}
type: NET
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payout_profiles/POhiPobG6PoUteNVKpUauWVP'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
PayoutProfilesList:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayoutProfilesList'
examples:
List of Payout Profiles:
value:
_embedded:
payout_profiles:
- id: PO6UbajkQrbFd5nAvs57dwyn
created_at: '2022-10-24T21:38:23.72Z'
updated_at: '2022-10-24T21:38:23.72Z'
tags: {}
linked_id: MU6TXYpA37uM9H4GwitQr8E3
linked_type: MERCHANT
type: GROSS
gross:
payouts:
frequency: DAILY
submission_delay_days: 1
payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
rail: SAME_DAY_ACH
fees:
frequency: MONTHLY
day_of_month: 1
submission_delay_days: 3
payment_instrument_id: PI2EmosKE8tvfSiF7Pd4SYE
rail: NEXT_DAY_ACH
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payout_profiles/PO6UbajkQrbFd5nAvs57dwyn'
- id: POf5rP3c3XyRX7M6PuCvmgxf
created_at: '2022-10-20T19:43:18.02Z'
updated_at: '2022-10-20T19:43:18.02Z'
tags: {}
linked_id: MUfbbKm7vRmBX2bP92pKw9zZ
linked_type: MERCHANT
type: CUSTOM
custom: {}
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payout_profiles/POf5rP3c3XyRX7M6PuCvmgxf'
_links:
self:
href: 'https://finix.sandbox-payments-api.com/payout_profiles'
next:
href: 'https://finix.sandbox-payments-api.com/payout_profiles?after_cursor=POf5rP3c3XyRX7M6PuCvmgxf'
page:
limit: 100
next_cursor: POf5rP3c3XyRX7M6PuCvmgxf
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
ComplianceFormList:
description: List of `Compliance Form` objects.
content:
application/json:
schema:
$ref: '#/components/schemas/ComplianceFormList'
examples:
List of Compliance Forms:
value:
_embedded:
compliance_forms:
- id: cf_pqJFvPD3DXAnut1w6iNFK
created_at: '2023-07-06T22:18:19.806288Z'
updated_at: '2023-07-06T22:26:41.003926Z'
linked_to: MUqXc76t2KiqtikLni1zrMmW
linked_type: MERCHANT
application: APgix2NcQ9ETSPpVoqwSYUHx
type: PCI_SAQ_A
version: '2018.10'
valid_from: '2023-07-06T22:18:25.775726Z'
valid_until: '2024-07-05T22:18:25.77573Z'
tags: {}
pci_saq_a:
name: John Smith
signed_at: '2022-03-18T16:42:55Z'
user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
ip_address: 42.1.1.113
is_accepted: true
title: CTO
due_at: '2023-10-04T22:18:19.790434Z'
compliance_form_template: cft_k6o6W33fdwnMXNxNhe4nfN
files:
unsigned_file: FILE_AwHMYuDX7w2d8hobjkxKD
signed_file: FILE_6E9ZpgGZJGmLcj2PiZzXHB
state: COMPLETE
page:
next_cursor: null
limit: 10
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'
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
MerchantPIVerification:
description: Single Verification object
content:
application/json:
schema:
$ref: '#/components/schemas/MerchantPIVerification'
examples:
Merchant - Reverify a Merchant:
value:
id: VIecViWTa71vFvgTgD3m8pyL
created_at: '2023-10-17T23:50:21.71Z'
updated_at: '2023-10-17T23:50:21.76Z'
application: APgPDQrLD52TYvqazjHJJchM
identity: null
merchant: MUucec6fHeaWo3VHYoSkUySM
merchant_identity: IDpYDM7J9n57q849o9E9yNrG
messages: []
payment_instrument: null
payment_instrument_verification_details:
push_to_card_domestic: null
push_to_card_cross_border: null
card_type: null
billing_currency: null
issuer_country: null
processor: DUMMY_V1
raw: null
state: PENDING
tags: {}
trace_id: 7ba9a29a-8988-48bb-9c0e-3b1889aa1f6c
type: MERCHANT
_links:
self:
href: 'https://finix.sandbox-payments-api.com/verifications/VIecViWTa71vFvgTgD3m8pyL'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
merchant:
href: 'https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM'
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
schemas:
Application:
type: object
properties:
id:
type: string
example: APxxxxxxxxxxxxxxxxxx
description: ID of the `Application` resource.
created_at:
type: string
description: Point in time when this object was created.
format: date-time
updated_at:
type: string
description: Point in time when this object was most recently updated.
format: date-time
card_cvv_required:
type: boolean
description: Details if the `Application` requires CVV code.
card_expiration_date_required:
type: boolean
description: Details if the `Application` requires the card's expiration date.
creating_transfer_from_report_enabled:
type: boolean
description: Details if the `Application` is automatically set to create `Transfers` once settlement reports get generated.
enabled:
type: boolean
description: Details if the `Application` is enabled and active. Set to **false** to disable the `Application`.
fee_ready_to_settle_upon:
type: string
enum:
- RECONCILIATION
- SUCCESSFUL_CAPTURE
description: Details when the `fees` of `Authroizations` submitted under the `Application` will be ready to settle.
nullable: true
name:
type: string
description: The name of the `Application`.
owner:
type: string
example: IDxxxxxxxxxxxxxxxxxx
description: ID of the `Identity` resource that created the `Application`.
processing_enabled:
type: boolean
description: 'Details if transaction processing is enabled for the `Application`. '
ready_to_settle_upon:
type: string
enum:
- RECONCILIATION
- SUCCESSFUL_CAPTURE
description: Details when transactions submitted under the `Application` will be ready to settle.
nullable: true
settlement_enabled:
type: boolean
description: 'Details if settlement processing is enabled for the `Application`. '
settlement_funding_identifier:
type: string
enum:
- UNSET
- MID_AND_DATE
- MID_AND_MERCHANT_NAME
default: UNSET
description: |-
Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors.
- **UNSET**: No additional details get provided to the processor.
- **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225**
- **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name` (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant**
These details appear alongside the seller's payout in their bank account as a description of the deposit.
tags:
$ref: '#/components/schemas/Tags'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
authorizations:
type: object
properties:
href:
type: string
application_profile:
type: object
properties:
href:
type: string
disputes:
type: object
properties:
href:
type: string
identities:
type: object
properties:
href:
type: string
merchants:
type: object
properties:
href:
type: string
owner_identity:
type: object
properties:
href:
type: string
payment_instruments:
type: object
properties:
href:
type: string
processors:
type: object
properties:
href:
type: string
reversals:
type: object
properties:
href:
type: string
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
settlements:
type: object
properties:
href:
type: string
tokens:
type: object
properties:
href:
type: string
transfers:
type: object
properties:
href:
type: string
users:
type: object
properties:
href:
type: string
webhooks:
type: object
properties:
href:
type: string
CreateApplicationRequest:
type: object
x-examples: {}
properties:
entity:
type: object
title: IdentityEntityForm
description: Information needed to verify the identity of the entity.
properties:
amex_mid:
type: string
description: Assigned amex_Mid value. If included must be 10 or 11 digits.
nullable: true
annual_card_volume:
type: integer
format: int64
description: Approximate annual credit card sales expected to be processed in cents by this seller (max 19 characters).
business_address:
type: object
description: Primary address for the legal entity.
required:
- city
- country
- line1
- postal_code
- region
nullable: true
properties:
city:
type: string
description: City (max 20 characters).
nullable: true
country:
type: string
enum:
- ABW
- AFG
- AGO
- AIA
- ALA
- ALB
- AND
- ARE
- ARG
- ARM
- ASM
- ATA
- ATF
- ATG
- AUS
- AUT
- AZE
- BDI
- BEL
- BEN
- BES
- BFA
- BGD
- BGR
- BHR
- BHS
- BIH
- BLM
- BLR
- BLZ
- BMU
- BOL
- BRA
- BRB
- BRN
- BTN
- BVT
- BWA
- CAF
- CAN
- CCK
- CHE
- CHL
- CHN
- CIV
- CMR
- COD
- COG
- COK
- COL
- COM
- CPV
- CRI
- CUB
- CUW
- CXR
- CYM
- CYP
- CZE
- DEU
- DJI
- DMA
- DNK
- DOM
- DZA
- ECU
- EGY
- ERI
- ESH
- ESP
- EST
- ETH
- FIN
- FJI
- FLK
- FRA
- FRO
- FSM
- GAB
- GBR
- GEO
- GGY
- GHA
- GIB
- GIN
- GLP
- GMB
- GNB
- GNQ
- GRC
- GRD
- GRL
- GTM
- GUF
- GUM
- GUY
- HKG
- HMD
- HND
- HRV
- HTI
- HUN
- IDN
- IMN
- IND
- IOT
- IRL
- IRN
- IRQ
- ISL
- ISR
- ITA
- JAM
- JEY
- JOR
- JPN
- KAZ
- KEN
- KGZ
- KHM
- KIR
- KNA
- KOR
- KWT
- LAO
- LBN
- LBR
- LBY
- LCA
- LIE
- LKA
- LSO
- LTU
- LUX
- LVA
- MAC
- MAF
- MAR
- MCO
- MDA
- MDG
- MDV
- MEX
- MHL
- MKD
- MLI
- MLT
- MMR
- MNE
- MNG
- MNP
- MRT
- MSR
- MTQ
- MUS
- MWI
- MYS
- MYT
- NAM
- NCL
- NER
- NFK
- NGA
- NIC
- NIU
- NLD
- NOR
- NPL
- NRU
- NZL
- OMN
- PAK
- PAN
- PCN
- PER
- PHL
- PLW
- PNG
- POL
- PRI
- PRK
- PRT
- PRY
- PSE
- PYF
- QAT
- REU
- ROU
- RUS
- RWA
- SAU
- SDN
- SEN
- SGP
- SGS
- SHN
- SJM
- SLB
- SLE
- SLV
- SMR
- SOM
- SPM
- SRB
- SSD
- STP
- SUR
- SVK
- SVN
- SWE
- SWZ
- SXM
- SYC
- SYR
- TCA
- TCD
- TGO
- THA
- TJK
- TKL
- TKM
- TLS
- TON
- TTO
- TUN
- TUR
- TUV
- TWN
- TZA
- UGA
- UKR
- UMI
- URY
- USA
- UZB
- VAT
- VCT
- VEN
- VGB
- VIR
- VNM
- VUT
- WLF
- WSM
- XKX
- YEM
- ZAF
- ZMB
- ZWE
description: 3-Letter Country code.
nullable: true
line1:
type: string
description: First line of the address (max 35 characters).
nullable: true
line2:
type: string
description: Second line of the address (max 35 characters).
nullable: true
postal_code:
type: string
description: Zip or Postal code (max 7 characters).
nullable: true
region:
type: string
description: 2-letter State code.
nullable: true
business_name:
type: string
description: 'Merchant''s full legal business name (If **INDIVIDUAL\_SOLE\_PROPRIETORSHIP**, input first name, Full legal last name and middle initial; max 120 characters)'
nullable: true
business_phone:
type: string
description: Customer service phone number where the merchant can be reached (max 10 characters).
business_tax_id:
type: string
description: 'Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL\_SOLE\_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor''s Social Security Number (SSN).'
business_type:
type: string
enum:
- INDIVIDUAL_SOLE_PROPRIETORSHIP
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- LIMITED_PARTNERSHIP
- GENERAL_PARTNERSHIP
- ASSOCIATION_ESTATE_TRUST
- TAX_EXEMPT_ORGANIZATION
- INTERNATIONAL_ORGANIZATION
- GOVERNMENT_AGENCY
- JOINT_VENTURE
description: Include the value that applies the best.
nullable: true
default_statement_descriptor:
type: string
maxLength: 20
minLength: 1
description: Billing description displayed on the buyer's bank or card statement (Length must be between 1 and 20 characters).
discover_mid:
type: string
description: Assigned Discover Mid value.
dob:
type: object
format: date
description: The principal control owner's date of birth.
properties:
day:
type: integer
description: Day of birth (between 1 and 31).
month:
type: integer
description: Month of birth (between 1 and 12).
year:
type: integer
description: Year of birth (4-digit).
doing_business_as:
type: string
maxLength: 60
description: Alternate name of the business. If no other name is used use the same value used in `business_name` (max 60 characters).
email:
type: string
description: Control person's email address where they can be reached (max 100 characters).
first_name:
type: string
description: Full legal first name of the merchant's principal representative (max 20 characters).
has_accepted_credit_cards_previously:
type: boolean
description: Defaults to **false** if not passed.
incorporation_date:
type: object
description: The date the company was founded and registered.
nullable: true
properties:
day:
type: integer
description: Day business was incorporated (between 1 and 31).
month:
type: integer
description: Month business was incorporated (between 1 and 12).
year:
type: integer
description: Year business was incorporated (4-digit).
last_name:
type: string
description: Full legal last name of the merchant's principal representative (max 20 characters).
max_transaction_amount:
type: integer
format: int64
description: Maximum amount that can be transacted for a single transaction in cents (max 12 characters).
mcc:
type: string
description: 'The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/business/security-and-compliance/approved-merchants/)'
ownership_type:
type: string
nullable: true
enum:
- PRIVATE
- PUBLIC
description: 'Values can be either: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.'
personal_address:
$ref: '#/components/schemas/Address'
phone:
type: string
description: Principal's phone number (max 10 characters).
principal_percentage_ownership:
type: integer
format: int64
maximum: 100
minimum: 0
description: Percentage of company owned by the principal (min 0; max 100).
short_business_name:
type: string
maxLength: 16
minLength: 1
description: |-
The short version of the business name.
(Defaults to **null**).
tax_authority:
type: string
description: Used and required when onboarding a `Merchant` with a `MCC` of **9311**. The `tax_authority` is the tax gathering entity (e.g San Francisco Water Authority).
tax_id:
type: string
description: Used to verify `tax_id` was provided.
title:
type: string
maxLength: 60
description: 'Control person''s corporate title or role (i.e. Chief Executive Officer, CFO, etc.; max 60 characters).'
nullable: true
url:
type: string
description: Merchant's publicly available website (max 100 characters).
required:
- business_address
- business_name
- business_phone
- business_tax_id
- business_type
- dob
- doing_business_as
- email
- first_name
- last_name
- personal_address
- phone
- tax_id
max_transaction_amount:
type: integer
description: Maximum amount that can be processed for a single transaction in cents (max 12 characters).
nullable: true
name:
type: string
description: 'Merchant''s full legal business name (If **INDIVIDUAL_SOLE_PROPRIETORSHIP**, enter first name, Full legal last name and middle initial; max 120 characters).'
nullable: true
tags:
$ref: '#/components/schemas/Tags'
user:
type: string
example: USxxxxxxxxxxxxxxxxxx
description: ID of the `User` resource.
required:
- user
ApplicationProfile:
type: object
properties:
id:
type: string
example: PPxxxxxxxxxxxxxxxxxx
description: ID of the `application_profile` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
description: The ID of the `Application` resource.
fee_profile:
type: string
example: FPxxxxxxxxxxxxxxxxxx
description: The ID of the `Fee Profile` associated with the `Application`.
nullable: true
risk_profile:
type: string
example: RPxxxxxxxxxxxxxxxxxx
description: The ID of the `risk_profile` that was created during provisioning.
tags:
$ref: '#/components/schemas/Tags'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
application:
type: object
description: Link to the `Application` the resource was created under.
properties:
href:
type: string
fee_profile:
type: object
properties:
href:
type: string
risk_profile:
type: object
properties:
href:
type: string
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
UpdateApplicationProfileRequest:
type: object
properties:
fee_profile:
type: object
description: The ID of the `Fee Profile` associated with the `Application`.
risk_profile:
type: object
description: The ID of the `Risk Profile` associated with the `Application`.
tags:
$ref: '#/components/schemas/Tags'
ApplicationProfilesList:
type: object
properties:
page:
$ref: '#/components/schemas/PageCursor'
_embedded:
type: object
description: List of `application_profile` resources.
properties:
application_profiles:
type: array
minItems: 0
uniqueItems: true
description: '`application_profile` resources.'
items:
$ref: '#/components/schemas/ApplicationProfile'
_links:
$ref: '#/components/schemas/ListLinks'
ApplicationsList:
type: object
description: ''
title: ApplicationsList
properties:
page:
$ref: '#/components/schemas/PageCursor'
_embedded:
type: object
description: List of `Application` resources.
properties:
applications:
type: array
minItems: 0
uniqueItems: true
description: '`Application` resources.'
items:
$ref: '#/components/schemas/Application'
_links:
$ref: '#/components/schemas/ListLinks'
CreateAuthorizationRequest:
anyOf:
- title: Authorization
properties:
additional_buyer_charges:
$ref: '#/components/schemas/AdditionalBuyerCharges'
additional_purchase_data:
$ref: '#/components/schemas/AdditionalPurchaseData'
amount:
format: int64
type: integer
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency:
$ref: '#/components/schemas/Currency'
device:
type: string
description: The ID of the `Device` that the `Authorization` was created under.
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
hsa_fsa_payment:
$ref: '#/components/schemas/HSAFSAPayment'
idempotency_id:
type: string
description: A randomly generated value that gets tied with the request.
nullable: true
merchant:
type: string
description: The ID of the `Merchant` that the `Authorization` was created under.
operation_key:
$ref: '#/components/schemas/OperationKey'
security_code:
type: string
description: 'The 3-4 digit security code for the card (i.e. CVV code). Include the CVV code of the card to include [Card Verification Checks](/guides/payments/making-a-payment/card-verification-checks/) with the created `Authorization`.'
source:
type: string
description: The ID of the `Payment Instrument` that will be debited and performing the `Authorization`.
tags:
$ref: '#/components/schemas/Tags'
3d_secure_authentication:
type: object
description: The 3D secure information required to create a 3D secure `Authorization`.
nullable: true
properties:
cardholder_authentication:
type: string
description: Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction.
cardholder_ip_address:
type: string
description: Only required for **American Express** cards.
example: 189.1.126.240
electronic_commerce_indicator:
type: string
description: |-
- **AUTHENTICATED**: Approved by 3D Secure Vendor.
- **ATTEMPTED**: Issuer or cardholder doesn't support 3D Secure.
transaction_id:
type: string
description: Only required for **Visa** cards.
required:
- amount
- currency
- merchant
- source
- title: Authorization - 3D Secure
properties:
amount:
format: int64
type: integer
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency:
$ref: '#/components/schemas/Currency'
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
idempotency_id:
type: string
description: A randomly generated value that gets tied with the request.
nullable: true
merchant:
type: string
description: The ID of the `Merchant` that the `Authorization` was created under.
source:
type: string
description: The ID of the `Payment Instrument` that will be debited and performing the `Authorization`.
tags:
$ref: '#/components/schemas/Tags'
3d_secure_authentication:
type: object
description: The 3D secure information required to create a 3D secure `Authorization.`
nullable: true
properties:
cardholder_authentication:
type: string
description: Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction.
cardholder_ip_address:
type: string
description: Only required for **American Express** cards.
example: 189.1.126.240
electronic_commerce_indicator:
type: string
description: |-
- **AUTHENTICATED**: Approved by 3D Secure Vendor.
- **ATTEMPTED**: Issuer or cardholder doesn't support 3D Secure.
transaction_id:
type: string
description: Only required for **Visa** cards.
required:
- cardholder_authentication
- electronic_commerce_indicator
required:
- amount
- currency
- merchant
- source
- title: Authorization - Authorization with CVV
properties:
amount:
format: int64
type: integer
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency:
$ref: '#/components/schemas/Currency'
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
idempotency_id:
type: string
description: A randomly generated value that gets tied with the request.
nullable: true
merchant:
type: string
description: The ID of the `Merchant` that the `Authorization` was created under.
security_code:
type: string
description: 'The 3-4 digit security code for the card (i.e. CVV code). Include the CVV code of the card to include [Card Verification Checks](/guides/payments/making-a-payment/card-verification-checks/) with the created `Authorization`.'
source:
type: string
description: The ID of the `Payment Instrument` that will be debited and performing the `Authorization`.
tags:
$ref: '#/components/schemas/Tags'
required:
- amount
- currency
- merchant
- security_code
- source
- title: Authorization - Buyer Charges
properties:
additional_buyer_charges:
$ref: '#/components/schemas/AdditionalBuyerCharges'
amount:
format: int64
type: integer
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency:
$ref: '#/components/schemas/Currency'
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
idempotency_id:
type: string
description: A randomly generated value that gets tied with the request.
nullable: true
merchant:
type: string
description: The ID of the `Merchant` that the `Authorization` was created under.
security_code:
type: string
description: 'The 3-4 digit security code for the card (i.e. CVV code). Include the CVV code of the card to include [Card Verification Checks](/guides/payments/making-a-payment/card-verification-checks/) with the created `Authorization`.'
source:
type: string
description: The ID of the `Payment Instrument` that will be debited and performing the `Authorization`.
tags:
$ref: '#/components/schemas/Tags'
required:
- additional_buyer_charges
- amount
- currency
- merchant
- source
- title: Authorization - HSA or FSA Card
properties:
amount:
format: int64
type: integer
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency:
$ref: '#/components/schemas/Currency'
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
hsa_fsa_payment:
$ref: '#/components/schemas/HSAFSAPayment'
idempotency_id:
type: string
description: A randomly generated value that gets tied with the request.
nullable: true
merchant:
type: string
description: The ID of the `Merchant` that the `Authorization` was created under.
source:
type: string
description: The ID of the `Payment Instrument` that will be debited and performing the `Authorization`.
tags:
$ref: '#/components/schemas/Tags'
required:
- amount
- currency
- hsa_fsa_payment
- merchant
- source
- title: Authorization - Level 2 Processing
properties:
additional_purchase_data:
$ref: '#/components/schemas/AdditionalPurchaseData'
amount:
format: int64
type: integer
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency:
$ref: '#/components/schemas/Currency'
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
idempotency_id:
type: string
description: A randomly generated value that gets tied with the request.
nullable: true
merchant:
type: string
description: The ID of the `Merchant` that the `Authorization` was created under.
source:
type: string
description: The ID of the `Payment Instrument` that will be debited and performing the `Authorization`.
tags:
$ref: '#/components/schemas/Tags'
3d_secure_authentication:
type: object
description: The 3D secure information required to create a 3D secure `Authorization.`
nullable: true
properties:
cardholder_authentication:
type: string
description: Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction.
cardholder_ip_address:
type: string
description: Only required for **American Express** cards.
example: 189.1.126.240
electronic_commerce_indicator:
type: string
description: |-
- **AUTHENTICATED**: Approved by 3D Secure Vendor.
- **ATTEMPTED**: Issuer or cardholder doesn't support 3D Secure.
transaction_id:
type: string
description: Only required for **Visa** cards.
required:
- amount
- currency
- merchant
- source
- title: Authorization - Level 3 Processing
properties:
'additional_purchase_data ':
$ref: '#/components/schemas/L3AdditionalPurchaseData'
amount:
format: int64
type: integer
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency:
$ref: '#/components/schemas/Currency'
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
idempotency_id:
type: string
description: A randomly generated value that gets tied with the request.
nullable: true
merchant:
type: string
description: The ID of the `Merchant` that the `Authorization` was created under.
source:
type: string
description: The ID of the `Payment Instrument` that will be debited and performing the `Authorization`.
tags:
$ref: '#/components/schemas/Tags'
required:
- amount
- currency
- merchant
- source
- title: Authorization - Partial Authorization
properties:
amount:
format: int64
type: integer
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency:
$ref: '#/components/schemas/Currency'
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
idempotency_id:
type: string
description: A randomly generated value that gets tied with the request.
nullable: true
merchant:
type: string
description: The ID of the `Merchant` that the `Authorization` was created under.
partial_authorization:
type: boolean
description: |-
- Set to **true** if you want to enable partial authorizations for a specific transaction.
- If `partial_authorization` is enabled for an individual transaction, the `Merchant` value for `default_partial_authorization_enabled` is disregarded.
- Partial authorizations enable you to collect a portion of the amount if the cardholder does not have the funds to cover the entire amount.
source:
type: string
description: The ID of the `Payment Instrument` that will be debited and performing the `Authorization`.
tags:
$ref: '#/components/schemas/Tags'
required:
- amount
- currency
- merchant
- source
- title: Card Present Authorization - EMV Card
properties:
amount:
format: int64
type: integer
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency:
$ref: '#/components/schemas/Currency'
device:
type: string
description: The ID of the `Device` that the `Authorization` was created under.
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
idempotency_id:
type: string
description: A randomly generated value that gets tied with the request.
nullable: true
operation_key:
$ref: '#/components/schemas/OperationKey'
tags:
$ref: '#/components/schemas/Tags'
required:
- amount
- currency
- device
- operation_key
- title: Card Present Authorization - Non-EMV Card
properties:
amount:
format: int64
type: integer
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
currency:
$ref: '#/components/schemas/Currency'
device:
type: string
description: The ID of the `Device` that the `Authorization` was created under.
fraud_session_id:
$ref: '#/components/schemas/FraudSessionID'
idempotency_id:
type: string
description: A randomly generated value that gets tied with the request.
nullable: true
operation_key:
$ref: '#/components/schemas/OperationKey'
tags:
$ref: '#/components/schemas/Tags'
required:
- amount
- currency
- device
- operation_key
type: object
Authorization:
type: object
title: Authorization
description: A charge authorization
properties:
id:
type: string
example: AUxxxxxxxxxxxxxxxxxx
description: The ID of the `Authorization` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
3ds_redirect_url:
type: string
description: The redirect URL used for 3DS transactions (if supported by the processor).
nullable: true
address_verification:
type: string
description: Details the results of the Address Verification checks.
nullable: true
additional_buyer_charges:
$ref: '#/components/schemas/AdditionalBuyerCharges'
additional_healthcare_data:
$ref: '#/components/schemas/AdditionalHealthcareData'
additional_purchase_data:
$ref: '#/components/schemas/AdditionalPurchaseData'
amount:
type: integer
minimum: 0
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
amount_requested:
type: integer
description: 'When `default_partial_authorization_enabled` is set to **true**, `amount_requested` indicates the amount the cardholder attempted to authorize.'
application:
type: string
description: The ID of the `Application` resource the `Authorization` was created under.
card_present_details:
$ref: '#/components/schemas/CardPresentDetails'
capture_amount:
type: integer
format: int64
description: The amount of the `Authorization` you would like to capture in cents. Must be less than or equal to the `amount` of the `Authorization`.
currency:
$ref: '#/components/schemas/Currency'
device:
type: string
example: DVxxxxxxxxxxxxxxxxxx
description: The ID of the activated device.
nullable: true
expires_at:
type: string
description: '`Authorization` expiration time.'
format: date-time
failure_code:
$ref: '#/components/schemas/FailureCode'
failure_message:
$ref: '#/components/schemas/FailureMessage'
security_code_checks:
type: string
description: Details the results of the Security Code Verification checks.
nullable: true
is_void:
type: boolean
description: Details if the `Authorization` is void.
merchant:
type: string
example: MUxxxxxxxxxxxxxxxxxxxxxx
description: The ID of the `Merchant` resource the `Authorization` was created under.
merchant_identity:
type: string
example: IDxxxxxxxxxxxxxxxxxxxxxx
description: The ID of the `Identity` resource used by the `Merchant` the `Authorization` was processed under.
messages:
type: array
description: Message field that provides additional details. This field is typically **null**.
nullable: true
items:
type: string
raw:
$ref: '#/components/schemas/Raw'
security_code_verification:
type: string
description: Details the results of the Security Code Verification che
nullable: true
source:
type: string
example: PIxxxxxxxxxxxxxxxxxx
description: ID of the `Payment Instrument` where funds get debited.
state:
type: string
enum:
- CANCELED
- PENDING
- FAILED
- SUCCEEDED
- UNKNOWN
description: The state of the `Authorization`.
tags:
$ref: '#/components/schemas/Tags'
trace_id:
type: string
description: Trace ID of the `Authorization`. The processor sends back the `trace_id` so you can track the authorization end-to-end.
transfer:
type: string
example: TRxxxxxxxxxxxxxxxxxx
description: The ID of the `transfer` resource that gets created when the `Authorization` moves to **SUCCEEDED**.
nullable: true
void_state:
type: string
description: Details if the `Authorization` has been voided.
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
application:
type: object
description: Link to the `Application` the resource was created under.
properties:
href:
type: string
device:
type: object
description: Link to the `Device` the request was made under.
properties:
href:
type: string
merchant_identity:
type: object
description: Link to the `Identity` the `Merchant` was created under and the `Transfer` was submitted with.
properties:
href:
type: string
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
transfer:
type: object
description: Link to the `Transfers` realted to the `Authorization`.
properties:
href:
type: string
AuthorizationCaptured:
type: object
title: AuthorizationCaptured
description: A captured authorization
properties:
id:
type: string
example: AUxxxxxxxxxxxxxxxxxx
description: The ID of the `Authorization` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
3ds_redirect_url:
type: string
description: The redirect URL used for 3DS transactions (if supported by the processor).
nullable: true
additional_buyer_charges:
$ref: '#/components/schemas/AdditionalBuyerCharges'
amount:
type: integer
minimum: 0
description: The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
application:
type: string
description: The ID of the `Application` resource the `Authorization` was created under.
card_present_details:
$ref: '#/components/schemas/CardPresentDetails'
capture_amount:
type: integer
format: int64
description: The amount of the `Authorization` you would like to capture in cents. Must be less than or equal to the `amount` of the `Authorization`.
currency:
$ref: '#/components/schemas/Currency'
device:
type: string
example: DVxxxxxxxxxxxxxxxxxx
description: The ID of the activated device.
nullable: true
expires_at:
type: string
description: Authorization expiration time.
format: date-time
external_responses:
type: array
nullable: true
items:
type: object
properties:
body:
type: string
content_type:
type: string
failure_code:
$ref: '#/components/schemas/FailureCode'
failure_message:
$ref: '#/components/schemas/FailureMessage'
idempotency_id:
type: string
description: A randomly generated value that gets tied with the request.
nullable: true
is_void:
type: boolean
description: Details if the `Authorization` is void.
merchant:
type: string
description: The ID of the `Merchant` resource the `Authorization` was created under.
example: MUxxxxxxxxxxxxxxxxx
merchant_identity:
type: string
description: The ID of `Identity` resource used by the `Merchant` the `Authorization` was created under.
example: IDxxxxxxxxxxxxxxxxx
messages:
type: array
description: Message field that provides additional details. This field is typically **null**.
items:
type: string
raw:
$ref: '#/components/schemas/Raw'
source:
type: string
example: PIxxxxxxxxxxxxxxxxxx
description: ID of the `Payment Instrument` where funds get debited.
state:
type: string
enum:
- CANCELED
- PENDING
- FAILED
- SUCCEEDED
- UNKNOWN
description: The state of the `Transfer`.
tags:
$ref: '#/components/schemas/Tags'
trace_id:
type: string
description: Trace ID of the `Authorization`. The processor sends back the `trace_id` so you can track the authorization end-to-end.
transfer:
type: string
example: TRxxxxxxxxxxxxxxxxxx
description: The ID of the `transfer` resource that gets created when the `Authorization` moves to **SUCCEEDED**.
nullable: true
void_state:
type: string
description: Details if the `Authorization` has been voided.
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
application:
type: object
description: Link to the `Application` the resource was created under.
properties:
href:
type: string
device:
type: object
description: Link to the `Device` the request was made under.
properties:
href:
type: string
merchant_identity:
type: object
description: Link to the `Identity` the `Merchant` was created under and the `Transfer` was submitted with.
properties:
href:
type: string
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
transfer:
type: object
description: Link to the `Transfers` realted to the `Authorization`.
properties:
href:
type: string
AuthorizationsList:
type: object
properties:
page:
$ref: '#/components/schemas/PageCursor'
_embedded:
type: object
description: List of `Authroization` objects.
properties:
authorizations:
type: array
minItems: 0
uniqueItems: true
description: '`Authorization` objects.'
items:
$ref: '#/components/schemas/Authorization'
_links:
$ref: '#/components/schemas/ListLinks'
CreateDevice:
type: object
title: CreateDevice
description: ''
properties:
configuration:
$ref: '#/components/schemas/ConfigurationDetails'
description:
type: string
description: Additional information about device (e.g. self serving terminal).
model:
type: string
enum:
- BBPOS
- DESK_3500
- DESK_5000
- IPP320
- IPP350
- ISC250
- ISC480
- ISMP4
- LANE_3000
- LANE_5000
- LANE_7000
- LANE_8000
- LINK_2500
- MOVE_5000
- MX915
- MX925
- PAX_A30
- PAX_A35
- PAX_A60
- PAX_A77
- PAX_A920PRO
- PAX_ARIES6
- PAX_ARIES8
- PAX_IM30
description: The model type of the device.
name:
type: string
description: Name of the `Device`.
tags:
$ref: '#/components/schemas/Tags'
required:
- model
- name
x-examples:
example-1:
name: 'Finix triPOS #1'
model: MX915
description: John Smith
configuration:
allow_debit: true
prompt_signature: NEVER
bypass_device_on_capture: true
Currency:
type: string
description: ISO 4217 3 letter currency code.
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BOV
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHE
- CHF
- CHW
- CLF
- CLP
- CNY
- COP
- COU
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MXV
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- SSP
- STD
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- USN
- UYI
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
- XSU
- XTS
- XUA
- XXX
- YER
- ZAR
- ZMW
- ZWL
Device:
type: object
title: Device
description: '`Device` resource.'
properties:
id:
type: string
description: The ID of the activated `Device`.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
configuration_details:
type: object
title: DeviceConfigDetails
description: Information used to configure how the `Device` handles transactions.
nullable: true
properties:
allow_debit:
type: boolean
description: 'Allow transaction to be processed on Debit rails. If **false**, Debit card transactions will be processed on Credit rails.'
bypass_device_on_capture:
type: boolean
description: Sets whether or not the device will be used to capture transactions. This field must be set to **true** (defaults to **false**).
nullable: true
check_for_duplicate_transactions:
type: boolean
description: Sets whether the `Device` will check for duplicate transactions.
prompt_amount_confirmation:
type: boolean
description: Sets if the card holder needs to confirm the amount they will pay (defaults to **true**).
prompt_manual_entry:
type: boolean
description: Sets if the device defaults to manual entry as the default card input method. (defaults to **false**).
prompt_signature:
type: string
description: 'Sets if the device will prompt the card holder for a signature by default. Available values include: <ul><li><strong>ALWAYS</strong><li><strong>NEVER</strong><li><strong>AMOUNT</strong>: Used in conjunction with `signature_threshold_amount` so when the threshold is reached the signature form appears on the device.'
signature_threshold_amount:
type: integer
format: int64
description: The threshold to prompt a signature when `prompt_signature` is set to **AMOUNT** (defaults to 0).
connection:
type: string
description: Details if the `Device` is connected and online. Only returned when `include_connection parameter` provided.
enum:
- OPEN
- CLOSED
description:
type: string
description: Additional information about device (e.g. self serving terminal).
nullable: true
enabled:
type: boolean
description: Details if the `Device` resource is enabled. Set to **false** to disable the `Device`.
idle_message:
type: string
description: The message that diplays on the device after a period of inactivity.
nullable: true
merchant:
type: string
example: MUxxxxxxxxxxxxxxxxxx
description: ID of the `Merchant` resource.
model:
type: string
description: Details the model of the card reader.
name:
type: string
description: Name of the `Device`.
serial_number:
type: string
description: Serial number of the device.
nullable: true
tags:
$ref: '#/components/schemas/Tags'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
authorizations:
type: object
properties:
href:
type: string
merchant:
type: object
description: Link to the `Merhcant` resource that was used in the request.
properties:
href:
type: string
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
transfers:
type: object
properties:
href:
type: string
Dispute:
type: object
title: Dispute
description: A `Dispute` objected created for a chargeback or customer disputes.
properties:
id:
type: string
example: DIxxxxxxxxxxxxxxxxxx
description: The ID of the `Dispute` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
action:
type: string
description: The next `action` required to move forward with the `Dispute`.
nullable: true
amount:
type: integer
description: The total amount of the `Dispute` (in cents).
nullable: true
application:
type: string
description: The ID of the `Application` resource that the `Dispute` was created under.
dispute_details:
description: Details about the `Dispute` received by the `Processor`. Any data from the processor can get included.
type: object
properties:
case_id:
type: string
description: The case number the `Processor` has given the dispute in their internal database.
nullable: true
pin_debit_adjustment_number:
type: string
description: Used by the processor to identify the funds that are getting disputed.
nullable: true
reason_code:
type: string
description: Used by the processor and card networks to identify why the dispute got filed.
nullable: true
evidence_submitted:
type: string
enum:
- CHARGEBACK
- NOT_SUPPORTED
- NONE
- UNKNOWN
- INQUIRY
description: 'The status of the uploaded evidence. [See `Dispute#response_details` for the next steps to move the `Dispute` forward](/api/tag/Disputes/#tag/Disputes/operation/getDispute!c=200&path=response_state&t=response).'
identity:
type: string
description: |-
- The ID of the seller's `Identity` resource.
- This is the `Identity` resource that was used to create the seller's `Merchant`.
merchant:
type: string
description: |-
- The ID of the seller's `Merchant` resource.
- This is the `Merchant` account the `Dispute` was filed against.
message:
type: string
description: Message field that provides additional details. This field is typically **null**.
nullable: true
occurred_at:
type: string
description: Point in time when the `Transfer` that's getting disputed got created.
format: date-time
nullable: true
reason:
type: string
enum:
- CLERICAL
- FRAUD
- INQUIRY
- QUALITY
- TECHNICAL
description: 'The system-defined reason for the `Dispute`. Available values include:<ul><li>**INQUIRY**<li>**QUALITY**<li>**FRAUD**'
respond_by:
type: string
format: date-time
description: 'Point in time, the `Merchant` needs to respond to the dispute by.'
nullable: true
response_state:
type: string
enum:
- NEEDS_RESPONSE
- RESPONDED
- ACCEPTED
- NO_RESPONSE_ALLOWED
- UNKNOWN
description: |-
Details the state of the `Dispute` and what action the `Merchant` needs to take.
- **NEEDS_RESPONSE**: The `Merchant` needs to respond to the `Dispute` by `Dispute#respond_by`. For details on how to respond to a `Dispute`, see [Responding to Disputes](/guides/after-the-payment/disputes/responding-disputes/).
- **RESPONDED**: The issuing bank has received the evidence and actively reviewing it. No action needed from the `Merchant`.
- **ACCEPTED**: The `Merchant` has accepted the `Dispute`. When a `Dispute` is accepted, you concede that the dispute is not worth challenging or representing. For details on how to accept a `Dispute`, see [Accepting a Dispute](/guides/after-the-payment/disputes/accepting-disputes/).
- **NO_RESPONSE_ALLOWED**: The final `Dispute#response_state` when a `Dispute` is either **WON** or **LOST**.
- **UNKNOWN**: `Dispute` details couldn't be submitted to the processor. Comes up when testing `Disputes` in sandbox or on the **DUMMY_V1** processor.
state:
type: string
enum:
- INQUIRY
- PENDING
- WON
- LOST
description: The current state of the `Dispute`.
tags:
$ref: '#/components/schemas/Tags'
transfer:
type: string
description: ID of the `Transfer` resource.
example: TRxxxxxxxxxxxxxxxxxx
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
adjustment_transfers:
type: object
properties:
href:
type: string
application:
type: object
description: Link to the `Application` the resource was created under.
properties:
href:
type: string
evidence:
type: object
properties:
href:
type: string
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
transfer:
type: object
description: Link to the `Transfers` realted to the `Dispute`.
properties:
href:
type: string
DisputeEvidence:
type: object
properties:
id:
type: string
example: DFxxxxxxxxxxxxxxxxxx
description: The ID of the `Dispute` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
example: APgPDQrLD52TYvqazjHJJchM
description: The ID of the `Application` resource that the `Dispute` was created under.
dispute:
type: string
description: The ID of the `Dispute` associated with the evidence.
state:
type: string
enum:
- PENDING
- SUCCEEDED
- CANCELED
- FAILED
description: |-
Result of the evidence uploaded.
- **PENDING**: The evidence file has not yet been submitted to the Processor. No user action is required.
- **SUCCEEDED**: The evidence file has been successfully sent to the Processor. No further user action is required.
- **CANCELED**: The evidence file upload was not completed due to user action.
- **FAILED**: An issue occurred. User action is required**. Any of the following issues could have occurred:
- There was an error in the system and the user should retry uploading their evidence file.
- There is an issue with the file and the user should retry uploading a different file.
- There is an issue and the user should contact Support.
identity:
type: string
example: IDpYDM7J9n57q849o9E9yNrG
description: |-
- The ID of the seller's `Identity` resource.
- This is the `Identity` resource that was used to create the seller's `Merchant`.
merchant:
type: string
example: MUucec6fHeaWo3VHYoSkUySM
description: |-
- The ID of the seller's `Merchant` resource.
- This is the `Merchant` account the `Dispute` was filed against.
tags:
$ref: '#/components/schemas/Tags'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
CreateDisputeEvidenceRequest:
type: object
properties:
file:
type: string
format: binary
description: The binary contents of the file.
DisputeEvidenceList:
type: object
title: ''
properties:
page:
$ref: '#/components/schemas/PageCursor'
_embedded:
type: object
description: List of `evidence` created for a `Dispute`.
properties:
evidences:
type: array
minItems: 0
uniqueItems: true
description: '`Evidence` objects.'
items:
$ref: '#/components/schemas/DisputeEvidence'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
DisputesList:
type: object
properties:
page:
$ref: '#/components/schemas/PageOffset'
_embedded:
type: object
description: List of `Dispute` objects.
properties:
disputes:
type: array
minItems: 0
uniqueItems: true
description: '`Dispute` objects.'
items:
$ref: '#/components/schemas/Dispute'
_links:
$ref: '#/components/schemas/ListLinks'
Error401Unauthorized:
type: object
properties:
total:
type: integer
_embedded:
type: object
properties:
errors:
type: array
items:
type: object
additionalProperties: true
properties:
code:
type: string
enum:
- UNKNOWN
logref:
$ref: '#/components/schemas/LogRef'
message:
type: string
_links:
type: object
additionalProperties: true
properties:
self:
type: object
properties:
href:
type: string
source:
type: object
properties:
href:
type: string
Error402PaymentRequired:
type: object
properties:
total:
type: integer
_embedded:
type: object
properties:
errors:
type: array
items:
type: object
additionalProperties: true
properties:
code:
type: string
enum:
- CALL_ISSUER
logref:
$ref: '#/components/schemas/LogRef'
message:
type: string
enum:
- Please contact card issuer for more information.
_links:
type: object
properties:
source:
type: object
properties:
href:
type: string
Error403ForbiddenList:
type: object
properties:
total:
type: integer
_embedded:
type: object
properties:
errors:
type: array
items:
type: object
additionalProperties: true
properties:
code:
type: string
enum:
- FORBIDDEN
logref:
$ref: '#/components/schemas/LogRef'
message:
type: string
_links:
type: object
properties:
source:
type: object
properties:
href:
type: string
description: ''
title: ''
ErrorGeneric:
type: object
properties:
total:
type: integer
_embedded:
type: object
properties:
errors:
type: array
items:
type: object
additionalProperties: true
properties:
code:
type: string
enum:
- FORBIDDEN
logref:
$ref: '#/components/schemas/LogRef'
message:
type: string
_links:
type: object
properties:
source:
type: object
properties:
href:
type: string
Error404NotFoundList:
type: object
properties:
total:
type: integer
_embedded:
type: object
properties:
errors:
type: array
items:
type: object
additionalProperties: true
properties:
code:
type: string
enum:
- NOT_FOUND
logref:
$ref: '#/components/schemas/LogRef'
message:
type: string
_links:
type: object
properties:
source:
type: object
properties:
href:
type: string
Error406NotAcceptable:
type: object
properties:
total:
type: integer
_embedded:
type: object
properties:
errors:
type: array
items:
type: object
additionalProperties: true
properties:
code:
type: string
enum:
- NOT_FOUND
logref:
$ref: '#/components/schemas/LogRef'
message:
type: string
_links:
type: object
properties:
source:
type: object
properties:
href:
type: string
title: ''
Error422InvalidFieldList:
type: object
description: Invalid field
title: ''
properties:
total:
type: integer
_embedded:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
enum:
- INVALID_FIELD
field:
type: string
logref:
$ref: '#/components/schemas/LogRef'
message:
type: string
_links:
type: object
properties:
source:
type: object
properties:
href:
type: string
Fee:
type: object
title: Fee
description: An out of flow `fee` that is added to a `settlement`.
properties:
id:
type: string
example: FExxxxxxxxxxxxxxxxxx
description: The ID of the `fee` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
amount:
type: integer
description: The amount of the fee in cents.
currency:
$ref: '#/components/schemas/Currency'
display_name:
type: string
description: The name of the `fee` object that was include in `display_name` when creating the fee.
nullable: true
fee_subtype:
type: string
enum:
- CUSTOM
- APPLICATION_FEE
- PLATFORM_FEE
description: Subtype of the `fee`.
fee_type:
type: string
enum:
- APPLICATION_FEE
- ACH_BASIS_POINTS
- ACH_FIXED
- CARD_BASIS_POINTS
- CARD_FIXED
- CARD_INTERCHANGE
- VISA_BASIS_POINTS
- VISA_FIXED
- VISA_INTERCHANGE
- VISA_ASSESSMENT_BASIS_POINTS
- VISA_ACQUIRER_PROCESSING_FIXED
- VISA_CREDIT_VOUCHER_FIXED
- VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED
- VISA_BASE_II_CREDIT_VOUCHER_FIXED
- VISA_KILOBYTE_ACCESS_FIXED
- DISCOVER_BASIS_POINTS
- DISCOVER_FIXED
- DISCOVER_INTERCHANGE
- DISCOVER_ASSESSMENT_BASIS_POINTS
- DISCOVER_DATA_USAGE_FIXED
- DISCOVER_NETWORK_AUTHORIZATION_FIXED
- DINERS_CLUB_BASIS_POINTS
- DINERS_CLUB_FIXED
- DINERS_CLUB_INTERCHANGE
- MASTERCARD_BASIS_POINTS
- MASTERCARD_FIXED
- MASTERCARD_INTERCHANGE
- MASTERCARD_ASSESSMENT_UNDER_1K_BASIS_POINTS
- MASTERCARD_ASSESSMENT_OVER_1K_BASIS_POINTS
- MASTERCARD_ACQUIRER_FEE_BASIS_POINTS
- JCB_BASIS_POINTS
- JCB_FIXED
- JCB_INTERCHANGE
- AMERICAN_EXPRESS_BASIS_POINTS
- AMERICAN_EXPRESS_FIXED
- AMERICAN_EXPRESS_INTERCHANGE
- AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS
- DISPUTE_INQUIRY_FIXED_FEE
- DISPUTE_FIXED_FEE
- QUALIFIED_TIER_BASIS_POINTS_FEE
- QUALIFIED_TIER_FIXED_FEE
- CUSTOM
- ACH_DEBIT_RETURN_FIXED_FEE
- ACH_CREDIT_RETURN_FIXED_FEE
- ANCILLARY_FIXED_FEE_PRIMARY
- ANCILLARY_FIXED_FEE_SECONDARY
- SETTLEMENT_V2_TRANSFER
description: The type of `fee`.
label:
type: string
description: The name of the `fee` object that was include in `label` when creating the fee.
nullable: true
linked_id:
type: string
description: ID of the linked resource.
linked_type:
type: string
enum:
- APPLICATION
- PLATFORM
- SUBSCRIPTION
- TRANSFER
description: The type of entity the `fee` is linked to (**null** by default).
merchant:
type: string
description: The `Merchant` ID that the fee is being debited from.
tags:
$ref: '#/components/schemas/Tags'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
merchant:
type: object
description: Link to the `Merhcant` resource that was used in the request.
properties:
href:
type: string
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
transfer:
type: object
description: Link to the `Transfers` realted to the `Dispute`.
properties:
href:
type: string
CreateFeeRequest:
type: object
title: ''
properties:
amount:
$ref: '#/components/schemas/Amount'
currency:
$ref: '#/components/schemas/Currency'
fee_subtype:
type: string
enum:
- CUSTOM
description: Subtype of the fee. Set to **CUSTOM**.
fee_type:
type: string
enum:
- CUSTOM
description: The type of the fee. Must be set to **CUSTOM**.
label:
type: string
description: The display name of the `Fee` that can be used for filtering purposes.
linked_id:
type: string
description: ID of the linked resource
linked_type:
type: string
enum:
- APPLICATION
- PLATFORM
- SUBSCRIPTION
- TRANSFER
description: The type of entity the fee is linked to (**null** by default).
merchant_id:
type: string
description: The ID of the `Merchant` resource used to create the `Fee`.
settlement_delay_days:
type: integer
description: 'Delays in days, when the `Transfer` the `Fee` creates will be submitted for settlement.'
nullable: true
tags:
$ref: '#/components/schemas/Tags'
required:
- amount
- currency
- fee_subtype
- fee_type
- merchant_id
FeeProfile:
type: object
properties:
id:
type: string
example: FPxxxxxxxxxxxxxxxxxx
description: The ID of the `Fee Profile` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
ach_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of an eCheck (also called ACH payments). Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)
ach_credit_return_fixed_fee:
type: integer
description: A fixed amount in cents that will be charged to the seller for processing an echeck (also called ACH payments) credit return.
nullable: true
ach_debit_return_fixed_fee:
type: integer
description: A fixed amount in cents that will be charged to the seller for processing an echeck (also called ACH payment) debit return.
nullable: true
ach_fixed_fee:
type: integer
description: Fee in cents incurred for each individual `Transfer`.
american_express_assessment_basis_points:
type: integer
description: Applies to gross American Express card volume.
nullable: true
american_express_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each American Express `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)
nullable: true
american_express_charge_interchange:
type: boolean
description: Set to **True** to incur interchange fees for American Express `Transfers`.
nullable: true
american_express_externally_funded_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each American Express externally funded `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)
nullable: true
american_express_externally_funded_fixed_fee:
type: integer
description: Fee in cents incurred for each individual American Express externally funded `Transfer`.
nullable: true
american_express_fixed_fee:
type: integer
description: Fee in cents incurred for each individual American Express `Transfer`.
nullable: true
ancillary_fixed_fee_primary:
type: integer
description: An additional fixed fee that can be charged per `Transfer`.
nullable: true
ancillary_fixed_fee_secondary:
type: integer
description: An additional fixed fee that can be charged per `Transfer` if `ancillary_fixed_fee_primary` is included.
nullable: true
application:
type: string
description: The ID of the `Application` associated with the `Fee Profile`.
basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each card-based `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)
card_cross_border_basis_points:
type: integer
description: Percentage-based fee charged against the full amount of every `Transfer` that includes non-US cards. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).
nullable: true
card_cross_border_fixed_fee:
type: integer
description: Fee in cents charged against every `Transfer` that includes non-US cards.
nullable: true
charge_interchange:
type: boolean
description: Set to **True** to incur interchange fees for card-based `Transfers`.
diners_club_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each Diners `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).
nullable: true
diners_club_charge_interchange:
type: boolean
description: Set to **True** to incur interchange fees for Diners `Transfers`.
nullable: true
diners_club_fixed_fee:
type: integer
description: Fee in cents incurred for each individual Diners `Transfer`.
nullable: true
discover_assessments_basis_points:
type: integer
description: Assessment applies to gross Discover card transaction volume.
nullable: true
discover_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each Discover `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)
nullable: true
discover_charge_interchange:
type: boolean
description: Set to **True** to incur interchange fees for Discover `Transfers`.
nullable: true
discover_data_usage_fixed_fee:
type: integer
description: Applies to all U.S.-based `authorization` transactions.
nullable: true
discover_externally_funded_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each Discover externally funded `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).
nullable: true
discover_externally_funded_fixed_fee:
type: integer
description: Fee in cents incurred for each individual Discover externally funded `Transfer`.
nullable: true
discover_fixed_fee:
type: integer
description: Fee in cents incurred for each individual Discover `Transfer`.
nullable: true
discover_network_authorization_fixed_fee:
type: integer
description: This fee applies to all Discover network `authorizations` and replaces the previously assessed Data Transmission.
nullable: true
dispute_fixed_fee:
type: integer
description: Applied when a `dispute` is created or updated to a **PENDING** state.
nullable: true
dispute_inquiry_fixed_fee:
type: integer
description: Applied when a `dispute` is created or updated to a **INQUIRY** state.
nullable: true
externally_funded_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each `Transfer` that's card-based and externally funded. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%).
nullable: true
externally_funded_fixed_fee:
type: integer
description: Fee in cents incurred for each individual `Transfer` that's card-based and externally funded.
nullable: true
fixed_fee:
type: integer
description: Fee in cents incurred for each individual card-based `Transfer`.
jcb_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each JCB `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)
nullable: true
jcb_charge_interchange:
type: boolean
description: Set to **True** to incur interchange fees for JCB Transfers.
nullable: true
jcb_fixed_fee:
type: integer
description: Fee in cents incurred for each individual JCB `Transfer`.
nullable: true
mastercard_acquirer_fees_basis_points:
type: integer
description: 'The fee is assessed on a business’s gross MasterCard processing volume. This fee varies per acquirer based on MasterCard’s assessed charge as it’s distributed across the acquirer’s portfolio of merchants. Generally, this fee is a fraction of a basis point. For example, 0.0045%, 0.0075%, etc. are examples of a likely fee.'
nullable: true
mastercard_assessments_over1k_basis_points:
type: integer
description: 'Fee applied to Mastercard credit sale transactions greater than $1,000.'
nullable: true
mastercard_assessments_under1k_basis_points:
type: integer
description: 'Fee applied to Mastercard transactions less than or equal to $1,000.'
nullable: true
mastercard_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each MasterCard `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)
nullable: true
mastercard_charge_interchange:
type: boolean
description: Set to **True** to incur interchange fees for MasterCard `Transfers`.
nullable: true
mastercard_fixed_fee:
type: integer
description: Fee in cents incurred for each individual MasterCard `Transfer`.
nullable: true
qualified_tiers:
type: object
description: The top of the qualified tier tree.
nullable: true
rounding_mode:
type: string
enum:
- TRANSACTION
- AGGREGATE
description: '<ul><li>Include <strong>AGGREGATE</strong> if you want to round after the settlement calculation.<li>By default, rounding happens before the sum of the settlement calculation (i.e. round each fee transfer)</ul>'
visa_acquirer_processing_fixed_fee:
type: integer
description: 'Applied to all U.S.-based credit card authorizations acquired in the U.S. regardless of where the issuer/cardholder is located. If your business is based in the U.S., the acquirer processing fee will apply to all Visa credit card authorizations'
nullable: true
visa_assessments_basis_points:
type: integer
description: Applies to all Visa credit transactions.
nullable: true
visa_base_II_credit_voucher_fixed_fee:
type: integer
description: Applies to all U.S.-based refunds.
nullable: true
visa_base_II_system_file_transmission_fixed_fee:
type: integer
description: Applies to all Visa transactions and is charged in addition to other transaction-based assessments.
nullable: true
visa_basis_points:
type: integer
description: Percentage-based fee incurred against the full amount of each Visa `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)
nullable: true
visa_charge_interchange:
type: boolean
description: Set to **True** to incur interchange fees for Visa `Transfers`.
nullable: true
visa_credit_voucher_fixed_fee:
type: integer
description: Applies to Visa refunds.
nullable: true
visa_fixed_fee:
type: integer
description: Fee in cents incurred for each individual Visa `Transfer`.
nullable: true
visa_kilobyte_access_fixed_fee:
type: integer
description: Charged on each authorization transaction submitted to Visa’s network for settlement.
nullable: true
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
application:
type: object
description: Link to the `Application` the resource was created under.
properties:
href:
type: string
owner_identity:
type: object
properties:
href:
type: string
processors:
type: object
properties:
href:
type: string
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
users:
type: object
properties:
href:
type: string
FeeProfilesList:
type: object
properties:
page:
$ref: '#/components/schemas/PageCursor'
_embedded:
type: object
description: List of `fee_profile` objects.
properties:
fee_profiles:
type: array
minItems: 0
uniqueItems: true
description: '`fee_profile` objects.'
items:
$ref: '#/components/schemas/FeeProfile'
_links:
$ref: '#/components/schemas/ListLinks'
UpdateFeeRequest:
type: object
description: ''
properties:
tags:
type: object
description: Key value pair for annotating custom meta data (e.g. order numbers).
nullable: true
FeesList:
type: object
properties:
page:
$ref: '#/components/schemas/PageOffset'
_embedded:
type: object
description: List of `fee` objects.
properties:
fees:
type: array
minItems: 0
uniqueItems: true
description: '`fee` objects.'
items:
$ref: '#/components/schemas/Fee'
_links:
$ref: '#/components/schemas/ListLinks'
IdentitiesList:
type: object
properties:
page:
$ref: '#/components/schemas/PageCursor'
_embedded:
type: object
description: List of `Identity` resources.
properties:
identities:
type: array
uniqueItems: true
description: An `Identity` resource represents either a person or business in Finix.
items:
$ref: '#/components/schemas/Identity'
_links:
$ref: '#/components/schemas/ListLinks'
Identity:
anyOf:
- title: Identity - Merchant
properties:
id:
type: string
minLength: 1
description: The ID of the `Identity` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
additional_underwriting_data:
type: object
description: Additional underwriting data that's required to verify the `Identity`.
nullable: true
properties:
annual_ach_volume:
type: integer
description: The approximate annual ACH sales expected to be processed (in cents) by this seller (max 10 characters).
average_ach_transfer_amount:
type: integer
description: The approximate average ACH sale amount (in cents) for this seller.
average_card_transfer_amount:
type: integer
description: The average credit card sale amount (in cents) for this seller.
business_description:
type: string
minLength: 1
description: Description of this merchant's business (max 200 characters).
card_volume_distribution:
type: object
description: The distribution of the merchant's credit card volume The sum of `card_volume_distribution` must be 100.
nullable: true
properties:
card_present_percentage:
type: integer
description: The percentage of the merchant's volume that's card present (between 0 and 100).
ecommerce_percentage:
type: integer
description: The percentage of the merchant's business that is eCommerce (between 0 and 100).
mail_order_telephone_order_percentage:
type: integer
description: The percentage of the merchant's business that is a mail or telephone order (between 0 and 100).
credit_check_allowed:
type: boolean
description: Sets if this merchant has consented and accepted to a credit check.
credit_check_ip_address:
type: string
minLength: 1
description: 'The IP address of the merchant when they consented to a credit check (e.g., 42.1.1.113 ).'
credit_check_timestamp:
type: string
minLength: 1
description: 'A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z).'
credit_check_user_agent:
type: string
minLength: 1
description: 'The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).'
merchant_agreement_accepted:
type: boolean
description: Sets whether this merchant has accepted the terms and conditions of the merchant agreement.
merchant_agreement_ip_address:
type: string
minLength: 1
description: 'IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113).'
merchant_agreement_timestamp:
type: string
minLength: 1
description: 'Timestamp of when the merchant accepted Finix''s Terms of Service (e.g., 2021-04-28T16:42:55Z).'
merchant_agreement_user_agent:
type: string
minLength: 1
description: 'The details of the browser that was used when this merchant accepted Finix''s Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).'
refund_policy:
type: string
minLength: 1
description: Include the value that best applies to the seller's refund policy.
enum:
- NO_REFUNDS
- MERCHANDISE_EXCHANGE_ONLY
- WITHIN_30_DAYS
- OTHER
volume_distribution_by_business_type:
type: object
description: Merchant's distribution of credit card volume by business type. Sum of `volume_distribution_by_business_type` must be 100.
nullable: true
properties:
business_to_business_volume_percentage:
type: integer
description: The percentage of the merchant's volume that's business to business (between 0 and 100).
business_to_consumer_volume_percentage:
type: integer
description: The percentage of the merchant's volume that's business to consumer (between 0 and 100).
consumer_to_consumer_volume_percentage:
type: integer
description: Merchant's percentage of volume that is consumer to consumer (between 0 and 100).
other_volume_percentage:
type: integer
description: The percentage of the merchant's volume that isn't represented by the previous fields (between 0 and 100).
person_to_person_volume_percentage:
type: integer
description: The percentage the merchant's volume that's person to person (between 0 and 100).
application:
type: string
minLength: 1
description: ID of the `Application` associated with the `Identity`.
entity:
type: object
description: The underwriting details required to verify the `Identity`.
properties:
amex_mid:
type: integer
description: 'Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.'
nullable: true
annual_card_volume:
type: integer
description: The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).
nullable: true
business_address:
type: object
description: The primary address for the legal entity.
nullable: true
properties:
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
nullable: true
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
nullable: true
city:
type: string
minLength: 1
description: City (max 20 characters).
nullable: true
region:
type: string
minLength: 1
description: 2-letter state code.
nullable: true
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
nullable: true
country:
type: string
minLength: 1
description: 3-Letter Country code (e.g. USA).
nullable: true
business_name:
type: string
minLength: 1
description: 'The merchant''s legal business name (max 120 characters).<ul><li>If <strong>INDIVIDUAL_SOLE_PROPRIETORSHIP</strong>, pass the owner''s legal first name, last name and middle initial.'
nullable: true
business_phone:
type: string
minLength: 1
description: Customer service phone number where the merchant can be reached (max 10 characters).
nullable: true
business_tax_id_provided:
type: boolean
description: Details if the `business_tax_id` was provided.
business_type:
description: Include the value that best applies to the merchant.
type: string
nullable: true
default_statement_descriptor:
type: string
minLength: 1
description: The description of the merchant that appears on the buyer's bank or card statement.
nullable: true
discover_mid:
description: Assigned discoverMid value.
type: integer
nullable: true
dob:
type: object
description: The control owner's date of birth.
nullable: true
properties:
day:
type: integer
description: Day of birth (between 1 and 31).
minimum: 1
month:
type: integer
description: Month of birth (between 1 and 12).
minimum: 1
year:
type: integer
description: Year of birth (4-digit). Year must be greater than 1900.
minimum: 1900
doing_business_as:
type: string
minLength: 1
description: 'Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).'
nullable: true
email:
type: string
minLength: 1
description: The email address of the principal control owner where they can be reached (max 100 characters).
nullable: true
first_name:
type: string
minLength: 1
description: The legal first name of the merchant's control owner (max 20 characters).
nullable: true
has_accepted_credit_cards_previously:
type: boolean
description: Defaults to **false** if not passed.
incorporation_date:
type: object
description: The date the company was founded and registered.
nullable: true
properties:
day:
type: integer
description: Day business was incorporated (between 1 and 31).
month:
type: integer
description: Month business was incorporated (between 1 and 12).
year:
type: integer
description: Year business was incorporated (4-digit).
last_name:
type: string
minLength: 1
description: The legal last name of the merchant's control owner (max 20 characters).
nullable: true
max_transaction_amount:
type: integer
description: The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).
nullable: true
mcc:
type: string
minLength: 1
description: 'The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/business/security-and-compliance/approved-merchants/)'
nullable: true
ownership_type:
type: string
minLength: 1
description: 'Values can be either: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.'
enum:
- PUBLIC
- PRIVATE
nullable: true
personal_address:
type: object
description: The home address of the merchant's principal control owner. This field is used for identity verification purposes.
nullable: true
properties:
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
nullable: true
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
nullable: true
city:
type: string
minLength: 1
description: City (max 20 characters).
nullable: true
region:
type: string
minLength: 1
description: 2-letter State code.
nullable: true
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
nullable: true
country:
type: string
minLength: 1
description: 3-Letter country code (e.g. USA).
nullable: true
phone:
type: string
minLength: 1
description: The principal control owner's phone number (max 10 characters).
nullable: true
principal_percentage_ownership:
type: integer
description: Percentage of the company owned by the principal control owner (min 0; max 100).
nullable: true
short_business_name:
type: string
description: 'Abbreviated names of the business. If there are no abbreviated name, leave this field blank.'
nullable: true
tax_authority:
type: string
description: <ul><li>Only required when onboarding a merchant with a <tt>MCC</tt> of <strong>9311</strong>.<li> The <tt>tax_authority</tt> is the tax gathering entity (e.g San Francisco Water Authority).
nullable: true
tax_id_provided:
type: boolean
description: Details if the `tax_id` was provided.
title:
type: string
minLength: 1
description: 'The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).'
nullable: true
url:
type: string
minLength: 1
description: The URL of the merchant's public website.
nullable: true
identity_roles:
$ref: '#/components/schemas/IdentityRoles'
tags:
$ref: '#/components/schemas/Tags'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
minLength: 1
verifications:
type: object
description: Link to the `Verification` the request was made under.
properties:
href:
type: string
minLength: 1
merchants:
type: object
description: Link to the `Merchant` the request was made under.
properties:
href:
type: string
minLength: 1
settlements:
type: object
description: Link to the `Settlement` the request was made under.
properties:
href:
type: string
minLength: 1
authorizations:
type: object
description: Link to the `Authorization` the request was made under.
properties:
href:
type: string
minLength: 1
transfers:
type: object
description: Link to the `Transfer` the request was made under.
properties:
href:
type: string
minLength: 1
payment_instruments:
type: object
description: Link to the `Payment Instrume` the request was made under.
properties:
href:
type: string
minLength: 1
associated_identities:
type: object
description: Link to any other `Identites` associated with the request.
properties:
href:
type: string
minLength: 1
disputes:
type: object
description: Link to the `Dispute` the request was made under.
properties:
href:
type: string
minLength: 1
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
minLength: 1
- title: Identity - Buyer
properties:
id:
type: string
minLength: 1
description: The ID of the `Identity` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
application:
type: string
minLength: 1
description: ID of the `Application` associated with the `Identity`.
updated_at:
$ref: '#/components/schemas/UpdatedAt'
entity:
type: object
description: The underwriting details required to verify the `Identity`.
properties:
amex_mid:
type: integer
description: 'Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.'
nullable: true
annual_card_volume:
type: integer
description: The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).
nullable: true
business_address:
type: object
description: The primary address for the legal entity.
nullable: true
properties:
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
nullable: true
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
nullable: true
city:
type: string
minLength: 1
description: City (max 20 characters).
nullable: true
region:
type: string
minLength: 1
description: 2-letter state code.
nullable: true
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
nullable: true
country:
type: string
minLength: 1
description: 3-Letter Country code (e.g. USA).
nullable: true
business_name:
type: string
minLength: 1
description: 'The merchant''s legal business name (max 120 characters).<ul><li>If <strong>INDIVIDUAL_SOLE_PROPRIETORSHIP</strong>, pass the owner''s legal first name, last name and middle initial.'
nullable: true
business_phone:
type: string
minLength: 1
description: Customer service phone number where the merchant can be reached (max 10 characters).
nullable: true
business_tax_id_provided:
type: boolean
description: Details if the `business_tax_id` was provided.
business_type:
description: Include the value that best applies to the merchant.
type: string
nullable: true
default_statement_descriptor:
type: string
minLength: 1
description: The description of the merchant that appears on the buyer's bank or card statement.
nullable: true
discover_mid:
description: Assigned discoverMid value.
type: integer
nullable: true
dob:
type: object
description: The control owner's date of birth.
nullable: true
properties:
day:
type: integer
description: Day of birth (between 1 and 31).
minimum: 1
month:
type: integer
description: Month of birth (between 1 and 12).
minimum: 1
year:
type: integer
description: Year of birth (4-digit). Year must be greater than 1900.
minimum: 1900
doing_business_as:
type: string
minLength: 1
description: 'Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).'
nullable: true
email:
type: string
minLength: 1
description: The email address of the principal control owner where they can be reached (max 100 characters).
nullable: true
first_name:
type: string
minLength: 1
description: The legal first name of the merchant's control owner (max 20 characters).
nullable: true
has_accepted_credit_cards_previously:
type: boolean
description: Defaults to **false** if not passed.
incorporation_date:
type: object
description: The date the company was founded and registered.
nullable: true
properties:
day:
type: integer
description: Day business was incorporated (between 1 and 31).
month:
type: integer
description: Month business was incorporated (between 1 and 12).
year:
type: integer
description: Year business was incorporated (4-digit).
last_name:
type: string
minLength: 1
description: The legal last name of the merchant's control owner (max 20 characters).
nullable: true
max_transaction_amount:
type: integer
description: The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).
nullable: true
mcc:
type: string
minLength: 1
description: 'The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/business/security-and-compliance/approved-merchants/)'
nullable: true
ownership_type:
type: string
minLength: 1
description: 'Values can be either: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.'
enum:
- PUBLIC
- PRIVATE
nullable: true
personal_address:
type: object
description: The home address of the merchant's principal control owner. This field is used for identity verification purposes.
nullable: true
properties:
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
nullable: true
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
nullable: true
city:
type: string
minLength: 1
description: City (max 20 characters).
nullable: true
region:
type: string
minLength: 1
description: 2-letter State code.
nullable: true
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
nullable: true
country:
type: string
minLength: 1
description: 3-Letter country code (e.g. USA).
nullable: true
phone:
type: string
minLength: 1
description: The principal control owner's phone number (max 10 characters).
nullable: true
principal_percentage_ownership:
type: integer
description: Percentage of the company owned by the principal control owner (min 0; max 100).
nullable: true
short_business_name:
type: string
description: 'Abbreviated names of the business. If there are no abbreviated name, leave this field blank.'
nullable: true
tax_authority:
type: string
description: <ul><li>Only required when onboarding a merchant with a <tt>MCC</tt> of <strong>9311</strong>.<li> The <tt>tax_authority</tt> is the tax gathering entity (e.g San Francisco Water Authority).
nullable: true
tax_id_provided:
type: boolean
description: Details if the `tax_id` was provided.
title:
type: string
minLength: 1
description: 'The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).'
nullable: true
url:
type: string
minLength: 1
description: The URL of the merchant's public website.
nullable: true
identity_roles:
$ref: '#/components/schemas/IdentityRoles'
tags:
$ref: '#/components/schemas/Tags'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
minLength: 1
verifications:
type: object
description: Link to the `Verification` the request was made under.
properties:
href:
type: string
minLength: 1
merchants:
type: object
description: Link to the `Merchant` the request was made under.
properties:
href:
type: string
minLength: 1
settlements:
type: object
description: Link to the `Settlement` the request was made under.
properties:
href:
type: string
minLength: 1
authorizations:
type: object
description: Link to the `Authorization` the request was made under.
properties:
href:
type: string
minLength: 1
transfers:
type: object
description: Link to the `Transfer` the request was made under.
properties:
href:
type: string
minLength: 1
payment_instruments:
type: object
description: Link to the `Payment Instrume` the request was made under.
properties:
href:
type: string
minLength: 1
associated_identities:
type: object
description: Link to any other `Identites` associated with the request.
properties:
href:
type: string
minLength: 1
disputes:
type: object
description: Link to the `Dispute` the request was made under.
properties:
href:
type: string
minLength: 1
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
minLength: 1
- title: Associated Identity
properties:
id:
type: string
minLength: 1
description: The ID of the `Identity` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
application:
type: string
minLength: 1
description: ID of the `Application` associated with the `Identity`.
updated_at:
$ref: '#/components/schemas/UpdatedAt'
entity:
type: object
description: The underwriting details required to verify the `Identity`.
properties:
annual_card_volume:
type: integer
description: The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).
nullable: true
business_address:
type: object
description: The primary address for the legal entity.
nullable: true
properties:
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
nullable: true
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
nullable: true
city:
type: string
minLength: 1
description: City (max 20 characters).
nullable: true
region:
type: string
minLength: 1
description: 2-letter state code.
nullable: true
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
nullable: true
country:
type: string
minLength: 1
description: 3-Letter Country code (e.g. USA).
nullable: true
business_name:
type: string
minLength: 1
description: 'The merchant''s legal business name (max 120 characters).<ul><li>If <strong>INDIVIDUAL_SOLE_PROPRIETORSHIP</strong>, pass the owner''s legal first name, last name and middle initial.'
nullable: true
business_phone:
type: string
minLength: 1
description: Customer service phone number where the merchant can be reached (max 10 characters).
nullable: true
business_tax_id_provided:
type: boolean
description: Details if the `business_tax_id` was provided.
business_type:
description: Include the value that best applies to the merchant.
type: string
nullable: true
default_statement_descriptor:
type: string
minLength: 1
description: The description of the merchant that appears on the buyer's bank or card statement.
nullable: true
discover_mid:
description: Assigned discoverMid value.
type: integer
nullable: true
dob:
type: object
description: The control owner's date of birth.
nullable: true
properties:
day:
type: integer
description: Day of birth (between 1 and 31).
minimum: 1
month:
type: integer
description: Month of birth (between 1 and 12).
minimum: 1
year:
type: integer
description: Year of birth (4-digit). Year must be greater than 1900.
minimum: 1900
doing_business_as:
type: string
minLength: 1
description: 'Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).'
nullable: true
email:
type: string
minLength: 1
description: The email address of the principal control owner where they can be reached (max 100 characters).
nullable: true
first_name:
type: string
minLength: 1
description: The legal first name of the merchant's control owner (max 20 characters).
nullable: true
has_accepted_credit_cards_previously:
type: boolean
description: Defaults to **false** if not passed.
incorporation_date:
type: object
description: The date the company was founded and registered.
nullable: true
properties:
day:
type: integer
description: Day business was incorporated (between 1 and 31).
month:
type: integer
description: Month business was incorporated (between 1 and 12).
year:
type: integer
description: Year business was incorporated (4-digit).
last_name:
type: string
minLength: 1
description: The legal last name of the merchant's control owner (max 20 characters).
nullable: true
max_transaction_amount:
type: integer
description: The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).
nullable: true
mcc:
type: string
minLength: 1
description: 'The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/business/security-and-compliance/approved-merchants/)'
nullable: true
ownership_type:
type: string
minLength: 1
description: 'Values can be either: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.'
enum:
- PUBLIC
- PRIVATE
nullable: true
personal_address:
type: object
description: The home address of the merchant's principal control owner. This field is used for identity verification purposes.
nullable: true
properties:
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
nullable: true
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
nullable: true
city:
type: string
minLength: 1
description: City (max 20 characters).
nullable: true
region:
type: string
minLength: 1
description: 2-letter State code.
nullable: true
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
nullable: true
country:
type: string
minLength: 1
description: 3-Letter country code (e.g. USA).
nullable: true
phone:
type: string
minLength: 1
description: The principal control owner's phone number (max 10 characters).
nullable: true
principal_percentage_ownership:
type: integer
description: Percentage of the company owned by the principal control owner (min 0; max 100).
nullable: true
short_business_name:
type: string
description: 'Abbreviated names of the business. If there are no abbreviated name, leave this field blank.'
nullable: true
tax_authority:
type: string
description: <ul><li>Only required when onboarding a merchant with a <tt>MCC</tt> of <strong>9311</strong>.<li> The <tt>tax_authority</tt> is the tax gathering entity (e.g San Francisco Water Authority).
nullable: true
tax_id_provided:
type: boolean
description: Details if the `tax_id` was provided.
title:
type: string
minLength: 1
description: 'The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).'
nullable: true
url:
type: string
minLength: 1
description: The URL of the merchant's public website.
nullable: true
identity_roles:
$ref: '#/components/schemas/IdentityRoles'
tags:
$ref: '#/components/schemas/Tags'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
minLength: 1
verifications:
type: object
description: Link to the `Verification` the request was made under.
properties:
href:
type: string
minLength: 1
merchants:
type: object
description: Link to the `Merchant` the request was made under.
properties:
href:
type: string
minLength: 1
settlements:
type: object
description: Link to the `Settlement` the request was made under.
properties:
href:
type: string
minLength: 1
authorizations:
type: object
description: Link to the `Authorization` the request was made under.
properties:
href:
type: string
minLength: 1
transfers:
type: object
description: Link to the `Transfer` the request was made under.
properties:
href:
type: string
minLength: 1
payment_instruments:
type: object
description: Link to the `Payment Instrume` the request was made under.
properties:
href:
type: string
minLength: 1
associated_identities:
type: object
description: Link to any other `Identites` associated with the request.
properties:
href:
type: string
minLength: 1
disputes:
type: object
description: Link to the `Dispute` the request was made under.
properties:
href:
type: string
minLength: 1
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
minLength: 1
type: object
AssociatedIdentity:
description: ''
x-examples:
example-1:
id: IDpYDM7J9n57q849o9E9yNrG
application: APgPDQrLD52TYvqazjHJJchM
entity:
title: CEO
first_name: dwayne
last_name: Sunkhronos
email: user@example.org
business_name: Petes Coffee
business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP
doing_business_as: Petes Coffee
phone: '14158885080'
business_phone: +1 (408) 756-4497
personal_address:
line1: 741 Douglass St
line2: Apartment 7
city: San Mateo
region: CA
postal_code: '94114'
country: USA
business_address:
line1: 741 Douglass St
line2: Apartment 8
city: San Mateo
region: CA
postal_code: '94114'
country: USA
mcc: '4900'
dob:
day: 27
month: 6
year: 1978
max_transaction_amount: 12000000
amex_mid: null
discover_mid: null
url: www.PetesCoffee.com
annual_card_volume: 12000000
has_accepted_credit_cards_previously: true
incorporation_date:
day: 27
month: 6
year: 1978
principal_percentage_ownership: 50
short_business_name: null
ownership_type: PRIVATE
tax_authority: null
tax_id_provided: true
business_tax_id_provided: true
default_statement_descriptor: Petes Coffee
tags:
Studio Rating: '4.7'
created_at: '2022-01-27T07:36:52.11Z'
updated_at: '2022-01-27T07:36:52.00Z'
additional_underwriting_data:
annual_ach_volume: 200000
average_ach_transfer_amount: 200000
average_card_transfer_amount: 200000
business_description: SB3 vegan cafe
card_volume_distribution:
card_present_percentage: 30
ecommerce_percentage: 60
mail_order_telephone_order_percentage: 10
credit_check_allowed: true
credit_check_ip_address: 42.1.1.113
credit_check_timestamp: '2021-04-28T16:42:55Z'
credit_check_user_agent: Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)
merchant_agreement_accepted: true
merchant_agreement_ip_address: 42.1.1.113
merchant_agreement_timestamp: '2021-04-28T16:42:55Z'
merchant_agreement_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)
refund_policy: MERCHANDISE_EXCHANGE_ONLY
volume_distribution_by_business_type:
business_to_business_volume_percentage: 100
business_to_consumer_volume_percentage: 0
consumer_to_consumer_volume_percentage: 0
other_volume_percentage: 0
person_to_person_volume_percentage: 0
_links:
self:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG'
verifications:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/verifications'
merchants:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/merchants'
settlements:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/settlements'
authorizations:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/authorizations'
transfers:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/transfers'
payment_instruments:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/payment_instruments'
associated_identities:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/associated_identities'
disputes:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/disputes'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
title: ''
anyOf:
- title: Associated Identity (Merchant)
properties:
id:
type: string
minLength: 1
description: The ID of the `Identity` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
minLength: 1
description: ID of the `Application` associated with the `Identity`.
entity:
type: object
description: The underwriting details required to verify the `Identity`.
properties:
business_address:
type: object
description: The primary address for the legal entity.
nullable: true
properties:
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
nullable: true
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
nullable: true
city:
type: string
minLength: 1
description: City (max 20 characters).
nullable: true
region:
type: string
minLength: 1
description: 2-letter state code.
nullable: true
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
nullable: true
country:
type: string
minLength: 1
description: 3-Letter Country code (e.g. USA).
nullable: true
business_name:
type: string
minLength: 1
description: 'The merchant''s legal business name (max 120 characters).<ul><li>If <strong>INDIVIDUAL_SOLE_PROPRIETORSHIP</strong>, pass the owner''s legal first name, last name and middle initial.'
nullable: true
business_phone:
type: string
minLength: 1
description: Customer service phone number where the merchant can be reached (max 10 characters).
nullable: true
business_tax_id_provided:
type: boolean
description: Details if the `business_tax_id` was provided.
business_type:
description: Include the value that best applies to the merchant.
type: string
nullable: true
default_statement_descriptor:
type: string
minLength: 1
description: The description of the merchant that appears on the buyer's bank or card statement.
nullable: true
discover_mid:
description: Assigned discoverMid value.
type: integer
nullable: true
dob:
type: object
description: The control owner's date of birth.
nullable: true
properties:
day:
type: integer
description: Day of birth (between 1 and 31).
minimum: 1
month:
type: integer
description: Month of birth (between 1 and 12).
minimum: 1
year:
type: integer
description: Year of birth (4-digit). Year must be greater than 1900.
minimum: 1900
doing_business_as:
type: string
minLength: 1
description: 'Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).'
nullable: true
email:
type: string
minLength: 1
description: The email address of the principal control owner where they can be reached (max 100 characters).
nullable: true
first_name:
type: string
minLength: 1
description: The legal first name of the merchant's control owner (max 20 characters).
nullable: true
has_accepted_credit_cards_previously:
type: boolean
description: Defaults to **false** if not passed.
incorporation_date:
type: object
description: The date the company was founded and registered.
nullable: true
properties:
day:
type: integer
description: Day business was incorporated (between 1 and 31).
month:
type: integer
description: Month business was incorporated (between 1 and 12).
year:
type: integer
description: Year business was incorporated (4-digit).
last_name:
type: string
minLength: 1
description: The legal last name of the merchant's control owner (max 20 characters).
nullable: true
max_transaction_amount:
type: integer
description: The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).
nullable: true
mcc:
type: string
minLength: 1
description: 'The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/business/security-and-compliance/approved-merchants/)'
nullable: true
ownership_type:
type: string
minLength: 1
description: 'Values can be either: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.'
enum:
- PUBLIC
- PRIVATE
nullable: true
personal_address:
type: object
description: The home address of the merchant's principal control owner. This field is used for identity verification purposes.
nullable: true
properties:
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
nullable: true
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
nullable: true
city:
type: string
minLength: 1
description: City (max 20 characters).
nullable: true
region:
type: string
minLength: 1
description: 2-letter State code.
nullable: true
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
nullable: true
country:
type: string
minLength: 1
description: 3-Letter country code (e.g. USA).
nullable: true
phone:
type: string
minLength: 1
description: The principal control owner's phone number (max 10 characters).
nullable: true
principal_percentage_ownership:
type: integer
description: Percentage of the company owned by the principal control owner (min 0; max 100).
nullable: true
short_business_name:
type: string
description: 'Abbreviated names of the business. If there are no abbreviated name, leave this field blank.'
nullable: true
tax_authority:
type: string
description: <ul><li>Only required when onboarding a merchant with a <tt>MCC</tt> of <strong>9311</strong>.<li> The <tt>tax_authority</tt> is the tax gathering entity (e.g San Francisco Water Authority).
nullable: true
tax_id_provided:
type: boolean
description: Details if the `tax_id` was provided.
title:
type: string
minLength: 1
description: 'The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).'
nullable: true
url:
type: string
minLength: 1
description: The URL of the merchant's public website.
nullable: true
tags:
$ref: '#/components/schemas/Tags'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
minLength: 1
verifications:
type: object
description: Link to the `Verification` the request was made under.
properties:
href:
type: string
minLength: 1
merchants:
type: object
description: Link to the `Merchant` the request was made under.
properties:
href:
type: string
minLength: 1
settlements:
type: object
description: Link to the `Settlement` the request was made under.
properties:
href:
type: string
minLength: 1
authorizations:
type: object
description: Link to the `Authorization` the request was made under.
properties:
href:
type: string
minLength: 1
transfers:
type: object
description: Link to the `Transfer` the request was made under.
properties:
href:
type: string
minLength: 1
payment_instruments:
type: object
description: Link to the `Payment Instrume` the request was made under.
properties:
href:
type: string
minLength: 1
associated_identities:
type: object
description: Link to any other `Identites` associated with the request.
properties:
href:
type: string
minLength: 1
disputes:
type: object
description: Link to the `Dispute` the request was made under.
properties:
href:
type: string
minLength: 1
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
minLength: 1
- title: Associated Identity (Buyer)
properties:
id:
type: string
minLength: 1
description: The ID of the `Identity` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
minLength: 1
description: ID of the `Application` associated with the `Identity`.
entity:
type: object
description: The underwriting details required to verify the `Identity`.
properties:
amex_mid:
type: integer
description: 'Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.'
nullable: true
annual_card_volume:
type: integer
description: The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).
nullable: true
business_address:
type: object
description: The primary address for the legal entity.
nullable: true
properties:
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
nullable: true
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
nullable: true
city:
type: string
minLength: 1
description: City (max 20 characters).
nullable: true
region:
type: string
minLength: 1
description: 2-letter state code.
nullable: true
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
nullable: true
country:
type: string
minLength: 1
description: 3-Letter Country code (e.g. USA).
nullable: true
business_name:
type: string
minLength: 1
description: 'The merchant''s legal business name (max 120 characters).<ul><li>If <strong>INDIVIDUAL_SOLE_PROPRIETORSHIP</strong>, pass the owner''s legal first name, last name and middle initial.'
nullable: true
business_phone:
type: string
minLength: 1
description: Customer service phone number where the merchant can be reached (max 10 characters).
nullable: true
business_tax_id_provided:
type: boolean
description: Details if the `business_tax_id` was provided.
business_type:
description: Include the value that best applies to the merchant.
type: string
nullable: true
default_statement_descriptor:
type: string
minLength: 1
description: The description of the merchant that appears on the buyer's bank or card statement.
nullable: true
discover_mid:
description: Assigned discoverMid value.
type: integer
nullable: true
dob:
type: object
description: The control owner's date of birth.
nullable: true
properties:
day:
type: integer
description: Day of birth (between 1 and 31).
minimum: 1
month:
type: integer
description: Month of birth (between 1 and 12).
minimum: 1
year:
type: integer
description: Year of birth (4-digit). Year must be greater than 1900.
minimum: 1900
doing_business_as:
type: string
minLength: 1
description: 'Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).'
nullable: true
email:
type: string
minLength: 1
description: The email address of the principal control owner where they can be reached (max 100 characters).
nullable: true
first_name:
type: string
minLength: 1
description: The legal first name of the merchant's control owner (max 20 characters).
nullable: true
has_accepted_credit_cards_previously:
type: boolean
description: Defaults to **false** if not passed.
incorporation_date:
type: object
description: The date the company was founded and registered.
nullable: true
properties:
day:
type: integer
description: Day business was incorporated (between 1 and 31).
month:
type: integer
description: Month business was incorporated (between 1 and 12).
year:
type: integer
description: Year business was incorporated (4-digit).
last_name:
type: string
minLength: 1
description: The legal last name of the merchant's control owner (max 20 characters).
nullable: true
max_transaction_amount:
type: integer
description: The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).
nullable: true
mcc:
type: string
minLength: 1
description: 'The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/business/security-and-compliance/approved-merchants/)'
nullable: true
ownership_type:
type: string
minLength: 1
description: 'Values can be either: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.'
enum:
- PUBLIC
- PRIVATE
nullable: true
personal_address:
type: object
description: The home address of the merchant's principal control owner. This field is used for identity verification purposes.
nullable: true
properties:
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
nullable: true
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
nullable: true
city:
type: string
minLength: 1
description: City (max 20 characters).
nullable: true
region:
type: string
minLength: 1
description: 2-letter State code.
nullable: true
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
nullable: true
country:
type: string
minLength: 1
description: 3-Letter country code (e.g. USA).
nullable: true
phone:
type: string
minLength: 1
description: The principal control owner's phone number (max 10 characters).
nullable: true
principal_percentage_ownership:
type: integer
description: Percentage of the company owned by the principal control owner (min 0; max 100).
nullable: true
short_business_name:
type: string
description: 'Abbreviated names of the business. If there are no abbreviated name, leave this field blank.'
nullable: true
tax_authority:
type: string
description: <ul><li>Only required when onboarding a merchant with a <tt>MCC</tt> of <strong>9311</strong>.<li> The <tt>tax_authority</tt> is the tax gathering entity (e.g San Francisco Water Authority).
nullable: true
tax_id_provided:
type: boolean
description: Details if the `tax_id` was provided.
title:
type: string
minLength: 1
description: 'The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).'
nullable: true
url:
type: string
minLength: 1
description: The URL of the merchant's public website.
nullable: true
tags:
$ref: '#/components/schemas/Tags'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
minLength: 1
verifications:
type: object
description: Link to the `Verification` the request was made under.
properties:
href:
type: string
minLength: 1
merchants:
type: object
description: Link to the `Merchant` the request was made under.
properties:
href:
type: string
minLength: 1
settlements:
type: object
description: Link to the `Settlement` the request was made under.
properties:
href:
type: string
minLength: 1
authorizations:
type: object
description: Link to the `Authorization` the request was made under.
properties:
href:
type: string
minLength: 1
transfers:
type: object
description: Link to the `Transfer` the request was made under.
properties:
href:
type: string
minLength: 1
payment_instruments:
type: object
description: Link to the `Payment Instrume` the request was made under.
properties:
href:
type: string
minLength: 1
associated_identities:
type: object
description: Link to any other `Identites` associated with the request.
properties:
href:
type: string
minLength: 1
disputes:
type: object
description: Link to the `Dispute` the request was made under.
properties:
href:
type: string
minLength: 1
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
minLength: 1
type: object
CreateIdentityRequest:
anyOf:
- title: Identity - Merchant
properties:
additional_underwriting_data:
type: object
description: |-
- Additional underwriting details required to verify `Identities`.
- Required for any `Merchants` onboarded by Finix Flex customers. If you have any questions, please contact [Finix Support](/guides/business/support-at-finix/).
nullable: true
properties:
annual_ach_volume:
type: integer
description: The approximate annual ACH sales expected to be processed (in cents) by this merchant (max 10 characters).
average_ach_transfer_amount:
type: integer
description: The approximate average ACH sale amount (in cents) for this merchant.
average_card_transfer_amount:
type: integer
description: The average credit card sale amount (in cents) for this merchant.
business_description:
type: string
description: Description of this merchant's business (max 200 characters).
card_volume_distribution:
type: object
description: The distribution of the merchant's credit card volume The sum of `card_volume_distribution` must be 100.
properties:
card_present_percentage:
type: integer
description: The percentage of the merchant's volume that's card present (between 0 and 100).
mail_order_telephone_order_percentage:
type: integer
description: The percentage of the merchant's business that is a mail order or telephone order (between 0 and 100).
ecommerce_percentage:
type: integer
description: The percentage of the merchant's business that is eCommerce (between 0 and 100).
credit_check_allowed:
type: boolean
description: Sets if this merchant has consented and accepted to a credit check.
credit_check_ip_address:
type: string
description: 'The IP address of the merchant when they consented to a credit check (e.g., 42.1.1.113 ).'
minLength: 1
credit_check_timestamp:
type: string
minLength: 1
description: 'A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z).'
credit_check_user_agent:
type: string
minLength: 1
description: 'The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).'
merchant_agreement_accepted:
type: boolean
description: Sets whether this merchant has accepted the terms and conditions of the merchant agreement.
merchant_agreement_ip_address:
type: string
description: 'IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113).'
minLength: 1
merchant_agreement_timestamp:
type: string
minLength: 1
description: Sets if this merchant has consented and accepted to a credit check.
merchant_agreement_user_agent:
type: string
description: 'The details of the browser that was used when this merchant accepted Finix''s Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).'
minLength: 1
refund_policy:
type: string
description: 'The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).'
enum:
- NO_REFUNDS
- MERCHANDISE_EXCHANGE_ONLY
- 30_DAYS
- OTHER
volume_distribution_by_business_type:
type: object
description: 'IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113).'
properties:
other_volume_percentage:
type: integer
description: The percentage of the merchant's volume that isn't represented by the previous fields (between 0 and 100).
consumer_to_consumer_volume_percentage:
type: integer
description: Merchant's percentage of volume that is consumer to consumer (between 0 and 100).
business_to_consumer_volume_percentage:
type: integer
description: The percentage of the merchant's volume that's business to consumer (between 0 and 100).
business_to_business_volume_percentage:
type: integer
description: The percentage of the merchant's volume that's business to business (between 0 and 100).
person_to_person_volume_percentage:
type: integer
description: The percentage of the merchant's volume that's person to person (between 0 and 100).
entity:
type: object
description: The underwriting details required to verify `Identities`.
properties:
annual_card_volume:
type: integer
description: The annual credit card sales (in cents) expected to be processed (max 19 characters).
business_address:
type: object
description: The primary address for the legal entity.
required:
- city
- country
- region
- line1
- postal_code
nullable: true
properties:
city:
type: string
minLength: 1
description: City (max 20 characters).
country:
type: string
minLength: 1
description: 3-Letter Country code (e.g. USA).
region:
type: string
minLength: 1
description: 2-letter state code.
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
business_name:
type: string
description: 'The merchant''s legal business name (max 120 characters).<ul><li>If **INDIVIDUAL_SOLE_PROPRIETORSHIP**, pass the owner''s legal first name, last name and middle initial.</li><li>Special characters (e.g., <code>.</code><code>,</code><code>_</code><code>-</code><code>?</code><code>+</code><code>*</code> or <code>/</code>.) are not allowed.</li></ul>'
nullable: true
business_phone:
type: string
description: Customer service phone number where the merchant can be reached (max 10 characters).
business_tax_id:
type: string
description: 'Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL\_SOLE\_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor''s Social Security Number (SSN).'
business_type:
type: string
description: The business entity type of the Merchant.
enum:
- INDIVIDUAL_SOLE_PROPRIETORSHIP
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- ASSOCIATION_ESTATE_TRUST
- TAX_EXEMPT_ORGANIZATION
- INTERNATIONAL_ORGANIZATION
- GOVERNMENT_AGENCY
default_statement_descriptor:
type: string
description: The description of the merchant that appears on the buyer's bank or card statement.
dob:
type: object
description: The control owner's date of birth.
required:
- day
- month
- year
properties:
day:
type: integer
description: Day of birth (between 1 and 31).
month:
type: integer
description: Month of birth (between 1 and 12).
year:
type: integer
description: Year of birth (4-digit). Year must be greater than 1900
doing_business_as:
type: string
description: 'Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).'
email:
type: string
description: The email address of the principal control owner where they can be reached (max 100 characters).
first_name:
type: string
description: The legal first name of the merchant's control owner (max 20 characters).
has_accepted_credit_cards_previously:
type: boolean
description: Defaults to **false** if not passed.
incorporation_date:
type: object
description: The date the company was founded and registered.
required:
- day
- month
- year
nullable: true
properties:
day:
type: integer
description: Day business was incorporated (between 1 and 31).
month:
type: integer
description: Month business was incorporated (between 1 and 12).
year:
type: integer
description: Year business was incorporated (4-digit).
last_name:
type: string
description: The legal last name of the control owner (max 20 characters).
max_transaction_amount:
type: integer
description: The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).
ach_max_transaction_amount:
type: integer
description: The maximum amount (in cents) that can be charged for a single ACH transaction (max 12 characters).
mcc:
type: string
description: 'The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/business/security-and-compliance/approved-merchants/)'
ownership_type:
type: string
description: |-
Avalible values include: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.
For `business_type` of **GOVERNMENT_AGENCY** and **TAX_EXEMPT_ORGANIZATION** the `ownership_type` should be set to **PUBLIC**.
For `business_type` **INDIVIDUAL_SOLE_PROPRIETORSHIP**, the `ownership_type` should be set to **PRIVATE**.
enum:
- PUBLIC
- PRIVATE
nullable: true
personal_address:
type: object
description: The billing address of the Principal Owner. This field is used for identity verification purposes.
required:
- city
- country
- line1
- postal_code
- region
properties:
city:
type: string
description: City (max 20 characters).
country:
type: string
description: 3-Letter country code (e.g. USA).
line1:
type: string
description: First line of the address (max 35 characters).
line2:
type: string
description: Second line of the address (max 35 characters).
postal_code:
type: string
description: Zip or Postal code (max 7 characters).
region:
type: string
description: 2-letter State code.
phone:
type: string
description: The principal control owner's phone number (max 10 characters).
principal_percentage_ownership:
type: integer
description: Percentage of the company owned by the principal control owner (min 0; max 100).
tax_id:
type: string
description: 'Pass one of the following values (nine digits):<ul><li>Social Security Number (SSN)<li>Tax Identification Number (TIN)<li>Individual Taxpayer Identification Number (ITIN)</ul>'
title:
type: string
description: 'The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).'
url:
type: string
description: The URL of the merchant's public website.
required:
- annual_card_volume
- business_address
- business_name
- business_phone
- business_tax_id
- business_type
- default_statement_descriptor
- dob
- doing_business_as
- email
- first_name
- has_accepted_credit_cards_previously
- incorporation_date
- last_name
- max_transaction_amount
- ach_max_transaction_amount
- mcc
- ownership_type
- personal_address
- phone
- principal_percentage_ownership
- tax_id
- title
- url
tags:
$ref: '#/components/schemas/Tags'
- title: Identity - Buyer
properties:
entity:
type: object
description: The underwriting details required to verify `Identities`.
properties:
email:
type: string
description: The email address of the buyer where they can be reached (max 100 characters).
first_name:
type: string
description: The legal first name of the buyer (max 20 characters).
last_name:
type: string
description: The legal last name of the buyer (max 20 characters).
personal_address:
type: object
description: The billing address of the buyer. This field is used for identity verification purposes.
properties:
city:
type: string
description: City (max 20 characters).
country:
type: string
description: 3-Letter country code (e.g. USA).
line1:
type: string
description: First line of the address (max 35 characters).
line2:
type: string
description: Second line of the address (max 35 characters).
postal_code:
type: string
description: Zip or Postal code (max 7 characters).
region:
type: string
description: 2-letter State code.
phone:
type: string
description: Phone number where the buyer can be reached.
tags:
$ref: '#/components/schemas/Tags'
type: object
UpdateIdentityRequest:
anyOf:
- title: Update Identity - Merchant
properties:
additional_underwriting_data:
type: object
description: Additional underwriting data that's required to verify the `Identity` of merchants.
properties:
annual_ach_volume:
type: integer
description: The approximate annual ACH sales expected to be processed (in cents) by this merchant (max 10 characters).
average_ach_transfer_amount:
type: integer
description: The approximate average ACH sale amount (in cents) for this merchant.
average_card_transfer_amount:
type: integer
description: The average credit card sale amount (in cents) for this merchant.
business_description:
type: string
minLength: 1
description: Description of this merchant's business (max 200 characters).
credit_check_allowed:
type: boolean
description: Sets if this merchant has consented and accepted to a credit check.
credit_check_ip_address:
type: string
minLength: 1
description: 'The IP address of the merchant when they consented to a credit check (e.g., 42.1.1.113 ).'
credit_check_timestamp:
type: string
minLength: 1
description: 'A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z).'
credit_check_user_agent:
type: string
minLength: 1
description: 'The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).'
card_volume_distribution:
type: object
description: The distribution of the merchant's credit card volume The sum of `card_volume_distribution` must be 100.
properties:
card_present_percentage:
type: integer
description: The percentage of the merchant's business that's card present (between 0 and 100).
ecommerce_percentage:
type: integer
description: The percentage of the merchant's business that's e-commerce (between 0 and 100).
mail_order_telephone_order_percentage:
type: integer
description: The percentage of the merchant's business that's mail or telephone order (between 0 and 100).
merchant_agreement_accepted:
type: boolean
description: Sets whether this merchant has accepted the terms and conditions of the merchant agreement.
merchant_agreement_ip_address:
type: string
minLength: 1
description: 'IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113).'
merchant_agreement_timestamp:
type: string
minLength: 1
description: 'Timestamp of when the merchant accepted Finix''s Terms of Service (e.g., 2021-04-28T16:42:55Z).'
merchant_agreement_user_agent:
type: string
minLength: 1
description: 'The details of the browser that was used when this merchant accepted Finix''s Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)).'
refund_policy:
type: string
minLength: 1
description: Include the value that best applies to the merchant's refund policy.
enum:
- NO_REFUNDS
- MERCHANDISE_EXCHANGE_ONLY
- WITHIN_30_DAYS OTHER
volume_distribution_by_business_type:
type: object
description: Merchant's distribution of credit card volume by business type. Sum of `volume_distribution_by_business_type` must be 100.
properties:
other_volume_percentage:
type: integer
description: The percentage of the merchant's volume that isn't represented by the previous fields (between 0 and 100).
consumer_to_consumer_volume_percentage:
type: integer
description: Merchant's percentage of volume that is consumer to consumer (between 0 and 100).
business_to_consumer_volume_percentage:
type: integer
description: The percentage of the merchant's volume that's business to consumer (between 0 and 100).
business_to_business_volume_percentage:
type: integer
description: The percentage of the merchant's volume that's business to business (between 0 and 100).
person_to_person_volume_percentage:
type: integer
description: The percentage the merchant's volume that's person to person (between 0 and 100).
entity:
type: object
description: Underwriting data that's required to verify the `Identity`.
properties:
annual_card_volume:
type: integer
description: The annual credit card sales (in cents) expected to be processed (max 19 characters).
business_address:
type: object
description: The primary address for the legal entity.
nullable: true
properties:
city:
type: string
description: City (max 20 characters).
minLength: 1
country:
type: string
minLength: 1
region:
type: string
minLength: 1
description: 2-letter state code.
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
business_name:
type: string
minLength: 1
description: 'Abbreviated names of the business. If there are no abbreviated name, leave this field blank.'
nullable: true
business_phone:
type: string
minLength: 1
description: Customer service phone number where the merchant can be reached (max 10 characters).
business_tax_id:
type: string
minLength: 1
description: 'Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL\_SOLE\_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor''s Social Security Number (SSN).'
business_type:
type: string
minLength: 1
description: Include the value that best applies to the merchant.
enum:
- INDIVIDUAL_SOLE_PROPRIETORSHIP
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- ASSOCIATION_ESTATE_TRUST
- TAX_EXEMPT_ORGANIZATION
- INTERNATIONAL_ORGANIZATION
- GOVERNMENT_AGENCY
default_statement_descriptor:
type: string
minLength: 1
description: The description of the merchant that appears on the buyer's bank or card statement.
dob:
type: object
description: |
The principal control owner's date of birth.
properties:
day:
type: integer
description: Day of birth (between 1 and 31).
month:
type: integer
description: Month of birth (between 1 and 12).
year:
type: integer
description: Year of birth (4-digits).
doing_business_as:
type: string
minLength: 1
description: 'Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).'
email:
type: string
minLength: 1
description: The email address of the principal control owner (max 100 characters).
first_name:
type: string
minLength: 1
description: The legal first name of the control owner (max 20 characters).
has_accepted_credit_cards_previously:
type: boolean
description: Defaults to **false** if not passed.
incorporation_date:
type: object
description: The date the company was founded and registered.
nullable: true
properties:
day:
type: integer
description: Day business was incorporated (between 1 and 31).
month:
type: integer
description: Month business was incorporated (between 1 and 12).
year:
type: integer
description: Year business was incorporated (4-digit).
last_name:
type: string
minLength: 1
description: The `Identity` owner's legal last name.
max_transaction_amount:
type: integer
description: The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).
mcc:
type: string
minLength: 1
description: 'The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/business/security-and-compliance/approved-merchants/)'
ownership_type:
type: string
minLength: 1
description: |-
Values can be either:
<ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.
<li><strong>PRIVATE</strong> for privately-held businesses.
nullable: true
personal_address:
type: object
description: The home address of the principal control owner. This field is used for identity verification purposes.
properties:
city:
type: string
minLength: 1
description: City (max 20 characters).
country:
type: string
minLength: 1
description: 3-Letter country code (e.g. USA).
region:
type: string
minLength: 1
description: 2-letter State code.
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
phone:
type: string
minLength: 1
description: The principal control owner's phone number (max 10 characters).
principal_percentage_ownership:
type: integer
description: Percentage of the company owned by the principal control owner (min 0; max 100).
tax_id:
type: string
minLength: 1
description: Details if the `tax_id` was provided.
title:
type: string
minLength: 1
description: 'The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).'
url:
type: string
minLength: 1
description: The URL of the `Identity` owner's public website.
tags:
$ref: '#/components/schemas/Tags'
- title: Update Identity - Buyer
properties:
entity:
type: object
description: Identifying information about the buyer.
properties:
email:
type: string
description: The email address of the buyer (max 100 characters).
first_name:
type: string
description: The legal first name of the buyer (max 20 characters).
last_name:
type: string
description: The legal last name of the buyer (max 20 characters).
personal_address:
type: object
description: The billing address of the buyer. This field is used for identity verification purposes.
properties:
city:
type: string
description: City (max 20 characters).
country:
type: string
description: 3-Letter country code (e.g. USA).
line1:
type: string
description: First line of the address (max 35 characters).
line2:
type: string
description: Second line of the address (max 35 characters).
postal_code:
type: string
description: Zip or Postal code (max 7 characters).
phone:
type: string
description: Phone number where the buyer can be reached.
tags:
$ref: '#/components/schemas/Tags'
type: object
CreateAssociatedIdentityRequest:
x-examples: {}
type: object
properties:
entity:
type: object
description: Underwriting data that's required to verify the `Identity`.
properties:
annual_card_volume:
type: integer
description: The annual credit card sales (in cents) expected to be processed (max 19 characters).
business_address:
type: object
description: The primary address for the legal entity.
nullable: true
properties:
city:
type: string
description: City (max 20 characters).
minLength: 1
country:
type: string
minLength: 1
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
region:
type: string
minLength: 1
description: 2-letter state code.
business_name:
type: string
minLength: 1
description: 'Abbreviated names of the business. If there are no abbreviated name, leave this field blank.'
nullable: true
business_phone:
type: string
minLength: 1
description: Customer service phone number where the merchant can be reached (max 10 characters).
business_tax_id:
type: string
minLength: 1
description: 'Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL\_SOLE\_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor''s Social Security Number (SSN).'
business_type:
type: string
minLength: 1
description: Include the value that best applies to the merchant.
enum:
- INDIVIDUAL_SOLE_PROPRIETORSHIP
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- ASSOCIATION_ESTATE_TRUST
- TAX_EXEMPT_ORGANIZATION
- INTERNATIONAL_ORGANIZATION
- GOVERNMENT_AGENCY
default_statement_descriptor:
type: string
minLength: 1
description: The description of the merchant that appears on the buyer's bank or card statement.
dob:
type: object
description: |
The control owner's date of birth.
properties:
day:
type: integer
month:
type: integer
year:
type: integer
doing_business_as:
type: string
minLength: 1
description: 'Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).'
email:
type: string
minLength: 1
description: The email address of the principal control owner where they can be reached (max 100 characters).
first_name:
type: string
minLength: 1
description: The legal first name of the control owner (max 20 characters).
has_accepted_credit_cards_previously:
type: boolean
description: Defaults to **false** if not passed.
incorporation_date:
type: object
description: The date the company was founded and registered.
nullable: true
properties:
day:
type: integer
description: Day business was incorporated (between 1 and 31).
month:
type: integer
description: Month business was incorporated (between 1 and 12).
year:
type: integer
description: Year business was incorporated (4-digit).
last_name:
type: string
minLength: 1
description: The `Identity` owner's legal last name.
max_transaction_amount:
type: integer
description: The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).
mcc:
type: string
minLength: 1
description: 'The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/business/security-and-compliance/approved-merchants/)'
ownership_type:
type: string
minLength: 1
nullable: true
description: |-
Values can be either:
<ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.
<li><strong>PRIVATE</strong> for privately-held businesses.
personal_address:
type: object
description: The home address of the principal control owner. This field is used for identity verification purposes.
properties:
city:
type: string
minLength: 1
description: City (max 20 characters).
country:
type: string
minLength: 1
description: 3-Letter country code (e.g. USA).
line1:
type: string
minLength: 1
description: First line of the address (max 35 characters).
line2:
type: string
minLength: 1
description: Second line of the address (max 35 characters).
postal_code:
type: string
minLength: 1
description: Zip or Postal code (max 7 characters).
region:
type: string
minLength: 1
description: 2-letter State code.
phone:
type: string
minLength: 1
description: The principal control owner's phone number (max 10 characters).
principal_percentage_ownership:
type: integer
description: Percentage of the company owned by the principal control owner (min 0; max 100).
tax_id:
type: string
minLength: 1
description: Details if the `tax_id` was provided.
title:
type: string
minLength: 1
description: 'The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).'
url:
type: string
minLength: 1
description: The URL of the `Identity` owner's public website.
tags:
$ref: '#/components/schemas/Tags'
Merchant:
type: object
x-examples:
example-1:
id: MUucec6fHeaWo3VHYoSkUySM
application: APgPDQrLD52TYvqazjHJJchM
identity: IDpYDM7J9n57q849o9E9yNrG
verification: VIdikDHXv7x8nWyJg8JZemGx
merchant_profile: MPzW2oRPtkLxK3fymcMACFi
processor: DUMMY_V1
processing_enabled: true
settlement_enabled: true
gross_settlement_enabled: false
creating_transfer_from_report_enabled: true
card_expiration_date_required: true
card_cvv_required: false
tags:
key_2: value_2
mcc: '4900'
mid: FNX7CwmebftudY7i5mA4qF6XT
merchant_name: Petes Coffee
settlement_funding_identifier: UNSET
ready_to_settle_upon: RECONCILIATION
fee_ready_to_settle_upon: RECONCILIATION
level_two_level_three_data_enabled: false
created_at: '2022-01-27T07:36:58.19Z'
updated_at: '2022-01-27T07:36:58.46Z'
onboarding_state: APPROVED
processor_details:
mid: FNX7CwmebftudY7i5mA4qF6XT
api_key: secretValue
_links:
self:
href: 'https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM'
identity:
href: 'https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG'
verifications:
href: 'https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM/verifications'
merchant_profile:
href: 'https://finix.sandbox-payments-api.com/merchant_profiles/MPzW2oRPtkLxK3fymcMACFi'
application:
href: 'https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM'
verification:
href: 'https://finix.sandbox-payments-api.com/verifications/VIdikDHXv7x8nWyJg8JZemGx'
title: Merchant
properties:
id:
type: string
description: The ID of the `Merchant` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
description: ID of the `Application` the `Merchant` was created under.
card_cvv_required:
type: boolean
description: Set to **true** to require the card's CVV code.
card_expiration_date_required:
type: boolean
description: Set to **true** to require the card's expiration date.
creating_transfer_from_report_enabled:
type: boolean
description: Set to **true** to automatically create `Transfers` once settlement reports get generated.
convenience_charges_enabled:
type: boolean
description: Set to **true** if you want to enable the `Merchant` to accept convenience fees and/or service fees.
fee_ready_to_settle_upon:
type: string
description: Details how the `Merchant` settles fees.
gateway:
type: string
description: Name of the gateway that routes the `Merchant's` transactions to the processor.
enum:
- TRIPOS_MOBILE_V1
- TRIPOS_CLOUD_V1
- DATACAP_V1
nullable: true
gross_settlement_enabled:
type: boolean
description: Set to **true** to enable gross settlements.
identity:
type: string
description: The ID of the `Identity` resource associated with the `Merchant`.
level_two_level_three_data_enabled:
type: boolean
description: Set to **true** to enable the `Merchant` for Level 2 and Level 3 processing. Default value is **false**.
mcc:
type: string
description: 'The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/business/security-and-compliance/approved-merchants/)'
nullable: true
merchant_name:
type: string
description: The legal name saved in the `Merchant` resource.
merchant_profile:
type: string
description: Details if a merchant's info was submitted to third-party processors for provisioning.
mid:
type: string
description: MID of the `Merchant`.
nullable: true
onboarding_state:
type: string
enum:
- PROVISIONING
- APPROVED
- REJECTED
description: Details the state of the `Merchant's` onboarding.
processor:
type: string
description: Name of the transaction processor.
processor_details:
type: object
description: Additional details specific to the processor.
properties:
api_key:
type: string
mid:
type: string
processing_enabled:
type: boolean
description: Details if transaction processing is enabled for the `Merchant`.
ready_to_settle_upon:
type: string
description: Details how transactions captured by the `Merchant` are settled.
enum:
- RECONCILIATION
- SUCCESSFUL_CAPTURE
- PROCESSOR_WINDOW
rent_surcharges_enabled:
type: boolean
description: Set to **true** if you want to enable a `Merchant` to accept rent charges.
settlement_enabled:
type: boolean
description: Details if settlement processing is enabled for the `Merchant`.
settlement_funding_identifier:
type: string
description: |-
Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors.
- **UNSET**: No additional details get provided to the processor.
- **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225**
- **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name` (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant**
These details appear alongside the seller's payout in their bank account as a description of the deposit.
enum:
- UNSET
- MID_AND_DATE
- MID_AND_MERCHANT_NAME
default: UNSET
surcharges_enabled:
type: boolean
default: false
description: 'Set to **true** if you want to enable a `Merchant` to accept surcharge fees. For more details, see [Buyer Charges](/guides/payments/modify/buyer-charges/).'
tags:
$ref: '#/components/schemas/Tags'
verification:
type: string
description: ID of the `Verification` that was submitted to verify the `Merchant`.
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
identity:
type: object
description: Link to the `Identity` the request was made under.
properties:
href:
type: string
verifications:
type: object
description: Link to the `Verification` that was used to verify the `Merchant` that the request was made under.
properties:
href:
type: string
merchant_profile:
type: object
description: Link to the `merchant_profile` the request was made under.
properties:
href:
type: string
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
verification:
type: object
description: Link to the `Verification` that was used to verify the `Identity` that the request was made under.
properties:
href:
type: string
MerchantProfile:
type: object
description: ''
properties:
id:
type: string
description: The ID of the `Merchant Profile` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
description: The ID of the `Application` associated with the `Merchant Profile`.
fee_profile:
type: string
description: The ID of the `Fee Profile` associated with the `Merchant Profile` resource.
nullable: true
payout_profile:
type: string
description: The ID of the `Payout Profile` associated with the `Merchant Profile` resource.
nullable: true
risk_profile:
type: string
description: The ID of the `Risk Profile` associated with the `Merchant Profile` resource.
nullable: true
tags:
$ref: '#/components/schemas/Tags'
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
application:
type: object
description: Link to the `Application` the resource was created under.
properties:
href:
type: string
fee_profile:
type: object
properties:
href:
type: string
owner_identity:
type: object
properties:
href:
type: string
processors:
type: object
properties:
href:
type: string
reserve_profile:
type: object
properties:
href:
type: string
risk_profile:
type: object
properties:
href:
type: string
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
users:
type: object
properties:
href:
type: string
MerchantProfilesList:
type: object
properties:
page:
$ref: '#/components/schemas/PageCursor'
_embedded:
type: object
description: List of `merchant_profile` objects.
properties:
merchant_profiles:
type: array
description: '`merchant_profile` objects.'
items:
$ref: '#/components/schemas/MerchantProfile'
_links:
$ref: '#/components/schemas/ListLinks'
CreateMerchantUnderwritingRequest:
type: object
title: MerchantUnderwritingCreate
properties:
gateway:
type: string
enum:
- TRIPOS_CLOUD_V1
- TRIPOS_MOBILE_V1
- DATACAP_V1
description: Name of the gateway that processes the `Merchant's` card present transactions. Use `gateway` only to enable a merchant to accept card present transactions.
default_partial_authorization_enabled:
type: boolean
default: false
description: |-
- Set to **true** if you want to enable partial authorizations for a specific `Merchant`.
- Partial authorizations enables the `Merchant` to collect a portion of the amount if the cardholder doesn't have the funds to cover the entire amount on their card.
processor:
$ref: '#/components/schemas/ProcessorRequest'
tags:
$ref: '#/components/schemas/Tags'
required:
- processor
UpdateMerchantRequest:
anyOf:
- title: Merchant
properties:
card_cvv_required:
type: boolean
description: Set to **true** to require the card's CVV code.
card_expiration_date_required:
type: boolean
description: Set to **true** to require the card's expiration date.
convenience_charges_enabled:
type: boolean
description: Set to **true** if you want to enable the `Merchant` to accept convenience fees and/or service fees.
creating_transfer_from_report_enabled:
type: boolean
description: Set to **true** to automatically create `Transfers` once settlement reports get generated.
fee_ready_to_settle_upon:
type: string
description: Details how the `Merchant` settles fees.
gross_settlement_enabled:
type: boolean
description: Set to **true** to enable gross settlements.
level_two_level_three_data_enabled:
type: boolean
description: Set to **true** to enable the `Merchant` for Level 2 and Level 3 processing. Default value is **false**.
merchant_name:
type: string
description: The legal name saved in the `Merchant` resource.
processing_enabled:
type: boolean
description: Details if transaction processing is enabled for the `Merchant`.
ready_to_settle_upon:
type: string
description: Details how transactions captured by the `Merchant` are settled.
rent_surcharges_enabled:
type: boolean
description: Set to **true** if you want to enable a `Merchant` to accept rent charges.
settlement_enabled:
type: boolean
description: Details if settlement processing is enabled for the `Merchant`.
settlement_funding_identifier:
type: string
enum:
- UNSET
- MID_AND_DATE
- MID_AND_MERCHANT_NAME
default: UNSET
description: |-
Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors.
- **UNSET**: No additional details get provided to the processor.
- **MID_AND_DATE**: The `MID` of the `Merchant` and the date the funding `Transfer` was submitted (Date is in UTC). e.g **MID:12345678-20220225**
- **MID_AND_MERCHANT_NAME**: The `MID` of the `Merchant` and the `Merchant#name` (white spaces will be removed). e.g. **MID:12345678-NameOfMerchant**
These details appear alongside the seller's payout in their bank account as a description of the deposit.
tags:
$ref: '#/components/schemas/Tags'
- title: Merchant - Disable a Merchant
properties:
processing_enabled:
type: boolean
description: Details if transaction processing is enabled for the `Merchant`.
tags:
$ref: '#/components/schemas/Tags'
required:
- processing_enabled
- title: Merchant - Enable Buyer Charges
properties:
convenience_charges_enabled:
type: boolean
description: Set to **true** if you want to enable the `Merchant` to accept convenience fees and/or service fees.
rent_surcharges_enabled:
type: boolean
description: Set to **true** if you want to enable a `Merchant` to accept rent charges.
surcharge_fees_enabled:
type: boolean
description: Set to **true** if you want to enable a `Merchant` to accept surcharge fees.
tags:
$ref: '#/components/schemas/Tags'
required:
- convenience_charges_enabled
- rent_surcharges_enabled
- surcharge_fees_enabled
- title: Merchant - Enable Level 2/3 Processing
properties:
level_two_level_three_data_enabled:
type: boolean
description: Set to **true** to enable the `Merchant` for Level 2 and Level 3 processing. Default value is **false**.
tags:
$ref: '#/components/schemas/Tags'
required:
- level_two_level_three_data_enabled
- title: Merchant - Enable Partial Authorizations
properties:
default_partial_authorization_enabled:
type: boolean
description: |-
- Set to **true** if you want to enable partial authorizations for a specific `Merchant`.
- Partial authorizations enables the `Merchant` to collect a portion of the amount if the cardholder doesn't have the funds to cover the entire amount on their card.
tags:
$ref: '#/components/schemas/Tags'
type: object
MerchantsList:
type: object
properties:
page:
$ref: '#/components/schemas/PageCursor'
_embedded:
type: object
description: List of `Merchant` objects.
properties:
merchants:
type: array
minItems: 0
uniqueItems: true
description: '`Merchant` objects.'
items:
$ref: '#/components/schemas/Merchant'
_links:
$ref: '#/components/schemas/ListLinks'
PaymentInstrument:
anyOf:
- title: Payment Instrument - Card
properties:
id:
type: string
description: The ID of the `Payment Instrument`.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
address:
$ref: '#/components/schemas/Address'
address_verification:
type: string
enum:
- POSTAL_CODE_AND_STREET_MATCH
- STREET_MATCH
- POSTAL_CODE_MATCH
- NO_ADDRESS
- NO_MATCH
- NOT_SUPPORTED
- UNKNOWN
description: |-
- Details the results of verifying `address` with the issuing bank.
- Set to **UNKNOWN** when `address` gets updated.
application:
type: string
description: The ID of the `Application` resource the `Payment Instrument` was created under.
bin:
type: string
description: Bank Identification number for the `Payment Instrument`.
brand:
type: string
enum:
- UNKNOWN
- DINERS_CLUB_INTERNATIONAL
- DANKORT
- MIR
- TROY
- UATP
- CHINA_T_UNION
- CHINA_UNION_PAY
- AMERICAN_EXPRESS
- VERVE
- RUPAY
- DISCOVER
- JCB
- MASTERCARD
- INTERPAYMENT
- INSTAPAYMENT
- MAESTRO
- VISA
- LANKAPAY
- DINERS_CLUB
description: The `brand` of the card saved in the `Payment Instrument`.
card_name:
type: string
description: A custom name you can include to identify the card being used (e.g. **Business Card**).
nullable: true
card_type:
type: string
enum:
- CREDIT
- DEBIT
- HSA_FSA
- NON_RELOADABLE_PREPAID
- RELOADABLE_PREPAID
- UNKNOWN
description: The type of payment card saved in the `Payment Instrument`.
currency:
$ref: '#/components/schemas/Currency'
enabled:
type: boolean
description: Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.
expiration_month:
type: integer
maximum: 12
minimum: 1
description: Expiration month (e.g. 12 for December).
expiration_year:
type: integer
minimum: 1
description: 4-digit expiration year.
fast_funds_indicator:
type: string
description: Details if Fast Funds is enabled for the card.
fingerprint:
type: string
example: FPRxxxxxxxxxxxxxxxxx
description: Unique ID that represents the tokenized card data.
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
instrument_type:
type: string
enum:
- PAYMENT_CARD
description: The type of `Payment Instrument`.
issuer_country:
type: string
enum:
- USA
- NON_USA
- UNKNOWN
description: 'Details what country the card was issued in:<li><strong>USA</strong>: The card was issued inside the United States.<li><strong>NON_USA</strong>: The card was issued outside of the United States.<li><strong>UNKNOWN</strong>: Processor did not return an issuer country for this particular BIN.'
last_four:
type: string
description: Last four digits of the card or bank account number.
name:
type: string
description: The name of the bank account or card owner.
nullable: true
online_gambing_block_indicator:
type: string
description: Detailes if the card is enabled to receive push-payments for online gambling payouts.
payload_type:
type: string
enum:
- SOURCE
- DESTINATION
push_funds_block_indicator:
type: string
description: Details if the card is enabled to receive push-to-card disbursements.
security_code_verification:
type: string
enum:
- MATCHED
- UNKNOWN
- UNMATCHED
description: Details the results of the Card Verification Code check.
tags:
$ref: '#/components/schemas/Tags'
type:
type: string
enum:
- PAYMENT_CARD
description: Type of `Payment Instrument`.
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
authorizations:
type: object
description: Link to the `Authorizations` created under the resource.
properties:
href:
type: string
identity:
type: object
description: Link to the `Identity` the request was made under.
properties:
href:
type: string
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
transfers:
type: object
description: Link to the `Transfers` created under the resource.
properties:
href:
type: string
updates:
type: object
description: Link to the `Updates` created under the resource.
properties:
href:
type: string
verifications:
type: object
description: Link to the `Verification` that was used to verify the `Merchant` that the request was made under.
properties:
href:
type: string
- title: Payment Instrument - Bank Account
properties:
id:
type: string
description: The ID of the `Payment Instrument`.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
account_type:
type: string
enum:
- CHECKING
- SAVINGS
description: Details what kind of **BANK_ACCOUNT** is being used.
application:
type: string
description: The ID of the `Application` resource the `Payment Instrument` was created under.
bank_account_validation_check:
type: string
enum:
- INCONCLUSIVE
- INVALID
- NOT_ATTEMPTED
- VALID
default: NOT_ATTEMPTED
description: |-
Details the results of the bank account validation check if `attempt_bank_account_validation_check` is set to **true** or the `Payment Instrument` gets used to create a `Transfer`.
- **INCONCLUSIVE**: A verification check was performed, but the bank account couldn't be found or verified with the issuing bank. Reach out to the buyer to verify the details collected or request another method of payment,
- **INVALID**: The `Payment Instrument` was used in transactions that returned one of the following ACH errors: <ul><li>**Account Does Not Allow ACH Transactions**</li><li>**Account is Closed**</li><li>**Account Funds are Frozen**</li><li>**Deceased Account Holder**</li><li>**Invalid Account Number**</li><li>**Invalid Routing Number**</li><li>**No Account on File**</li></ul>. For more details on the different ACH failure codes, see [ACH Direct Debit.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/#failed-ach-direct-debits)
- **NOT_ATTEMPTED**: A verification check wasn't performed and the `Payment Instrument` hasn't been used to create a `Transfer` or `Authorization`.
- **VALID**: The bank account was verified. The `Payment Instrument` can be used to create [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/#failed-ach-direct-debits)
bank_code:
type: string
description: The routing number of the bank account.
country:
$ref: '#/components/schemas/Country'
currency:
$ref: '#/components/schemas/Currency'
enabled:
type: boolean
description: Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.
fingerprint:
type: string
example: FPRxxxxxxxxxxxxxxxxx
description: Unique ID that represents the tokenized card data.
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
instrument_type:
type: string
enum:
- BANK_ACCOUNT
description: The type of `Payment Instrument`.
masked_account_number:
type: string
description: The last 4 digits of the account number used to create the `Payment Instrument`.
nullable: true
name:
type: string
description: The name of the bank account or card owner.
nullable: true
tags:
$ref: '#/components/schemas/Tags'
type:
type: string
enum:
- BANK_ACCOUNT
description: Type of `Payment Instrument`.
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
authorizations:
type: object
description: Link to the `Authorizations` created under the resource.
properties:
href:
type: string
transfers:
type: object
description: Link to the `Transfers` created under the resource.
properties:
href:
type: string
verifications:
type: object
description: Link to the `Verification` that was used to verify the `Merchant` that the request was made under.
properties:
href:
type: string
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
identity:
type: object
description: Link to the `Identity` the request was made under.
properties:
href:
type: string
- title: Payment Instrument - Token
properties:
id:
type: string
description: The ID of the `Payment Instrument` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
address:
$ref: '#/components/schemas/Address'
address_verification:
type: string
description: Additional address information that’s required to verify the identity of the merchant.
enum:
- POSTAL_CODE_AND_STREET_MATCH
- STREET_MATCH
- POSTAL_CODE_MATCH
- NO_ADDRESS
- NO_MATCH
- NOT_SUPPORTED
- UNKNOWN
application:
type: string
description: The ID of the `Application` resource.
bin:
type: string
description: Bank Identification number for the `Payment Instrument`.
brand:
type: string
description: The `brand` of the card saved in the `Payment Instrument`.
card_type:
type: string
description: The type of payment card saved in the `Payment Instrument`.
currency:
$ref: '#/components/schemas/Currency'
enabled:
type: boolean
description: Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.
expiration_month:
type: integer
description: Expiration month (e.g. 12 for December).
minimum: 1
maximum: 12
expiration_year:
type: integer
description: 4-digit expiration year.
minimum: 1
fingerprint:
type: string
example: FPRxxxxxxxxxxxxxxxxx
description: Unique ID that represents the tokenized card data.
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
instrument_type:
type: string
enum:
- TOKEN
description: The type of `Payment Instrument`.
last_four:
type: string
description: Last four digits of the card or bank account number.
name:
type: string
description: The name of the bank account or card owner.
nullable: true
security_code_verification:
type: string
description: Details the results of the Card Verification Code check.
enum:
- MATCHED
- UNKNOWN
- UNMATCHED
tags:
$ref: '#/components/schemas/Tags'
type:
type: string
enum:
- TOKEN
description: Type of `Payment Instrument`.
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
authorizations:
type: object
description: Link to the `Authorizations` created under the resource.
properties:
href:
type: string
transfers:
type: object
description: Link to the `Transfers` created under the resource.
properties:
href:
type: string
verifications:
type: object
description: Link to the `Verification` that was used to verify the `Merchant` that the request was made under.
properties:
href:
type: string
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
identity:
type: object
description: Link to the `Identity` the request was made under.
properties:
href:
type: string
- title: Payment Instrument - Apple Pay
properties:
id:
type: string
description: The ID of the `Payment Instrument`.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
description: The ID of the `Application` resource the `Payment Instrument` was created under.
bin:
type: string
description: Bank Identification number for the `Payment Instrument`.
brand:
type: string
description: The `brand` of the card saved in the `Payment Instrument`.
card_type:
type: string
description: The type of payment card saved in the `Payment Instrument`.
currency:
$ref: '#/components/schemas/Currency'
enabled:
type: boolean
description: Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.
expiration_month:
type: integer
description: Expiration month (e.g. 12 for December).
minimum: 1
maximum: 12
expiration_year:
type: integer
description: 4-digit expiration year.
minimum: 1
fingerprint:
type: string
example: FPRxxxxxxxxxxxxxxxxx
description: Unique ID that represents the tokenized card data.
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
instrument_type:
type: string
enum:
- APPLE_PAY
description: The type of `Payment Instrument`.
payload_type:
type: string
enum:
- SOURCE
- DESTINATION
tags:
$ref: '#/components/schemas/Tags'
type:
type: string
enum:
- APPLE_PAY
description: Type of `Payment Instrument`.
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
authorizations:
type: object
description: Link to the `Authorizations` created under the resource.
properties:
href:
type: string
transfers:
type: object
description: Link to the `Transfers` created under the resource.
properties:
href:
type: string
verifications:
type: object
description: Link to the `Verification` that was used to verify the `Merchant` that the request was made under.
properties:
href:
type: string
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
identity:
type: object
description: Link to the `Identity` the request was made under.
properties:
href:
type: string
- title: Payment Instrument - Google Pay
properties:
id:
type: string
description: The ID of the `Payment Instrument`.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
description: The ID of the `Application` resource the `Payment Instrument` was created under.
bin:
type: string
description: Bank Identification number for the `Payment Instrument`.
brand:
type: string
description: The `brand` of the card saved in the `Payment Instrument`.
card_type:
type: string
description: The type of payment card saved in the `Payment Instrument`.
currency:
$ref: '#/components/schemas/Currency'
enabled:
type: boolean
description: Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.
expiration_month:
type: integer
description: Expiration month (e.g. 12 for December).
minimum: 1
maximum: 12
expiration_year:
type: integer
description: 4-digit expiration year.
minimum: 1
fingerprint:
type: string
example: FPRxxxxxxxxxxxxxxxxx
description: Unique ID that represents the tokenized card data.
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
instrument_type:
type: string
enum:
- GOOGLE_PAY
description: The type of `Payment Instrument`.
payload_type:
type: string
enum:
- SOURCE
- DESTINATION
tags:
$ref: '#/components/schemas/Tags'
type:
type: string
enum:
- GOOGLE_PAY
description: Type of `Payment Instrument`.
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
authorizations:
type: object
description: Link to the `Authorizations` created under the resource.
properties:
href:
type: string
transfers:
type: object
description: Link to the `Transfers` created under the resource.
properties:
href:
type: string
verifications:
type: object
description: Link to the `Verification` that was used to verify the `Merchant` that the request was made under.
properties:
href:
type: string
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
identity:
type: object
description: Link to the `Identity` the request was made under.
properties:
href:
type: string
- title: Payment Instrument - Other
properties:
id:
type: string
description: The ID of the `Payment Instrument`.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
description: The ID of the `Application` resource the `Payment Instrument` was created under.
currency:
$ref: '#/components/schemas/Currency'
enabled:
type: boolean
description: Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.
fingerprint:
type: string
example: FPRxxxxxxxxxxxxxxxxx
description: Unique ID that represents the tokenized card data.
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
instrument_type:
type: string
enum:
- VIRTUAL
- SWIPED_PAYMENT_CARD
- PAYMENT_CARD_PRESENT
- VANTIV_OMNI_TOKEN
description: The type of `Payment Instrument`.
payload_type:
type: string
enum:
- SOURCE
- DESTINATION
tags:
$ref: '#/components/schemas/Tags'
type:
type: string
enum:
- VIRTUAL
- SWIPED_PAYMENT_CARD
- PAYMENT_CARD_PRESENT
- VANTIV_OMNI_TOKEN
description: Type of `Payment Instrument`.
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
authorizations:
type: object
description: Link to the `Authorizations` created under the resource.
properties:
href:
type: string
transfers:
type: object
description: Link to the `Transfers` created under the resource.
properties:
href:
type: string
verifications:
type: object
description: Link to the `Verification` that was used to verify the `Merchant` that the request was made under.
properties:
href:
type: string
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
identity:
type: object
description: Link to the `Identity` the request was made under.
properties:
href:
type: string
- title: Payment Instrument - Bank Account Validation Check
properties:
id:
type: string
description: The ID of the `Payment Instrument`.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
account_type:
type: string
enum:
- CHECKING
- SAVINGS
description: Details what kind of **BANK_ACCOUNT** is being used.
application:
type: string
description: The ID of the `Application` resource the `Payment Instrument` was created under.
bank_account_validation_check:
type: string
enum:
- INCONCLUSIVE
- INVALID
- NOT_ATTEMPTED
- VALID
default: NOT_ATTEMPTED
description: |-
Details the results of the bank account validation check if `attempt_bank_account_validation_check` is set to **true** or the `Payment Instrument` gets used to create a `Transfer`.
- **INCONCLUSIVE**: A verification check was performed, but the bank account couldn't be found or verified with the issuing bank. Reach out to the buyer to verify the details collected or request another method of payment,
- **INVALID**: The `Payment Instrument` was used in transactions that returned one of the following ACH errors: <ul><li>**Account Does Not Allow ACH Transactions**</li><li>**Account is Closed**</li><li>**Account Funds are Frozen**</li><li>**Deceased Account Holder**</li><li>**Invalid Account Number**</li><li>**Invalid Routing Number**</li><li>**No Account on File**</li></ul>. For more details on the different ACH failure codes, see [ACH Direct Debit.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/#failed-ach-direct-debits)
- **NOT_ATTEMPTED**: A verification check wasn't performed and the `Payment Instrument` hasn't been used to create a `Transfer` or `Authorization`.
- **VALID**: The bank account was verified. The `Payment Instrument` can be used to create [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/#failed-ach-direct-debits)
bank_code:
type: string
description: The routing number of the bank account.
country:
$ref: '#/components/schemas/Country'
currency:
$ref: '#/components/schemas/Currency'
enabled:
type: boolean
description: Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.
fingerprint:
type: string
example: FPRxxxxxxxxxxxxxxxxx
description: Unique ID that represents the tokenized card data.
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
instrument_type:
type: string
enum:
- BANK_ACCOUNT
description: The type of `Payment Instrument`.
masked_account_number:
type: string
description: The last 4 digits of the account number used to create the `Payment Instrument`.
nullable: true
name:
type: string
description: The name of the bank account or card owner.
nullable: true
tags:
$ref: '#/components/schemas/Tags'
type:
type: string
enum:
- BANK_ACCOUNT
description: Type of `Payment Instrument`.
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
authorizations:
type: object
description: Link to the `Authorizations` created under the resource.
properties:
href:
type: string
transfers:
type: object
description: Link to the `Transfers` created under the resource.
properties:
href:
type: string
verifications:
type: object
description: Link to the `Verification` that was used to verify the `Merchant` that the request was made under.
properties:
href:
type: string
application:
type: object
description: Link to the `Application` the request was made under.
properties:
href:
type: string
identity:
type: object
description: Link to the `Identity` the request was made under.
properties:
href:
type: string
type: object
CreatePaymentInstrumentRequest:
anyOf:
- title: Payment Instrument - Card
properties:
address:
type: object
description: |-
The address of the card owner.
**Note**: Including a postal or zip code when creating a `Payment Instrument` can lower the interchange on credit card transactions.
properties:
city:
type: string
description: City (max 20 characters).
region:
type: string
description: 2-letter State code.
postal_code:
type: string
description: Zip or Postal code (max 7 characters).
line1:
type: string
description: First line of the address (max 35 characters).
country:
type: string
description: 3 Letter country code (e.g. USA).
expiration_month:
type: integer
description: The expiration month of the card (e.g. 12 for December).
expiration_year:
type: integer
description: The 4-digit expiration year of the card.
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
name:
type: string
description: The name of the bank account or card owner. This value can get truncated to comply with processor requirements.
number:
type: string
description: The card or bank account number (no dashes in between numbers).
security_code:
type: string
description: The 3-4 digit security code of the card (i.e. CVV code).
tags:
$ref: '#/components/schemas/Tags'
type:
type: string
description: Type of `Payment Instrument`.
enum:
- PAYMENT_CARD
third_party_token:
type: string
description: Stringified token provided by Apple or Google. Required if using Apple or Google Pay.
required:
- expiration_month
- expiration_year
- identity
- name
- number
- security_code
- type
- title: Payment Instrument - Bank Account
properties:
account_number:
type: string
description: The bank account number (no dashes in between numbers).
minLength: 5
maxLength: 17
account_type:
type: string
enum:
- PERSONAL_CHECKING
- PERSONAL_SAVINGS
- BUSINESS_CHECKING
- BUSINESS_SAVINGS
description: 'The type of bank account. Use the following respective enum when creating a `Payment Instrument` for:<ul><li><strong>PERSONAL_CHECKING: </strong>A personal checking account.</li><li><strong>PERSONAL_SAVINGS: </strong>A personal savings account.</li><li><strong>BUSINESS_CHECKING: </strong>A business checking account.</li><li><strong>BUSINESS_SAVINGS: </strong>A business savings account.</li></ul>'
attempt_bank_account_validation_check:
type: boolean
description: |-
Verify and validate the `Payment Instrument` to confirm it can be used for [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/)
- Set to **True** to verify the `Payment Instrument` can be used for ACH payments.
default: false
bank_code:
type: string
description: The routing number of the bank account.
minLength: 9
maxLength: 9
example: '123456789'
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
name:
type: string
description: The name of the bank account or card owner. This value can get truncated to comply with processor requirements.
tags:
$ref: '#/components/schemas/Tags'
type:
type: string
enum:
- BANK_ACCOUNT
description: Type of `Payment Instrument`.
required:
- account_number
- account_type
- bank_code
- identity
- type
- title: Payment Instrument - Token
properties:
attempt_bank_account_validation_check:
type: boolean
description: |-
Verify and validate the `Payment Instrument` to confirm it can be used for [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/)
- Set to **True** to verify the `Payment Instrument` can be used for ACH payments.
- Only `Payment Instruments` created from bank accounts can be used for ACH payments.
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
name:
type: string
description: The name of the bank account or card owner. This value can get truncated to comply with processor requirements.
tags:
$ref: '#/components/schemas/Tags'
token:
type: string
description: ID of the `Token` that was returned from the tokenization client or hosted fields
type:
type: string
enum:
- TOKEN
description: Type of `Payment Instrument`.
required:
- identity
- token
- type
- title: Payment Instrument - Apple Pay
properties:
identity:
type: string
description: The `Identity#id` of the buyer and owner of the card.
merchant_identity:
type: string
name:
type: string
description: The `id` of the `Identity` used when registering the seller with Apple Pay through our registration API.
third_party_token:
type: string
description: Stringified token provided by Apple. Required to process Apple Pay transactions.
tags:
$ref: '#/components/schemas/Tags'
type:
type: string
description: Type of `Payment Instrument`.
enum:
- APPLE_PAY
required:
- identity
- merchant_identity
- third_party_token
- type
- title: Payment Instrument - Google Pay
properties:
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
merchant_identity:
type: string
description: The `id` of the identity used when registering the business with Google Pay through our registration API.
name:
type: string
description: The name of the bank account or card owner. This value can get truncated to comply with processor requirements.
tags:
$ref: '#/components/schemas/Tags'
third_party_token:
type: string
description: Stringified token provided by Google. Required to process Google Pay transactions.
type:
type: string
enum:
- GOOGLE_PAY
description: Type of `Payment Instrument`.
required:
- identity
- merchant_identity
- third_party_token
type: object
UpdatePaymentInstrumentRequest:
anyOf:
- title: Payment Instrument - Update a Card's Address
properties:
address:
$ref: '#/components/schemas/Address'
merchant:
default: false
type: string
description: The ID of the `Merchant` that the `Payment Instrument` will be created under.
verify_payment_card:
type: boolean
description: |-
- Set to **true** to verify card details with the card issuer.
- Must be set to **true** to update the CVV or security code of a card.
- When set to **true**, `merchant` must also be included with your request.
default: false
tags:
$ref: '#/components/schemas/Tags'
required:
- address
- merchant
- verify_payment_card
- title: Payment Instrument - Disable a Payment Instrument
properties:
enabled:
type: boolean
description: Details if the `Payment Instrument` resource is enabled. Default value is **true**; set to **false** to disable the `Payment Instrument`.
tags:
$ref: '#/components/schemas/Tags'
required:
- enabled
- title: Payment Instrument - Update Name
properties:
name:
type: string
default: false
description: The name of the bank account or card owner. This value can get truncated to comply with processor requirements.
tags:
$ref: '#/components/schemas/Tags'
required:
- name
- title: Payment Instrument - Bank Account Validation Check
properties:
attempt_bank_account_validation_check:
type: boolean
default: false
description: |-
Verify and validate the `Payment Instrument` to confirm it can be used for [ACH Direct Debits.](/guides/payments/online-payments/getting-started/finix-api/ach-echeck/)
- Set to **True** to verify the `Payment Instrument` can be used for ACH payments.
- Only `Payment Instruments` created from bank accounts can be used for ACH payments.
tags:
$ref: '#/components/schemas/Tags'
required:
- attempt_bank_account_validation_check
- title: Payment Instrument - Update Payment Instrument Tags
properties:
tags:
$ref: '#/components/schemas/Tags'
required:
- tags
type: object
PaymentInstrumentToken:
type: object
title: Payment instrument
properties:
tags:
$ref: '#/components/schemas/Tags'
enabled:
type: boolean
description: Details if the `Payment Instrument` resource is enabled. Set to `false` to disable the `Payment Instrument`.
type:
type: string
enum:
- TOKEN
id:
type: string
description: The ID of the `Payment Instrument`.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
description: The ID of the `Application` resource the `Payment Instrument` was created under.
currency:
$ref: '#/components/schemas/Currency'
fingerprint:
type: string
example: FPRxxxxxxxxxxxxxxxxx
identity:
type: string
description: The ID of the `Identity` used to create the `Payment Instrument` resource.
instrument_type:
type: string
enum:
- TOKEN
payload_type:
type: string
enum:
- SOURCE
- DESTINATION
_links:
type: object
description: 'For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.'
properties:
application:
type: object
description: Link to the `Application` the resource was created under.
properties:
href:
type: string
authorizations:
type: object
properties:
href:
type: string
identity:
type: object
properties:
href:
type: string
self:
type: object
description: Link to the resource that was used in the request.
properties:
href:
type: string
transfers:
type: object
properties:
href:
type: string
verifications:
type: object
description: Link to the `Verification` the request was made under.
properties:
href:
type: string
PaymentInstrumentUpdatesList:
type: object
description: ''
properties:
page:
$ref: '#/components/schemas/PageOffset'
_embedded:
type: object
description: List of `updates` for a `Payment Instrument`.
properties:
updates:
type: array
minItems: 0
uniqueItems: true
description: '`Update` objects.'
items:
$ref: '#/components/schemas/InstrumentUpdate'
_links:
$ref: '#/components/schemas/ListLinks'
PaymentInstrumentsList:
type: object
properties:
page:
$ref: '#/components/schemas/PageCursor'
_embedded:
type: object
description: List of `Payment Instrument` objects.
properties:
payment_instruments:
type: array
minItems: 0
uniqueItems: true
description: '`Payment Instrument` objects.'
items:
$ref: '#/components/schemas/PaymentInstrument'
_links:
$ref: '#/components/schemas/ListLinks'
Processor:
description: ''
type: object
properties:
id:
type: string
example: PRxxxxxxxxxxxxxxxxxx
description: ID of the `Processor` resource.
created_at:
$ref: '#/components/schemas/CreatedAt'
updated_at:
$ref: '#/components/schemas/UpdatedAt'
application:
type: string
description: The ID of the `Application` resource.
application_config:
type: object
description: Details that configure how the `Processor` handles transactions.
nullable: true
properties:
ach_settlement_delay_days:
type: integer
minimum: 0
x-finix-issues:
- property2
description: Details how days ACH settlments are delayed by.
nullable: true
allow_split_payouts:
type: boolean
description: Details if the `Processor` allows split payouts to `Merchants`.
allowed_business_application_ids:
type: array
description: Identifies the `Processors` business application type for VisaNet transaction processing.
items:
type: string
enum:
- AA
- BB
- BI
- CP
- FD
- FT
- GD
- GP
- LO
- CI
- CO
- MP
- MD
- OG
- PD
- PP
- TU
- WT
card_acceptor_id_code:
type: string
description: 'An ID for the card acceptor (e.g Visa). '
card_acceptor_terminal_id:
type: string
description: The ID for the terminal at a card acceptor location.
configuration_templates:
type: object
nullable: true
properties:
country:
type: object
description: 3-Letter Country code.
default_currencies:
type: array
description: ISO 4217 3 letter currency code.
items:
$ref: '#/components/schemas/Currency'
default_mcc:
type: string
enum:
- '0742'
- '0763'
- '0780'
- '1520'
- '1711'
- '1731'
- '1740'
- '1750'
- '1761'
- '1771'
- '1799'
- '2741'
- '2791'
- '2842'
- '3000'
- '3001'
- '3002'
- '3003'
- '3004'
- '3005'
- '3006'
- '3007'
- '3008'
- '3009'
- '3010'
- '3011'
- '3012'
- '3013'
- '3014'
- '3015'
- '3016'
- '3017'
- '3018'
- '3019'
- '3020'
- '3021'
- '3022'
- '3023'
- '3024'
- '3025'
- '3026'
- '3027'
- '3028'
- '3029'
- '3030'
- '3031'
- '3032'
- '3033'
- '3034'
- '3035'
- '3036'
- '3037'
- '3038'
- '3039'
- '3040'
- '3041'
- '3042'
- '3043'
- '3044'
- '3045'
- '3046'
- '3047'
- '3048'
- '3049'
- '3050'
- '3051'
- '3052'
- '3053'
- '3054'
- '3055'
- '3056'
- '3057'
- '3058'
- '3059'
- '3060'
- '3061'
- '3062'
- '3063'
- '3064'
- '3065'
- '3066'
- '3067'
- '3068'
- '3069'
- '3070'
- '3071'
- '3072'
- '3073'
- '3074'
- '3075'
- '3076'
- '3077'
- '3078'
- '3079'
- '3080'
- '3081'
- '3082'
- '3083'
- '3084'
- '3085'
- '3086'
- '3087'
- '3088'
- '3089'
- '3090'
- '3091'
- '3092'
- '3093'
- '3094'
- '3095'
- '3096'
- '3097'
- '3098'
- '3099'
- '3100'
- '3101'
- '3102'
- '3103'
- '3104'
- '3105'
- '3106'
- '3107'
- '3108'
- '3109'
- '3110'
- '3111'
- '3112'
- '3113'
- '3114'
- '3115'
- '3116'
- '3117'
- '3118'
- '3119'
- '3120'
- '3121'
- '3122'
- '3123'
- '3124'
- '3125'
- '3126'
- '3127'
- '3128'
- '3129'
- '3130'
- '3131'
- '3132'
- '3133'
- '3134'
- '3135'
- '3136'
- '3137'
- '3138'
- '3139'
- '3140'
- '3141'
- '3142'
- '3143'
- '3144'
- '3145'
- '3146'
- '3147'
- '3148'
- '3149'
- '3150'
- '3151'
- '3152'
- '3153'
- '3154'
- '3155'
- '3156'
- '3157'
- '3158'
- '3159'
- '3160'
- '3161'
- '3162'
- '3163'
- '3164'
- '3165'
- '3166'
- '3167'
- '3168'
- '3169'
- '3170'
- '3171'
- '3172'
- '3173'
- '3174'
- '3175'
- '3176'
- '3177'
- '3178'
- '3179'
- '3180'
- '3181'
- '3182'
- '3183'
- '3184'
- '3185'
- '3186'
- '3187'
- '3188'
- '3189'
- '3190'
- '3191'
- '3192'
- '3193'
- '3194'
- '3195'
- '3196'
- '3197'
- '3198'
- '3199'
- '3200'
- '3201'
- '3202'
- '3203'
- '3204'
- '3205'
- '3206'
- '3207'
- '3208'
- '3209'
- '3210'
- '3211'
- '3212'
- '3213'
- '3214'
- '3215'
- '3216'
- '3217'
- '3218'
- '3219'
- '3220'
- '3221'
- '3222'
- '3223'
- '3224'
- '3225'
- '3226'
- '3227'
- '3228'
- '3229'
- '3230'
- '3231'
- '3232'
- '3233'
- '3234'
- '3235'
- '3236'
- '3237'
- '3238'
- '3239'
- '3240'
- '3241'
- '3242'
- '3243'
- '3244'
- '3245'
- '3246'
- '3247'
- '3248'
- '3249'
- '3250'
- '3251'
- '3252'
- '3253'
- '3254'
- '3255'
- '3256'
- '3257'
- '3258'
- '3259'
- '3260'
- '3261'
- '3262'
- '3263'
- '3264'
- '3265'
- '3266'
- '3267'
- '3268'
- '3269'
- '3270'
- '3271'
- '3272'
- '3273'
- '3274'
- '3275'
- '3276'
- '3277'
- '3278'
- '3279'
- '3280'
- '3281'
- '3282'
- '3283'
- '3284'
- '3285'
- '3286'
- '3287'
- '3288'
- '3289'
- '3290'
- '3291'
- '3292'
- '3293'
- '3294'
- '3295'
- '3296'
- '3297'
- '3298'
- '3299'
- '3351'
- '3352'
- '3353'
- '3354'
- '3355'
- '3356'
- '3357'
- '3358'
- '3359'
- '3360'
- '3361'
- '3362'
- '3363'
- '3364'
- '3365'
- '3366'
- '3367'
- '3368'
- '3369'
- '3370'
- '3371'
- '3372'
- '3373'
- '3374'
- '3375'
- '3376'
- '3377'
- '3378'
- '3379'
- '3380'
- '3381'
- '3382'
- '3383'
- '3384'
- '3385'
- '3386'
- '3387'
- '3388'
- '3389'
- '3390'
- '3391'
- '3392'
- '3393'
- '3394'
- '3395'
- '3396'
- '3397'
- '3398'
- '3399'
- '3400'
- '3401'
- '3402'
- '3403'
- '3404'
- '3405'
- '3406'
- '3407'
- '3408'
- '3409'
- '3410'
- '3411'
- '3412'
- '3413'
- '3414'
- '3415'
- '3416'
- '3417'
- '3418'
- '3419'
- '3420'
- '3421'
- '3422'
- '3423'
- '3424'
- '3425'
- '3426'
- '3427'
- '3428'
- '3429'
- '3430'
- '3431'
- '3432'
- '3433'
- '3434'
- '3435'
- '3436'
- '3437'
- '3438'
- '3439'
- '3440'
- '3441'
- '3501'
- '3502'
- '3503'
- '3504'
- '3505'
- '3506'
- '3507'
- '3508'
- '3509'
- '3510'
- '3511'
- '3512'
- '3513'
- '3514'
- '3515'
- '3516'
- '3517'
- '3518'
- '3519'
- '3520'
- '3521'
- '3522'
- '3523'
- '3524'
- '3525'
- '3526'
- '3527'
- '3528'
- '3529'
- '3530'
- '3531'
- '3532'
- '3533'
- '3534'
- '3535'
- '3536'
- '3537'
- '3538'
- '3539'
- '3540'
- '3541'
- '3542'
- '3543'
- '3544'
- '3545'
- '3546'
- '3547'
- '3548'
- '3549'
- '3550'
- '3551'
- '3552'
- '3553'
- '3554'
- '3555'
- '3556'
- '3557'
- '3558'
- '3559'
- '3560'
- '3561'
- '3562'
- '3563'
- '3564'
- '3565'
- '3566'
- '3567'
- '3568'
- '3569'
- '3570'
- '3571'
- '3572'
- '3573'
- '3574'
- '3575'
- '3576'
- '3577'
- '3578'
- '3579'
- '3580'
- '3581'
- '3582'
- '3583'
- '3584'
- '3585'
- '3586'
- '3587'
- '3588'
- '3589'
- '3590'
- '3591'
- '3592'
- '3593'
- '3594'
- '3595'
- '3596'
- '3597'
- '3598'
- '3599'
- '3600'
- '3601'
- '3602'
- '3603'
- '3604'
- '3605'
- '3606'
- '3607'
- '3608'
- '3609'
- '3610'
- '3611'
- '3612'
- '3613'
- '3614'
- '3615'
- '3616'
- '3617'
- '3618'
- '3619'
- '3620'
- '3621'
- '3622'
- '3623'
- '3624'
- '3625'
- '3626'
- '3627'
- '3628'
- '3629'
- '3630'
- '3631'
- '3632'
- '3633'
- '3634'
- '3635'
- '3636'
- '3637'
- '3638'
- '3639'
- '3640'
- '3641'
- '3642'
- '3643'
- '3644'
- '3645'
- '3646'
- '3647'
- '3648'
- '3649'
- '3650'
- '3651'
- '3652'
- '3653'
- '3654'
- '3655'
- '3656'
- '3657'
- '3658'
- '3659'
- '3660'
- '3661'
- '3662'
- '3663'
- '3664'
- '3665'
- '3666'
- '3667'
- '3668'
- '3669'
- '3670'
- '3671'
- '3672'
- '3673'
- '3674'
- '3675'
- '3676'
- '3677'
- '3678'
- '3679'
- '3680'
- '3681'
- '3682'
- '3683'
- '3684'
- '3685'
- '3686'
- '3687'
- '3688'
- '3689'
- '3690'
- '3691'
- '3692'
- '3693'
- '3694'
- '3695'
- '3696'
- '3697'
- '3698'
- '3699'
- '3700'
- '3701'
- '3702'
- '3703'
- '3704'
- '3705'
- '3706'
- '3707'
- '3708'
- '3709'
- '3710'
- '3711'
- '3712'
- '3713'
- '3714'
- '3715'
- '3716'
- '3717'
- '3718'
- '3719'
- '3720'
- '3721'
- '3722'
- '3723'
- '3724'
- '3725'
- '3726'
- '3727'
- '3728'
- '3729'
- '3730'
- '3731'
- '3732'
- '3733'
- '3734'
- '3735'
- '3736'
- '3737'
- '3738'
- '3739'
- '3740'
- '3741'
- '3742'
- '3743'
- '3744'
- '3745'
- '3746'
- '3747'
- '3748'
- '3749'
- '3750'
- '3751'
- '3752'
- '3753'
- '3754'
- '3755'
- '3756'
- '3757'
- '3758'
- '3759'
- '3760'
- '3761'
- '3762'
- '3763'
- '3764'
- '3765'
- '3766'
- '3767'
- '3768'
- '3769'
- '3770'
- '3771'
- '3772'
- '3773'
- '3774'
- '3775'
- '3776'
- '3777'
- '3778'
- '3779'
- '3780'
- '3781'
- '3782'
- '3783'
- '3784'
- '3785'
- '3786'
- '3787'
- '3788'
- '3789'
- '3790'
- '3816'
- '3835'
- '4011'
- '4111'
- '4112'
- '4119'
- '4121'
- '4131'
- '4214'
- '4215'
- '4225'
- '4411'
- '4457'
- '4468'
- '4511'
- '4582'
- '4722'
- '4723'
- '4784'
- '4789'
- '4812'
- '4814'
- '4815'
- '4816'
- '4821'
- '4829'
- '4899'
- '4900'
- '5013'
- '5021'
- '5039'
- '5044'
- '5045'
- '5046'
- '5047'
- '5051'
- '5065'
- '5072'
- '5074'
- '5085'
- '5094'
- '5099'
- '5111'
- '5122'
- '5131'
- '5137'
- '5139'
- '5169'
- '5172'
- '5192'
- '5193'
- '5198'
- '5199'
- '5200'
- '5211'
- '5231'
- '5251'
- '5261'
- '5271'
- '5300'
- '5309'
- '5310'
- '5311'
- '5331'
- '5399'
- '5411'
- '5422'
- '5441'
- '5451'
- '5462'
- '5499'
- '5511'
- '5521'
- '5531'
- '5532'
- '5533'
- '5541'
- '5542'
- '5551'
- '5561'
- '5571'
- '5592'
- '5598'
- '5599'
- '5611'
- '5621'
- '5631'
- '5641'
- '5651'
- '5655'
- '5661'
- '5681'
- '5691'
- '5697'
- '5698'
- '5699'
- '5712'
- '5713'
- '5714'
- '5718'
- '5719'
- '5722'
- '5732'
- '5733'
- '5734'
- '5735'
- '5811'
- '5812'
- '5813'
- '5814'
- '5815'
- '5816'
- '5817'
- '5818'
- '5832'
- '5912'
- '5921'
- '5931'
- '5932'
- '5933'
- '5935'
- '5937'
- '5940'
- '5941'
- '5942'
- '5943'
- '5944'
- '5945'
- '5946'
- '5947'
- '5948'
- '5949'
- '5950'
- '5960'
- '5961'
- '5962'
- '5963'
- '5964'
- '5965'
- '5966'
- '5967'
- '5968'
- '5969'
- '5970'
- '5971'
- '5972'
- '5973'
- '5975'
- '5976'
- '5977'
- '5978'
- '5983'
- '5992'
- '5993'
- '5994'
- '5995'
- '5996'
- '5997'
- '5998'
- '5999'
- '6010'
- '6011'
- '6012'
- '6051'
- '6211'
- '6300'
- '6381'
- '6399'
- '6513'
- '7011'
- '7012'
- '7032'
- '7033'
- '7210'
- '7211'
- '7216'
- '7217'
- '7221'
- '7230'
- '7251'
- '7261'
- '7273'
- '7276'
- '7277'
- '7278'
- '7296'
- '7297'
- '7298'
- '7299'
- '7311'
- '7321'
- '7332'
- '7333'
- '7338'
- '7339'
- '7342'
- '7349'
- '7361'
- '7372'
- '7375'
- '7379'
- '7392'
- '7393'
- '7394'
- '7395'
- '7399'
- '7511'
- '7512'
- '7513'
- '7519'
- '7523'
- '7531'
- '7534'
- '7535'
- '7538'
- '7542'
- '7549'
- '7622'
- '7623'
- '7629'
- '7631'
- '7641'
- '7692'
- '7699'
- '7800'
- '7801'
- '7802'
- '7829'
- '7832'
- '7841'
- '7911'
- '7922'
- '7929'
- '7932'
- '7933'
- '7941'
- '7991'
- '7992'
- '7993'
- '7994'
- '7995'
- '7996'
- '7997'
- '7998'
- '7999'
- '8011'
- '8021'
- '8031'
- '8041'
- '8042'
- '8043'
- '8044'
- '8049'
- '8050'
- '8062'
- '8071'
- '8099'
- '8111'
- '8211'
- '8220'
- '8241'
- '8244'
- '8249'
- '8299'
- '8351'
- '8398'
- '8641'
- '8651'
- '8661'
- '8675'
- '8699'
- '8734'
- '8911'
- '8931'
- '8999'
- '9211'
- '9222'
- '9223'
- '9311'
- '9399'
- '9402'
- '9405'
- '9700'
- '9701'
- '9702'
- '9950'
x-finix-issues:
- property2
description: 'The Merchant Category Code of the `Merchan. '
default_sender_account_number:
type: string
description: The default account of the sender.
nullable: true
default_sender_address:
type: string
description: The sender’s address.
nullable: true
default_sender_city:
type: string
description: The city saved in the sender's address.
nullable: true
default_sender_country:
$ref: '#/components/schemas/Country'
default_sender_country_code:
type: string
description: The sender's 3 letter ISO 4217 currency code.
nullable: true
default_sender_county_code:
type: string
description: The sender’s county.
nullable: true
default_sender_name:
type: string
description: The sender’s name.
nullable: true
default_sender_state_code:
type: string
description: The sender's 2-letter State code.
nullable: true
default_sender_zip_code:
type: string
description: The sender’s zip code.
nullable: true
include_colombia_data:
type: boolean
description: Must be true if transactions are in Colombia where there are different fees.
moto_eciindicator:
type: string
enum:
- '5'
- '6'
- '7'
- '8'
x-finix-issues:
- property2
description: Identifies the level of security used in an electronic commerce transaction (only applies to card-present transactions).
pan_entry_mode:
type: string
enum:
- '00'
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
- '07'
- '08'
- '09'
- '10'
- '80'
- '82'
- '83'
- '90'
- '91'
- '95'
x-finix-issues:
- property2
description: A 2-digit code that identifies the method used to enter the cardholder account number and card expiration date (only applies to card-present transactions).
pos_condition_code:
type: string
enum:
- '00'
- '01'
- '02'
- '03'
- '05'
- '06'
- '08'
- '10'
- '51'
- '59'
- '71'
- '73'
x-finix-issues:
- property2
description: Contains a code identifying transaction conditions at the point of sale or point of service (only applies to card-present transactions).
config:
type: object
description: 'Configure how the `Processor` handles transaction details, specifc to the processor.'
nullable: true
properties:
canDebitBankAccount:
type: boolean
description: Details if the `Application` can debit bank accounts using the `Processor`.
default_merchant_profile:
type: string
description: The ID of the `Merchant Profile` resource used to create the `Processor`.
enabled:
type: boolean
description: Details if the `Processor` resource is enabled. Set to **false** to disable the `Processor`.
processor:
type: string
description: The name of the processor.
system_config:
type: object
description: Details that configure how the `Processor` handles transactions with the processor.
nullable: true
properties:
acquirer_country_code:
type: string
enum:
- '004'
- '008'
- '010'
- '012'
- '016'
- '020'
- '024'
- '028'
- '031'
- '032'
- '036'
- '040'
- '044'
- '048'
- '050'
- '051'
- '052'
- '056'
- '060'
- '064'
- '068'
- '070'
- '072'
- '074'
- '076'
- '084'
- '086'
- '090'
- '092'
- '096'
- '100'
- '104'
- '108'
- '112'
- '116'
- '120'
- '124'
- '132'
- '136'
- '140'
- '144'
- '148'
- '152'
- '156'
- '158'
- '162'
- '166'
- '170'
- '174'
- '175'
- '178'
- '180'
- '184'
- '188'
- '191'
- '192'
- '196'
- '203'
- '204'
- '208'
- '212'
- '214'
- '218'
- '222'
- '226'
- '231'
- '232'
- '233'
- '234'
- '238'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment