From 142a0c039c8d8be84e701d87e14a0545bb19a760 Mon Sep 17 00:00:00 2001 From: haoyang-finix <106175390+haoyang-finix@users.noreply.github.com> Date: Thu, 18 Aug 2022 15:01:59 -0700 Subject: [PATCH 1/5] init change to new spec, #113 in openapi spec repo --- spec/finix_openapi.yaml | 8805 +++++++++++++++++++-------------------- 1 file changed, 4285 insertions(+), 4520 deletions(-) diff --git a/spec/finix_openapi.yaml b/spec/finix_openapi.yaml index e2262e6..90e5a41 100644 --- a/spec/finix_openapi.yaml +++ b/spec/finix_openapi.yaml @@ -18,8 +18,6 @@ x-ignoredHeaderParameters: servers: - description: Sandbox server to be used for testing and development url: https://finix.sandbox-payments-api.com -- description: Live server to be used for production charges - url: https://finix.live-payments-api.com tags: - name: Authorizations description: @@ -108,11 +106,14 @@ paths: tags: - Authorizations description: "Create an `Authorization` to process a transaction.\n\n`Authorizations`\ - \ can have two possible `states`:\n\n- **SUCCEEDED** \n- **FAILED**\n\nIf\ - \ the `Authorization` has **SUCCEEDED** , it must be captured before `expires_at`\ - \ passes or the funds will be released.\n\nLearn how to prevent duplicate\ - \ authorizations by passing an [Idempotency ID](#section/Idempotency-Requests)\ - \ in the payload." + \ can have six possible `states`, two of which are expected:\n\n- **SUCCEEDED**\ + \ \n- **FAILED**\n\nIf the `Authorization` has **SUCCEEDED** , it must be\ + \ captured before `expires_at` passes or the funds will be released. If the\ + \ `transfer` field of an `Authorization` is **null**, it hasn't been captured\ + \ yet.\n\nLearn how to prevent duplicate authorizations by passing an [Idempotency\ + \ ID](#section/Idempotency-Requests) in the payload.\n- `Authorizations` on\ + \ debit cards place a hold on funds in the cardholder's bank account and can\ + \ lead to lower than expected balances or issues with insufficient funds." summary: Create an Authorization operationId: createAuthorization requestBody: @@ -143,10 +144,17 @@ paths: summary: List Authorizations operationId: listAuthorizations parameters: - - $ref: '#/components/parameters/QuerySort' + - $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/QueryLimit' + - $ref: '#/components/parameters/QueryCreatedAtGteFilter' + - $ref: '#/components/parameters/QueryCreatedAtLteFilter' - $ref: '#/components/parameters/QueryIdempotencyIdFilter' + - $ref: '#/components/parameters/QueryLimit' + - $ref: '#/components/parameters/QuerySort' - in: query name: state description: Filter by Transaction state. @@ -156,21 +164,14 @@ paths: - FAILED - PENDING - CANCELED - - $ref: '#/components/parameters/QueryCreatedAtGteFilter' - - $ref: '#/components/parameters/QueryCreatedAtLteFilter' - $ref: '#/components/parameters/QueryUpdatedAtGteFilter' - $ref: '#/components/parameters/QueryUpdatedAtLteFilter' - - $ref: '#/components/parameters/QueryVoidFilter' - - $ref: '#/components/parameters/QueryAmountFilter' - - $ref: '#/components/parameters/QueryAmountLtFilter' - - $ref: '#/components/parameters/QueryAmountGtFilter' - - $ref: '#/components/parameters/QueryAmountLteFilter' - - $ref: '#/components/parameters/QueryAmountGteFilter' - $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 + 6 digits of the masked number. schema: type: string - schema: @@ -179,59 +180,59 @@ paths: 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\t" + \ 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 + in the drop-down. - schema: type: string in: query name: merchant_identity_id - description: Filter by 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 + 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 + 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' + 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 + description: Filter by `Merchant` ID. - schema: type: string in: query name: merchant_mid - description: Filter by Merchant Identification Number (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 + description: Filter by the payment card last 4 digits. - schema: type: string in: query name: merchant_processor_id - description: Filter by Processor ID + description: Filter by `Processor` ID. - schema: type: string in: query name: type - description: Type of the authorization. + description: Type of the `Authorization`. - $ref: '#/components/parameters/QueryAfterCursor' responses: '200': @@ -246,6 +247,11 @@ paths: $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 \\\n \ + \ -H \"Content-Type: application/vnd.json+api\" \\\n -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041\n" x-python-method-name: list x-returns-list: true /authorizations/{authorization_id}: @@ -253,7 +259,7 @@ paths: tags: - Authorizations description: Retrieve the details of a previously created `Authorization`. - summary: Get an Authorization + summary: Fetch an Authorization operationId: getAuthorization responses: '200': @@ -267,6 +273,11 @@ paths: '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/AUcaGi9WKyKn2GwX3bNSpsXo\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041\n" x-python-method-name: get parameters: - $ref: '#/components/parameters/AuthorizationId' @@ -276,10 +287,10 @@ paths: description: "If successfully captured, the `transfer` field of the `Authorization`\ \ will contain the ID of the `Transfer` resource that'll move funds. \n\n\ By default, `Transfers` are in a **PENDING** state. The **PENDING** state\ - \ means the system hasn't submitted the request to capture funds. Capture\ - \ requests get submitted via a batch request. \n\nOnce the `Authorization`\ - \ is updated with a `capture_amount` (i.e. *Captured*), the state of the `Transfer`\ - \ will update to **SUCCEEDED**.\n\n> Voided `Authorizations` can't be captured." + \ means the request to capture funds hasn't been submitted yet. Capture requests\ + \ get submitted via a batch request. \n\nOnce the `Authorization` is updated\ + \ with a `capture_amount` (i.e. *Captured*), the state of the `Transfer` will\ + \ update to **SUCCEEDED**.\n\n> Voided `Authorizations` can't be captured." summary: Capture an Authorization operationId: captureAuthorization requestBody: @@ -346,12 +357,12 @@ paths: type: integer in: query name: pageNumber - description: The page number to list + description: The page number to list. - schema: type: integer in: query name: pageSize - description: The size of the page + description: The size of the page. - $ref: '#/components/parameters/QueryCreatedAtGteFilter' - $ref: '#/components/parameters/QueryCreatedAtLteFilter' - $ref: '#/components/parameters/QueryUpdatedAtGteFilter' @@ -362,44 +373,47 @@ paths: name: description schema: type: string - description: 'Filter by the `description` value ' + description: Filter by the `Description` value . - schema: type: string in: query name: destination - description: Filter by the `Payment Instrument` saved in `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` + 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` + description: Filter by the value saved in `reference_id`. - schema: type: string in: query - description: Filter by the `Payment Instrument` saved in `source` + 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/ \\\ + \n -H \"Content-Type: application/vnd.json+api\" \\\n -u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99\n" x-python-method-name: list x-returns-list: true /devices/{device_id}: get: - tags: - - Devices description: 'Retrieve the details of an existing `Device`. - To check the connectivity of the device, include `?include_connection\=true - \` at the end of the request endpoint.' - summary: Get Device + To check the connectivity of the device, include `?include_connection\=true\` + at the end of the request endpoint.' + summary: Fetch a Device operationId: getDevice responses: '200': @@ -413,6 +427,20 @@ paths: '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/DVf2H8sh4LZZC52GTUrwCPPf\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USjHFGYvecE4LBitYG8KDE2g:b698f403-d9b7-4157-82d8-162cea8c8cc3\n" x-python-method-name: get parameters: - description: ID of the `Device`. @@ -422,8 +450,6 @@ paths: schema: type: string put: - tags: - - Devices description: Update a `Device` to activate or deactivate it. summary: Update a Device operationId: updateDevice @@ -441,6 +467,8 @@ paths: '406': $ref: '#/components/responses/Error406NotAcceptable' x-java-method-name: update + tags: + - Devices x-python-method-name: update /disputes: get: @@ -468,6 +496,11 @@ paths: $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/ \\\n -H \"\ + Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list x-returns-list: true /disputes/{dispute_id}: @@ -475,7 +508,7 @@ paths: tags: - Disputes description: Retrieve the details of a previously created `Dispute`. - summary: Get Dispute + summary: Fetch a Dispute operationId: getDispute responses: '200': @@ -489,6 +522,11 @@ paths: '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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get parameters: - description: ID of `Dispute` to fetch. @@ -501,18 +539,21 @@ paths: post: tags: - Disputes - description: "Upload dispute evidence for a `Dispute`.\n\nThere are four values\ - \ available for `state` that details the status of the evidence upload:\n\n\ - * **PENDING**: The evidence file has not yet been submitted to the `Processor`.\ - \ No user action is required.\n* **SUCCEEDED**: The evidence file has been\ - \ successfully sent to the `Processor`. No further user action is required.\n\ - * **CANCELED**: The evidence file upload was not completed due to user action.\n\ - * **FAILED**: An issue occurred. User action is required. Any of the following\ - \ issues could have occurred:\n * There was an error in the system and\ - \ the user should retry uploading their evidence file.\n * There is an\ - \ issue with the file and the user should retry uploading a different file.\n\ - \ * There is an issue and the user should contact Support.\n" - summary: Create Dispute Evidence + description: "Upload dispute evidence for a `Dispute`.\n\n- You can upload up\ + \ to 8 files; the total size of the uploaded files combined cannot exceed\ + \ 10 MB.\n- The allowed file formats include JPG, PNG, PDF, or TIFF.\n- Individual\ + \ PNG and JPEG files can't exceed 50 KB; PDF and TIFF files can't exceed 1\ + \ MB.\n\nThere are four values available for `state` that details the status\ + \ of the evidence upload:\n\n* **PENDING**: The evidence file has not yet\ + \ been submitted to the `Processor`. No user action is required.\n* **SUCCEEDED**:\ + \ The evidence file has been successfully sent to the `Processor`. No further\ + \ user action is required.\n* **CANCELED**: The evidence file upload was not\ + \ completed due to user action.\n* **FAILED**: An issue occurred. User action\ + \ is required. Any of the following issues could have occurred:\n * There\ + \ was an error in the system and the user should retry uploading their evidence\ + \ file.\n * There is an issue with the file and the user should retry uploading\ + \ a different file.\n * There is an issue and the user should contact Support.\n" + summary: Upload Dispute Evidence operationId: createDisputeEvidence responses: '201': @@ -552,6 +593,11 @@ paths: - $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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list_dispute_evidence_by_dispute_id x-returns-list: true parameters: @@ -581,6 +627,11 @@ paths: $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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get_dispute_evidence parameters: - description: ID of `Dispute` to fetch evidence for. @@ -597,7 +648,7 @@ paths: type: string /fee_profiles: get: - description: Get all fee profiles + description: List all `Fee Profiles`. summary: List Fee Profiles operationId: listFeeProfiles responses: @@ -617,10 +668,15 @@ paths: - $ref: '#/components/parameters/QueryLimit' tags: - Fee Profiles + x-codeSamples: + - lang: cURL + label: curl + source: "curl https://finix.sandbox-payments-api.com/fee_profiles \\\n -H\ + \ \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list x-returns-list: true post: - description: Create fee profiles + description: Create a `fee_profile`. summary: Create a Fee Profile operationId: createFeeProfile requestBody: @@ -642,7 +698,7 @@ paths: x-python-method-name: create /fee_profiles/{fee_profile_id}: get: - description: Get fee profile + description: Get a `fee_profile`. summary: Fetch a Fee Profile operationId: getFeeProfile responses: @@ -659,6 +715,11 @@ paths: 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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get parameters: - required: true @@ -666,7 +727,7 @@ paths: name: fee_profile_id schema: type: string - description: The ID of the fee profile. + description: The ID of the `fee_profile`. /identities: post: tags: @@ -729,6 +790,11 @@ paths: $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 \\\n -H \"\ + Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list x-returns-list: true /identities/{identity_id}: @@ -750,9 +816,14 @@ paths: '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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get parameters: - - description: ID of the `identity` to fetch + - description: ID of the `Identity` to fetch. required: true in: path name: identity_id @@ -838,6 +909,11 @@ paths: $ref: '#/components/responses/Error406NotAcceptable' x-java-method-name: listAssocaiatedIdentities x-group-parameters: true + x-codeSamples: + - lang: cURL + label: curl + source: "curl https://finix.sandbox-payments-api.com/identities/IDf33pdVaTZGXVFNccdKvaPu/associated_identities\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list_assocaiated_identities x-returns-list: true parameters: @@ -856,12 +932,12 @@ paths: schema: type: string post: - description: "Create a `Merchant` to start the underwriting process for your\ - \ merchant. `Merchants` must be created under an [`Identity`](#tag/Identities).\n\ + description: "Create a `Merchant` to start the underwriting (also called provisioning)\ + \ process for your merchant. `Merchants` must be created under an [`Identity`](#tag/Identities).\n\ \n> A bank account must be associated with the previously created `Identity`\ \ before a `Merchant` can be succefully onboarded and verified.\n\n`Merchant`\ \ resources can have three possible `onboarding_states`:\n\n1. **PROVISIONING**:\ - \ The request is pending (the state may change after two minutes).\n *\ + \ The request is pending (the state can change after two minutes).\n *\ \ `processing_enabled`: **False**\n * `settlement_enabled`: **False**\n\ \n1. **APPROVED**: The `Merchant` has been approved and can begin processing\ \ payments.\n * `processing_enabled`: **True**\n * `settlement_enabled`:\ @@ -897,15 +973,22 @@ paths: x-python-method-name: create /identities/{identity_id}/settlements: parameters: - - description: ID of identity to fetch + - description: 'ID of the `Identity` for the merchant you want to settle. ' required: true in: path name: identity_id schema: type: string post: - description: Create a batch `Settlement`. A `Settlement` is a collection of - **SUCCEEDED** Transfers that are ready to get paid out to a `Merchant`. + description: "Send this POST request to batch every `Transfer` that got updated\ + \ to **SUCCEEDED** into a `Settlement`. The new `Settlement` will include\ + \ every `Transfer` that got updated to **SUCCEEDED** since the last `Settlement`\ + \ got approved.\n\nThe `Settlement` that gets created will not accrue any\ + \ further transactions and gets immediately submitted for approval.\n- Any\ + \ refunded `Transfers` get included in `Settlements` as a deduction.\n- **PENDING**\ + \ `Transfers` don't get included in `Settlements`. \n- The `total_amount`\ + \ minus the `total_fee` equals the `net_amount`. The `net_amount` is the amount\ + \ in cents that gets deposited into the merchant's bank account." summary: Create a Batch Settlement operationId: createIdentitySettlement requestBody: @@ -932,7 +1015,7 @@ paths: x-python-method-name: create /identities/{identity_id}/verifications: parameters: - - description: ID of identity to fetch + - description: ID of `Identity` to verify. required: true in: path name: identity_id @@ -964,13 +1047,12 @@ paths: get: tags: - Merchant Profiles - description: Get list of all the merchant_profiles objects + description: Retireve a list of all `merchant_profiles`. summary: List Merchant Profiles operationId: listMerchantProfiles parameters: - $ref: '#/components/parameters/QueryIdFilter' - $ref: '#/components/parameters/QueryBeforeCursor' - - $ref: '#/components/parameters/QueryAfterCursor' - $ref: '#/components/parameters/QueryLimit' responses: '200': @@ -983,6 +1065,11 @@ paths: $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 \\\n\ + \ -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list x-returns-list: true /merchants: @@ -996,10 +1083,10 @@ paths: - $ref: '#/components/parameters/QueryIdFilter' - $ref: '#/components/parameters/QueryCreatedAtGteFilter' - $ref: '#/components/parameters/QueryCreatedAtLteFilter' - - $ref: '#/components/parameters/QuerySort' - $ref: '#/components/parameters/QueryAfterCursor' - - $ref: '#/components/parameters/QueryLimit' - $ref: '#/components/parameters/QueryBeforeCursor' + - $ref: '#/components/parameters/QueryLimit' + - $ref: '#/components/parameters/QuerySort' responses: '200': $ref: '#/components/responses/MerchantsList' @@ -1015,6 +1102,11 @@ paths: $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 \\\n -H \"\ + Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list x-returns-list: true /merchants/{merchant_id}: @@ -1022,7 +1114,7 @@ paths: tags: - Merchants description: Retrieve the details of a `Merchant`. - summary: Get a Merchant + summary: Fetch a Merchant operationId: getMerchant responses: '200': @@ -1036,6 +1128,11 @@ paths: '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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get parameters: - description: ID of `Merchant`. @@ -1071,8 +1168,8 @@ paths: get: tags: - Merchant Profiles - description: Get the merchant profile object - summary: Show Merchant Profile + description: Retrieve the details of a previosuly created `merchant_profile`. + summary: Fetch a Merchant Profile operationId: getMerchantProfile responses: '200': @@ -1086,9 +1183,14 @@ paths: '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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get parameters: - - description: ID of merchant profile + - description: ID of `merchant_profile`. required: true in: path name: merchant_profile_id @@ -1097,11 +1199,11 @@ paths: put: tags: - Merchant Profiles - description: Update a merchant profile + description: Update a `merchant_profile`. summary: Update a Merchant Profile operationId: updateMerchantProfile requestBody: - $ref: '#/components/requestBodies/CreateMerchantProfileRequest' + $ref: '#/components/requestBodies/UpdateMerchantProfileRequest' responses: '200': $ref: '#/components/responses/MerchantProfile' @@ -1148,7 +1250,7 @@ paths: x-python-method-name: create /merchants/{merchant_id}/verifications: get: - description: Get a list of all the `Verifications` in the `Merchant` object. + description: Get a list of all the `Verifications` for a `Merchant` resource. summary: List Merchant Verifications operationId: listMerchantVerifications parameters: @@ -1177,6 +1279,11 @@ paths: x-group-parameters: true tags: - Verifications + x-codeSamples: + - lang: cURL + label: curl + source: "curl https://finix.sandbox-payments-api.com/merchants/MUpaGK5dUb2Sb7aGuXhFRNbj/verifications\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list_by_merchant_id x-returns-list: true parameters: @@ -1189,8 +1296,10 @@ paths: post: tags: - Merchants - description: Verify a merchant either to reattempt provisioning, or when the - merchant's `Identity` was updated. + description: If the `onboarding_state` for a `Merchant` returns **FAILED**, + correct the `Identity` information saved for the `Merchant`. Once corrected, + try verifying (also called provisioning) the `Merchant` again with another + request. summary: Verify a Merchant operationId: createMerchantVerification requestBody: @@ -1220,9 +1329,9 @@ paths: hosted fields](/guides/payments/tokenization-with-hosted-fields). - > The creation of `Payment Instruments` using cards directly via Finix''s - API should only be done for testing purposes. You must use the Hosted Tokenization - fields or javascript client to remain out of PCI scope.' + - The creation of `Payment Instruments` directly via Finix''s API should only + be done for testing purposes. You must use the Hosted Tokenization fields + or the javascript client to remain out of PCI scope.' summary: Create a Payment Instrument operationId: createPaymentInstrument requestBody: @@ -1247,21 +1356,21 @@ paths: summary: List Payment Instruments operationId: listPaymentInstruments parameters: - - $ref: '#/components/parameters/QueryLimit' - - $ref: '#/components/parameters/QueryAfterCursor' - $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/QueryBeforeCursor' responses: '200': $ref: '#/components/responses/PaymentInstrumentsList' @@ -1273,6 +1382,11 @@ paths: $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 \\\ + \n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list x-returns-list: true /payment_instruments/{payment_instrument_id}: @@ -1280,7 +1394,7 @@ paths: tags: - Payment Instruments description: Retrieve the details of a `Payment Instrument`. - summary: Get a Payment Instrument + summary: Fetch a Payment Instrument operationId: getPaymentInstrument responses: '200': @@ -1296,6 +1410,11 @@ paths: '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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get parameters: - description: ID of object @@ -1373,10 +1492,80 @@ paths: x-java-method-name: listUpdatesByPaymentInstrumentId x-group-parameters: true x-internal: false + x-codeSamples: + - lang: cURL + label: curl + source: "curl https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137/updates\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list_updates_by_payment_instrument_id x-returns-list: true parameters: - - description: ID of object + - description: ID of `Payment Instrument` object. + required: true + in: path + name: payment_instrument_id + schema: + type: string + /payment_instruments/{payment_instrument_id}/verifications: + 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/\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USpEbizhxFRAFT7oYgWjX87B:6d3ace2c-23f9-4e59-8b75-a1a5b8a53055\n" + x-python-method-name: list_by_payment_instrument_id + x-returns-list: true + parameters: + - description: ID of `Payment Instrument `object. required: true in: path name: payment_instrument_id @@ -1386,8 +1575,10 @@ paths: get: tags: - Settlements - description: Retrieve a list of `Settlements`. - summary: List Settlements + description: 'Retrieve a list of `Settlements`. + + ' + summary: List All Settlements operationId: listSettlements parameters: - $ref: '#/components/parameters/QueryCreatedAtGteFilter' @@ -1409,6 +1600,11 @@ paths: $ref: '#/components/responses/Error406NotAcceptable' x-java-method-name: list x-group-parameters: true + x-codeSamples: + - lang: cURL + label: curl + source: "curl https://finix.sandbox-payments-api.com/settlements/ \\\n -H\ + \ \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list x-returns-list: true /settlements/{settlement_id}: @@ -1416,7 +1612,7 @@ paths: tags: - Settlements description: Retreive the details of a `Settlement`. - summary: Get a Settlement + summary: Fetch a Settlement operationId: getSettlement responses: '200': @@ -1430,6 +1626,11 @@ paths: '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/STimypRqs5TXoCDRq2swMFUY\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get parameters: - description: ID of `Settlement` object. @@ -1438,30 +1639,12 @@ paths: name: settlement_id schema: type: string - put: - tags: - - Settlements - description: Update a `Settlement`. - summary: Update a Settlement - operationId: updateSettlement - responses: - '200': - $ref: '#/components/responses/Settlement' - '401': - $ref: '#/components/responses/ErrorUnauthorized' - '403': - $ref: '#/components/responses/ErrorForbidden403' - '406': - $ref: '#/components/responses/Error406NotAcceptable' - requestBody: - $ref: '#/components/requestBodies/UpdateSettlementRequest' - x-java-method-name: update - x-python-method-name: update /settlements/{settlement_id}/funding_transfers: get: tags: - Settlements - description: Retrieve the `Transfers` in a `Settlement` that have `type` **CREDIT**. + description: Retrieve the `Transfers` in a `Settlement` that have `type` **CREDIT** + or **DEBIT**. summary: List Settlement Funding Transfers operationId: listSettlementFundingTransfers responses: @@ -1481,6 +1664,11 @@ paths: - $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/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list_funding_transfers x-returns-list: true parameters: @@ -1550,6 +1738,11 @@ paths: - $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/settlements/STivxR2KrnVdD75TQtitnsG8/transfers\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list_transfers_by_settlement_id x-returns-list: true parameters: @@ -1626,7 +1819,7 @@ paths: - in: query name: instrument_bin description: Filter by Bank Identification Number (BIN). The BIN is the first - 6 digits of the masked number + 6 digits of the masked number. schema: type: string - schema: @@ -1635,54 +1828,54 @@ paths: 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\t" + \ 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 + in the drop-down. - schema: type: string in: query name: merchant_identity_id - description: Filter by 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 + 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 + 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' + 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 + description: Filter by `Merchant` ID. - schema: type: string in: query name: merchant_mid - description: Filter by Merchant Identification Number (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 + description: Filter by the payment card last 4 digits. - schema: type: string in: query name: merchant_processor_id - description: Filter by Processor ID + description: Filter by `Processor` ID. - schema: type: string enum: @@ -1694,7 +1887,7 @@ paths: example: REVERSAL in: query name: type - description: 'Filter by Transfer type. Available type filters include: All, + description: 'Filter by `Transfer` type. Available type filters include: All, Debits, Refunds, or Credits.' - $ref: '#/components/parameters/QueryBeforeCursor' responses: @@ -1710,14 +1903,19 @@ paths: $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 \\\n -H \"\ + Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list x-returns-list: true /transfers/{transfer_id}: get: tags: - Transfers - description: Retrieve a `transfer`. - summary: Get a Transfer + description: Retrieve a `Transfer`. + summary: Fetch a Transfer operationId: getTransfer responses: '200': @@ -1731,9 +1929,14 @@ paths: '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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get parameters: - - description: ID of `transfer` object. + - description: ID of `Transfer` resource. required: true in: path name: transfer_id @@ -1768,9 +1971,9 @@ paths: \ a new `Transfer` resource with a `type` of **REVERSAL**. \n\nThe refund\ \ can get delivered in most cases without the physical card. The card only\ \ needs to be swiped (to receive the refund) when:\n\n- The payment type is\ - \ **DEBIT**, and the transaction is no longer in the batch.\n- The payment\ - \ type is **CREDIT**, and the transaction is no longer in the batch and is\ - \ older than 45 days." + \ **DEBIT**, and the transaction is no longer in the Settlement batch.\n-\ + \ The payment type is **CREDIT**, and the transaction is no longer in the\ + \ batch and is older than 45 days." summary: Refund or Reverse a Transfer operationId: createTransferReversal requestBody: @@ -1820,10 +2023,15 @@ paths: $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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list_transfers_reversals x-returns-list: true parameters: - - description: ID of `transfer` object + - description: ID of `Transfer` object. required: true in: path name: transfer_id @@ -1833,15 +2041,19 @@ paths: post: tags: - Verifications - description: 'Create a `verification` to verify an `Identity` or `Payment Instrument`. + description: 'Create a `Verification` to verify a merchant''s `Identity`. Verifications can also be created directly on the resources you want to verify: - - `POST /merchants/{id}/verifications` + - `POST /merchants/{merchant_id}/verifications` + + + Verify `Payment Instruments` directly on the resource: - - `POST /payment_instruments/{id}/verifications`' - summary: Perform a Verification + + - `POST /payment_instruments/{payment_instrument_id}/verifications`' + summary: Create a Merchant Verification operationId: createVerification requestBody: $ref: '#/components/requestBodies/CreateVerificationRequest' @@ -1881,6 +2093,11 @@ paths: $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 \\\n -H\ + \ \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list x-returns-list: true /verifications/{verification_id}: @@ -1888,7 +2105,7 @@ paths: tags: - Verifications description: Retrieve the details of a `Verification`. - summary: Get a Verification + summary: Fetch a Verification operationId: getVerification responses: '200': @@ -1902,6 +2119,11 @@ paths: '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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get parameters: - description: ID of `Verification` object. @@ -1956,6 +2178,11 @@ paths: $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 \\\n -H \"\ + Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list x-returns-list: true /webhooks/{webhook_id}: @@ -1963,7 +2190,7 @@ paths: tags: - Webhooks description: Retrieve the details of a `Webhook`. - summary: Get a Webhook + summary: Fetch a Webhook operationId: getWebhook responses: '200': @@ -1977,6 +2204,11 @@ paths: '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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get parameters: - description: ID of `Webhook` object. @@ -2015,7 +2247,7 @@ paths: required: true description: ID of the `balance_transfer` resource. get: - summary: Get a Balance Transfer + summary: Fetch a Balance Transfer tags: - Balance Transfers responses: @@ -2033,6 +2265,11 @@ paths: 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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99\n" x-python-method-name: get /instrument_updates: post: @@ -2051,7 +2288,6 @@ paths: $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. - For more info, the following guide on using our [Account Updater](/docs/guides/payments/account-updater/). requestBody: $ref: '#/components/requestBodies/CreateInstrumentUpdateRequest' parameters: [] @@ -2104,6 +2340,11 @@ paths: - $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/IUp9oSWhWUF31DPrJ8CojQeQ/download\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: download /files: post: @@ -2159,6 +2400,11 @@ paths: - $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 \\\n -H \"Content-Type:\ + \ application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list x-returns-list: true /files/{file_id}: @@ -2188,6 +2434,11 @@ paths: description: Retrieve the details of a `File` resource. For more info see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link). x-java-method-name: get + x-codeSamples: + - lang: cURL + label: curl + source: "curl https://finix.sandbox-payments-api.com/files/FILE_abki8bFEjq51eZ5w2pYFik\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get /files/{file_id}/external_links: parameters: @@ -2213,8 +2464,8 @@ paths: '406': description: Not Acceptable operationId: listExternalLinks - description: List the previously `external_links` for a `File`. For more info, - see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link). + description: List the previously created `external_links` for a `File`. For + more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link). parameters: - $ref: '#/components/parameters/QuerySort' - $ref: '#/components/parameters/QueryAfterCursor' @@ -2226,6 +2477,11 @@ paths: - $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_bJecqoRPasStEPVpvKHtgA/external_links\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list_external_links x-returns-list: true post: @@ -2308,6 +2564,11 @@ paths: operationId: downloadFile description: Download a file uploaded to a `File` resource. For more info, see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix). + x-codeSamples: + - lang: cURL + label: curl + source: "curl https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStGPVpvKHtgA/download\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: download_file /files/{file_id}/external_links/{external_link_id}: parameters: @@ -2341,6 +2602,11 @@ paths: operationId: getExternalLink description: Fetch a previously created `external_link` resource. For more info see [Uploading files to Finix](/guides/onboarding/uploading-files-to-finix/#create-an-external-link). + x-codeSamples: + - lang: cURL + label: curl + source: "curl https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA/external_links/EL_dh5YS66GePpkeSVyL4VdBL\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get_external_link /apple_pay_sessions: post: @@ -2406,13 +2672,18 @@ paths: - $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\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: list_disputes_adjustments x-returns-list: true /instrument_updates/{instrument_updates_id}: parameters: - schema: type: string - description: The Id of the instrument update. + description: The ID of the `instrument_update`. name: instrument_updates_id in: path required: true @@ -2435,6 +2706,11 @@ paths: description: Fetch a specific `instrument_update` from an `instrument_updates` resource. For more information, see the guide on using our [Account Updater](/guides/payments/account-updater). x-java-method-name: get + x-codeSamples: + - lang: cURL + label: curl + source: "curl https://finix.sandbox-payments-api.com/instrument_updates/IUp9oSWhWUF31DPrJ8CojQeQ/\ + \ \\\n -H \"Content-Type: application/vnd.json+api\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n" x-python-method-name: get components: headers: @@ -2456,77 +2732,77 @@ components: type: string parameters: ApplicationId: - description: ID of application to use + description: ID of `Application` to use. in: path name: application_id schema: type: string required: true ApplicationProfileId: - description: ID of application profile to use + 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 + description: ID of `Authorization` to fetch. required: true in: path name: authorization_id schema: type: string FeeId: - description: ID of fee to use + 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 + 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 + 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 + 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 + 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 + 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 + 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. + description: Filter where `created_at` is after the given date. in: query name: created_at.gte schema: @@ -2534,7 +2810,7 @@ components: example: created_at.gte=2019-06-15 style: form QueryCreatedAtLteFilter: - description: Filter where created_at is before the given date. + description: Filter where `created_at` is before the given date. in: query name: created_at.lte schema: @@ -2542,28 +2818,28 @@ components: example: created_at.lte=2019-06-15 style: form QueryDefaultStatementDescriptorFilter: - description: Filter by the default_statement_descriptor + description: Filter by the `default_statement_descriptor`. in: query name: default_statement_descriptor schema: type: string style: form QueryIdFilter: - description: Filter by id + description: Filter by `id`. in: query name: id schema: type: string style: form QueryIdempotencyIdFilter: - description: Filter by idempotency_id + description: Filter by `idempotency_id`. in: query name: idempotency_id schema: type: string style: form QueryLimit: - description: The numbers of items to return + description: The numbers of items to return. example: 10 in: query name: limit @@ -2572,7 +2848,7 @@ components: style: form QueryOffset: description: The number of items to skip before starting to collect the result - set + set. example: 20 in: query name: offset @@ -2580,56 +2856,56 @@ components: type: integer style: form QuerySettlementReadyToSettleAtGteFilter: - description: Filter by ready_to_settle_at + description: Filter by `ready_to_settle_at`. in: query name: ready_to_settle_at.gte schema: type: string style: form QuerySettlementReadyToSettleAtLteFilter: - description: Filter by ready_to_settle_at + description: Filter by `ready_to_settle_at`. in: query name: ready_to_settle_at.lte schema: type: string style: form QuerySort: - description: Specify key to be used for sorting the collection + 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 + description: Filter by `statement_descriptor`. in: query name: statement_descriptor schema: type: integer style: form QueryTraceIdFilter: - description: Filter by trace_id + 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 + 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 + 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 + description: Filter by `idempotency_id`. in: query name: is_void schema: @@ -2649,7 +2925,7 @@ components: required: false schema: type: string - description: Filter by the business type. Partial business types are not supported + description: Filter by the business type. Partial business types are not supported. QueryEmail: name: email in: query @@ -2666,7 +2942,7 @@ components: schema: type: string example: first_name=Daphne - description: Filter by the first name of the person associated to the Identity. + description: Filter by the first name of the person associated to the `Identity`. QueryLastName: name: last_name in: query @@ -2674,7 +2950,7 @@ components: schema: type: string example: kline - description: Filter by the last name of the person associated to the identity. + description: Filter by the last name of the person associated to the `Identity`. QueryTitle: name: title in: query @@ -2707,7 +2983,7 @@ components: type: string example: '489514' description: Filter by Bank Identification Number (BIN). The BIN is the first - 6 digits of the masked number + 6 digits of the masked number. QueryExpirationMonth: name: expiration_month in: query @@ -2725,7 +3001,7 @@ components: 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 + Instrument if applicable. This filter only applies to payment cards. QueryLastFour: name: last_four in: query @@ -2733,7 +3009,7 @@ components: schema: type: string example: '0454' - description: Filter by the last 4 digits of the Payment Instrument card. This + description: Filter by the last 4 digits of the `Payment Instrument` card. This filter only applies to payment cards. QueryName: name: name @@ -2750,7 +3026,7 @@ components: schema: type: string example: IDcWwprrKrD6cSh225JWPri3 - description: Filter by the owner id of the associated identity. + description: Filter by the owner id of the associated `Identity`. QueryPaymentInstrumentType: name: type in: query @@ -2762,7 +3038,7 @@ components: - BANK_ACCOUNT - PAYMENT_CARD example: BANK_ACCOUNT - description: Filter by the payment instrument type. + description: Filter by the `Payment Instrument` type. QueryAfterCursor: name: after_cursor in: query @@ -2796,8 +3072,8 @@ components: Create an Application: value: tags: - application_name: Daphne's Corner - user: USweC2ufdBEYxpvPuF3G3LUE + application_name: Finix Flowers + user: USpbnPYf1MMaYYtBqNsNzD6T entity: business_type: LIMITED_LIABILITY_COMPANY business_phone: +1 (408) 756-4497 @@ -2816,7 +3092,7 @@ components: postal_code: '94114' max_transaction_amount: 1200000 phone: '1234567890' - doing_business_as: Square + doing_business_as: Finix Flowers personal_address: city: San Mateo country: USA @@ -2824,7 +3100,7 @@ components: line2: Apartment 7 line1: 741 Douglass St postal_code: '94114' - business_name: Daphne's Corner + business_name: Finix Flowers business_tax_id: '123456789' email: user@example.org tax_id: '123456789' @@ -2909,7 +3185,7 @@ components: value: device: DVf2H8sh4LZZC52GTUrwCPPf tags: - order_number: chris123transfer + order_number: test123transfer currency: USD amount: 150 operation_key: CARD_PRESENT_AUTHORIZATION @@ -2917,10 +3193,20 @@ components: value: device: DVf2H8sh4LZZC52GTUrwCPPf tags: - order_number: chris123transfer + order_number: test123transfer currency: USD amount: 150 operation_key: CARD_PRESENT_AUTHORIZATION + Create an Authorization with Buyer Charges: + value: + additional_buyer_charges: + rent_surcharge_amount: 150 + amount: 5200 + currency: USD + merchant: MUeDVrf2ahuKc9Eg5TeZugvs + source: PIe2YvpcjvoVJ6PzoRPBK137 + tags: + test: sale UpdateAuthorizationRequest: content: application/hal+json: @@ -2991,7 +3277,7 @@ components: schema: $ref: '#/components/schemas/CreateFeeProfileRequest' examples: - Example fee profile: + Create a Fee Profile: value: ach_fixed_fee: 30 tags: @@ -3013,23 +3299,7 @@ components: schema: $ref: '#/components/schemas/CreateIdentityRequest' examples: - Create an Identity for a Buyer: - value: - tags: - key: value - entity: - phone: '7145677613' - first_name: Collen - last_name: Wade - email: therock@gmail.com - personal_address: - city: San Mateo - country: USA - region: CA - line2: Apartment 7 - line1: 741 Douglass St - postal_code: '94114' - Create an Identity for a Merchant: + Create an Identity (Merchant): value: additional_underwriting_data: merchant_agreement_accepted: true @@ -3101,17 +3371,44 @@ components: month: 6 url: www.PetesCoffee.com annual_card_volume: 12000000 + Create an Identity (Buyer): + value: + entity: + phone: '7145677613' + first_name: John + last_name: Smith + email: user@example.org + 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/hal+json: schema: $ref: '#/components/schemas/CreateSettlementRequest' - CreateMerchantProfileRequest: + examples: + Create a Settlement: + value: + currency: USD + processor: DUMMY_V1 + tags: + Internal Daily Settlement ID: 21DFASJSAKAS + UpdateMerchantProfileRequest: content: application/hal+json: schema: - type: object + $ref: '#/components/schemas/UpdateMerchantProfileRequest' + examples: + Update the Fee Profile for a Merchant Profile: + value: + fee_profile: FP4xXhxyFRiRePKBQXmueVTh CreateMerchantUnderwritingRequest: content: application/hal+json: @@ -3313,7 +3610,7 @@ components: value: device: DVf2H8sh4LZZC52GTUrwCPPf tags: - order_number: chris123transfer + order_number: test123transfer currency: USD amount: 150 operation_key: CARD_PRESENT_DEBIT @@ -3324,22 +3621,32 @@ components: amount: 150 operation_key: CARD_PRESENT_DEBIT tags: - order_number: chris123transfer + order_number: test123transfer Create a Card Present Transfer via Manual Entry: value: device: DVf2H8sh4LZZC52GTUrwCPPf tags: - order_number: chris123transfer + order_number: test123transfer device_configuration: prompt_manual_entry: true currency: USD amount: 150 operation_key: CARD_PRESENT_DEBIT + Create a Transfer with Buyer Charges: + value: + additional_buyer_charges: + convenience_amount: 300 + amount: 10300 + currency: USD + merchant: MUeDVrf2ahuKc9Eg5TeZugvs + source: PIe2YvpcjvoVJ6PzoRPBK137 + tags: + test: sale UpdateDeviceRequest: content: application/hal+json: schema: - type: object + $ref: '#/components/schemas/UpdateDeviceRequest' examples: Activate a Device: value: @@ -3350,7 +3657,7 @@ components: action: REBOOT Set Idle Message on Device: value: - idle_message: Daphne's Corner + idle_message: Finix Flowers action: CREATE_IDLE_MESSAGE Deactivate a Device: value: @@ -3366,10 +3673,9 @@ components: schema: $ref: '#/components/schemas/CreateVerificationRequest' examples: - Create a Verification: + Create a Merchant Verification: value: merchant: MUgWbPVvtKbzjKNNGKqdQYV7 - instrument: PI3tfx1Uw3SzHfqwPFGX9o1Y processor: DUMMY_V1 identity: ID2CGJmjqyYaQAu6qyuvGeWK tags: @@ -3380,12 +3686,12 @@ components: schema: $ref: '#/components/schemas/CreateWebhookRequest' examples: - Create a webhook with no authentication: + Create a Webhook with no Authentication: value: url: https://example.com/event_handler authentication: type: NONE - Create a webhook with Basic authentication: + Create a Webhook with Basic authentication: value: url: https://example.com/event_handler authentication: @@ -3393,7 +3699,7 @@ components: basic: username: basic-auth-username password: basic-auth-password - Create a webhook with Bearer Token authentication: + Create a Webhook with Bearer Token Authentication: value: url: https://example.com/event_handler enabled: true @@ -3454,7 +3760,7 @@ components: schema: $ref: '#/components/schemas/CreateSubscriptionScheduleRequest' examples: - FIXED_TIME_INTERVAL: + Create a Subscription Schedule (FIXED_TIME_INTERVAL): value: line_item_type: FEE nickname: Fixed_Time_Subscription_Schedule @@ -3462,7 +3768,7 @@ components: interval_count: 4 hourly_interval: 24 subscription_type: FIXED_TIME_INTERVAL - PERIODIC_MONTHLY: + Create a Subscription Schedule (PERIODIC_MONTHLY): value: line_item_type: FEE period_offset: @@ -3470,7 +3776,7 @@ components: month: null nickname: Monthly_Subscription_Schedule subscription_type: PERIODIC_MONTHLY - PERIODIC_YEARLY: + Create a Subscription Schedule (PERIODIC_YEARLY): value: line_item_type: FEE period_offset: @@ -3484,7 +3790,7 @@ components: schema: $ref: '#/components/schemas/UpdateSubscriptionScheduleRequest' examples: - Update the tags: + Update Tags: value: tags: order-reference: A1B2C3D4E5 @@ -3536,9 +3842,10 @@ components: schema: $ref: '#/components/schemas/UpdatePaymentInstrumentRequest' examples: - Update Name: + Update Tag: value: - name: Amy White + tags: + custom_key: custome value UpdateMerchantRequest: content: application/hal+json: @@ -3561,22 +3868,34 @@ components: Update an Identity: value: entity: - last_name: Wade - first_name: Collen - email: therock@gmail.com + last_name: Smith + first_name: John + email: user@example.org phone: '7145677613' CreateBalanceTransferRequest: content: application/hal+json: schema: $ref: '#/components/schemas/CreateBalanceTransferRequest' + examples: + Create a Balance Transfer: + value: + description: Need to increase buffer given the high number of NSFs + on merchant fee debits + tags: + example: documentation tag + destination: FOR_BENEFIT_OF_ACCOUNT + currency: USD + amount: 4000 + source: OPERATING_ACCOUNT + processor_type: LITLE_V1 CreateInstrumentUpdateRequest: content: multipart/form-data: schema: $ref: '#/components/schemas/CreateInstrumentUpdateRequest' examples: - Instrument Update request: + Instrument Update Request: value: request: '{"merchant": "MUucec6fHeaWo3VHYoSkUySM","idempotency_id": "123xyz testing"}' @@ -3591,9 +3910,9 @@ components: value: display_name: My Drivers License linked_to: MU2n7BSovtwYsWYZF6rBnnzk - type: DRIVERS_LICENSE_FRONT tags: key_1: value_1 + type: DRIVERS_LICENSE_FRONT CreateExternalLinkRequest: content: application/vnd.api+json: @@ -3637,7 +3956,7 @@ components: schema: $ref: '#/components/schemas/UpdateWebhookRequest' examples: - Update a webhook: + Update a Webhook: value: url: https://eohzjuj2prziycz.m.pipedream.net enabled: true @@ -3651,53 +3970,53 @@ components: examples: Application Created: value: - id: APmuwPBaW8pVcwb4vCTHQH32 + id: APgPDQrLD52TYvqazjHJJchM enabled: true tags: - application_name: Daphne's Corner - owner: ID5UsJr9TVJd6cqAA4CCBc9T - name: Daphne's Corner + application_name: Finix Flowers + owner: IDuquemzE7UkUJioGJfVKBKt + name: Finix Flowers processing_enabled: true settlement_enabled: true - creating_transfer_from_report_enabled: false - card_expiration_date_required: false + creating_transfer_from_report_enabled: true + card_expiration_date_required: true card_cvv_required: false settlement_funding_identifier: UNSET ready_to_settle_upon: RECONCILIATION fee_ready_to_settle_upon: RECONCILIATION - created_at: '2021-10-04T17:46:09.38Z' - updated_at: '2021-10-04T17:46:09.38Z' + created_at: '2022-01-27T07:36:33.59Z' + updated_at: '2022-01-27T07:44:04.94Z' _links: self: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32 + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM processors: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/processors users: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/users + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/users owner_identity: - href: https://finix.sandbox-payments-api.com/identities/ID5UsJr9TVJd6cqAA4CCBc9T + href: https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt transfers: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/transfers + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/transfers disputes: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/disputes + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/disputes authorizations: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/authorizations + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/authorizations settlements: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/settlements + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/settlements merchants: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/merchants + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/merchants identities: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/identities + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/identities webhooks: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/webhooks + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/webhooks reversals: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/reversals + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/reversals tokens: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/tokens + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/tokens payment_instruments: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/payment_instruments + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/payment_instruments application_profile: - href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/application_profile + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/application_profile headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -3711,6 +4030,23 @@ components: application/hal+json: schema: $ref: '#/components/schemas/ApplicationProfile' + examples: + Application Profile: + value: + id: PP6Gu3JTdcS5CVuTsY8eCoU7 + tags: {} + application: APkhCuFhbgVgNKKExUf8rpdV + fee_profile: null + risk_profile: RPk3988fTnZS6nEyU1WtNgyd + created_at: '2022-07-28T21:52:54.54Z' + updated_at: '2022-07-28T21:52:54.54Z' + _links: + self: + href: https://finix.sandbox-payments-api.com/application_profiles/PP6Gu3JTdcS5CVuTsY8eCoU7 + application: + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV + risk_profile: + href: https://finix.sandbox-payments-api.com/risk_profiles/RPk3988fTnZS6nEyU1WtNgyd headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -3781,58 +4117,12 @@ components: value: _embedded: applications: - - id: APtjNWUxQKj4Gkw1L4rQ1yNB + - id: APkhCuFhbgVgNKKExUf8rpdV enabled: true tags: - application_name: Daphne's Corner - owner: IDfFQSVMQ2Gj94r6tejVj1DR - name: Square - processing_enabled: true - settlement_enabled: true - creating_transfer_from_report_enabled: false - card_expiration_date_required: true - card_cvv_required: false - settlement_funding_identifier: UNSET - ready_to_settle_upon: RECONCILIATION - fee_ready_to_settle_upon: RECONCILIATION - created_at: '2022-05-31T16:18:44.49Z' - updated_at: '2022-05-31T16:18:44.49Z' - _links: - self: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB - processors: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/processors - users: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/users - owner_identity: - href: https://finix.sandbox-payments-api.com/identities/IDfFQSVMQ2Gj94r6tejVj1DR - transfers: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/transfers - disputes: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/disputes - authorizations: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/authorizations - settlements: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/settlements - merchants: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/merchants - identities: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/identities - webhooks: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/webhooks - reversals: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/reversals - tokens: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/tokens - payment_instruments: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/payment_instruments - application_profile: - href: https://finix.sandbox-payments-api.com/applications/APtjNWUxQKj4Gkw1L4rQ1yNB/application_profile - - id: APo9rPYT1bfrgaJAnQvvoGfu - enabled: true - tags: {} - owner: ID9MZvGw6eFaKx5EVxwiZvJJ - name: Sandbox Corp + name: application + owner: IDthvyMNJ4tK2A8K35rdX1kx + name: business inc processing_enabled: true settlement_enabled: true creating_transfer_from_report_enabled: false @@ -3841,44 +4131,44 @@ components: settlement_funding_identifier: UNSET ready_to_settle_upon: RECONCILIATION fee_ready_to_settle_upon: RECONCILIATION - created_at: '2022-05-25T16:17:24.41Z' - updated_at: '2022-05-25T16:17:24.41Z' + created_at: '2022-07-28T21:52:54.47Z' + updated_at: '2022-07-28T21:52:54.47Z' _links: self: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV processors: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/processors + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/processors users: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/users + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/users owner_identity: - href: https://finix.sandbox-payments-api.com/identities/ID9MZvGw6eFaKx5EVxwiZvJJ + href: https://finix.sandbox-payments-api.com/identities/IDthvyMNJ4tK2A8K35rdX1kx transfers: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/transfers + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/transfers disputes: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/disputes + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/disputes authorizations: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/authorizations + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/authorizations settlements: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/settlements + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/settlements merchants: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/merchants + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/merchants identities: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/identities + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/identities webhooks: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/webhooks + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/webhooks reversals: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/reversals + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/reversals tokens: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/tokens + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/tokens payment_instruments: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/payment_instruments + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/payment_instruments application_profile: - href: https://finix.sandbox-payments-api.com/applications/APo9rPYT1bfrgaJAnQvvoGfu/application_profile - - id: APoUsWg49wfXomJTGnvuKZeT + href: https://finix.sandbox-payments-api.com/applications/APkhCuFhbgVgNKKExUf8rpdV/application_profile + - id: APeT9uYCjww9UuKQB2mgi21A enabled: true tags: {} - owner: ID8SMkHMht1Rw7A3jZGXqsou - name: business inc + owner: IDcfZEYCYQG42RDZR2nqUVNm + name: Chris application processing_enabled: true settlement_enabled: true creating_transfer_from_report_enabled: false @@ -3887,47 +4177,50 @@ components: settlement_funding_identifier: UNSET ready_to_settle_upon: RECONCILIATION fee_ready_to_settle_upon: RECONCILIATION - created_at: '2022-03-24T16:25:56.19Z' - updated_at: '2022-03-24T16:25:56.19Z' + created_at: '2022-04-22T20:32:33.47Z' + updated_at: '2022-04-22T20:32:33.47Z' _links: self: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A processors: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/processors + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/processors users: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/users + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/users owner_identity: - href: https://finix.sandbox-payments-api.com/identities/ID8SMkHMht1Rw7A3jZGXqsou + href: https://finix.sandbox-payments-api.com/identities/IDcfZEYCYQG42RDZR2nqUVNm transfers: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/transfers + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/transfers disputes: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/disputes + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/disputes authorizations: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/authorizations + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/authorizations settlements: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/settlements + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/settlements merchants: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/merchants + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/merchants identities: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/identities + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/identities webhooks: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/webhooks + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/webhooks reversals: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/reversals + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/reversals tokens: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/tokens + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/tokens payment_instruments: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/payment_instruments + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/payment_instruments application_profile: - href: https://finix.sandbox-payments-api.com/applications/APoUsWg49wfXomJTGnvuKZeT/application_profile + href: https://finix.sandbox-payments-api.com/applications/APeT9uYCjww9UuKQB2mgi21A/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: - next_cursor: APoUsWg49wfXomJTGnvuKZeT + offset: 0 limit: 20 + count: 2 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -3944,35 +4237,38 @@ components: examples: Authorization: value: - id: AUeF44FtmytK6XD3JxjUt7HT - application: APgPDQrLD52TYvqazjHJJchM + id: AUcaGi9WKyKn2GwX3bNSpsXo + application: AP3AB2itAWrrrPVS6spvrGYp amount: 100 - tags: - order_number: 21DFASJSAKAS + tags: {} state: SUCCEEDED currency: USD transfer: null messages: [] - raw: null - created_at: '2022-01-27T07:37:19.16Z' - updated_at: '2022-01-27T07:37:19.28Z' - trace_id: b9e38593-da27-49e7-b948-f6c1d59d5e7e - source: PIe2YvpcjvoVJ6PzoRPBK137 - merchant_identity: IDpYDM7J9n57q849o9E9yNrG + raw: + additional_large_number: 9223372036854776000 + value: 100 + order_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce + created_at: '2022-08-01T22:15:30.41Z' + updated_at: '2022-08-01T22:15:30.51Z' + trace_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce + source: PIbDnouV59En1yKfYUNLTpG9 + merchant_identity: IDsArLxCm9QGbi2QfhaFrTED 3ds_redirect_url: null is_void: false void_state: UNATTEMPTED - expires_at: '2022-02-03T07:37:19.16Z' + expires_at: '2022-08-08T22:15:30.41Z' idempotency_id: null + additional_buyer_charges: null failure_code: null failure_message: null _links: self: - href: https://finix.sandbox-payments-api.com/authorizations/AUvAZfiEH7irXZf49P7o8P1r + href: https://finix.sandbox-payments-api.com/authorizations/AUcaGi9WKyKn2GwX3bNSpsXo application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp merchant_identity: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG + href: https://finix.sandbox-payments-api.com/identities/IDsArLxCm9QGbi2QfhaFrTED Authorization (with 3D Secure): value: id: AU27TBqkcCQn94aSVyTvRyrn @@ -3995,6 +4291,7 @@ components: void_state: UNATTEMPTED expires_at: '2022-02-03T07:37:19.95Z' idempotency_id: null + additional_buyer_charges: null failure_code: null failure_message: null _links: @@ -4026,6 +4323,7 @@ components: void_state: UNATTEMPTED expires_at: '2022-02-03T07:37:20.68Z' idempotency_id: null + additional_buyer_charges: null failure_code: null failure_message: null _links: @@ -4057,6 +4355,7 @@ components: void_state: UNATTEMPTED expires_at: '2022-02-03T07:37:21.55Z' idempotency_id: null + additional_buyer_charges: null failure_code: null failure_message: null _links: @@ -4088,6 +4387,7 @@ components: void_state: PENDING expires_at: '2022-02-03T07:37:28.10Z' idempotency_id: null + additional_buyer_charges: null failure_code: null failure_message: null _links: @@ -4103,7 +4403,7 @@ components: application: APeUbTUjvYb1CdPXvNcwW1wP amount: 150 tags: - order_number: chris123transfer + order_number: test123transfer state: SUCCEEDED currency: USD transfer: null @@ -4136,6 +4436,7 @@ components: void_state: UNATTEMPTED expires_at: '2019-03-18T23:36:42.03Z' idempotency_id: null + additional_buyer_charges: null failure_code: null failure_message: null sub_type: API @@ -4154,7 +4455,7 @@ components: application: APeUbTUjvYb1CdPXvNcwW1wP amount: 150 tags: - order_number: chris123transfer + order_number: test123transfer state: SUCCEEDED currency: USD transfer: null @@ -4177,6 +4478,7 @@ components: is_void: false expires_at: '2019-03-08T03:37:10.10Z' idempotency_id: null + additional_buyer_charges: null failure_code: null failure_message: null _links: @@ -4188,16 +4490,50 @@ components: href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf 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' - AuthorizationsList: - description: List of Authorization objects - content: + Authorization with Buyer Charges: + value: + id: AUnxmW39jBePKqYKwQamC3BR + application: APgPDQrLD52TYvqazjHJJchM + amount: 5200 + tags: + test: sale + state: SUCCEEDED + currency: USD + transfer: null + messages: [] + raw: null + created_at: '2022-08-01T19:04:00.29Z' + updated_at: '2022-08-01T19:04:00.43Z' + trace_id: dcb4b954-89b3-4c5e-9b3a-1b8e70e30556 + source: PIe2YvpcjvoVJ6PzoRPBK137 + merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg + 3ds_redirect_url: null + is_void: false + void_state: UNATTEMPTED + expires_at: '2022-08-08T19:04:00.29Z' + idempotency_id: null + additional_buyer_charges: + convenience_amount: 0 + rent_surcharge_amount: 200 + failure_code: null + failure_message: null + _links: + self: + href: https://finix.sandbox-payments-api.com/authorizations/AUnxmW39jBePKqYKwQamC3BR + 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/hal+json: schema: $ref: '#/components/schemas/AuthorizationsList' @@ -4206,72 +4542,126 @@ components: value: _embedded: authorizations: - - id: AUMeh7zWG45JWcogHFGmKFv - application: APgPDQrLD52TYvqazjHJJchM - amount: 1000 - tags: - order_number: 21DFASJSAKAS + - id: AUcaGi9WKyKn2GwX3bNSpsXo + application: AP3AB2itAWrrrPVS6spvrGYp + amount: 100 + tags: {} state: SUCCEEDED currency: USD transfer: null messages: [] - raw: null - created_at: '2022-06-05T21:34:06.19Z' - updated_at: '2022-06-05T21:34:06.38Z' - trace_id: ec55ff10-b5f7-4e4a-bf6a-503224c70013 - source: PIe2YvpcjvoVJ6PzoRPBK137 - merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg + raw: + additional_large_number: 9223372036854776000 + value: 100 + order_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce + created_at: '2022-08-01T22:15:30.41Z' + updated_at: '2022-08-01T22:15:30.51Z' + trace_id: 1c02bd0a-119f-4ded-8bd8-7f23b6d869ce + source: PIbDnouV59En1yKfYUNLTpG9 + merchant_identity: IDsArLxCm9QGbi2QfhaFrTED 3ds_redirect_url: null is_void: false void_state: UNATTEMPTED - expires_at: '2022-06-12T21:34:06.19Z' + expires_at: '2022-08-08T22:15:30.41Z' idempotency_id: null + additional_buyer_charges: null failure_code: null failure_message: null _links: self: - href: https://finix.sandbox-payments-api.com/authorizations/AUMeh7zWG45JWcogHFGmKFv + href: https://finix.sandbox-payments-api.com/authorizations/AUcaGi9WKyKn2GwX3bNSpsXo application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp merchant_identity: - href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg - - id: AUq4AYbftfv7SVgvXRw7tHgW - application: APgPDQrLD52TYvqazjHJJchM - amount: 100 + href: https://finix.sandbox-payments-api.com/identities/IDsArLxCm9QGbi2QfhaFrTED + - id: AUfh49WdxqokwZMkxiDaAp9d + application: APeUbTUjvYb1CdPXvNcwW1wP + amount: 150 tags: - order_number: 21DFASJSAKAS - state: SUCCEEDED + order_number: test123transfer + state: FAILED currency: USD transfer: null - messages: [] - raw: null - created_at: '2022-05-25T17:58:23.63Z' - updated_at: '2022-05-25T17:58:23.77Z' - trace_id: 9e2e9b96-9454-4cff-85bb-b8dab5719f8e - source: PIe2YvpcjvoVJ6PzoRPBK137 - merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg + messages: + - LaneID 1 does not exist. + - 'Authorization AUfh49WdxqokwZMkxiDaAp9d 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: FNX7FBcyvYEAfuVczJdtR8VpV + 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: [] + card_present_details: + emv_data: null + masked_account_number: null + name: null + brand: null + entry_mode: null + payment_type: NONE + approval_code: '000037' + created_at: '2022-08-01T20:00:07.65Z' + updated_at: '2022-08-01T20:00:08.07Z' + trace_id: FNX7FBcyvYEAfuVczJdtR8VpV + source: PI2tXhSnoqT6pwyvWLHBkun5 + merchant_identity: IDsbTBawhnLBAVeinRb84vFR + device: DVf2H8sh4LZZC52GTUrwCPPf 3ds_redirect_url: null is_void: false void_state: UNATTEMPTED - expires_at: '2022-06-01T17:58:23.63Z' + expires_at: '2022-08-08T20:00:07.65Z' idempotency_id: null + additional_buyer_charges: null failure_code: null failure_message: null _links: self: - href: https://finix.sandbox-payments-api.com/authorizations/AUq4AYbftfv7SVgvXRw7tHgW + href: https://finix.sandbox-payments-api.com/authorizations/AUfh49WdxqokwZMkxiDaAp9d application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP + device: + href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf merchant_identity: - href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg + href: https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR _links: self: - href: https://finix.sandbox-payments-api.com/authorizations/?offset=0&limit=20&sort=created_at,desc&sort=id,desc + 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/?next_curosr=AUq4AYbftfv7SVgvXRw7tHgW&limit=20&sort=created_at,desc&sort=id,desc + 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: - next_cursor: AUq4AYbftfv7SVgvXRw7tHgW + offset: 0 limit: 20 + count: 2 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -4300,7 +4690,7 @@ components: examples: Device: value: - id: DV8EVnpCwHwB9Dk3xTysgt5d + id: DVf2H8sh4LZZC52GTUrwCPPf merchant: MUu56ZGx3Xb6U9gAqKfgNisd name: 'Finix Tripos #1' model: MX915 @@ -4309,19 +4699,19 @@ components: idle_message: null enabled: false tags: {} - created_at: '2022-06-06T03:59:42.415893Z' - updated_at: '2022-06-06T03:59:42.416446Z' + 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 + check_for_duplicate_transactions: false prompt_amount_confirmation: true prompt_manual_entry: false prompt_signature: NEVER signature_threshold_amount: 0 - bypass_device_on_capture: false + bypass_device_on_capture: null _links: self: - href: https://finix.sandbox-payments-api.com/devices/DV8EVnpCwHwB9Dk3xTysgt5d + href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf merchant: href: https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd transfers: @@ -4502,18 +4892,18 @@ components: examples: Dispute Evidence: value: - id: DFeTjhgtrvAA9YsPsx2e5PgY + id: DF58kdVTa5eMQUjcXH2F7DH4 tags: file-extension: .png content-type: image/png - file-name: black.png + file-name: test_file.png dispute: DIs7yQRkHDdMYhurzYz72SFk state: SUCCEEDED - created_at: '2022-06-02T17:23:57.67Z' - updated_at: '2022-06-02T17:30:01.84Z' + created_at: '2022-08-15T21:37:04.41Z' + updated_at: '2022-08-15T21:45:00.74Z' _links: self: - href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFeTjhgtrvAA9YsPsx2e5PgY + href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF58kdVTa5eMQUjcXH2F7DH4 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -4530,25 +4920,55 @@ components: examples: List of Dispute Evidence: value: - page: - limit: 1 - next_cursor: null _embedded: evidences: - - tags: - property1: string - property2: string - id: DFxxxxxxxxxxxxxxxxxx - created_at: '2019-08-24T14:15:22Z' - updated_at: '2019-08-24T14:15:22Z' - dispute: string - state: PENDING + - id: DF47KJ5djC346QuLVaQSSw8H + tags: + file-extension: .png + content-type: image/png + file-name: test_file.png + dispute: DIs7yQRkHDdMYhurzYz72SFk + state: SUCCEEDED + created_at: '2022-08-16T18:50:24.16Z' + updated_at: '2022-08-16T19:00:01.10Z' + _links: + self: + href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DF47KJ5djC346QuLVaQSSw8H + - id: DFoLbyCxETSX6ScfMgnrZGER + tags: + file-extension: .png + content-type: image/png + file-name: finix_file.png + dispute: DIs7yQRkHDdMYhurzYz72SFk + state: SUCCEEDED + created_at: '2022-08-15T20:23:04.01Z' + updated_at: '2022-08-15T20:30:00.54Z' + _links: + self: + href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFoLbyCxETSX6ScfMgnrZGER + - id: DFo3KoCCCAhN7iJNmdt4CAqm + tags: + file-extension: .png + content-type: image/png + file-name: finix_file.png + dispute: DIs7yQRkHDdMYhurzYz72SFk + state: SUCCEEDED + created_at: '2022-08-15T18:48:32.81Z' + updated_at: '2022-08-15T19:00:00.64Z' _links: self: - href: string + href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence/DFo3KoCCCAhN7iJNmdt4CAqm _links: self: - href: string + 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=1040&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' @@ -4567,69 +4987,97 @@ components: value: _embedded: disputes: - - id: DIaFfc4tNXbRDDXXFE5qt6Rq - application: AP3AB2itAWrrrPVS6spvrGYp + - id: DIb72obRhTmPdMG1VxDKFLrb + application: APgPDQrLD52TYvqazjHJJchM + tags: + test: sale + amount: 888888 + state: PENDING + transfer: TRkhvS4GfMKxaHyBBdkPSx6g + reason: FRAUD + message: null + action: null + identity: IDuqZpDw28f2KK6YuDk4jNLg + created_at: '2022-07-14T19:40:06.52Z' + updated_at: '2022-07-14T19:40:06.11Z' + occurred_at: '2022-07-14T19:39:00.77Z' + respond_by: '2022-07-21T19:40:06.51Z' + dispute_details: + arn: '123' + _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 + application: APgPDQrLD52TYvqazjHJJchM tags: order_number: 21DFASJSAKAS amount: 888888 - state: WON - transfer: TRikkDuedytMAj6A1pdfFCTg + state: PENDING + transfer: TR27JnLR2pKDXjVVcGBKrjwU reason: FRAUD message: null action: null - identity: IDsArLxCm9QGbi2QfhaFrTED - created_at: '2022-05-13T21:28:11.04Z' - updated_at: '2022-05-13T21:31:33.22Z' - occurred_at: '2022-05-13T21:27:53.49Z' - respond_by: '2022-05-20T21:28:11.04Z' + identity: IDpYDM7J9n57q849o9E9yNrG + created_at: '2022-06-15T16:14:03.95Z' + updated_at: '2022-06-15T16:14:03.64Z' + occurred_at: '2022-06-15T16:13:04.09Z' + respond_by: '2022-06-22T16:14:03.94Z' dispute_details: arn: '123' _links: self: - href: https://finix.sandbox-payments-api.com/disputes/DIaFfc4tNXbRDDXXFE5qt6Rq + href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49 application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM transfer: - href: https://finix.sandbox-payments-api.com/transfers/TRikkDuedytMAj6A1pdfFCTg + href: https://finix.sandbox-payments-api.com/transfers/TR27JnLR2pKDXjVVcGBKrjwU evidence: - href: https://finix.sandbox-payments-api.com/disputes/DIaFfc4tNXbRDDXXFE5qt6Rq/evidence + href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49/evidence adjustment_transfers: - href: https://finix.sandbox-payments-api.com/disputes/DIaFfc4tNXbRDDXXFE5qt6Rq/adjustment_transfers - - id: DItDftgrrkhcyFLzZiUFxn6Y - application: AP3AB2itAWrrrPVS6spvrGYp + href: https://finix.sandbox-payments-api.com/disputes/DIuk8T4ayQdmxewz8EDLHe49/adjustment_transfers + - id: DIs7yQRkHDdMYhurzYz72SFk + application: APgPDQrLD52TYvqazjHJJchM tags: order_number: 21DFASJSAKAS amount: 888888 - state: LOST - transfer: TRkcQz9i5EhQ2cxjriQcSVJQ + state: PENDING + transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky reason: FRAUD message: null action: null - identity: IDqvpp6sfYBLxDsYNeFRdYeF - created_at: '2021-05-25T00:25:03.81Z' - updated_at: '2021-05-25T00:25:03.42Z' - occurred_at: '2021-05-25T00:24:45.72Z' - respond_by: '2021-06-01T00:25:03.80Z' + identity: IDpYDM7J9n57q849o9E9yNrG + created_at: '2022-01-27T07:43:03.74Z' + updated_at: '2022-01-27T07:43:03.48Z' + occurred_at: '2022-01-27T07:42:48.56Z' + respond_by: '2022-02-03T07:43:03.73Z' dispute_details: arn: '123' _links: self: - href: https://finix.sandbox-payments-api.com/disputes/DItDftgrrkhcyFLzZiUFxn6Y + href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM transfer: - href: https://finix.sandbox-payments-api.com/transfers/TRkcQz9i5EhQ2cxjriQcSVJQ + href: https://finix.sandbox-payments-api.com/transfers/TRoTrJ3kqNTFh1P2FJ7A36Ky evidence: - href: https://finix.sandbox-payments-api.com/disputes/DItDftgrrkhcyFLzZiUFxn6Y/evidence + href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/evidence adjustment_transfers: - href: https://finix.sandbox-payments-api.com/disputes/DItDftgrrkhcyFLzZiUFxn6Y/adjustment_transfers + href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers _links: self: - href: https://finix.sandbox-payments-api.com/disputes/?limit=20&sort=created_at,desc&sort=id,desc + href: https://finix.sandbox-payments-api.com/disputes/?offset=0&limit=20&sort=created_at,desc&sort=id,desc page: offset: 0 - count: 2 limit: 20 + count: 3 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -4777,26 +5225,26 @@ components: examples: Fee: value: - id: FEecPYWAL24ZBAcCuR8Q5jZi - amount: 20 + id: FEtSD9oNjoCtJaN2C1FwhZ29 + amount: 100 currency: USD display_name: null fee_subtype: PLATFORM_FEE - fee_type: CARD_BASIS_POINTS + fee_type: CARD_FIXED label: null - linked_id: TRnka9J9CD4cHv814R87C5g3 + linked_id: TR7m4FqzubzFvPJf4WEmkEEv linked_type: TRANSFER merchant: MUeDVrf2ahuKc9Eg5TeZugvs - created_at: '2022-06-05T22:35:04.54Z' - updated_at: '2022-06-05T22:35:04.54Z' + created_at: '2022-08-15T23:14:03.37Z' + updated_at: '2022-08-15T23:14:03.37Z' tags: {} _links: self: - href: https://finix.sandbox-payments-api.com/fees/FEecPYWAL24ZBAcCuR8Q5jZi + 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/TRnka9J9CD4cHv814R87C5g3 + href: https://finix.sandbox-payments-api.com/transfers/TR7m4FqzubzFvPJf4WEmkEEv headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -4810,6 +5258,69 @@ components: application/hal+json: schema: $ref: '#/components/schemas/FeeProfile' + examples: + Fee Profile: + value: + id: FPq6PQ9pHsab66fKMmjQ7jb5 + tags: {} + application: APgPDQrLD52TYvqazjHJJchM + fixed_fee: 100 + ancillary_fixed_fee_primary: null + ancillary_fixed_fee_secondary: null + basis_points: 200 + externally_funded_basis_points: null + externally_funded_fixed_fee: null + ach_basis_points: 300 + ach_fixed_fee: 30 + charge_interchange: false + dispute_inquiry_fixed_fee: null + dispute_fixed_fee: null + ach_debit_return_fixed_fee: null + ach_credit_return_fixed_fee: null + visa_basis_points: null + visa_fixed_fee: null + visa_charge_interchange: null + visa_assessments_basis_points: null + visa_acquirer_processing_fixed_fee: null + visa_credit_voucher_fixed_fee: null + visa_kilobyte_access_fixed_fee: null + discover_basis_points: null + discover_fixed_fee: null + discover_externally_funded_basis_points: null + discover_externally_funded_fixed_fee: null + discover_charge_interchange: null + discover_assessments_basis_points: null + discover_data_usage_fixed_fee: null + discover_network_authorization_fixed_fee: null + diners_club_basis_points: null + diners_club_fixed_fee: null + diners_club_charge_interchange: null + mastercard_basis_points: null + mastercard_fixed_fee: null + mastercard_charge_interchange: null + mastercard_assessments_under1k_basis_points: null + mastercard_assessments_over1k_basis_points: null + mastercard_acquirer_fees_basis_points: null + jcb_basis_points: null + jcb_fixed_fee: null + jcb_charge_interchange: null + american_express_basis_points: null + american_express_fixed_fee: null + american_express_externally_funded_basis_points: null + american_express_externally_funded_fixed_fee: null + american_express_charge_interchange: null + american_express_assessment_basis_points: null + rounding_mode: TRANSACTION + qualified_tiers: null + created_at: '2022-01-27T07:37:38.66Z' + updated_at: '2022-01-27T07:37:38.66Z' + visa_base_II_system_file_transmission_fixed_fee: null + visa_base_II_credit_voucher_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' @@ -4823,6 +5334,138 @@ components: application/hal+json: schema: $ref: '#/components/schemas/FeeProfilesList' + examples: + List of Fee Profiles: + value: + _embedded: + fee_profiles: + - id: FPq6PQ9pHsab66fKMmjQ7jb5 + tags: {} + application: APgPDQrLD52TYvqazjHJJchM + fixed_fee: 100 + ancillary_fixed_fee_primary: null + ancillary_fixed_fee_secondary: null + basis_points: 200 + externally_funded_basis_points: null + externally_funded_fixed_fee: null + ach_basis_points: 300 + ach_fixed_fee: 30 + charge_interchange: false + dispute_inquiry_fixed_fee: null + dispute_fixed_fee: null + ach_debit_return_fixed_fee: null + ach_credit_return_fixed_fee: null + visa_basis_points: null + visa_fixed_fee: null + visa_charge_interchange: null + visa_assessments_basis_points: null + visa_acquirer_processing_fixed_fee: null + visa_credit_voucher_fixed_fee: null + visa_kilobyte_access_fixed_fee: null + discover_basis_points: null + discover_fixed_fee: null + discover_externally_funded_basis_points: null + discover_externally_funded_fixed_fee: null + discover_charge_interchange: null + discover_assessments_basis_points: null + discover_data_usage_fixed_fee: null + discover_network_authorization_fixed_fee: null + diners_club_basis_points: null + diners_club_fixed_fee: null + diners_club_charge_interchange: null + mastercard_basis_points: null + mastercard_fixed_fee: null + mastercard_charge_interchange: null + mastercard_assessments_under1k_basis_points: null + mastercard_assessments_over1k_basis_points: null + mastercard_acquirer_fees_basis_points: null + jcb_basis_points: null + jcb_fixed_fee: null + jcb_charge_interchange: null + american_express_basis_points: null + american_express_fixed_fee: null + american_express_externally_funded_basis_points: null + american_express_externally_funded_fixed_fee: null + american_express_charge_interchange: null + american_express_assessment_basis_points: null + rounding_mode: TRANSACTION + qualified_tiers: null + created_at: '2022-01-27T07:37:38.66Z' + updated_at: '2022-01-27T07:37:38.66Z' + visa_base_II_system_file_transmission_fixed_fee: null + visa_base_II_credit_voucher_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 + tags: {} + application: APgPDQrLD52TYvqazjHJJchM + fixed_fee: 100 + ancillary_fixed_fee_primary: null + ancillary_fixed_fee_secondary: null + basis_points: 200 + externally_funded_basis_points: null + externally_funded_fixed_fee: null + ach_basis_points: 300 + ach_fixed_fee: 30 + charge_interchange: false + dispute_inquiry_fixed_fee: null + dispute_fixed_fee: null + ach_debit_return_fixed_fee: null + ach_credit_return_fixed_fee: null + visa_basis_points: null + visa_fixed_fee: null + visa_charge_interchange: null + visa_assessments_basis_points: null + visa_acquirer_processing_fixed_fee: null + visa_credit_voucher_fixed_fee: null + visa_kilobyte_access_fixed_fee: null + discover_basis_points: null + discover_fixed_fee: null + discover_externally_funded_basis_points: null + discover_externally_funded_fixed_fee: null + discover_charge_interchange: null + discover_assessments_basis_points: null + discover_data_usage_fixed_fee: null + discover_network_authorization_fixed_fee: null + diners_club_basis_points: null + diners_club_fixed_fee: null + diners_club_charge_interchange: null + mastercard_basis_points: null + mastercard_fixed_fee: null + mastercard_charge_interchange: null + mastercard_assessments_under1k_basis_points: null + mastercard_assessments_over1k_basis_points: null + mastercard_acquirer_fees_basis_points: null + jcb_basis_points: null + jcb_fixed_fee: null + jcb_charge_interchange: null + american_express_basis_points: null + american_express_fixed_fee: null + american_express_externally_funded_basis_points: null + american_express_externally_funded_fixed_fee: null + american_express_charge_interchange: null + american_express_assessment_basis_points: null + rounding_mode: TRANSACTION + qualified_tiers: null + created_at: '2022-01-27T07:37:36.69Z' + updated_at: '2022-01-27T07:37:36.69Z' + visa_base_II_system_file_transmission_fixed_fee: null + visa_base_II_credit_voucher_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' @@ -4841,55 +5484,57 @@ components: value: _embedded: fees: - - id: FEecPYWAL24ZBAcCuR8Q5jZi - amount: 20 + - id: FEjoBcxx8X3hPVsdzT19SXp9 + amount: 2 currency: USD display_name: null fee_subtype: PLATFORM_FEE fee_type: CARD_BASIS_POINTS label: null - linked_id: TRnka9J9CD4cHv814R87C5g3 + linked_id: TRvmcvtpCSj3qNkzz18TLneX linked_type: TRANSFER merchant: MUeDVrf2ahuKc9Eg5TeZugvs - created_at: '2022-06-05T22:35:04.54Z' - updated_at: '2022-06-05T22:35:04.54Z' + created_at: '2022-08-17T16:37:00.99Z' + updated_at: '2022-08-17T16:37:00.99Z' tags: {} _links: self: - href: https://finix.sandbox-payments-api.com/fees/FEecPYWAL24ZBAcCuR8Q5jZi + href: https://finix.sandbox-payments-api.com/fees/FEjoBcxx8X3hPVsdzT19SXp9 merchant: href: https://finix.sandbox-payments-api.com/merchants/MUeDVrf2ahuKc9Eg5TeZugvs transfer: - href: https://finix.sandbox-payments-api.com/transfers/TRnka9J9CD4cHv814R87C5g3 - - id: FErW8ePqkQFByxuEDkkPXFLW - amount: 392 + href: https://finix.sandbox-payments-api.com/transfers/TRvmcvtpCSj3qNkzz18TLneX + - id: FEtSD9oNjoCtJaN2C1FwhZ29 + amount: 100 currency: USD display_name: null - fee_subtype: APPLICATION_FEE - fee_type: APPLICATION_FEE + fee_subtype: PLATFORM_FEE + fee_type: CARD_FIXED label: null - linked_id: TRnesQtx4oL8aFHTdKk2ruER + linked_id: TR7m4FqzubzFvPJf4WEmkEEv linked_type: TRANSFER merchant: MUeDVrf2ahuKc9Eg5TeZugvs - created_at: '2022-06-03T22:02:04.79Z' - updated_at: '2022-06-03T22:02:04.79Z' + created_at: '2022-08-15T23:14:03.37Z' + updated_at: '2022-08-15T23:14:03.37Z' tags: {} _links: self: - href: https://finix.sandbox-payments-api.com/fees/FEecPYWAL24ZBAcCuR8Q5jZi + 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/TRnka9J9CD4cHv814R87C5g3 + href: https://finix.sandbox-payments-api.com/transfers/TR7m4FqzubzFvPJf4WEmkEEv _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=13360&limit=20&sort=created_at,desc&sort=id,desc page: offset: 0 - count: 2 limit: 20 + count: 2 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -4908,16 +5553,16 @@ components: value: _embedded: identities: - - id: IDuqZpDw28f2KK6YuDk4jNLg + - id: IDrNRsZ2miEQcmGHCpo4rBQr application: APgPDQrLD52TYvqazjHJJchM entity: title: CEO first_name: dwayne - last_name: Sunkhronos + last_name: xbc email: user@example.org - business_name: Dunder Mifflin - business_type: CORPORATION - doing_business_as: Dunder Mifflin + business_name: Petes Coffee + business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP + doing_business_as: Petes Coffee phone: '1234567890' business_phone: +1 (408) 756-4497 personal_address: @@ -4942,7 +5587,7 @@ components: max_transaction_amount: 12000000 amex_mid: null discover_mid: null - url: www.DunderMifflin.com + url: www.PetesCoffee.com annual_card_volume: 12000000 has_accepted_credit_cards_previously: true incorporation_date: @@ -4955,743 +5600,39 @@ components: tax_authority: null tax_id_provided: true business_tax_id_provided: true - default_statement_descriptor: Dunder Mifflin - tags: - Studio Rating: '4.7' - created_at: '2022-01-27T07:37:02.85Z' - updated_at: '2022-01-27T07:37:02.76Z' - _links: - self: - href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg - verifications: - href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg/verifications - merchants: - href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg/merchants - settlements: - href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg/settlements - authorizations: - href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg/authorizations - transfers: - href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg/transfers - payment_instruments: - href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg/payment_instruments - associated_identities: - href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg/associated_identities - disputes: - href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg/disputes - application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - - id: IDqXfTAYjLL4Lyce4Xq33g9k - application: APgPDQrLD52TYvqazjHJJchM - entity: - title: Founder - first_name: John - last_name: Smith - email: john.smith@company1.com - business_name: null - business_type: null - doing_business_as: null - phone: '1234567890' - business_phone: null - personal_address: - line1: 123 Main Street - line2: null - city: San Francisco - region: CA - postal_code: '90650' - country: USA - business_address: null - mcc: null - dob: - day: 1 - month: 1 - year: 2013 - max_transaction_amount: 0 - amex_mid: null - discover_mid: null - url: null - annual_card_volume: 0 - has_accepted_credit_cards_previously: false - incorporation_date: null - principal_percentage_ownership: 25 - short_business_name: null - ownership_type: PRIVATE - tax_authority: null - tax_id_provided: true - business_tax_id_provided: false - default_statement_descriptor: null - tags: {} - created_at: '2022-01-27T07:37:01.87Z' - updated_at: '2022-01-27T07:37:01.93Z' - _links: - self: - href: https://finix.sandbox-payments-api.com/identities/IDqXfTAYjLL4Lyce4Xq33g9k - verifications: - href: https://finix.sandbox-payments-api.com/identities/IDqXfTAYjLL4Lyce4Xq33g9k/verifications - merchants: - href: https://finix.sandbox-payments-api.com/identities/IDqXfTAYjLL4Lyce4Xq33g9k/merchants - settlements: - href: https://finix.sandbox-payments-api.com/identities/IDqXfTAYjLL4Lyce4Xq33g9k/settlements - authorizations: - href: https://finix.sandbox-payments-api.com/identities/IDqXfTAYjLL4Lyce4Xq33g9k/authorizations - transfers: - href: https://finix.sandbox-payments-api.com/identities/IDqXfTAYjLL4Lyce4Xq33g9k/transfers - payment_instruments: - href: https://finix.sandbox-payments-api.com/identities/IDqXfTAYjLL4Lyce4Xq33g9k/payment_instruments - associated_identities: - href: https://finix.sandbox-payments-api.com/identities/IDqXfTAYjLL4Lyce4Xq33g9k/associated_identities - disputes: - href: https://finix.sandbox-payments-api.com/identities/IDqXfTAYjLL4Lyce4Xq33g9k/disputes - application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - - id: IDgWxBhfGYLLdkhxx2ddYf9K - application: APgPDQrLD52TYvqazjHJJchM - entity: - title: null - first_name: Collen - last_name: Wade - email: therock@gmail.com - business_name: null - business_type: null - doing_business_as: null - phone: '7145677613' - business_phone: null - personal_address: - line1: 741 Douglass St - line2: Apartment 7 - city: San Mateo - region: CA - postal_code: '94114' - country: USA - business_address: null - mcc: null - dob: null - max_transaction_amount: 0 - amex_mid: null - discover_mid: null - url: null - annual_card_volume: 0 - has_accepted_credit_cards_previously: false - incorporation_date: null - principal_percentage_ownership: null - short_business_name: null - ownership_type: PRIVATE - tax_authority: null - tax_id_provided: false - business_tax_id_provided: false - default_statement_descriptor: null + default_statement_descriptor: Petes Coffee tags: - key: value - created_at: '2022-01-27T07:36:59.91Z' - updated_at: '2022-01-27T07:36:59.83Z' + test_key_103: test_val_103 + created_at: '2022-08-16T18:44:27.46Z' + updated_at: '2022-08-16T18:44:27.46Z' _links: self: - href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K + href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr verifications: - href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/verifications + href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/verifications merchants: - href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/merchants + href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/merchants settlements: - href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/settlements + href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/settlements authorizations: - href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/authorizations + href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/authorizations transfers: - href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/transfers + href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/transfers payment_instruments: - href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/payment_instruments + href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/payment_instruments associated_identities: - href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/associated_identities + href: https://finix.sandbox-payments-api.com/identities/IDrNRsZ2miEQcmGHCpo4rBQr/associated_identities disputes: - href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K/disputes - application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - - id: IDtuGQoXUHTCjNMgm2Eg7vEW - application: APgPDQrLD52TYvqazjHJJchM - entity: - title: CEO - first_name: dwayne - last_name: Sunkhronos - email: user@example.org - business_name: Bobs Burgers - business_type: GOVERNMENT_AGENCY - doing_business_as: Bobs Burgers - phone: '1234567890' - 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: '0742' - dob: - day: 27 - month: 6 - year: 1978 - max_transaction_amount: 12000000 - amex_mid: null - discover_mid: null - url: www.BobsBurgers.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: PUBLIC - tax_authority: null - tax_id_provided: true - business_tax_id_provided: true - default_statement_descriptor: Bobs Burgers - tags: - Studio Rating: '4.7' - created_at: '2022-01-27T07:36:56.53Z' - updated_at: '2022-01-27T07:36:56.44Z' - _links: - self: - href: https://finix.sandbox-payments-api.com/identities/IDtuGQoXUHTCjNMgm2Eg7vEW - verifications: - href: https://finix.sandbox-payments-api.com/identities/IDtuGQoXUHTCjNMgm2Eg7vEW/verifications - merchants: - href: https://finix.sandbox-payments-api.com/identities/IDtuGQoXUHTCjNMgm2Eg7vEW/merchants - settlements: - href: https://finix.sandbox-payments-api.com/identities/IDtuGQoXUHTCjNMgm2Eg7vEW/settlements - authorizations: - href: https://finix.sandbox-payments-api.com/identities/IDtuGQoXUHTCjNMgm2Eg7vEW/authorizations - transfers: - href: https://finix.sandbox-payments-api.com/identities/IDtuGQoXUHTCjNMgm2Eg7vEW/transfers - payment_instruments: - href: https://finix.sandbox-payments-api.com/identities/IDtuGQoXUHTCjNMgm2Eg7vEW/payment_instruments - associated_identities: - href: https://finix.sandbox-payments-api.com/identities/IDtuGQoXUHTCjNMgm2Eg7vEW/associated_identities - disputes: - href: https://finix.sandbox-payments-api.com/identities/IDtuGQoXUHTCjNMgm2Eg7vEW/disputes - application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - - id: IDxAP2TJ1Gxq5rLtcQE58i1b - application: APgPDQrLD52TYvqazjHJJchM - entity: - title: CEO - first_name: dwayne - last_name: Sunkhronos - email: user@example.org - business_name: Petes Coffee - business_type: INTERNATIONAL_ORGANIZATION - doing_business_as: Petes Coffee - phone: '1234567890' - 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: '0742' - 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:55.94Z' - updated_at: '2022-01-27T07:36:55.84Z' - _links: - self: - href: https://finix.sandbox-payments-api.com/identities/IDxAP2TJ1Gxq5rLtcQE58i1b - verifications: - href: https://finix.sandbox-payments-api.com/identities/IDxAP2TJ1Gxq5rLtcQE58i1b/verifications - merchants: - href: https://finix.sandbox-payments-api.com/identities/IDxAP2TJ1Gxq5rLtcQE58i1b/merchants - settlements: - href: https://finix.sandbox-payments-api.com/identities/IDxAP2TJ1Gxq5rLtcQE58i1b/settlements - authorizations: - href: https://finix.sandbox-payments-api.com/identities/IDxAP2TJ1Gxq5rLtcQE58i1b/authorizations - transfers: - href: https://finix.sandbox-payments-api.com/identities/IDxAP2TJ1Gxq5rLtcQE58i1b/transfers - payment_instruments: - href: https://finix.sandbox-payments-api.com/identities/IDxAP2TJ1Gxq5rLtcQE58i1b/payment_instruments - associated_identities: - href: https://finix.sandbox-payments-api.com/identities/IDxAP2TJ1Gxq5rLtcQE58i1b/associated_identities - disputes: - href: https://finix.sandbox-payments-api.com/identities/IDxAP2TJ1Gxq5rLtcQE58i1b/disputes - application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - - id: IDbXQoC8j4DoShzhQzap8R9W - application: APgPDQrLD52TYvqazjHJJchM - entity: - title: CEO - first_name: dwayne - last_name: Sunkhronos - email: user@example.org - business_name: Bobs Burgers - business_type: TAX_EXEMPT_ORGANIZATION - doing_business_as: Bobs Burgers - phone: '1234567890' - 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: '0742' - dob: - day: 27 - month: 6 - year: 1978 - max_transaction_amount: 12000000 - amex_mid: null - discover_mid: null - url: www.BobsBurgers.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: PUBLIC - tax_authority: null - tax_id_provided: true - business_tax_id_provided: true - default_statement_descriptor: Bobs Burgers - tags: - Studio Rating: '4.7' - created_at: '2022-01-27T07:36:55.28Z' - updated_at: '2022-01-27T07:36:55.18Z' - _links: - self: - href: https://finix.sandbox-payments-api.com/identities/IDbXQoC8j4DoShzhQzap8R9W - verifications: - href: https://finix.sandbox-payments-api.com/identities/IDbXQoC8j4DoShzhQzap8R9W/verifications - merchants: - href: https://finix.sandbox-payments-api.com/identities/IDbXQoC8j4DoShzhQzap8R9W/merchants - settlements: - href: https://finix.sandbox-payments-api.com/identities/IDbXQoC8j4DoShzhQzap8R9W/settlements - authorizations: - href: https://finix.sandbox-payments-api.com/identities/IDbXQoC8j4DoShzhQzap8R9W/authorizations - transfers: - href: https://finix.sandbox-payments-api.com/identities/IDbXQoC8j4DoShzhQzap8R9W/transfers - payment_instruments: - href: https://finix.sandbox-payments-api.com/identities/IDbXQoC8j4DoShzhQzap8R9W/payment_instruments - associated_identities: - href: https://finix.sandbox-payments-api.com/identities/IDbXQoC8j4DoShzhQzap8R9W/associated_identities - disputes: - href: https://finix.sandbox-payments-api.com/identities/IDbXQoC8j4DoShzhQzap8R9W/disputes - application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - - id: IDqwZqmgukJsFGLAfLkBVcAM - application: APgPDQrLD52TYvqazjHJJchM - entity: - title: CEO - first_name: dwayne - last_name: Sunkhronos - email: user@example.org - business_name: Dunder Mifflin - business_type: ASSOCIATION_ESTATE_TRUST - doing_business_as: Dunder Mifflin - phone: '1234567890' - 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: '0742' - dob: - day: 27 - month: 6 - year: 1978 - max_transaction_amount: 12000000 - amex_mid: null - discover_mid: null - url: www.DunderMifflin.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: Dunder Mifflin - tags: - Studio Rating: '4.7' - created_at: '2022-01-27T07:36:54.61Z' - updated_at: '2022-01-27T07:36:54.48Z' - _links: - self: - href: https://finix.sandbox-payments-api.com/identities/IDqwZqmgukJsFGLAfLkBVcAM - verifications: - href: https://finix.sandbox-payments-api.com/identities/IDqwZqmgukJsFGLAfLkBVcAM/verifications - merchants: - href: https://finix.sandbox-payments-api.com/identities/IDqwZqmgukJsFGLAfLkBVcAM/merchants - settlements: - href: https://finix.sandbox-payments-api.com/identities/IDqwZqmgukJsFGLAfLkBVcAM/settlements - authorizations: - href: https://finix.sandbox-payments-api.com/identities/IDqwZqmgukJsFGLAfLkBVcAM/authorizations - transfers: - href: https://finix.sandbox-payments-api.com/identities/IDqwZqmgukJsFGLAfLkBVcAM/transfers - payment_instruments: - href: https://finix.sandbox-payments-api.com/identities/IDqwZqmgukJsFGLAfLkBVcAM/payment_instruments - associated_identities: - href: https://finix.sandbox-payments-api.com/identities/IDqwZqmgukJsFGLAfLkBVcAM/associated_identities - disputes: - href: https://finix.sandbox-payments-api.com/identities/IDqwZqmgukJsFGLAfLkBVcAM/disputes - application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - - id: ID2RahCnmeXoGpWdZeNuoBw1 - application: APgPDQrLD52TYvqazjHJJchM - entity: - title: CEO - first_name: dwayne - last_name: Sunkhronos - email: user@example.org - business_name: Pollos Hermanos - business_type: PARTNERSHIP - doing_business_as: Pollos Hermanos - phone: '1234567890' - 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: '0742' - dob: - day: 27 - month: 6 - year: 1978 - max_transaction_amount: 12000000 - amex_mid: null - discover_mid: null - url: www.PollosHermanos.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: Pollos Hermanos - tags: - Studio Rating: '4.7' - created_at: '2022-01-27T07:36:53.82Z' - updated_at: '2022-01-27T07:36:53.62Z' - _links: - self: - href: https://finix.sandbox-payments-api.com/identities/ID2RahCnmeXoGpWdZeNuoBw1 - verifications: - href: https://finix.sandbox-payments-api.com/identities/ID2RahCnmeXoGpWdZeNuoBw1/verifications - merchants: - href: https://finix.sandbox-payments-api.com/identities/ID2RahCnmeXoGpWdZeNuoBw1/merchants - settlements: - href: https://finix.sandbox-payments-api.com/identities/ID2RahCnmeXoGpWdZeNuoBw1/settlements - authorizations: - href: https://finix.sandbox-payments-api.com/identities/ID2RahCnmeXoGpWdZeNuoBw1/authorizations - transfers: - href: https://finix.sandbox-payments-api.com/identities/ID2RahCnmeXoGpWdZeNuoBw1/transfers - payment_instruments: - href: https://finix.sandbox-payments-api.com/identities/ID2RahCnmeXoGpWdZeNuoBw1/payment_instruments - associated_identities: - href: https://finix.sandbox-payments-api.com/identities/ID2RahCnmeXoGpWdZeNuoBw1/associated_identities - disputes: - href: https://finix.sandbox-payments-api.com/identities/ID2RahCnmeXoGpWdZeNuoBw1/disputes - application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - - id: IDp15SMzFRtu39HeXmictVFe - application: APgPDQrLD52TYvqazjHJJchM - entity: - title: CEO - first_name: dwayne - last_name: Sunkhronos - email: user@example.org - business_name: Pollos Hermanos - business_type: LIMITED_LIABILITY_COMPANY - doing_business_as: Pollos Hermanos - phone: '1234567890' - 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: '0742' - dob: - day: 27 - month: 6 - year: 1978 - max_transaction_amount: 12000000 - amex_mid: null - discover_mid: null - url: www.PollosHermanos.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: Pollos Hermanos - tags: - Studio Rating: '4.7' - created_at: '2022-01-27T07:36:52.89Z' - updated_at: '2022-01-27T07:36:52.79Z' - _links: - self: - href: https://finix.sandbox-payments-api.com/identities/IDp15SMzFRtu39HeXmictVFe - verifications: - href: https://finix.sandbox-payments-api.com/identities/IDp15SMzFRtu39HeXmictVFe/verifications - merchants: - href: https://finix.sandbox-payments-api.com/identities/IDp15SMzFRtu39HeXmictVFe/merchants - settlements: - href: https://finix.sandbox-payments-api.com/identities/IDp15SMzFRtu39HeXmictVFe/settlements - authorizations: - href: https://finix.sandbox-payments-api.com/identities/IDp15SMzFRtu39HeXmictVFe/authorizations - transfers: - href: https://finix.sandbox-payments-api.com/identities/IDp15SMzFRtu39HeXmictVFe/transfers - payment_instruments: - href: https://finix.sandbox-payments-api.com/identities/IDp15SMzFRtu39HeXmictVFe/payment_instruments - associated_identities: - href: https://finix.sandbox-payments-api.com/identities/IDp15SMzFRtu39HeXmictVFe/associated_identities - disputes: - href: https://finix.sandbox-payments-api.com/identities/IDp15SMzFRtu39HeXmictVFe/disputes - application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - - 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: '1234567890' - 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: '0742' - 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' - _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 - - id: IDuquemzE7UkUJioGJfVKBKt - application: APgPDQrLD52TYvqazjHJJchM - entity: - title: null - first_name: dwayne - last_name: Sunkhronos - email: user@example.org - business_name: BrainTree - business_type: LIMITED_LIABILITY_COMPANY - doing_business_as: BrainTree - phone: '1234567890' - 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: null - dob: - day: 27 - month: 5 - year: 1978 - max_transaction_amount: 1200000 - amex_mid: null - discover_mid: null - url: null - annual_card_volume: 0 - has_accepted_credit_cards_previously: false - incorporation_date: null - principal_percentage_ownership: null - short_business_name: null - ownership_type: PRIVATE - tax_authority: null - tax_id_provided: true - business_tax_id_provided: true - default_statement_descriptor: null - tags: - application_name: BrainTree - created_at: '2022-01-27T07:36:33.52Z' - updated_at: '2022-01-27T07:36:33.61Z' - _links: - self: - href: https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt - verifications: - href: https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt/verifications - merchants: - href: https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt/merchants - settlements: - href: https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt/settlements - authorizations: - href: https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt/authorizations - transfers: - href: https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt/transfers - payment_instruments: - href: https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt/payment_instruments - associated_identities: - href: https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt/associated_identities - disputes: - href: https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt/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?&limit=20&sort=created_at,desc&sort=id,desc + href: https://finix.sandbox-payments-api.com/identities/IDf33pdVaTZGXVFNccdKvaPu/associated_identities?offset=0&limit=20&sort=created_at,desc&sort=id,desc page: - next_cursor: IDuquemzE7UkUJioGJfVKBKt + offset: 0 limit: 20 + count: 1 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -5712,9 +5653,9 @@ components: application: APgPDQrLD52TYvqazjHJJchM entity: title: null - first_name: Collen - last_name: Wade - email: therock@gmail.com + first_name: John + last_name: Smith + email: user@example.org business_name: null business_type: null doing_business_as: null @@ -5771,16 +5712,16 @@ components: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM Identity (Merchant): value: - id: IDpYDM7J9n57q849o9E9yNrG + id: IDg6KVYcoRJKdEC5HqKxGMhY application: APgPDQrLD52TYvqazjHJJchM entity: title: CEO - first_name: dwayne - last_name: Smith + first_name: Jane + last_name: Dow email: user@example.org - business_name: Daphne's Corner + business_name: Finix Ferry business_type: INDIVIDUAL_SOLE_PROPRIETORSHIP - doing_business_as: Daphne's Corner + doing_business_as: Finix Ferry phone: '1234567890' business_phone: +1 (408) 756-4497 personal_address: @@ -5805,7 +5746,7 @@ components: max_transaction_amount: 12000000 amex_mid: null discover_mid: null - url: www.PetesCoffee.com + url: www.FinixFerry.com annual_card_volume: 12000000 has_accepted_credit_cards_previously: true incorporation_date: @@ -5818,16 +5759,16 @@ components: tax_authority: null tax_id_provided: true business_tax_id_provided: true - default_statement_descriptor: Daphne's Corner + default_statement_descriptor: Finix Ferry tags: - Studio Rating: '4.7' - created_at: '2022-01-27T07:36:52.11Z' - updated_at: '2022-01-27T07:36:52.11Z' + test_key_102: test_val_102 + created_at: '2022-08-16T18:44:26.55Z' + updated_at: '2022-08-16T18:44:26.55Z' additional_underwriting_data: annual_ach_volume: 200000 average_ach_transfer_amount: 200000 average_card_transfer_amount: 200000 - business_description: SB3 vegan cafe + business_description: BCSB3 vegan cafe card_volume_distribution: card_present_percentage: 30 ecommerce_percentage: 60 @@ -5851,23 +5792,23 @@ components: person_to_person_volume_percentage: 0 _links: self: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG + href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY verifications: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/verifications + href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/verifications merchants: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/merchants + href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/merchants settlements: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/settlements + href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/settlements authorizations: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/authorizations + href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/authorizations transfers: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/transfers + href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/transfers payment_instruments: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/payment_instruments + href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/payment_instruments associated_identities: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/associated_identities + href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/associated_identities disputes: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/disputes + href: https://finix.sandbox-payments-api.com/identities/IDg6KVYcoRJKdEC5HqKxGMhY/disputes application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM headers: @@ -5886,11 +5827,11 @@ components: examples: Merchant: value: - id: MUucec6fHeaWo3VHYoSkUySM + id: MUmUL7aBsHkxVLQawJxEXw6N application: APgPDQrLD52TYvqazjHJJchM - identity: IDpYDM7J9n57q849o9E9yNrG - verification: VIdikDHXv7x8nWyJg8JZemGx - merchant_profile: MPzW2oRPtkLxK3fymcMACFi + identity: IDrH4G2VTfNjn1VFkvhcyMYj + verification: VIioiAQWmoT6b6p6mqSggKvA + merchant_profile: MPjBZguwk8oJ9H5ouJo3jaG4 processor: DUMMY_V1 processing_enabled: true settlement_enabled: true @@ -5900,32 +5841,34 @@ components: card_cvv_required: false tags: key_2: value_2 - mcc: '0742' - mid: FNX7CwmebftudY7i5mA4qF6XT - merchant_name: Daphne's Corner + mcc: null + mid: FNXeyy4moA2MvW2Ng9yctRyAZ + merchant_name: John Smith 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' + created_at: '2022-08-17T20:33:34.04Z' + updated_at: '2022-08-17T20:34:01.49Z' onboarding_state: APPROVED processor_details: - mid: FNX7CwmebftudY7i5mA4qF6XT + mid: FNXeyy4moA2MvW2Ng9yctRyAZ api_key: secretValue + convenience_charges_enabled: false + rent_surcharges_enabled: false _links: self: - href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM + href: https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N identity: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG + href: https://finix.sandbox-payments-api.com/identities/IDrH4G2VTfNjn1VFkvhcyMYj verifications: - href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM/verifications + href: https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N/verifications merchant_profile: - href: https://finix.sandbox-payments-api.com/merchant_profiles/MPzW2oRPtkLxK3fymcMACFi + href: https://finix.sandbox-payments-api.com/merchant_profiles/MPjBZguwk8oJ9H5ouJo3jaG4 application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM verification: - href: https://finix.sandbox-payments-api.com/verifications/VIdikDHXv7x8nWyJg8JZemGx + href: https://finix.sandbox-payments-api.com/verifications/VIioiAQWmoT6b6p6mqSggKvA Merchant Created with Card Present Enabled: value: id: MUnvf2P5BkDjJ3giAAs6LVrM @@ -5944,7 +5887,7 @@ components: key_2: value_2 mcc: null mid: null - merchant_name: Collen Wade + merchant_name: Finix Flowers settlement_funding_identifier: UNSET ready_to_settle_upon: RECONCILIATION fee_ready_to_settle_upon: RECONCILIATION @@ -5979,6 +5922,23 @@ components: application/hal+json: schema: $ref: '#/components/schemas/MerchantProfile' + examples: + Merchant Profile: + value: + id: MPsdo8WPP5erWzfPwMjYjVy3 + tags: {} + application: APgPDQrLD52TYvqazjHJJchM + fee_profile: null + risk_profile: RPwAziDZginXDWuuiDSaA3wr + created_at: '2022-08-15T21:37:47.26Z' + updated_at: '2022-08-15T21:38:24.02Z' + _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' @@ -5992,6 +5952,64 @@ components: application/hal+json: schema: $ref: '#/components/schemas/MerchantProfilesList' + examples: + List of Merchant Profiles: + value: + _embedded: + merchant_profiles: + - id: MPjBZguwk8oJ9H5ouJo3jaG4 + tags: {} + application: APgPDQrLD52TYvqazjHJJchM + fee_profile: null + risk_profile: RPnxLQLjV4Rma67zU4m8NnqW + created_at: '2022-08-17T20:33:34.04Z' + updated_at: '2022-08-17T20:33:34.04Z' + _links: + self: + href: https://finix.sandbox-payments-api.com/merchant_profiles/MPjBZguwk8oJ9H5ouJo3jaG4 + application: + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + risk_profile: + href: https://finix.sandbox-payments-api.com/risk_profiles/RPnxLQLjV4Rma67zU4m8NnqW + - id: MPhphMCVwQ6ioryNXT9fFdpQ + tags: {} + application: APgPDQrLD52TYvqazjHJJchM + fee_profile: null + risk_profile: RPv4BsNuXQYqB6sAyXVaiXvQ + created_at: '2022-08-16T18:50:51.99Z' + updated_at: '2022-08-16T18:51:03.18Z' + _links: + self: + href: https://finix.sandbox-payments-api.com/merchant_profiles/MPhphMCVwQ6ioryNXT9fFdpQ + application: + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + risk_profile: + href: https://finix.sandbox-payments-api.com/risk_profiles/RPv4BsNuXQYqB6sAyXVaiXvQ + - id: MPnZBXBVKYHBgYXzx7vhznWc + tags: {} + application: APgPDQrLD52TYvqazjHJJchM + fee_profile: null + risk_profile: RPpiJkfXqstuuhvX8GbbSCQU + created_at: '2022-08-15T21:37:45.87Z' + updated_at: '2022-08-15T21:38:23.63Z' + _links: + self: + href: https://finix.sandbox-payments-api.com/merchant_profiles/MPnZBXBVKYHBgYXzx7vhznWc + application: + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + risk_profile: + href: https://finix.sandbox-payments-api.com/risk_profiles/RPpiJkfXqstuuhvX8GbbSCQU + _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=1500&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' @@ -6010,51 +6028,53 @@ components: value: _embedded: merchants: - - id: MUgWbPVvtKbzjKNNGKqdQYV7 + - id: MUmUL7aBsHkxVLQawJxEXw6N application: APgPDQrLD52TYvqazjHJJchM - identity: ID2CGJmjqyYaQAu6qyuvGeWK - verification: VImHtL3M26rtFueivcoTbexs - merchant_profile: MPqLEQcYhUQoyxe2SKuTFekf + identity: IDrH4G2VTfNjn1VFkvhcyMYj + verification: VIioiAQWmoT6b6p6mqSggKvA + merchant_profile: MPjBZguwk8oJ9H5ouJo3jaG4 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: true + card_cvv_required: false tags: key_2: value_2 mcc: null - mid: FNXbrUD2h3AryEo26aTNbDMYH - merchant_name: Collen Wade + mid: FNXeyy4moA2MvW2Ng9yctRyAZ + merchant_name: John Smith 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-06-05T18:03:24.80Z' - updated_at: '2022-06-05T18:04:00.89Z' + created_at: '2022-08-17T20:33:34.04Z' + updated_at: '2022-08-17T20:34:01.49Z' onboarding_state: APPROVED processor_details: - mid: FNXbrUD2h3AryEo26aTNbDMYH + mid: FNXeyy4moA2MvW2Ng9yctRyAZ api_key: secretValue + convenience_charges_enabled: false + rent_surcharges_enabled: false _links: self: - href: https://finix.sandbox-payments-api.com/merchants/MUgWbPVvtKbzjKNNGKqdQYV7 + href: https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N identity: - href: https://finix.sandbox-payments-api.com/identities/ID2CGJmjqyYaQAu6qyuvGeWK + href: https://finix.sandbox-payments-api.com/identities/IDrH4G2VTfNjn1VFkvhcyMYj verifications: - href: https://finix.sandbox-payments-api.com/merchants/MUgWbPVvtKbzjKNNGKqdQYV7/verifications + href: https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N/verifications merchant_profile: - href: https://finix.sandbox-payments-api.com/merchant_profiles/MPqLEQcYhUQoyxe2SKuTFekf + href: https://finix.sandbox-payments-api.com/merchant_profiles/MPjBZguwk8oJ9H5ouJo3jaG4 application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM verification: - href: https://finix.sandbox-payments-api.com/verifications/VImHtL3M26rtFueivcoTbexs - - id: MUucec6fHeaWo3VHYoSkUySM + href: https://finix.sandbox-payments-api.com/verifications/VIioiAQWmoT6b6p6mqSggKvA + - id: MUkobdhdxtCL4tzvJobZ7vBH application: APgPDQrLD52TYvqazjHJJchM - identity: IDpYDM7J9n57q849o9E9yNrG - verification: VI7nPHu84MA8iXoRVFwvD5Xm - merchant_profile: MPzW2oRPtkLxK3fymcMACFi + identity: IDx7GYHa4eiZtqCEAB2suaKt + verification: VIvkSfF4m5B6q3CGwtUGgGRi + merchant_profile: MPnZBXBVKYHBgYXzx7vhznWc processor: DUMMY_V1 processing_enabled: true settlement_enabled: true @@ -6063,39 +6083,46 @@ components: card_expiration_date_required: true card_cvv_required: false tags: - key_2: value_2 + test_key_102: test_val_102 mcc: '0742' - mid: FNX4dDYTLszGmBkfACLwFHp7j - merchant_name: Bobs Burgers + mid: FNXdmKNYL1PedUZhopAwg83ZU + 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-05-24T06:59:01.58Z' + created_at: '2022-08-15T21:37:45.87Z' + updated_at: '2022-08-15T21:38:23.63Z' onboarding_state: APPROVED processor_details: - mid: FNX4dDYTLszGmBkfACLwFHp7j + mid: FNXdmKNYL1PedUZhopAwg83ZU api_key: secretValue + convenience_charges_enabled: false + rent_surcharges_enabled: false _links: self: - href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM + href: https://finix.sandbox-payments-api.com/merchants/MUkobdhdxtCL4tzvJobZ7vBH identity: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG + href: https://finix.sandbox-payments-api.com/identities/IDx7GYHa4eiZtqCEAB2suaKt verifications: - href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM/verifications + href: https://finix.sandbox-payments-api.com/merchants/MUkobdhdxtCL4tzvJobZ7vBH/verifications merchant_profile: - href: https://finix.sandbox-payments-api.com/merchant_profiles/MPzW2oRPtkLxK3fymcMACFi + href: https://finix.sandbox-payments-api.com/merchant_profiles/MPnZBXBVKYHBgYXzx7vhznWc application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM verification: - href: https://finix.sandbox-payments-api.com/verifications/VI7nPHu84MA8iXoRVFwvD5Xm + href: https://finix.sandbox-payments-api.com/verifications/VIvkSfF4m5B6q3CGwtUGgGRi _links: self: - href: https://finix.sandbox-payments-api.com/merchants/?limit=20&sort=created_at,desc&sort=id,desc + 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=1500&limit=20&sort=created_at,desc&sort=id,desc page: - next_cursor: MUucec6fHeaWo3VHYoSkUySM + offset: 0 limit: 20 + count: 2 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -6123,18 +6150,18 @@ components: examples: Payment Instrument (Card): value: - id: PIgHFzzdUGYi2iaiMhGVZffq + id: PIwWisLuZNwPBoLbCgQVTCoY application: APgPDQrLD52TYvqazjHJJchM - fingerprint: FPRiCenDk2SoRng7WjQTr7RJY + fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D tags: card_name: Business Card expiration_month: 12 expiration_year: 2029 - bin: '520082' - last_four: '8210' - brand: MASTERCARD - card_type: DEBIT - name: John Smith + bin: '400000' + last_four: '9979' + brand: VISA + card_type: UNKNOWN + name: Amy White address: line1: 900 Metro Center Blv line2: null @@ -6142,29 +6169,29 @@ components: region: CA postal_code: '94404' country: USA - address_verification: UNKNOWN - security_code_verification: UNKNOWN - created_at: '2022-07-22T02:36:56.75Z' - updated_at: '2022-07-22T02:36:56.75Z' + address_verification: NO_MATCH + security_code_verification: UNMATCHED + created_at: '2022-08-15T23:13:06.13Z' + updated_at: '2022-08-15T23:13:06.88Z' instrument_type: PAYMENT_CARD type: PAYMENT_CARD currency: USD identity: IDgWxBhfGYLLdkhxx2ddYf9K _links: self: - href: https://finix.sandbox-payments-api.com/payment_instruments/PIgHFzzdUGYi2iaiMhGVZffq + href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY authorizations: - href: https://finix.sandbox-payments-api.com/payment_instruments/PIgHFzzdUGYi2iaiMhGVZffq/authorizations + href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations transfers: - href: https://finix.sandbox-payments-api.com/payment_instruments/PIgHFzzdUGYi2iaiMhGVZffq/transfers + href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers verifications: - href: https://finix.sandbox-payments-api.com/payment_instruments/PIgHFzzdUGYi2iaiMhGVZffq/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/PIgHFzzdUGYi2iaiMhGVZffq/updates + href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates Payment Instrument (Bank Account): value: id: PI8sdzepdapDehPWKFTcre1m @@ -6177,6 +6204,7 @@ components: masked_account_number: XXXXX3123 name: Alice account_type: SAVINGS + bank_account_validation_check: NOT_ATTEMPTED created_at: '2022-01-27T07:36:57.62Z' updated_at: '2022-01-27T07:36:57.62Z' instrument_type: BANK_ACCOUNT @@ -6286,13 +6314,45 @@ components: href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137 application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + - id: IUaZCvDxBcdSeCvtVMnM6tBk + application: APgPDQrLD52TYvqazjHJJchM + merchant: MUucec6fHeaWo3VHYoSkUySM + state: SUCCEEDED + messages: [] + created_at: '2022-06-27T16:53:35.84Z' + updated_at: '2022-06-27T16:54:02.43Z' + payment_instrument: PIe2YvpcjvoVJ6PzoRPBK137 + trace_id: bbe9656f-3c6d-4eef-912b-600f15da3f49 + _links: + self: + href: https://finix.sandbox-payments-api.com/updates/IUaZCvDxBcdSeCvtVMnM6tBk + payment_instrument: + href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137 + application: + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + - id: IUbnw4ZC5EvQcZp6fCw6S1GS + application: APgPDQrLD52TYvqazjHJJchM + merchant: MUucec6fHeaWo3VHYoSkUySM + state: SUCCEEDED + messages: [] + created_at: '2022-08-01T01:25:41.63Z' + updated_at: '2022-08-01T01:26:02.82Z' + payment_instrument: PIe2YvpcjvoVJ6PzoRPBK137 + trace_id: 11db0d65-78aa-4fe4-a0c8-a7d26c434dce + _links: + self: + href: https://finix.sandbox-payments-api.com/updates/IUbnw4ZC5EvQcZp6fCw6S1GS + payment_instrument: + href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137 + application: + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM _links: self: href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137/updates?offset=0&limit=20&sort=created_at,desc&sort=id,desc page: - limit: 10 offset: 0 - count: 1 + limit: 20 + count: 3 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -6311,15 +6371,45 @@ components: value: _embedded: payment_instruments: - - id: PI3tfx1Uw3SzHfqwPFGX9o1Y + - id: PI5peqd4kzQ6LD3hb3vebj5x + application: APgPDQrLD52TYvqazjHJJchM + fingerprint: FPRd5moHxL3Ltuvk4cczxetCg + tags: + Bank Account: Company Account + bank_code: '123123123' + country: USA + masked_account_number: XXXXX3123 + name: Alice + account_type: SAVINGS + bank_account_validation_check: NOT_ATTEMPTED + created_at: '2022-08-17T20:33:24.57Z' + updated_at: '2022-08-17T20:33:24.57Z' + instrument_type: BANK_ACCOUNT + type: BANK_ACCOUNT + currency: USD + identity: IDrH4G2VTfNjn1VFkvhcyMYj + _links: + self: + href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x + authorizations: + href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x/authorizations + transfers: + href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x/transfers + verifications: + href: https://finix.sandbox-payments-api.com/payment_instruments/PI5peqd4kzQ6LD3hb3vebj5x/verifications + application: + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + identity: + href: https://finix.sandbox-payments-api.com/identities/IDrH4G2VTfNjn1VFkvhcyMYj + - id: PIwWisLuZNwPBoLbCgQVTCoY application: APgPDQrLD52TYvqazjHJJchM - fingerprint: FPRogKWsRQks2HGaau5eGR9AF + fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D tags: card_name: Business Card expiration_month: 12 expiration_year: 2029 - bin: '489514' - last_four: '0006' + bin: '400000' + last_four: '9979' brand: VISA card_type: UNKNOWN name: Amy White @@ -6330,93 +6420,40 @@ components: region: CA postal_code: '94404' country: USA - address_verification: UNKNOWN - security_code_verification: UNKNOWN - created_at: '2022-06-05T20:27:25.79Z' - updated_at: '2022-06-05T20:27:25.79Z' + address_verification: NO_MATCH + security_code_verification: UNMATCHED + created_at: '2022-08-15T23:13:06.13Z' + updated_at: '2022-08-15T23:13:06.88Z' instrument_type: PAYMENT_CARD type: PAYMENT_CARD currency: USD identity: IDgWxBhfGYLLdkhxx2ddYf9K _links: self: - href: https://finix.sandbox-payments-api.com/payment_instruments/PI3tfx1Uw3SzHfqwPFGX9o1Y + href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY authorizations: - href: https://finix.sandbox-payments-api.com/payment_instruments/PI3tfx1Uw3SzHfqwPFGX9o1Y/authorizations + href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations transfers: - href: https://finix.sandbox-payments-api.com/payment_instruments/PI3tfx1Uw3SzHfqwPFGX9o1Y/transfers + href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers verifications: - href: https://finix.sandbox-payments-api.com/payment_instruments/PI3tfx1Uw3SzHfqwPFGX9o1Y/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/PI3tfx1Uw3SzHfqwPFGX9o1Y/updates - - id: PI2Wu61exHykAdaioJwke3c6 - application: APgPDQrLD52TYvqazjHJJchM - fingerprint: FPR3jsfobdimwceYmtzWBRoUF - tags: {} - bank_code: '731775673' - country: USA - masked_account_number: XXXXXX5796 - name: MX Bank Savings - account_type: SAVINGS - created_at: '2022-05-31T08:07:12.30Z' - updated_at: '2022-05-31T08:07:12.30Z' - instrument_type: BANK_ACCOUNT - type: BANK_ACCOUNT - currency: USD - identity: ID3BE1zM4qoFjuHeSSyrCJeB - _links: - self: - href: https://finix.sandbox-payments-api.com/payment_instruments/PI2Wu61exHykAdaioJwke3c6 - authorizations: - href: https://finix.sandbox-payments-api.com/payment_instruments/PI2Wu61exHykAdaioJwke3c6/authorizations - transfers: - href: https://finix.sandbox-payments-api.com/payment_instruments/PI2Wu61exHykAdaioJwke3c6/transfers - verifications: - href: https://finix.sandbox-payments-api.com/payment_instruments/PI2Wu61exHykAdaioJwke3c6/verifications - application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - identity: - href: https://finix.sandbox-payments-api.com/identities/ID3BE1zM4qoFjuHeSSyrCJeB - - id: PIg5nW4pnnfHeuNf4eMk9d7C - application: APgPDQrLD52TYvqazjHJJchM - fingerprint: FPRogrhWTnXU8FTGPrSwobMnr - tags: {} - bank_code: '222222226' - country: USA - masked_account_number: XXXXXX5796 - name: MX Bank Savings - account_type: SAVINGS - created_at: '2022-05-29T12:37:53.67Z' - updated_at: '2022-05-29T12:37:53.67Z' - instrument_type: BANK_ACCOUNT - type: BANK_ACCOUNT - currency: USD - identity: ID5tbVBQ1HGma8p2miV53wdD - _links: - self: - href: https://finix.sandbox-payments-api.com/payment_instruments/PIg5nW4pnnfHeuNf4eMk9d7C - authorizations: - href: https://finix.sandbox-payments-api.com/payment_instruments/PIg5nW4pnnfHeuNf4eMk9d7C/authorizations - transfers: - href: https://finix.sandbox-payments-api.com/payment_instruments/PIg5nW4pnnfHeuNf4eMk9d7C/transfers - verifications: - href: https://finix.sandbox-payments-api.com/payment_instruments/PIg5nW4pnnfHeuNf4eMk9d7C/verifications - application: - href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - identity: - href: https://finix.sandbox-payments-api.com/identities/ID5tbVBQ1HGma8p2miV53wdD + href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates _links: self: - href: https://finix.sandbox-payments-api.com/payment_instruments?limit=20&sort=created_at,desc&sort=id,desc + 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?next_cursor=PIg5nW4pnnfHeuNf4eMk9d7C&limit=20&sort=created_at,desc&sort=id,desc + 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=13100&limit=20&sort=created_at,desc&sort=id,desc page: - next_cursor: PIg5nW4pnnfHeuNf4eMk9d7C + offset: 0 limit: 20 + count: 2 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -6469,107 +6506,190 @@ components: value: _embedded: processors: - - id: PRoXd4U33uUp25Kn6P6Uo9A6 - application: AP3AB2itAWrrrPVS6spvrGYp - default_merchant_profile: MPsgBdQgKCc9w9tzT5wSTo7E - application_config: null + - id: PRrH5Cy9ZYFUZDha4cuDgipv + application: APmuwPBaW8pVcwb4vCTHQH32 + default_merchant_profile: MP53dza14XzW4VYqRTnQ8Bpw + application_config: + default_sender_account_number: '123456789012' + 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 + default_level_two_level_three_data_enabled: false + ach_settlement_delay_days: null + allow_split_payouts: false + alert_on_unknown_merchants: false system_config: null - created_at: '2022-04-19T00:05:03.84Z' - updated_at: '2022-04-19T00:05:03.15Z' - processor: MICROBILT_V1 - config: - memberPassword: '1817272702' - useMockCommunication: true - host: sdkstage.microbilt.com - memberId: CCC0008008 + created_at: '2022-04-01T20:45:28.22Z' + updated_at: '2022-04-01T20:45:28.11Z' + processor: MASTERCARD_V1 + config: {} enabled: true _links: self: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp/processors/MICROBILT_V1 + href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors/MASTERCARD_V1 application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp - - id: PRwjmyiGjacweM5KJTp7fazB - application: AP3AB2itAWrrrPVS6spvrGYp - default_merchant_profile: MPsgBdQgKCc9w9tzT5wSTo7E - application_config: null + href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32 + - id: PR686aPfkq2cyHGtKfsxtoib + application: APmuwPBaW8pVcwb4vCTHQH32 + default_merchant_profile: MPf31wi1tKdVqtrT8PFyPFSg + 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 system_config: null - created_at: '2022-04-19T00:05:03.82Z' - updated_at: '2022-04-19T00:05:03.15Z' - processor: LITLE_V1 - config: {} + created_at: '2021-10-04T17:46:10.09Z' + updated_at: '2021-10-04T17:46:10.00Z' + processor: DUMMY_V1 + config: + key1: value-1 + key2: value-2 + canDebitBankAccount: true enabled: true _links: self: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp/processors/LITLE_V1 + href: https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors/DUMMY_V1 application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp - - id: PR5U1BDuxgH7gT2jtCj48RGr - application: AP3AB2itAWrrrPVS6spvrGYp - default_merchant_profile: MPsgBdQgKCc9w9tzT5wSTo7E - application_config: null - system_config: null - created_at: '2022-04-19T00:05:03.69Z' - updated_at: '2022-04-19T00:05:03.15Z' - processor: VISA_V1 - config: {} - enabled: true + 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: 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' + ReversalsList: + description: List of Reversals + content: + application/hal+json: + schema: + $ref: '#/components/schemas/TransfersList' + examples: + List of Reversals on a Transfer: + value: + _embedded: + transfers: + - id: TR6tJC1MuHgr52KC2orx84oh + amount: 100 + tags: + test: refund + state: SUCCEEDED + trace_id: e47cc3b1-f70f-4873-8fc8-4e3863755d89 + currency: USD + application: APgPDQrLD52TYvqazjHJJchM + source: null + destination: PIe2YvpcjvoVJ6PzoRPBK137 + ready_to_settle_at: '2022-08-16T04:00:00.00Z' + externally_funded: 'FALSE' + fee: 0 + statement_descriptor: FNX*DUNDER MIFFLIN + type: REVERSAL + messages: [] + raw: null + created_at: '2022-08-15T23:12:32.53Z' + updated_at: '2022-08-15T23:13:13.89Z' + idempotency_id: null + merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg + subtype: API + failure_code: null + failure_message: null + additional_buyer_charges: null _links: - self: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp/processors/VISA_V1 application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp - - id: PRcG8kdGRnY8MEhvZexUFRTe - application: AP3AB2itAWrrrPVS6spvrGYp - default_merchant_profile: MPsgBdQgKCc9w9tzT5wSTo7E - application_config: null - system_config: null - created_at: '2022-04-19T00:05:03.62Z' - updated_at: '2022-04-19T00:05:03.14Z' - processor: VANTIV_V1 - config: {} - enabled: true + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + self: + href: https://finix.sandbox-payments-api.com/transfers/TR6tJC1MuHgr52KC2orx84oh + 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/TR6tJC1MuHgr52KC2orx84oh/payment_instruments + fee_profile: + href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8 + - id: TRpjXvjTV4cPwS7KkVJqN753 + amount: 100 + tags: + test: refund + state: SUCCEEDED + trace_id: ef1b2012-2ae6-4013-8811-6ec23ead4b8c + currency: USD + application: APgPDQrLD52TYvqazjHJJchM + source: null + destination: PIe2YvpcjvoVJ6PzoRPBK137 + ready_to_settle_at: '2022-08-12T04:00:00.00Z' + externally_funded: 'FALSE' + fee: 0 + statement_descriptor: FNX*DUNDER MIFFLIN + type: REVERSAL + messages: [] + raw: null + created_at: '2022-08-12T22:17:51.46Z' + updated_at: '2022-08-12T22:18:08.58Z' + idempotency_id: null + merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg + subtype: API + failure_code: null + failure_message: null + additional_buyer_charges: null _links: - self: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp/processors/VANTIV_V1 application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp - - id: PRt2uZ8f2R8qyWEALef3PWz6 - application: AP3AB2itAWrrrPVS6spvrGYp - default_merchant_profile: MPtHXbG4Yn9rKyxBmCb446T2 - application_config: null - system_config: null - created_at: '2021-05-25T00:18:36.26Z' - updated_at: '2021-05-25T00:18:36.15Z' - processor: DUMMY_V1 - config: - key1: value-1 - key2: value-2 - canDebitBankAccount: true - enabled: true - _links: + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM self: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp/processors/DUMMY_V1 - application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp + href: https://finix.sandbox-payments-api.com/transfers/TRpjXvjTV4cPwS7KkVJqN753 + 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/TRpjXvjTV4cPwS7KkVJqN753/payment_instruments + fee_profile: + href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8 _links: self: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp/processors + 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=720&limit=20&sort=created_at,desc&sort=id,desc + parent: + href: https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP page: - limit: 100 - next_cursor: null - 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/hal+json: - schema: - $ref: '#/components/schemas/TransfersList' + offset: 0 + limit: 20 + count: 2 + unreversed_amount: 591654 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -6586,46 +6706,45 @@ components: examples: Settlement: value: - id: STmCc8GbjjX33SdymwNhb9Et - application: AP3AB2itAWrrrPVS6spvrGYp - tags: - Internal Daily Settlement ID: 21DFASJSAKAS - identity: IDqvpp6sfYBLxDsYNeFRdYeF + id: STimypRqs5TXoCDRq2swMFUY + application: APgPDQrLD52TYvqazjHJJchM + tags: {} + identity: IDgWxBhfGYLLdkhxx2ddYf9K currency: USD - merchant_id: MUfBgBvvv355djUi4uXQKtit - created_at: '2021-05-25T00:25:04.98Z' - updated_at: '2021-05-25T00:35:02.21Z' + merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs + created_at: '2022-08-09T17:06:02.99Z' + updated_at: '2022-08-09T17:15:25.60Z' processor: DUMMY_V1 type: MERCHANT_REVENUE funds_flow: null payment_type: null - total_amount: 0 - total_fees: 10 - total_fee: 10 - net_amount: -10 + total_amount: 2287662 + total_fees: 49305 + total_fee: 49305 + net_amount: 2238357 destination: null status: AWAITING_APPROVAL _links: self: - href: https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM identity: - href: https://finix.sandbox-payments-api.com/identities/IDqvpp6sfYBLxDsYNeFRdYeF + href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg funding_transfers: - href: https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/funding_transfers + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/funding_transfers transfers: - href: https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers fees: - href: https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers?type=fee + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=fee reversals: - href: https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers?type=reverse + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=reverse credits: - href: https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers?type=credit + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=credit debits: - href: https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers?type=debit + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=debit disputes: - href: https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers?type=dispute + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=dispute headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -6644,92 +6763,96 @@ components: value: _embedded: settlements: - - id: ST5Ke17cVkeRPWkmvYyFuG8S - application: AP3AB2itAWrrrPVS6spvrGYp - tags: {} - identity: IDhKZw6H3bbFigSoic3rCnZF + - id: STrYmJ27NeLqRfWSXVKJboNy + application: APgPDQrLD52TYvqazjHJJchM + tags: + Internal Daily Settlement ID: 21DFASJSAKAS + identity: IDuqZpDw28f2KK6YuDk4jNLg currency: USD - merchant_id: MU6yVa8Aw1xJCv6x1y5HB7wF - created_at: '2022-06-01T23:04:11.91Z' - updated_at: '2022-06-01T23:15:25.20Z' + merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs + created_at: '2022-08-17T16:37:02.32Z' + updated_at: '2022-08-17T16:39:04.98Z' processor: DUMMY_V1 type: MERCHANT_REVENUE funds_flow: null payment_type: null - total_amount: 0 - total_fees: 10 - total_fee: 10 - net_amount: -10 + total_amount: 100 + total_fees: 102 + total_fee: 102 + net_amount: -2 destination: null status: AWAITING_APPROVAL _links: self: - href: https://finix.sandbox-payments-api.com/settlements/ST5Ke17cVkeRPWkmvYyFuG8S + href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM identity: - href: https://finix.sandbox-payments-api.com/identities/IDhKZw6H3bbFigSoic3rCnZF + href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg funding_transfers: - href: https://finix.sandbox-payments-api.com/settlements/ST5Ke17cVkeRPWkmvYyFuG8S/funding_transfers + href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/funding_transfers transfers: - href: https://finix.sandbox-payments-api.com/settlements/ST5Ke17cVkeRPWkmvYyFuG8S/transfers + href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers fees: - href: https://finix.sandbox-payments-api.com/settlements/ST5Ke17cVkeRPWkmvYyFuG8S/transfers?type=fee + href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=fee reversals: - href: https://finix.sandbox-payments-api.com/settlements/ST5Ke17cVkeRPWkmvYyFuG8S/transfers?type=reverse + href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=reverse credits: - href: https://finix.sandbox-payments-api.com/settlements/ST5Ke17cVkeRPWkmvYyFuG8S/transfers?type=credit + href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=credit debits: - href: https://finix.sandbox-payments-api.com/settlements/ST5Ke17cVkeRPWkmvYyFuG8S/transfers?type=debit + href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=debit disputes: - href: https://finix.sandbox-payments-api.com/settlements/ST5Ke17cVkeRPWkmvYyFuG8S/transfers?type=dispute - - id: STuqotawQEt9m7GtPHGiKeCW - application: AP3AB2itAWrrrPVS6spvrGYp + href: https://finix.sandbox-payments-api.com/settlements/STrYmJ27NeLqRfWSXVKJboNy/transfers?type=dispute + - id: STimypRqs5TXoCDRq2swMFUY + application: APgPDQrLD52TYvqazjHJJchM tags: {} - identity: IDcSB8UKqxe6AZ67KtFBTuZX + identity: IDuqZpDw28f2KK6YuDk4jNLg currency: USD - merchant_id: MUwvGSZ2R6uDNFggXVWp6GgM - created_at: '2022-06-01T16:14:22.76Z' - updated_at: '2022-06-01T16:15:28.46Z' + merchant_id: MUeDVrf2ahuKc9Eg5TeZugvs + created_at: '2022-08-09T17:06:02.99Z' + updated_at: '2022-08-09T17:15:25.60Z' processor: DUMMY_V1 type: MERCHANT_REVENUE funds_flow: null payment_type: null - total_amount: 0 - total_fees: 10 - total_fee: 10 - net_amount: -10 + total_amount: 2287662 + total_fees: 49305 + total_fee: 49305 + net_amount: 2238357 destination: null status: AWAITING_APPROVAL _links: self: - href: https://finix.sandbox-payments-api.com/settlements/STuqotawQEt9m7GtPHGiKeCW + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM identity: - href: https://finix.sandbox-payments-api.com/identities/IDcSB8UKqxe6AZ67KtFBTuZX + href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg funding_transfers: - href: https://finix.sandbox-payments-api.com/settlements/STuqotawQEt9m7GtPHGiKeCW/funding_transfers + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/funding_transfers transfers: - href: https://finix.sandbox-payments-api.com/settlements/STuqotawQEt9m7GtPHGiKeCW/transfers + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers fees: - href: https://finix.sandbox-payments-api.com/settlements/STuqotawQEt9m7GtPHGiKeCW/transfers?type=fee + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=fee reversals: - href: https://finix.sandbox-payments-api.com/settlements/STuqotawQEt9m7GtPHGiKeCW/transfers?type=reverse + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=reverse credits: - href: https://finix.sandbox-payments-api.com/settlements/STuqotawQEt9m7GtPHGiKeCW/transfers?type=credit + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=credit debits: - href: https://finix.sandbox-payments-api.com/settlements/STuqotawQEt9m7GtPHGiKeCW/transfers?type=debit + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=debit disputes: - href: https://finix.sandbox-payments-api.com/settlements/STuqotawQEt9m7GtPHGiKeCW/transfers?type=dispute + href: https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY/transfers?type=dispute _links: self: - href: https://finix.sandbox-payments-api.com/settlements + href: https://finix.sandbox-payments-api.com/settlements/?offset=0&limit=20&sort=created_at,desc&sort=id,desc next: - href: https://finix.sandbox-payments-api.com/settlements?after_cursor=SToxk3Lm1PFLL7ZQDJBLqbxQ + href: https://finix.sandbox-payments-api.com/settlements/?offset=20&limit=20&sort=created_at,desc&sort=id,desc + last: + href: https://finix.sandbox-payments-api.com/settlements/?offset=460&limit=20&sort=created_at,desc&sort=id,desc page: + offset: 0 limit: 20 - next_cursor: SToxk3Lm1PFLL7ZQDJBLqbxQ + count: 2 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -6759,7 +6882,7 @@ components: ready_to_settle_at: null externally_funded: UNKNOWN fee: 0 - statement_descriptor: FNX*DUNDER MIFFLIN + statement_descriptor: FNX*FINIX FLOWERS type: DEBIT messages: [] raw: null @@ -6770,6 +6893,7 @@ components: subtype: API failure_code: null failure_message: null + additional_buyer_charges: null _links: application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM @@ -6804,7 +6928,7 @@ components: ready_to_settle_at: null externally_funded: UNKNOWN fee: 603 - statement_descriptor: FNX*DUNDER MIFFLIN + statement_descriptor: FNX*FINIX FLOWERS type: DEBIT messages: [] raw: null @@ -6815,6 +6939,7 @@ components: subtype: API failure_code: null failure_message: null + additional_buyer_charges: null _links: application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM @@ -6849,7 +6974,7 @@ components: ready_to_settle_at: null externally_funded: UNKNOWN fee: 0 - statement_descriptor: FNX*DAPHNES CORNER + statement_descriptor: FNX*FINIX FLOWERS type: DEBIT messages: [] raw: null @@ -6860,6 +6985,7 @@ components: subtype: API failure_code: null failure_message: null + additional_buyer_charges: null _links: application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM @@ -6894,7 +7020,7 @@ components: ready_to_settle_at: null externally_funded: UNKNOWN fee: 0 - statement_descriptor: FNX*DUNDER MIFFLIN + statement_descriptor: FNX*FINIX FLOWERS type: DEBIT messages: [] raw: null @@ -6905,6 +7031,7 @@ components: subtype: API failure_code: null failure_message: null + additional_buyer_charges: null _links: application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM @@ -6939,7 +7066,7 @@ components: ready_to_settle_at: null externally_funded: UNKNOWN fee: 0 - statement_descriptor: FNX*DUNDER MIFFLIN + statement_descriptor: FNX*FINIX FLOWERS type: DEBIT messages: [] raw: null @@ -6950,6 +7077,7 @@ components: subtype: API failure_code: null failure_message: null + additional_buyer_charges: null _links: application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM @@ -6984,7 +7112,7 @@ components: ready_to_settle_at: null externally_funded: UNKNOWN fee: 0 - statement_descriptor: FNX*DUNDER MIFFLIN + statement_descriptor: FNX*FINIX FLOWERS type: REVERSAL messages: [] raw: null @@ -6995,6 +7123,7 @@ components: subtype: API failure_code: null failure_message: null + additional_buyer_charges: null _links: application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM @@ -7025,7 +7154,7 @@ components: ready_to_settle_at: null externally_funded: UNKNOWN fee: 0 - statement_descriptor: FIN*GOLDS GYM + statement_descriptor: FIN*FINIX FLOWERS type: DEBIT messages: [] raw: null @@ -7052,6 +7181,7 @@ components: subtype: API failure_code: null failure_message: null + additional_buyer_charges: null _links: application: href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP @@ -7086,7 +7216,7 @@ components: ready_to_settle_at: null externally_funded: UNKNOWN fee: 0 - statement_descriptor: FIN*GOLDS GYM + statement_descriptor: FIN*FINIX FLOWERS type: DEBIT messages: - Unable to find PIN pad with laneId 1 @@ -7107,6 +7237,7 @@ components: subtype: API failure_code: null failure_message: null + additional_buyer_charges: null _links: application: href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP @@ -7141,7 +7272,7 @@ components: ready_to_settle_at: null externally_funded: UNKNOWN fee: 0 - statement_descriptor: FIN*GOLDS GYM + statement_descriptor: FIN*FINIX FLOWERS type: DEBIT messages: [] raw: null @@ -7161,6 +7292,7 @@ components: subtype: API failure_code: null failure_message: null + additional_buyer_charges: null _links: application: href: https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP @@ -7194,7 +7326,7 @@ components: ready_to_settle_at: null externally_funded: UNKNOWN fee: 0 - statement_descriptor: FNXQA*POLLOS HERMANOS + statement_descriptor: FNXQA*FINIX FLOWERSS type: REVERSAL messages: [] raw: null @@ -7206,6 +7338,7 @@ components: subtype: API failure_code: null failure_message: null + additional_buyer_charges: null _links: application: href: https://finix.sandbox-payments-api.com/applications/APuZMfMerci2JuLUs7xWpf5G @@ -7240,7 +7373,7 @@ components: ready_to_settle_at: null externally_funded: UNKNOWN fee: 0 - statement_descriptor: FNXQA*POLLOS HERMANOS + statement_descriptor: FNXQA*FINIX FLOWERS type: CREDIT messages: [] raw: null @@ -7260,53 +7393,279 @@ components: subtype: API failure_code: null failure_message: null + additional_buyer_charges: null + _links: + application: + href: https://finix.sandbox-payments-api.com/applications/APuZMfMerci2JuLUs7xWpf5G + self: + href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG + merchant_identity: + href: https://finix.sandbox-payments-api.com/identities/ID8W4rxaFN8HsxqugmesLMVo + device: + href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf + payment_instruments: + href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/payment_instruments + 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 + fee_profile: + href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx + Transfer (with Buyer Charges): + value: + id: AUpaSunWzKyq73A6DKyZ3g8f + application: APgPDQrLD52TYvqazjHJJchM + amount: 5200 + tags: + test: sale + state: SUCCEEDED + currency: USD + transfer: null + messages: [] + raw: null + created_at: '2022-08-01T19:40:17.99Z' + updated_at: '2022-08-01T19:40:18.16Z' + trace_id: 767f5042-49ab-48f3-b6ce-5c7c1bbe4b39 + source: PIe2YvpcjvoVJ6PzoRPBK137 + merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg + 3ds_redirect_url: null + is_void: false + void_state: UNATTEMPTED + expires_at: '2022-08-08T19:40:17.99Z' + idempotency_id: null + additional_buyer_charges: + convenience_amount: 100 + rent_surcharge_amount: 200 + failure_code: null + failure_message: null + _links: + self: + href: https://finix.sandbox-payments-api.com/authorizations/AUpaSunWzKyq73A6DKyZ3g8f + 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' + TransfersList: + description: List of Transfer objects + content: + application/hal+json: + schema: + $ref: '#/components/schemas/TransfersList' + examples: + List of Transfers: + value: + _embedded: + transfers: + - id: TRw4MuMkkAZbRJC7362mF1qY + amount: 123 + tags: {} + state: FAILED + trace_id: 61f0192a-d5e3-4b96-8220-60e63fd45605 + currency: USD + application: APgPDQrLD52TYvqazjHJJchM + source: PIdxgKpYuMX3DtnDk3Pes2JK + destination: null + ready_to_settle_at: null + externally_funded: UNKNOWN + fee: 0 + statement_descriptor: FNX*DUNDER MIFFLIN + type: DEBIT + messages: + - RAW MESSAGE + raw: null + created_at: '2022-08-17T22:08:21.39Z' + updated_at: '2022-08-17T22:09:01.30Z' + idempotency_id: null + merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg + subtype: API + failure_code: GENERIC_DECLINE + failure_message: The card was declined for an unknown reason. + The cardholder needs to contact their issuer for more information. + additional_buyer_charges: null + _links: + application: + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + self: + href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY + merchant_identity: + href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg + payment_instruments: + href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/payment_instruments + reversals: + href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/reversals + fees: + href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/fees + disputes: + href: https://finix.sandbox-payments-api.com/transfers/TRw4MuMkkAZbRJC7362mF1qY/disputes + source: + href: https://finix.sandbox-payments-api.com/payment_instruments/PIdxgKpYuMX3DtnDk3Pes2JK + fee_profile: + href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8 + - id: TR4MCT6kZGm5z7BeZu6HQCeq + amount: 13 + tags: {} + state: SUCCEEDED + trace_id: a4a807fe-dc25-482d-8fc0-bee7535ed4b6 + currency: USD + application: APgPDQrLD52TYvqazjHJJchM + source: null + destination: null + ready_to_settle_at: '2022-08-16T19:00:01.11Z' + externally_funded: 'FALSE' + fee: 0 + statement_descriptor: null + type: FEE + fee_type: CARD_BASIS_POINTS + messages: [] + raw: null + created_at: '2022-08-16T18:46:04.34Z' + updated_at: '2022-08-16T18:46:04.34Z' + idempotency_id: null + merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM + subtype: PLATFORM_FEE + failure_code: null + failure_message: null + additional_buyer_charges: null + _links: + application: + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + self: + href: https://finix.sandbox-payments-api.com/transfers/TR4MCT6kZGm5z7BeZu6HQCeq + merchant_identity: + href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM + payment_instruments: + href: https://finix.sandbox-payments-api.com/transfers/TR4MCT6kZGm5z7BeZu6HQCeq/payment_instruments + parent: + href: https://finix.sandbox-payments-api.com/transfers/TRi3agaoYJQoS9wFXenMRgA1 + 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=21140&limit=20&sort=created_at,desc&sort=id,desc + page: + offset: 0 + limit: 20 + count: 2 + List of Settlement Funding Transfers: + value: + _embedded: + transfers: + - id: TRkwxPhCf3qChKFEVGhDjr76 + amount: 102 + tags: {} + state: FAILED + trace_id: d4a6df17-f581-42d0-ac70-ad6770acd5c4 + currency: USD + application: APgPDQrLD52TYvqazjHJJchM + source: null + destination: PIrFpayBAQcqK35HMQgRfaqD + ready_to_settle_at: null + externally_funded: UNKNOWN + fee: 0 + statement_descriptor: null + type: CREDIT + messages: [] + raw: null + created_at: '2022-08-12T21:46:12.97Z' + updated_at: '2022-08-12T21:47:06.65Z' + idempotency_id: null + merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg + subtype: SETTLEMENT_PLATFORM + failure_code: null + failure_message: null + additional_buyer_charges: null + _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 + amount: 2 + tags: {} + state: SUCCEEDED + trace_id: e192bc39-0909-4da9-b4c2-022a84ae3984 + currency: USD + application: APgPDQrLD52TYvqazjHJJchM + source: PIm8mdyYcEnYAZLLyw8g59Pw + destination: null + ready_to_settle_at: null + externally_funded: UNKNOWN + fee: 0 + statement_descriptor: null + type: DEBIT + messages: [] + raw: null + created_at: '2022-08-12T21:46:12.98Z' + updated_at: '2022-08-12T21:47:05.26Z' + idempotency_id: null + merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg + subtype: SETTLEMENT_MERCHANT + failure_code: null + failure_message: null + additional_buyer_charges: null + _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: - application: - href: https://finix.sandbox-payments-api.com/applications/APuZMfMerci2JuLUs7xWpf5G self: - href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG - merchant_identity: - href: https://finix.sandbox-payments-api.com/identities/ID8W4rxaFN8HsxqugmesLMVo - device: - href: https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf - payment_instruments: - href: https://finix.sandbox-payments-api.com/transfers/TR3vLiG6wecEwY3TC3oQiudG/payment_instruments - 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 - fee_profile: - href: https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx - 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/hal+json: - schema: - $ref: '#/components/schemas/TransfersList' - examples: - List of Transfers: + href: https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc + page: + offset: 0 + limit: 20 + count: 2 + List of Settlement Transfers: value: _embedded: transfers: - - id: TR8nRgFgSxi3kXWEzXtbbAz + - id: TR8yiKY6ju988aUZhfqJFjag amount: 100 tags: {} state: SUCCEEDED - trace_id: a4d58329-1db6-408e-9d8b-f515a267f00d + trace_id: 272fe816-2dd1-46ed-a7e7-9041d7a8f0ff currency: USD - application: AP3AB2itAWrrrPVS6spvrGYp + application: APgPDQrLD52TYvqazjHJJchM source: null destination: null - ready_to_settle_at: '2022-06-06T04:00:00.00Z' + ready_to_settle_at: '2022-08-12T22:15:02.69Z' externally_funded: 'FALSE' fee: 0 statement_descriptor: null @@ -7314,78 +7673,80 @@ components: fee_type: CARD_FIXED messages: [] raw: null - created_at: '2022-06-06T00:30:03.39Z' - updated_at: '2022-06-06T00:30:03.39Z' + created_at: '2022-08-12T16:56:01.90Z' + updated_at: '2022-08-12T16:56:01.90Z' idempotency_id: null - merchant_identity: ID8bW3W9DmKEgFYF4GfDJ8or + merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM subtype: PLATFORM_FEE failure_code: null failure_message: null + additional_buyer_charges: null _links: application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM self: - href: https://finix.sandbox-payments-api.com/transfers/TR8nRgFgSxi3kXWEzXtbbAz + href: https://finix.sandbox-payments-api.com/transfers/TR8yiKY6ju988aUZhfqJFjag merchant_identity: - href: https://finix.sandbox-payments-api.com/identities/ID8bW3W9DmKEgFYF4GfDJ8or + href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM payment_instruments: - href: https://finix.sandbox-payments-api.com/transfers/TR8nRgFgSxi3kXWEzXtbbAz/payment_instruments + href: https://finix.sandbox-payments-api.com/transfers/TR8yiKY6ju988aUZhfqJFjag/payment_instruments parent: - href: https://finix.sandbox-payments-api.com/transfers/TRb44SoiGLP2qj1dMXtCdDFR + href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb fee_profile: - href: https://finix.sandbox-payments-api.com/fee_profiles/FPpKrHcHGiaDo3skhteaWitW - - id: TRb44SoiGLP2qj1dMXtCdDFR + href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8 + - id: TRm9ppvqX43CbwmNzhckf2gb amount: 100 tags: {} state: SUCCEEDED - trace_id: 8cf3253f-3cb4-4e59-8c0b-0a18121c5b9a + trace_id: 381f1f6f-492b-4101-9a57-40001a59813a currency: USD - application: AP3AB2itAWrrrPVS6spvrGYp - source: PIek2eHptMghiegHFXJBxm6G + application: APgPDQrLD52TYvqazjHJJchM + source: PIe2YvpcjvoVJ6PzoRPBK137 destination: null - ready_to_settle_at: '2022-06-06T04:00:00.00Z' + ready_to_settle_at: '2022-08-12T04:00:00.00Z' externally_funded: 'FALSE' fee: 0 - statement_descriptor: FIN*PRESTIGE WORLD WI + statement_descriptor: FNX*DUNDER MIFFLIN type: DEBIT messages: [] raw: null - created_at: '2022-06-06T00:16:04.46Z' - updated_at: '2022-06-06T00:17:01.25Z' + created_at: '2022-08-12T16:55:47.66Z' + updated_at: '2022-08-12T16:56:02.19Z' idempotency_id: null - merchant_identity: IDqvpp6sfYBLxDsYNeFRdYeF + merchant_identity: IDuqZpDw28f2KK6YuDk4jNLg subtype: API failure_code: null failure_message: null + additional_buyer_charges: null _links: application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM self: - href: https://finix.sandbox-payments-api.com/transfers/TRb44SoiGLP2qj1dMXtCdDFR + href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb merchant_identity: - href: https://finix.sandbox-payments-api.com/identities/IDqvpp6sfYBLxDsYNeFRdYeF + href: https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg payment_instruments: - href: https://finix.sandbox-payments-api.com/transfers/TRb44SoiGLP2qj1dMXtCdDFR/payment_instruments + href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/payment_instruments reversals: - href: https://finix.sandbox-payments-api.com/transfers/TRb44SoiGLP2qj1dMXtCdDFR/reversals + href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/reversals fees: - href: https://finix.sandbox-payments-api.com/transfers/TRb44SoiGLP2qj1dMXtCdDFR/fees + href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/fees disputes: - href: https://finix.sandbox-payments-api.com/transfers/TRb44SoiGLP2qj1dMXtCdDFR/disputes + href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/disputes source: - href: https://finix.sandbox-payments-api.com/payment_instruments/PIek2eHptMghiegHFXJBxm6G + href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137 fee_profile: - href: https://finix.sandbox-payments-api.com/fee_profiles/FPpKrHcHGiaDo3skhteaWitW - - id: TRjcrDPJUoUtmKSC5EuiqKuQ + href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8 + - id: TRwgubpxAJWbaDZE1kKP6SSi amount: 2 tags: {} state: SUCCEEDED - trace_id: 70d1020c-2bc8-4d50-825c-088db1e27e53 + trace_id: 5e2dbd9c-1ad1-4e36-8d16-cfedd3bce385 currency: USD - application: AP3AB2itAWrrrPVS6spvrGYp + application: APgPDQrLD52TYvqazjHJJchM source: null destination: null - ready_to_settle_at: '2022-06-06T04:00:00.00Z' + ready_to_settle_at: '2022-08-12T22:15:02.69Z' externally_funded: 'FALSE' fee: 0 statement_descriptor: null @@ -7393,34 +7754,34 @@ components: fee_type: CARD_BASIS_POINTS messages: [] raw: null - created_at: '2022-06-06T00:30:03.39Z' - updated_at: '2022-06-06T00:30:03.39Z' + created_at: '2022-08-12T16:56:01.90Z' + updated_at: '2022-08-12T16:56:01.90Z' idempotency_id: null - merchant_identity: ID8bW3W9DmKEgFYF4GfDJ8or + merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM subtype: PLATFORM_FEE failure_code: null failure_message: null + additional_buyer_charges: null _links: application: - href: https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM self: - href: https://finix.sandbox-payments-api.com/transfers/TRjcrDPJUoUtmKSC5EuiqKuQ + href: https://finix.sandbox-payments-api.com/transfers/TRwgubpxAJWbaDZE1kKP6SSi merchant_identity: - href: https://finix.sandbox-payments-api.com/identities/ID8bW3W9DmKEgFYF4GfDJ8or + href: https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM payment_instruments: - href: https://finix.sandbox-payments-api.com/transfers/TRjcrDPJUoUtmKSC5EuiqKuQ/payment_instruments + href: https://finix.sandbox-payments-api.com/transfers/TRwgubpxAJWbaDZE1kKP6SSi/payment_instruments parent: - href: https://finix.sandbox-payments-api.com/transfers/TRb44SoiGLP2qj1dMXtCdDFR + href: https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb fee_profile: - href: https://finix.sandbox-payments-api.com/fee_profiles/FPpKrHcHGiaDo3skhteaWitW + href: https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8 _links: self: - href: https://finix.sandbox-payments-api.com/transfers - next: - href: https://finix.sandbox-payments-api.com/transfers?after_cursor=TR6M2hPEbxf9Nr8RXjfmuPH2 + href: https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc page: - next_cursor: TR6M2hPEbxf9Nr8RXjfmuPH2 + offset: 0 limit: 20 + count: 3 headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -7437,22 +7798,21 @@ components: examples: ROLE_PARTNER User: value: - id: USweC2ufdBEYxpvPuF3G3LUE + id: USvVu9MXHz7hVzwDXwbx3UCL password: null - identity: ID5UsJr9TVJd6cqAA4CCBc9T + identity: IDpYDM7J9n57q849o9E9yNrG enabled: true - role: ROLE_PARTNER - tags: - card_name: New Employee - created_at: '2021-10-04T17:46:08.78Z' - updated_at: '2021-10-04T17:46:09.44Z' + role: ROLE_MERCHANT + tags: {} + created_at: '2022-01-27T07:37:14.65Z' + updated_at: '2022-01-27T07:37:15.47Z' _links: self: - href: https://finix.sandbox-payments-api.com/users/USweC2ufdBEYxpvPuF3G3LUE + 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/APmuwPBaW8pVcwb4vCTHQH32 + href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -7539,28 +7899,28 @@ components: examples: Verification: value: - id: VIe5unscPYp95Vdtie3UwbLj + id: VIioiAQWmoT6b6p6mqSggKvA application: APgPDQrLD52TYvqazjHJJchM tags: - card_name: Business_Card + key_2: value_2 messages: [] - raw: null + raw: RawDummyMerchantUnderwriteResult processor: DUMMY_V1 - state: PENDING - created_at: '2022-06-06T02:54:03.71Z' - updated_at: '2022-06-06T02:54:03.76Z' - trace_id: be3fbea7-450e-4433-960f-f34756ff9931 - payment_instrument: null - merchant: MUgWbPVvtKbzjKNNGKqdQYV7 + state: SUCCEEDED + created_at: '2022-08-17T20:33:34.25Z' + updated_at: '2022-08-17T20:34:01.49Z' + trace_id: 31740c79-7e23-4301-bfa1-fb4f0950b9e4 + payment_instrument: PIwWisLuZNwPBoLbCgQVTCoY + merchant: MUmUL7aBsHkxVLQawJxEXw6N identity: null - merchant_identity: ID2CGJmjqyYaQAu6qyuvGeWK + merchant_identity: IDrH4G2VTfNjn1VFkvhcyMYj _links: self: - href: https://finix.sandbox-payments-api.com/verifications/VIe5unscPYp95Vdtie3UwbLj + href: https://finix.sandbox-payments-api.com/verifications/VIbXwBuccEcqw7rfZneELCv4 application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUgWbPVvtKbzjKNNGKqdQYV7 + identity: + href: https://finix.sandbox-payments-api.com/identities/IDnDkihVYnsnsuAJDGG7im9t headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -7577,31 +7937,112 @@ components: examples: Merchant Verification: value: - page: - limit: 0 - next_cursor: VIdikDHXv7x8nWyJg8JZemGx _embedded: verifications: - - id: VIdikDHXv7x8nWyJg8JZemGx + - id: VInHzhoRAnAizVU7jcj2K6bX + application: APgPDQrLD52TYvqazjHJJchM + tags: {} + messages: [] + raw: RawDummyMerchantUnderwriteResult + processor: DUMMY_V1 + state: SUCCEEDED + created_at: '2022-08-15T23:12:56.40Z' + updated_at: '2022-08-15T23:12:56.85Z' + trace_id: 1c8fb49d-6f1c-40a0-8646-1bcb88047583 + payment_instrument: null + merchant: MUpaGK5dUb2Sb7aGuXhFRNbj + identity: null + merchant_identity: IDgahPGJ6hangmVJwrMRyZzr + _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 application: APgPDQrLD52TYvqazjHJJchM tags: - key_2: value_2 + key: value_2 messages: [] raw: RawDummyMerchantUnderwriteResult processor: DUMMY_V1 state: SUCCEEDED - created_at: '2022-01-27T07:36:58.21Z' - updated_at: '2022-01-27T07:36:58.46Z' - trace_id: 86e00b16-8b94-44fb-bb0f-d5c32c887133 + created_at: '2022-08-15T23:12:54.32Z' + updated_at: '2022-08-15T23:12:54.65Z' + trace_id: 4d12cbe6-032d-4e9d-8291-ce16f4add412 payment_instrument: null - merchant: MUucec6fHeaWo3VHYoSkUySM + merchant: MUpaGK5dUb2Sb7aGuXhFRNbj + identity: null + merchant_identity: IDgahPGJ6hangmVJwrMRyZzr + _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 + application: AP83dL8NE1Q7KfQo9onGg76M + tags: {} + messages: [] + 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: [] + processor: VISA_V1 + state: SUCCEEDED + created_at: '2022-02-04T18:33:14.50Z' + updated_at: '2022-02-04T18:33:15.69Z' + trace_id: '203518208518' + payment_instrument: PImc5nvdnp15atLxEBAGtxJs + merchant: null identity: null + merchant_identity: null _links: self: - href: https://finix.sandbox-payments-api.com/verifications/VIdikDHXv7x8nWyJg8JZemGx + 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: string + 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' @@ -7618,284 +8059,174 @@ components: examples: Webhook: value: - id: WHtPXJnAjmusyobzpmQZeHvJ - url: https://eohzjuj2prziycz.m.pipedream.net - enabled: true + id: WHN6HuqRqTV3mDCxoFLrRvP + url: https://example.com application: APgPDQrLD52TYvqazjHJJchM - created_at: '2022-06-05T23:29:06.66Z' - updated_at: '2022-06-05T23:29:06.66Z' - _links: - self: - href: https://finix.sandbox-payments-api.com/webhooks/WHtPXJnAjmusyobzpmQZeHvJ - 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' - WebhooksList: - description: List of Webhook objects - content: - application/hal+json: - schema: - $ref: '#/components/schemas/WebhooksList' - 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/hal+json: - schema: - $ref: '#/components/schemas/SubscriptionEnrollment' - examples: - Subscription Enrollment: - value: - id: SUBENROLLMENT_uPamF4YuEyzVTT42hwYgBV - created_at: '2022-01-27T07:44:09.08Z' - updated_at: '2022-01-27T07:44:09.08Z' - created_by: UStxEci4vXxGDWLQhNvao7YY - ended_at: null - merchant: MUucec6fHeaWo3VHYoSkUySM - nickname: Security Fee - started_at: '2022-11-11T16:50:59.89Z' - subscription_schedule: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ - tags: - enrollment_info: Security Fee Enrollment - _links: - self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_uPamF4YuEyzVTT42hwYgBV - merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM - schedule: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts - SubscriptionEnrollmentsList: - description: List of subscription_enrollment objects - content: - application/hal+json: - schema: - $ref: '#/components/schemas/SubscriptionEnrollmentList' - examples: - List of Subscription Enrollments: - value: - _embedded: - subscription_enrollments: - - id: SUBENROLLMENT_uPamF4YuEyzVTT42hwYgBV - created_at: '2022-01-27T07:44:09.08Z' - updated_at: '2022-01-27T07:44:09.08Z' - created_by: UStxEci4vXxGDWLQhNvao7YY - ended_at: null - merchant: MUucec6fHeaWo3VHYoSkUySM - nickname: Security Fee - started_at: '2022-11-11T16:50:59.89Z' - subscription_schedule: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ - tags: - enrollment_info: Security Fee Enrollment - _links: - self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_uPamF4YuEyzVTT42hwYgBV - merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM - schedule: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts - - id: SUBENROLLMENT_mdekY4w6XCv7gNzAHQxJ3e - created_at: '2022-01-26T23:35:26.43Z' - updated_at: '2022-01-26T23:35:26.43Z' - created_by: UStxEci4vXxGDWLQhNvao7YY - ended_at: null - merchant: MUhSozGFhgbR6gGjLwbysRaR - nickname: Security Fee - started_at: '2022-11-11T16:50:59.89Z' - subscription_schedule: SUBSCHEDULE_kUvyQgikZkbg6p2vd6U9of - tags: - enrollment_info: Security Fee Enrollment - _links: - self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_mdekY4w6XCv7gNzAHQxJ3e - merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUhSozGFhgbR6gGjLwbysRaR - schedule: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kUvyQgikZkbg6p2vd6U9of - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kUvyQgikZkbg6p2vd6U9of/subscription_amounts - - id: SUBENROLLMENT_bBhQSipvHBqf75VY7pqwta - created_at: '2022-01-13T00:04:11.16Z' - updated_at: '2022-01-13T00:04:11.16Z' - created_by: UStxEci4vXxGDWLQhNvao7YY - ended_at: null - merchant: MUwLX5PeoSp8worY84tX2MVq - nickname: Security Fee - started_at: '2022-11-11T16:50:59.89Z' - subscription_schedule: SUBSCHEDULE_bkXRUUeuN8AfR3RVNUn4vS - tags: - enrollment_info: Security Fee Enrollment - _links: - self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_bBhQSipvHBqf75VY7pqwta - merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUwLX5PeoSp8worY84tX2MVq - schedule: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_bkXRUUeuN8AfR3RVNUn4vS - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_bkXRUUeuN8AfR3RVNUn4vS/subscription_amounts - - id: SUBENROLLMENT_qvmKt49RiEYP4aUFbQUyAe - created_at: '2022-01-12T22:41:26.02Z' - updated_at: '2022-01-12T22:41:26.02Z' - created_by: UStxEci4vXxGDWLQhNvao7YY - ended_at: null - merchant: MUjNTohihEUuQMfPDMKULfeY - nickname: Security Fee - started_at: '2022-11-11T16:50:59.89Z' - subscription_schedule: SUBSCHEDULE_qeY8pHJiCo7e2fqmHyqKDV - tags: - enrollment_info: Security Fee Enrollment - _links: - self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_qvmKt49RiEYP4aUFbQUyAe - merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUjNTohihEUuQMfPDMKULfeY - schedule: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_qeY8pHJiCo7e2fqmHyqKDV - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_qeY8pHJiCo7e2fqmHyqKDV/subscription_amounts - - id: SUBENROLLMENT_fhXN1GwicvEbCYRzbH3KXR - created_at: '2022-01-08T00:53:53.98Z' - updated_at: '2022-01-08T00:53:53.98Z' - created_by: UStxEci4vXxGDWLQhNvao7YY - ended_at: null - merchant: MUuJkmQBCVPh9riNLVgEbPxf - nickname: Security Fee - started_at: '2022-11-11T16:50:59.89Z' - subscription_schedule: SUBSCHEDULE_f2CiEiZTqGju1TsCn1cesT - tags: - enrollment_info: Security Fee Enrollment - _links: - self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_fhXN1GwicvEbCYRzbH3KXR - merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUuJkmQBCVPh9riNLVgEbPxf - schedule: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_f2CiEiZTqGju1TsCn1cesT - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_f2CiEiZTqGju1TsCn1cesT/subscription_amounts - - id: SUBENROLLMENT_7PH3MEqYHbysoFf9vifPm7 - created_at: '2022-01-07T18:39:58.66Z' - updated_at: '2022-01-07T18:39:58.66Z' - created_by: UStxEci4vXxGDWLQhNvao7YY - ended_at: null - merchant: MUwKiuHLp9TJ1WABMfcEmvpW - nickname: Security Fee - started_at: '2022-11-11T16:50:59.89Z' - subscription_schedule: SUBSCHEDULE_7yDCdvjYL4gbKYmLxAUEHE - tags: - enrollment_info: Security Fee Enrollment - _links: - self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_7PH3MEqYHbysoFf9vifPm7 - merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUwKiuHLp9TJ1WABMfcEmvpW - schedule: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_7yDCdvjYL4gbKYmLxAUEHE - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_7yDCdvjYL4gbKYmLxAUEHE/subscription_amounts - - id: SUBENROLLMENT_5SJ9GLz8rAn2aeFGnqtC6v - created_at: '2022-01-06T02:20:02.30Z' - updated_at: '2022-01-06T02:20:02.30Z' - created_by: UStxEci4vXxGDWLQhNvao7YY - ended_at: null - merchant: MUrG5fHZJ8KXaf3GF6CWvhsY - nickname: Security Fee - started_at: '2022-11-11T16:50:59.89Z' - subscription_schedule: SUBSCHEDULE_5BjWJUDiS5cdHSXEyYcvP1 - tags: - enrollment_info: Security Fee Enrollment + enabled: false + authentication: + type: NONE + enabled_events: [] + created_at: '2022-08-15T21:41:30.94Z' + updated_at: '2022-08-15T21:41:31.01Z' + _links: + self: + href: http://finix.sandbox-payments-api.com/webhooks/WHN6HuqRqTV3mDCxoFLrRvP + 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/hal+json: + schema: + $ref: '#/components/schemas/WebhooksList' + examples: + List of Webhooks: + value: + _embedded: + webhooks: + - id: WHdocT8FUQGu73LqByAQ8qyT + url: https://webhook.site/dc0ac9f4-a423-4797-a4dc-3acecb39414e + application: APgPDQrLD52TYvqazjHJJchM + enabled: true + authentication: + type: NONE + enabled_events: [] + created_at: '2022-08-17T16:33:57.71Z' + updated_at: '2022-08-17T16:33:57.71Z' _links: self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_5SJ9GLz8rAn2aeFGnqtC6v - merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUrG5fHZJ8KXaf3GF6CWvhsY - schedule: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5BjWJUDiS5cdHSXEyYcvP1 - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5BjWJUDiS5cdHSXEyYcvP1/subscription_amounts - - id: SUBENROLLMENT_dwzpQ2XxYcJ5NXmWw66zdc - created_at: '2022-01-05T02:08:38.44Z' - updated_at: '2022-01-05T02:08:38.44Z' - created_by: USbkjk46XqUTQHN3i2jaVnc1 - ended_at: null - merchant: MUcpRFqZd66KX78cggJQ647x - nickname: Security Fee - started_at: '2022-11-11T16:50:59.89Z' - subscription_schedule: SUBSCHEDULE_dgwg964fyjJRmmuoASzRmH - tags: - enrollment_info: Security Fee Enrollment + href: http://finix.sandbox-payments-api.com/webhooks/WHdocT8FUQGu73LqByAQ8qyT + application: + href: http://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM + - id: WHN6HuqRqTV3mDCxoFLrRvP + url: https://example.com + application: APgPDQrLD52TYvqazjHJJchM + enabled: false + authentication: + type: NONE + enabled_events: [] + created_at: '2022-08-15T21:41:30.94Z' + updated_at: '2022-08-15T21:41:31.01Z' _links: self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_dwzpQ2XxYcJ5NXmWw66zdc - merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUcpRFqZd66KX78cggJQ647x - schedule: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_dgwg964fyjJRmmuoASzRmH - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_dgwg964fyjJRmmuoASzRmH/subscription_amounts - - id: SUBENROLLMENT_aVjCRvKLXte9LaLKj4Chms - created_at: '2022-01-04T21:57:30.62Z' - updated_at: '2022-01-04T21:57:30.62Z' - created_by: USbkjk46XqUTQHN3i2jaVnc1 + href: http://finix.sandbox-payments-api.com/webhooks/WHN6HuqRqTV3mDCxoFLrRvP + 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=1180&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/hal+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 + SubscriptionEnrollmentsList: + description: List of subscription_enrollment objects + content: + application/hal+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: MUm6Y99nmYz7DrTBnnMT3Hmi - nickname: Security Fee - started_at: '2022-11-11T16:50:59.89Z' - subscription_schedule: SUBSCHEDULE_aC9bWkVMfoUfXS7hkxdD3d - tags: - enrollment_info: Security Fee Enrollment + 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_aVjCRvKLXte9LaLKj4Chms + href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_sJdhvD6x91qENUvnr2otgp merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUm6Y99nmYz7DrTBnnMT3Hmi + href: https://finix.sandbox-payments-api.com/merchants/MUiysjyBGpiZEZYkzj7d5DhM schedule: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_aC9bWkVMfoUfXS7hkxdD3d + href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5GDvqCTAd6SrmWdsx4dUKx amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_aC9bWkVMfoUfXS7hkxdD3d/subscription_amounts - - id: SUBENROLLMENT_jaDVQHWdvBZ4EMnEQQhYVR - created_at: '2022-01-04T17:55:59.78Z' - updated_at: '2022-01-04T17:55:59.78Z' - created_by: USbkjk46XqUTQHN3i2jaVnc1 + 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: MUsw6VcdKxAdm5VZz6eFFXfW + merchant: MU7AxBA6MkF7Tee8veith3nG nickname: Security Fee started_at: '2022-11-11T16:50:59.89Z' - subscription_schedule: SUBSCHEDULE_iRNF53VNbZrb5hV9z69Ujf + subscription_schedule: SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv tags: enrollment_info: Security Fee Enrollment _links: self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_jaDVQHWdvBZ4EMnEQQhYVR + href: https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_Yxwo2Vb6oj97m3PuW9TxQ merchant: - href: https://finix.sandbox-payments-api.com/merchants/MUsw6VcdKxAdm5VZz6eFFXfW + href: https://finix.sandbox-payments-api.com/merchants/MU7AxBA6MkF7Tee8veith3nG schedule: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_iRNF53VNbZrb5hV9z69Ujf + href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_iRNF53VNbZrb5hV9z69Ujf/subscription_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: 10 + count: 2 SubscriptionAmount: description: Single subscription_amount object content: @@ -7905,9 +8236,9 @@ components: examples: Subscription Amount: value: - id: SUBAMOUNT_8vCno8tuYkhcCRHboGZ6ss - created_at: '2022-06-06T04:50:50.20Z' - updated_at: '2022-06-06T04:50:50.20Z' + 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: @@ -7916,11 +8247,10 @@ components: label: POS_INSTALLMENT_FEE nickname: POS_INSTALLMENT_FEE subscription_schedule: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ - tags: - order_number: '124' + tags: {} _links: self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_8vCno8tuYkhcCRHboGZ6ss + 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 SubscriptionAmountsList: @@ -7929,6 +8259,56 @@ components: application/hal+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 SubscriptionSchedule: description: Example response content: @@ -7936,11 +8316,11 @@ components: schema: $ref: '#/components/schemas/SubscriptionSchedule' examples: - FIXED_TIME_INTERVAL: + Subscription Schedule (FIXED_TIME_INTERVAL): value: - id: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ - created_at: '2022-01-27T07:44:05.40Z' - updated_at: '2022-01-27T07:44:05.40Z' + 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 @@ -7952,10 +8332,10 @@ components: tags: {} _links: self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ + href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts - PERIODIC_MONTHLY: + 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' @@ -7974,7 +8354,7 @@ components: 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 - PERIODIC_YEARLY: + Subscription Schedule (PERIODIC_YEARLY): value: id: SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru created_at: '2022-01-27T07:44:05.81Z' @@ -8004,247 +8384,9 @@ components: value: _embedded: subscription_schedules: - - 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 - - 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 - - id: SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ - created_at: '2022-01-27T07:44:05.40Z' - updated_at: '2022-01-27T07:44:05.40Z' - 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_uxsUJrgbQZEXsWm9toq6gZ - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts - - id: SUBSCHEDULE_kY8fuHfsoXWopwskSYKjzE - created_at: '2022-01-26T23:35:23.12Z' - updated_at: '2022-01-26T23:35:23.12Z' - 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_kY8fuHfsoXWopwskSYKjzE - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kY8fuHfsoXWopwskSYKjzE/subscription_amounts - - id: SUBSCHEDULE_kWiytjpEw7gnphwpW4nPSL - created_at: '2022-01-26T23:35:22.70Z' - updated_at: '2022-01-26T23:35:22.70Z' - 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_kWiytjpEw7gnphwpW4nPSL - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kWiytjpEw7gnphwpW4nPSL/subscription_amounts - - id: SUBSCHEDULE_kUvyQgikZkbg6p2vd6U9of - created_at: '2022-01-26T23:35:22.28Z' - updated_at: '2022-01-26T23:35:22.28Z' - 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_kUvyQgikZkbg6p2vd6U9of - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kUvyQgikZkbg6p2vd6U9of/subscription_amounts - - id: SUBSCHEDULE_bpdSWMpjwqv8w6HqDKNWfo - created_at: '2022-01-13T00:04:08.33Z' - updated_at: '2022-01-13T00:04:08.33Z' - 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_bpdSWMpjwqv8w6HqDKNWfo - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_bpdSWMpjwqv8w6HqDKNWfo/subscription_amounts - - id: SUBSCHEDULE_bnzrtYxdGkobVSb9MqYB28 - created_at: '2022-01-13T00:04:08.95Z' - updated_at: '2022-01-13T00:04:07.95Z' - 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_bnzrtYxdGkobVSb9MqYB28 - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_bnzrtYxdGkobVSb9MqYB28/subscription_amounts - - id: SUBSCHEDULE_bkXRUUeuN8AfR3RVNUn4vS - created_at: '2022-01-13T00:04:07.57Z' - updated_at: '2022-01-13T00:04:07.57Z' - 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_bkXRUUeuN8AfR3RVNUn4vS - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_bkXRUUeuN8AfR3RVNUn4vS/subscription_amounts - - id: SUBSCHEDULE_qik2T8iPqHfqDpW67mniow - created_at: '2022-01-12T22:41:23.20Z' - updated_at: '2022-01-12T22:41:23.20Z' - 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_qik2T8iPqHfqDpW67mniow - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_qik2T8iPqHfqDpW67mniow/subscription_amounts - - id: SUBSCHEDULE_qgBf9p8v3CMuDUWMGcKd8h - created_at: '2022-01-12T22:41:22.80Z' - updated_at: '2022-01-12T22:41:22.80Z' - 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_qgBf9p8v3CMuDUWMGcKd8h - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_qgBf9p8v3CMuDUWMGcKd8h/subscription_amounts - - id: SUBSCHEDULE_qeY8pHJiCo7e2fqmHyqKDV - created_at: '2022-01-12T22:41:22.42Z' - updated_at: '2022-01-12T22:41:22.42Z' - 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_qeY8pHJiCo7e2fqmHyqKDV - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_qeY8pHJiCo7e2fqmHyqKDV/subscription_amounts - - id: SUBSCHEDULE_f5TJFaSEbknvduAEg9gaE2 - created_at: '2022-01-08T00:53:51.15Z' - updated_at: '2022-01-08T00:53:51.15Z' - 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_f5TJFaSEbknvduAEg9gaE2 - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_f5TJFaSEbknvduAEg9gaE2/subscription_amounts - - id: SUBSCHEDULE_f4h5bprCWao72AYAnS89ht - created_at: '2022-01-08T00:53:50.77Z' - updated_at: '2022-01-08T00:53:50.77Z' - 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_f4h5bprCWao72AYAnS89ht - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_f4h5bprCWao72AYAnS89ht/subscription_amounts - - id: SUBSCHEDULE_f2CiEiZTqGju1TsCn1cesT - created_at: '2022-01-08T00:53:50.39Z' - updated_at: '2022-01-08T00:53:50.39Z' + - 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 @@ -8256,107 +8398,63 @@ components: tags: {} _links: self: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_f2CiEiZTqGju1TsCn1cesT - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_f2CiEiZTqGju1TsCn1cesT/subscription_amounts - - id: SUBSCHEDULE_7BVRFS8nAyBJ2h9qa5DSds - created_at: '2022-01-07T18:39:55.90Z' - updated_at: '2022-01-07T18:39:55.90Z' - 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_7BVRFS8nAyBJ2h9qa5DSds - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_7BVRFS8nAyBJ2h9qa5DSds/subscription_amounts - - id: SUBSCHEDULE_7AhAXfoxykb8z3pEXPdUaK - created_at: '2022-01-07T18:39:55.52Z' - updated_at: '2022-01-07T18:39:55.52Z' - 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_7AhAXfoxykb8z3pEXPdUaK + href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kfpANfUXxHyW2YBayXD39N amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_7AhAXfoxykb8z3pEXPdUaK/subscription_amounts - - id: SUBSCHEDULE_7yDCdvjYL4gbKYmLxAUEHE - created_at: '2022-01-07T18:39:55.13Z' - updated_at: '2022-01-07T18:39:55.13Z' + 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_7yDCdvjYL4gbKYmLxAUEHE - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_7yDCdvjYL4gbKYmLxAUEHE/subscription_amounts - - id: SUBSCHEDULE_5EwwTEScKDyMPo54mLzZwC - created_at: '2022-01-06T02:19:59.44Z' - updated_at: '2022-01-06T02:19:59.44Z' - 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_5EwwTEScKDyMPo54mLzZwC - amounts: - href: https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5EwwTEScKDyMPo54mLzZwC/subscription_amounts - - id: SUBSCHEDULE_5CWerip6qpb6eJnrENqDcD - created_at: '2022-01-06T02:19:59.07Z' - updated_at: '2022-01-06T02:19:59.07Z' - created_by: UStxEci4vXxGDWLQhNvao7YY - fixed_time_interval_offset: null + interval_count: 4 line_item_type: FEE - nickname: Yearly_Subscription_Schedule - period_offset: - day: 5 - month: 1 - subscription_type: PERIODIC_YEARLY + 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_5CWerip6qpb6eJnrENqDcD/subscription_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 + 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=20&limit=20&sort=created_at,desc&sort=id,desc + 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: 30 + count: 2 BalanceTransfer: description: Single balance_transfer object content: application/hal+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' @@ -8370,6 +8468,64 @@ components: application/hal+json: schema: $ref: '#/components/schemas/BalanceTransferList' + examples: + List of Balance Transfers: + value: + _embedded: + devices: + - id: DVtQV22Ezh7TAYazXFxYFHpb + merchant: MUu56ZGx3Xb6U9gAqKfgNisd + name: 'Finix triPOS #1' + model: MX915 + description: Mike Jones + serial_number: null + idle_message: null + enabled: true + tags: {} + created_at: '2022-08-15T20:22:26.339930Z' + updated_at: '2022-08-15T20:22:26.339930Z' + configuration_details: null + _links: + self: + href: https://finix.sandbox-payments-api.com/devices/DVtQV22Ezh7TAYazXFxYFHpb + 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 + - id: DVmcB1MTxnebU3VoqnfuatS7 + merchant: MUu56ZGx3Xb6U9gAqKfgNisd + name: 'Finix triPOS #1' + model: MX915 + description: Mike Jones + serial_number: null + idle_message: null + enabled: true + tags: {} + created_at: '2022-08-15T18:47:55.354154Z' + updated_at: '2022-08-15T18:47:55.354154Z' + configuration_details: null + _links: + self: + href: https://finix.sandbox-payments-api.com/devices/DVmcB1MTxnebU3VoqnfuatS7 + 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 + _links: + self: + href: https://finix.sandbox-payments-api.com/devices/?offset=0&limit=20&sort=created_at,desc&sort=id,desc + next: + href: https://finix.sandbox-payments-api.com/devices/?offset=20&limit=20&sort=created_at,desc&sort=id,desc + last: + href: https://finix.sandbox-payments-api.com/devices/?offset=8100&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' @@ -8384,11 +8540,12 @@ components: schema: $ref: '#/components/schemas/InstrumentUpdate' examples: - instrument_update: + 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: @@ -8408,21 +8565,53 @@ components: schema: $ref: '#/components/schemas/File' examples: - File: + File (Created): + value: + id: FILE_abki8bFEjq51eZ5w2pYFik + status: REQUIRES_UPLOAD + created_at: '2022-08-16T18:50:25.770825Z' + updated_at: '2022-08-16T18:50:25.807321Z' + linked_type: MERCHANT + linked_to: MU2n7BSovtwYsWYZF6rBnnzk + extension: null + display_name: license_file + type: DRIVERS_LICENSE_FRONT + platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN + application_id: APgPDQrLD52TYvqazjHJJchM + tags: + test_key_100: test_val_100 + identity_id: null + File (Uploading): value: - id: FILE_6rDUMaJ3znXx5XqfwWSPgd + id: FILE_abki8bFEjq51eZ5w2pYFik status: PENDING - created_at: '2022-06-06T02:20:02.67535Z' - updated_at: '2022-06-06T02:20:02.696699Z' + created_at: '2022-08-16T18:50:25.770825Z' + updated_at: '2022-08-16T18:50:25.807321Z' linked_type: MERCHANT linked_to: MU2n7BSovtwYsWYZF6rBnnzk extension: png - display_name: My Drivers License + display_name: license_file type: DRIVERS_LICENSE_FRONT platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN application_id: APgPDQrLD52TYvqazjHJJchM tags: - key_1: value_1 + test_key_100: test_val_100 + identity_id: null + File (Uploaded): + value: + id: FILE_abki8bFEjq51eZ5w2pYFik + status: UPLOADED + created_at: '2022-08-16T18:50:25.770825Z' + updated_at: '2022-08-16T18:50:25.807321Z' + linked_type: MERCHANT + linked_to: MU2n7BSovtwYsWYZF6rBnnzk + extension: png + display_name: license_file + type: DRIVERS_LICENSE_FRONT + platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN + application_id: APgPDQrLD52TYvqazjHJJchM + tags: + test_key_100: test_val_100 identity_id: null headers: finix-apiuser-role: @@ -8442,139 +8631,37 @@ components: value: _embedded: files: - - id: FILE_aRmZsRVSwcCX4D5YsKT2po - status: UPLOADED - created_at: '2022-05-23T17:18:06.876484Z' - updated_at: '2022-05-23T17:18:42.256164Z' - linked_type: MERCHANT - linked_to: MUbbHSsD4wVqeRUAChKUSWUp - extension: jpg - display_name: My Drivers License - type: DRIVERS_LICENSE_FRONT - platform_id: PLbDQTEq73EP3Y4cH2mqC79R - application_id: APj9Gw6wRhpbaHJM1QtZakqH - tags: {} - identity_id: null - - id: FILE_NoT7dDubHtbmEVCuY4BS6 - status: UPLOADED - created_at: '2022-05-11T21:05:02.692726Z' - updated_at: '2022-05-11T21:05:16.710033Z' - linked_type: MERCHANT - linked_to: MUvq9viguGbYQyjRv4bev6jb - extension: jpg - display_name: Driver License Back - type: DRIVERS_LICENSE_BACK - platform_id: PLbDQTEq73EP3Y4cH2mqC79R - application_id: APj9Gw6wRhpbaHJM1QtZakqH - tags: {} - identity_id: null - - id: FILE_ueH23FN2QAFKSTLdsn29WM + - id: FILE_aBDz8kr36yeuwmVvgn9VU9 status: UPLOADED - created_at: '2022-05-11T21:04:05.961178Z' - updated_at: '2022-05-11T21:04:59.926384Z' - linked_type: MERCHANT - linked_to: MUvq9viguGbYQyjRv4bev6jb - extension: jpg - display_name: Driver License Front - type: DRIVERS_LICENSE_FRONT - platform_id: PLbDQTEq73EP3Y4cH2mqC79R - application_id: APj9Gw6wRhpbaHJM1QtZakqH - tags: {} - identity_id: null - - id: FILE_iZ815nV4rGZxnpJ8MJ8mu3 - status: INVALID - created_at: '2022-05-03T20:35:28.454644Z' - updated_at: '2022-05-03T20:36:06.932028Z' - linked_type: MERCHANT - linked_to: MUbbHSsD4wVqeRUAChKUSWUp - extension: null - display_name: My Drivers License - type: IDENTIFICATION_CARD_BACK - platform_id: PLbDQTEq73EP3Y4cH2mqC79R - application_id: APj9Gw6wRhpbaHJM1QtZakqH - tags: {} - identity_id: null - - id: FILE_rUN71sr2x5CMEcz6dw8sqc - status: INVALID - created_at: '2022-05-03T20:30:06.636335Z' - updated_at: '2022-05-03T20:30:23.087997Z' - linked_type: MERCHANT - linked_to: MUbbHSsD4wVqeRUAChKUSWUp - extension: null - display_name: My Drivers License - type: BANK_STATEMENT - platform_id: PLbDQTEq73EP3Y4cH2mqC79R - application_id: APj9Gw6wRhpbaHJM1QtZakqH - tags: {} - identity_id: null - - id: FILE_f9WpLvqTq6Bkpu6SyCKzuE - status: INVALID - created_at: '2022-05-03T20:27:26.91157Z' - updated_at: '2022-05-03T20:27:40.607099Z' - linked_type: MERCHANT - linked_to: MUbbHSsD4wVqeRUAChKUSWUp - extension: null - display_name: My Drivers License - type: PASSPORT - platform_id: PLbDQTEq73EP3Y4cH2mqC79R - application_id: APj9Gw6wRhpbaHJM1QtZakqH - tags: {} - identity_id: null - - id: FILE_aKQFmzqGXnn778SQ2sdX6U - status: INVALID - created_at: '2022-05-03T20:26:27.154557Z' - updated_at: '2022-05-03T20:26:41.263177Z' - linked_type: MERCHANT - linked_to: MUbbHSsD4wVqeRUAChKUSWUp - extension: null - display_name: My Drivers License - type: DRIVERS_LICENSE_FRONT - platform_id: PLbDQTEq73EP3Y4cH2mqC79R - application_id: APj9Gw6wRhpbaHJM1QtZakqH - tags: {} - identity_id: null - - id: FILE_6tnVVEJso3DVkY3s4zYj3s - status: INVALID - created_at: '2022-05-03T20:25:28.952093Z' - updated_at: '2022-05-03T20:25:43.885587Z' + created_at: '2022-08-18T06:38:00.719761Z' + updated_at: '2022-08-18T06:38:52.223894Z' linked_type: MERCHANT - linked_to: MUbbHSsD4wVqeRUAChKUSWUp - extension: null - display_name: My Drivers License - type: PCI_DOCUMENT - platform_id: PLbDQTEq73EP3Y4cH2mqC79R - application_id: APj9Gw6wRhpbaHJM1QtZakqH - tags: {} - identity_id: null - - id: FILE_oSNEbXokQxpd8Wjwu4Yxof - status: INVALID - created_at: '2022-05-03T20:22:15.914195Z' - updated_at: '2022-05-03T20:22:30.813932Z' - linked_type: MERCHANT - linked_to: MUbbHSsD4wVqeRUAChKUSWUp - extension: null - display_name: My Drivers License + linked_to: MU2n7BSovtwYsWYZF6rBnnzk + extension: png + display_name: pytest_file type: DRIVERS_LICENSE_FRONT - platform_id: PLbDQTEq73EP3Y4cH2mqC79R - application_id: APj9Gw6wRhpbaHJM1QtZakqH - tags: {} + platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN + application_id: APgPDQrLD52TYvqazjHJJchM + tags: + test_key_100: test_val_100 identity_id: null - - id: FILE_epWgpnUEZrETnamkChkTDu - status: INVALID - created_at: '2022-05-03T20:20:07.340786Z' - updated_at: '2022-05-03T20:20:21.829517Z' + - id: FILE_abki8bFEjq51eZ5w2pYFik + status: REQUIRES_UPLOAD + created_at: '2022-08-16T18:50:25.770825Z' + updated_at: '2022-08-16T18:50:25.807321Z' linked_type: MERCHANT - linked_to: MUbbHSsD4wVqeRUAChKUSWUp + linked_to: MU2n7BSovtwYsWYZF6rBnnzk extension: null - display_name: My Drivers License + display_name: pytest_file type: DRIVERS_LICENSE_FRONT - platform_id: PLbDQTEq73EP3Y4cH2mqC79R - application_id: APj9Gw6wRhpbaHJM1QtZakqH - tags: {} + platform_id: PLm5E6FbtCZ5vjpCaKhq5PwN + application_id: APgPDQrLD52TYvqazjHJJchM + tags: + test_key_100: test_val_100 identity_id: null page: limit: 10 - next_cursor: FILE_epWgpnUEZrETnamkChkTDu + next_cursor: FILE_abki8bFEjq51eZ5w2pYFik headers: finix-apiuser-role: $ref: '#/components/headers/finix-apiuser-role' @@ -8591,16 +8678,16 @@ components: examples: External Link: value: - id: EL_n4baDHgeidWcst61qzf1Aq - created_at: '2022-02-25T16:18:47.641122-08:00' - url: http://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/.../upload/FILE_bJecqoRPasStEPVpvKHtgA/... + id: EL_dh5YS66GePpkeSVyL4VdBL + created_at: '2022-03-22T01:07:05.074313Z' + 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 type: UPLOAD - expires_at: '2022-02-25T16:28:47.631612-08:00' + expires_at: '2022-03-22T01:22:05.070415Z' user_id: USsRhsHYZGBPnQw8CByJyEQW file_id: FILE_bJecqoRPasStEPVpvKHtgA - tags: - key: value - expired: false + duration: null + tags: {} + expired: true ExternalLinksList: description: List of external_link objects content: @@ -8612,28 +8699,29 @@ components: value: _embedded: external_links: - - id: EL_a4qV42tDFHusrPD9H44bwu - created_at: '2022-02-28T10:14:36.353919-08:00' - url: https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA/external_links/external_link_id_1 - type: DOWNLOAD - expires_at: '2022-02-28T10:24:36.347676-08:00' + - id: EL_sVv61JP93htzDFTtNhbsdd + created_at: '2022-05-24T06:50:51.94704Z' + 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 + type: UPLOAD + expires_at: '2022-05-24T07:05:51.934426Z' user_id: USsRhsHYZGBPnQw8CByJyEQW file_id: FILE_bJecqoRPasStEPVpvKHtgA duration: null - tags: - key: value + tags: {} expired: true - - id: EL_9gfWgST6hYSx4zqJ5n1C5u - created_at: '2022-02-28T10:14:25.538041-08:00' - url: https://finix.sandbox-payments-api.com/files/FILE_bJpuitRPasStEPVpvKHlkE/external_links/external_link_id_2 + - id: EL_dh5YS66GePpkeSVyL4VdBL + created_at: '2022-03-22T01:07:05.074313Z' + 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 type: UPLOAD - expires_at: '2022-02-28T10:24:25.465268-08:00' - user_id: USiCkWDhvB5nwEPgzVi2G5yH - file_id: FILE_bJpuitRPasStEPVpvKHlkE + expires_at: '2022-03-22T01:22:05.070415Z' + user_id: USsRhsHYZGBPnQw8CByJyEQW + file_id: FILE_bJecqoRPasStEPVpvKHtgA duration: null - tags: - key: value + tags: {} expired: true + page: + limit: 10 + next_cursor: EL_dh5YS66GePpkeSVyL4VdBL MerchantUpdated: description: Single Merchant object content: @@ -8641,7 +8729,7 @@ components: schema: $ref: '#/components/schemas/Merchant' examples: - mercant_name Updated: + Merchant Name Updated: value: id: MUucec6fHeaWo3VHYoSkUySM application: APgPDQrLD52TYvqazjHJJchM @@ -8659,7 +8747,7 @@ components: key_2: value_2 mcc: '0742' mid: FNX7CwmebftudY7i5mA4qF6XT - merchant_name: Finix + merchant_name: Finix Flowers settlement_funding_identifier: UNSET ready_to_settle_upon: RECONCILIATION fee_ready_to_settle_upon: RECONCILIATION @@ -8701,7 +8789,7 @@ components: key_2: value_2 mcc: '0742' mid: FNXw5a7pBKHsCSgCAyQvU2soL - merchant_name: Dunder Mifflin + merchant_name: Finxi Flowers settlement_funding_identifier: UNSET ready_to_settle_upon: SUCCESSFUL_CAPTURE fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE @@ -8745,7 +8833,7 @@ components: key_2: value_2 mcc: '0742' mid: FNXw5a7pBKHsCSgCAyQvU2soL - merchant_name: Dunder Mifflin + merchant_name: Finix Flowers settlement_funding_identifier: UNSET ready_to_settle_upon: SUCCESSFUL_CAPTURE fee_ready_to_settle_upon: SUCCESSFUL_CAPTURE @@ -8813,83 +8901,98 @@ components: List of Adjustment Transfers in a Dispute: value: _embedded: - transfers: - - id: TRrqiR7x5zwUPV5SpPSbKH8B - amount: 888888 - tags: {} - state: SUCCEEDED - trace_id: c14d481c-60eb-4338-8331-9f34b3445710 - currency: USD + disputes: + - id: DIb72obRhTmPdMG1VxDKFLrb application: APgPDQrLD52TYvqazjHJJchM - source: null - destination: null - ready_to_settle_at: '2022-01-27T07:43:03.91Z' - externally_funded: 'FALSE' - fee: 0 - statement_descriptor: null - type: DISPUTE - messages: [] - raw: null - created_at: '2022-01-27T07:43:03.94Z' - updated_at: '2022-01-27T07:43:03.48Z' - idempotency_id: null - merchant_identity: IDddHpRqwf2VsH2XB1fmLfhM - subtype: PLATFORM_CREDIT + tags: + test: sale + amount: 888888 + state: PENDING + transfer: TRkhvS4GfMKxaHyBBdkPSx6g + reason: FRAUD + message: null + action: null + identity: IDuqZpDw28f2KK6YuDk4jNLg + created_at: '2022-07-14T19:40:06.52Z' + updated_at: '2022-07-14T19:40:06.11Z' + occurred_at: '2022-07-14T19:39:00.77Z' + respond_by: '2022-07-21T19:40:06.51Z' + dispute_details: + arn: '123' _links: + self: + href: https://finix.sandbox-payments-api.com/disputes/DIb72obRhTmPdMG1VxDKFLrb 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: TRsfZUjgXSCj7k2stZR7APEn + 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 + application: APgPDQrLD52TYvqazjHJJchM + tags: + order_number: 21DFASJSAKAS amount: 888888 - tags: {} - state: SUCCEEDED - trace_id: '08cb6b23-d177-47fb-b941-1bb7b8d78f70' - currency: USD + state: PENDING + transfer: TR27JnLR2pKDXjVVcGBKrjwU + reason: FRAUD + message: null + action: null + identity: IDpYDM7J9n57q849o9E9yNrG + created_at: '2022-06-15T16:14:03.95Z' + updated_at: '2022-06-15T16:14:03.64Z' + occurred_at: '2022-06-15T16:13:04.09Z' + respond_by: '2022-06-22T16:14:03.94Z' + dispute_details: + arn: '123' + _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 application: APgPDQrLD52TYvqazjHJJchM - source: null - destination: PIe2YvpcjvoVJ6PzoRPBK137 - ready_to_settle_at: '2022-01-27T07:43:03.76Z' - externally_funded: 'FALSE' - fee: 0 - statement_descriptor: null - type: DISPUTE - messages: [] - raw: null - created_at: '2022-01-27T07:43:03.77Z' + tags: + order_number: 21DFASJSAKAS + amount: 888888 + state: PENDING + transfer: TRoTrJ3kqNTFh1P2FJ7A36Ky + reason: FRAUD + message: null + action: null + identity: IDpYDM7J9n57q849o9E9yNrG + created_at: '2022-01-27T07:43:03.74Z' updated_at: '2022-01-27T07:43:03.48Z' - idempotency_id: null - merchant_identity: IDpYDM7J9n57q849o9E9yNrG - subtype: MERCHANT_DEBIT + occurred_at: '2022-01-27T07:42:48.56Z' + respond_by: '2022-02-03T07:43:03.73Z' + dispute_details: + arn: '123' _links: + self: + href: https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk application: href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM - self: - href: https://finix.sandbox-payments-api.com/transfers/TRsfZUjgXSCj7k2stZR7APEn - merchant_identity: - href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG - payment_instruments: - href: https://finix.sandbox-payments-api.com/transfers/TRsfZUjgXSCj7k2stZR7APEn/payment_instruments - disputed_transfer: - href: https://finix.sandbox-payments-api.com/transfers/TRsfZUjgXSCj7k2stZR7APEn/disputed_transfer - destination: - href: https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137 - fee_profile: - href: https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5 + 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/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc + href: https://finix.sandbox-payments-api.com/disputes?offset=0&limit=20&sort=created_at,desc&sort=id,desc page: - next_cursor: TRsfZUjgXSCj7k2stZR7APEn + offset: 0 limit: 20 + count: 3 FileDownload: description: Example response content: @@ -9156,9 +9259,8 @@ components: Application: type: object description: '' + title: '' properties: - tags: - $ref: '#/components/schemas/Tags' id: type: string example: APxxxxxxxxxxxxxxxxxx @@ -9187,6 +9289,14 @@ components: 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`. @@ -9198,14 +9308,6 @@ components: processing_enabled: type: boolean description: 'Details if transaction processing is enabled for the `Application`. ' - settlement_enabled: - type: boolean - description: 'Details if settlement processing is enabled for the `Application`. ' - settlement_funding_identifier: - type: string - enum: - - UNSET - nullable: true ready_to_settle_upon: type: string enum: @@ -9214,14 +9316,16 @@ components: description: Details when `Authroizations` submitted under the `Application` will be ready to settle. nullable: true - fee_ready_to_settle_upon: + settlement_enabled: + type: boolean + description: 'Details if settlement processing is enabled for the `Application`. ' + settlement_funding_identifier: type: string enum: - - RECONCILIATION - - SUCCESSFUL_CAPTURE - description: Details when the `fees` of `Authroizations` submitted under - the `Application` will be ready to settle. + - UNSET nullable: true + tags: + $ref: '#/components/schemas/Tags' _links: type: object description: For your convenience, every response includes several URLs @@ -9304,24 +9408,15 @@ components: properties: href: type: string - title: '' CreateApplicationRequest: type: object x-examples: {} properties: - tags: - $ref: '#/components/schemas/Tags' entity: type: object title: IdentityEntityForm description: Information needed to verify the identity of the entity. properties: - 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 amex_mid: type: string description: Assigned amex_Mid value. If included must be 10 or 11 digits. @@ -9334,6 +9429,12 @@ components: business_address: type: object description: Primary address for the legal entity. + required: + - city + - country + - line1 + - postal_code + - region nullable: true properties: city: @@ -9610,16 +9711,9 @@ components: type: string description: 2-letter State code. nullable: true - required: - - city - - country - - line1 - - line2 - - postal_code - - region business_name: type: string - description: Merchant's full legal business name (If INDIVIDUAL\_SOLE\_PROPRIETORSHIP, + 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 @@ -9657,7 +9751,7 @@ components: statement (Length must be between 1 and 20 characters). discover_mid: type: string - description: Assigned discover_Mid value. + description: Assigned Discover Mid value. dob: type: object format: date @@ -9676,7 +9770,7 @@ components: 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) + 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 @@ -9750,9 +9844,29 @@ components: 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 @@ -9760,23 +9874,21 @@ components: nullable: true name: type: string - description: Merchant's full legal business name (If INDIVIDUAL_SOLE_PROPRIETORSHIP, - please input first name, Full legal last name and middle initial; max - 120 characters). + 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 pattern: ^(US)[a-zA-Z0-9]{16,32}$ description: ID of the `User` resource. required: - - entity - user ApplicationProfile: type: object properties: - tags: - $ref: '#/components/schemas/Tags' id: type: string example: PPxxxxxxxxxxxxxxxxxx @@ -9800,6 +9912,8 @@ components: example: RPxxxxxxxxxxxxxxxxxx pattern: ^(RP)[a-zA-Z0-9]{16,32}$ 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 @@ -9831,12 +9945,12 @@ components: UpdateApplicationProfileRequest: type: object properties: - tags: - $ref: '#/components/schemas/Tags' fee_profile: $ref: '#/components/schemas/Id' risk_profile: $ref: '#/components/schemas/Id' + tags: + $ref: '#/components/schemas/Tags' ApplicationProfilesList: type: object properties: @@ -9844,12 +9958,13 @@ components: $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` resource.' + description: '`application_profile` resources.' items: $ref: '#/components/schemas/ApplicationProfile' _links: @@ -9887,28 +10002,31 @@ components: 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` resource.' + description: '`Application` resources.' items: $ref: '#/components/schemas/Application' _links: $ref: '#/components/schemas/ListLinks' - title: ApplicationsList CreateAuthorizationRequest: type: object description: Create an `Authorization` resource. properties: - tags: - $ref: '#/components/schemas/Tags' + additional_buyer_charges: + $ref: '#/components/schemas/AdditionalBuyerCharges' + additional_purchase_data: + $ref: '#/components/schemas/AdditionalPurchaseData' amount: format: int64 type: integer @@ -9916,14 +10034,18 @@ components: to debit $1.00). currency: $ref: '#/components/schemas/Currency' + device: + $ref: '#/components/schemas/Id' + fraud_session_id: + $ref: '#/components/schemas/FraudSessionID' idempotency_id: type: string description: A randomly generated value that'll be associated with the request. nullable: true merchant: $ref: '#/components/schemas/Id' - merchant_identity: - $ref: '#/components/schemas/Id' + operation_key: + $ref: '#/components/schemas/OperationKey' processor: type: string enum: @@ -9948,19 +10070,13 @@ components: description: Name of the transaction processor. source: $ref: '#/components/schemas/Id' - additional_purchase_data: - $ref: '#/components/schemas/AdditionalPurchaseData' - fraud_session_id: - $ref: '#/components/schemas/FraudSessionID' sub_type: $ref: '#/components/schemas/SubTypeTransfer' - operation_key: - $ref: '#/components/schemas/OperationKey' - device: - $ref: '#/components/schemas/Id' + tags: + $ref: '#/components/schemas/Tags' 3d_secure_authentication: type: object - description: The 3D secure information for an authorization. + description: The information required to create a 3D secure `Authorization`. nullable: true properties: cardholder_authentication: @@ -9979,9 +10095,6 @@ components: transaction_id: type: string description: Only valid for Visa transactions - required: - - cardholder_authentication - - electronic_commerce_indicator required: - amount - currency @@ -9990,8 +10103,6 @@ components: title: Authorization description: A charge authorization properties: - tags: - $ref: '#/components/schemas/Tags' id: type: string example: AUxxxxxxxxxxxxxxxxxx @@ -10006,6 +10117,8 @@ components: 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 @@ -10032,33 +10145,21 @@ components: nullable: true expires_at: type: string - description: Authorization expiration time. + description: '`Authorization` expiration time.' format: date-time - external_responses: - type: array - nullable: true - items: - type: object - properties: - body: - type: string - content_type: - type: string - idempotency_id: - type: string - description: A randomly generated value that'll be associated with the request. - nullable: true failure_code: $ref: '#/components/schemas/FailureCode' failure_message: $ref: '#/components/schemas/FailureMessage' + idempotency_id: + type: string + description: A randomly generated value that'll be associated with the request. + nullable: true is_void: type: boolean description: Details if the `Authorization` is void. merchant_identity: $ref: '#/components/schemas/Id' - merchant: - $ref: '#/components/schemas/Id' messages: type: array description: Message field that provides additional details. This field @@ -10080,7 +10181,9 @@ components: - FAILED - SUCCEEDED - UNKNOWN - description: The state of the `Transfer`. + 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 @@ -10095,8 +10198,6 @@ components: void_state: type: string description: Details if the `Authorization` has been voided. - sub_type: - $ref: '#/components/schemas/SubTypeTransfer' _links: type: object description: For your convenience, every response includes several URLs @@ -10139,8 +10240,6 @@ components: title: AuthorizationCaptured description: A captured authorization properties: - tags: - $ref: '#/components/schemas/Tags' id: type: string example: AUxxxxxxxxxxxxxxxxxx @@ -10155,6 +10254,8 @@ components: 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 @@ -10193,21 +10294,19 @@ components: type: string content_type: type: string - idempotency_id: - type: string - description: A randomly generated value that'll be associated with the request. - nullable: true failure_code: $ref: '#/components/schemas/FailureCode' failure_message: $ref: '#/components/schemas/FailureMessage' + idempotency_id: + type: string + description: A randomly generated value that'll be associated with the request. + nullable: true is_void: type: boolean description: Details if the `Authorization` is void. merchant_identity: $ref: '#/components/schemas/Id' - merchant: - $ref: '#/components/schemas/Id' messages: type: array description: Message field that provides additional details. This field @@ -10230,6 +10329,8 @@ components: - 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 @@ -10244,8 +10345,6 @@ components: void_state: type: string description: Details if the `Authorization` has been voided. - sub_type: - $ref: '#/components/schemas/SubTypeTransfer' _links: type: object description: For your convenience, every response includes several URLs @@ -10290,11 +10389,13 @@ components: $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: @@ -10304,13 +10405,11 @@ components: title: CreateDevice description: '' properties: - tags: - $ref: '#/components/schemas/Tags' + configuration: + $ref: '#/components/schemas/ConfigurationDetails' description: type: string description: Additional information about device (e.g. self serving terminal). - configuration: - $ref: '#/components/schemas/ConfigurationDetails' merchant_id: type: string description: ID of the `Merchant` the `Device` is associated with. @@ -10326,11 +10425,17 @@ components: - ISC480 - ISMP4 - ANDROID + - LANE_3000 description: Include one of the following values to let Finix know the type of device that's being used. name: type: string description: Name of the `Device`. + tags: + $ref: '#/components/schemas/Tags' + required: + - model + - name Currency: type: string description: ISO 4217 3 letter currency code. @@ -10519,19 +10624,13 @@ components: title: Device description: '`Device` resource.' properties: - tags: - $ref: '#/components/schemas/Tags' - description: - type: string - description: Additional information about device (e.g. self serving terminal). - nullable: true id: $ref: '#/components/schemas/Id' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' - configuration_details: + device_config_details: type: object title: DeviceConfigDetails description: Information used to configure how the `Device` handles transactions. @@ -10541,6 +10640,10 @@ components: 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**). check_for_duplicate_transactions: type: boolean description: Sets whether the `Device` will check for duplicate transactions. @@ -10563,32 +10666,22 @@ components: format: int64 description: The threshold to prompt a signature when `prompt_signature` is set to **AMOUNT** (defaults to 0). - 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**). connection: type: string - description: Details if the `Device` is connected and online. + description: Details if the `Device` is connected and online. Only returned + when `include_connection parameter` provided. + 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: ID of `Device`. + description: The message that diplays on the device after a period of inactivity. nullable: true - input_details: - type: object - title: InputDetails - properties: - input_text: - type: string - selection: - type: integer - format: int64 - signature_data: - type: string merchant: type: string example: MUxxxxxxxxxxxxxxxxxx @@ -10596,8 +10689,7 @@ components: description: ID of the `Merchant` resource. model: type: string - description: Please select one of the following values which will let Finix - know the type of device being used: