{"items":[{"type":"link","label":"Finix API Reference","link":"/api","routeSlug":"/api"},{"type":"link","label":"Authentication","link":"/api/section/authentication","routeSlug":"/api/section/authentication"},{"type":"link","label":"Environments","link":"/api/section/environments","routeSlug":"/api/section/environments"},{"type":"link","label":"HTTP Codes and Errors","link":"/api/section/http-codes-and-errors","routeSlug":"/api/section/http-codes-and-errors"},{"type":"link","label":"Idempotent Requests","link":"/api/section/idempotent-requests","routeSlug":"/api/section/idempotent-requests"},{"type":"link","label":"Query Parameters","link":"/api/section/query-parameters","routeSlug":"/api/section/query-parameters"},{"type":"link","label":"Tags","link":"/api/section/tags","routeSlug":"/api/section/tags"},{"type":"link","label":"Versioning","link":"/api/section/versioning","routeSlug":"/api/section/versioning"},{"type":"link","label":"Postman Collection","link":"/api/section/postman-collection","routeSlug":"/api/section/postman-collection"},{"type":"separator","label":"Main Resources"},{"type":"group","label":"3D Secure Sessions","link":"/api/3d-secure-sessions","routeSlug":"/api/3d-secure-sessions","items":[{"label":"Create a 3D Secure Session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/3d-secure-sessions/create3dsecuresession","routeSlug":"/api/3d-secure-sessions/create3dsecuresession","metadata":{"seo":{"title":"Create a 3D Secure Session","description":"Create a 3D Secure Session to authenticate a buyer before you charge their card."}},"httpPath":"/3d_secure_sessions"},{"label":"Fetch a 3D Secure Session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/3d-secure-sessions/get3dsecuresession","routeSlug":"/api/3d-secure-sessions/get3dsecuresession","metadata":{"seo":{"title":"Fetch a 3D Secure Session","description":"Retrieve the details of a 3D Secure Session to check the state of the authentication and read the values the card network returned."}},"httpPath":"/3d_secure_sessions/{3d_secure_session_id}"}]},{"type":"group","label":"Authorizations","link":"/api/authorizations","routeSlug":"/api/authorizations","items":[{"label":"Create an Authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/authorizations/createauthorization","routeSlug":"/api/authorizations/createauthorization","metadata":{"seo":{"title":"Create an Authorization","description":"Create an Authorization to process a transaction."}},"httpPath":"/authorizations"},{"label":"List Authorizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/authorizations/listauthorizations","routeSlug":"/api/authorizations/listauthorizations","metadata":{"seo":{"title":"List Authorizations","description":"Retrieve a list of Authorizations."}},"httpPath":"/authorizations"},{"label":"Fetch an Authorization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/authorizations/getauthorization","routeSlug":"/api/authorizations/getauthorization","metadata":{"seo":{"title":"Fetch an Authorization","description":"Retrieve the details of a previously created Authorization."}},"httpPath":"/authorizations/{authorization_id}"},{"label":"Capture an Authorization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/authorizations/captureauthorization","routeSlug":"/api/authorizations/captureauthorization","metadata":{"seo":{"title":"Capture an Authorization","description":"Use a PUT request to capture an Authorization. If captured successfully, the transfer field of the Authorization will contain the ID of the Transfer resource that moves funds."}},"httpPath":"/authorizations/{authorization_id}"},{"label":"Void an Authorization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/authorizations/voidauthorization","routeSlug":"/api/authorizations/voidauthorization","metadata":{"seo":{"title":"Void an Authorization","description":"Use a PUT request to void an Authorization. If voided successfully, funds get released, and the transaction is incomplete. Additionally, a voided Authorization can no longer be captured. Depending on the cardholder’s issuing bank, voids can take up to seven days to remove the Authorization hold."}},"httpPath":"/authorizations/{authorization_id_void_to}"}]},{"type":"group","label":"Compliance Forms","link":"/api/compliance-forms","routeSlug":"/api/compliance-forms","items":[{"label":"Fetch a Compliance Form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/compliance-forms/getcomplianceform","routeSlug":"/api/compliance-forms/getcomplianceform","metadata":{"seo":{"title":"Fetch a Compliance Form","description":"Finix sends a webhook whenever a new Compliance Form is created for your Merchant. Using the ID, you can retrieve the Compliance Form."}},"httpPath":"/compliance_forms/{compliance_form_id}"},{"label":"Complete a Compliance Form","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/compliance-forms/updatecomplianceform","routeSlug":"/api/compliance-forms/updatecomplianceform","metadata":{"seo":{"title":"Complete a Compliance Form","description":"As part of onboarding, your Merchants need to review and agree to their Compliance Form. Afterward, you need to update their Compliance Form with details about their digital signature. Finix will update their Compliance Form with those details, along with a reference to the new signed_file with their digital signature."}},"httpPath":"/compliance_forms/{compliance_form_id}"},{"label":"List Compliance Forms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/compliance-forms/listcomplianceforms","routeSlug":"/api/compliance-forms/listcomplianceforms","metadata":{"seo":{"title":"List Compliance Forms","description":"Retrieve a list of Compliance Form resources."}},"httpPath":"/compliance_forms"}]},{"type":"group","label":"Devices","link":"/api/devices","routeSlug":"/api/devices","items":[{"label":"List Devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/listdevices","routeSlug":"/api/devices/listdevices","metadata":{"seo":{"title":"List Devices","description":"Retrieve a list of Devices."}},"httpPath":"/devices"},{"label":"Fetch a Device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/getdevice","routeSlug":"/api/devices/getdevice","metadata":{"seo":{"title":"Fetch a Device","description":"Retrieve the details of an existing Device."}},"httpPath":"/devices/{device_id}"},{"label":"Update Device","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/updatedevice","routeSlug":"/api/devices/updatedevice","metadata":{"seo":{"title":"Update Device","description":"You can either update the configuration of a device or take an action on the device"}},"httpPath":"/devices/{device_id}"},{"label":"Check Device Connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/getdeviceconnection","routeSlug":"/api/devices/getdeviceconnection","metadata":{"seo":{"title":"Check Device Connection","description":"To check the connection of the Device, include ?include_connection=true at the end of the request endpoint."}},"httpPath":"/devices/{device_id_connection}"},{"label":"List Device Metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/listdevicemetrics","routeSlug":"/api/devices/listdevicemetrics","metadata":{"seo":{"title":"List Device Metrics","description":"Finix collects and analyzes data from payment devices and terminals to generate logs, known as Device Metric objects. Each Device Metric log provides insights into device health, network connectivity, and payment processing performance."}},"httpPath":"/devices/{device_id}/device_metrics"},{"label":"Create a Merchant Device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/createmerchantdevice","routeSlug":"/api/devices/createmerchantdevice","metadata":{"seo":{"title":"Create a Merchant Device","description":"Create a Device under a Merchant."}},"httpPath":"/merchants/{merchant_id}/devices"}]},{"type":"group","label":"Disputes","link":"/api/disputes","routeSlug":"/api/disputes","items":[{"label":"List Disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/listdisputes","routeSlug":"/api/disputes/listdisputes","metadata":{"seo":{"title":"List Disputes","description":"Retrieve a list of Dispute resources."}},"httpPath":"/disputes"},{"label":"Fetch a Dispute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/getdispute","routeSlug":"/api/disputes/getdispute","metadata":{"seo":{"title":"Fetch a Dispute","description":"Retrieve the details of an existing Dispute."}},"httpPath":"/disputes/{dispute_id}"},{"label":"Update Dispute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/updatedispute","routeSlug":"/api/disputes/updatedispute","metadata":{"seo":{"title":"Update Dispute","description":"Update tags on a Dispute."}},"httpPath":"/disputes/{dispute_id}"},{"label":"Upload Files as Dispute Evidence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/createdisputeevidence","routeSlug":"/api/disputes/createdisputeevidence","metadata":{"seo":{"title":"Upload Files as Dispute Evidence","description":"Upload a file as evidence for a Dispute."}},"httpPath":"/disputes/{dispute_id}/evidence"},{"label":"List Dispute Evidence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/listdisputesevidence","routeSlug":"/api/disputes/listdisputesevidence","metadata":{"seo":{"title":"List Dispute Evidence","description":"Retrieve a list of Dispute Evidence for a Dispute."}},"httpPath":"/disputes/{dispute_id}/evidence"},{"label":"Fetch Dispute Evidence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/getdisputeevidence","routeSlug":"/api/disputes/getdisputeevidence","metadata":{"seo":{"title":"Fetch Dispute Evidence","description":"Fetch evidence uploaded for a Dispute."}},"httpPath":"/disputes/{dispute_id}/evidence/{evidence_id}"},{"label":"Update Dispute Evidence","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/updatedisputeevidence","routeSlug":"/api/disputes/updatedisputeevidence","metadata":{"seo":{"title":"Update Dispute Evidence","description":"Update tags on Dispute Evidence."}},"httpPath":"/disputes/{dispute_id}/evidence/{evidence_id}"},{"label":"Delete Dispute Evidence","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/deletedisputeevidence","routeSlug":"/api/disputes/deletedisputeevidence","metadata":{"seo":{"title":"Delete Dispute Evidence","description":"Delete a Dispute Evidence file. You can delete evidence files only before a Dispute and its uploaded evidence are submitted for the first time, and only on FINIX_V1 or DUMMY_V1."}},"httpPath":"/disputes/{dispute_id}/evidence/{evidence_id}"},{"label":"List Dispute Adjustment Transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/listdisputesadjustments","routeSlug":"/api/disputes/listdisputesadjustments","metadata":{"seo":{"title":"List Dispute Adjustment Transfers","description":"List the adjustment Transfers for a Dispute. Depending on the stage of the Dispute, different adjustment Transfer subtypes can be applied."}},"httpPath":"/disputes/{dispute_id}/adjustment_transfers"},{"label":"Submit Dispute Evidence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/submitdisputeevidence","routeSlug":"/api/disputes/submitdisputeevidence","metadata":{"seo":{"title":"Submit Dispute Evidence","description":"You can submit evidence to the issuing bank, confirming that the Merchant has completed submitting evidence and is ready to proceed with the Dispute."}},"httpPath":"/disputes/{dispute_id}/submit"},{"label":"Accept a Dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/acceptdispute","routeSlug":"/api/disputes/acceptdispute","metadata":{"seo":{"title":"Accept a Dispute","description":"You can accept a Dispute to prevent a long (and potentially expensive) process. When you accept a Dispute, you concede that the Dispute is not worth challenging or representing."}},"httpPath":"/disputes/{dispute_id}/accept"},{"label":"Download Dispute Evidence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/downloaddisputeevidence","routeSlug":"/api/disputes/downloaddisputeevidence","metadata":{"seo":{"title":"Download Dispute Evidence","description":"Download a file uploaded as Dispute Evidence."}},"httpPath":"/disputes/{dispute_id}/evidence/{evidence_id}/download"}]},{"type":"group","label":"Fees","link":"/api/fees","routeSlug":"/api/fees","items":[{"label":"List Fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees/listfees","routeSlug":"/api/fees/listfees","metadata":{"seo":{"title":"List Fees","description":"Retrieve a list of Fee resources."}},"httpPath":"/fees"},{"label":"Create a Custom Fee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees/createfee","routeSlug":"/api/fees/createfee","metadata":{"seo":{"title":"Create a Custom Fee","description":"Create a custom (i.e. one-time) Fee."}},"httpPath":"/fees"},{"label":"Fetch a Fee","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees/getfee","routeSlug":"/api/fees/getfee","metadata":{"seo":{"title":"Fetch a Fee","description":"Retrieve the details of an existing Fee."}},"httpPath":"/fees/{fee_id}"},{"label":"Update Fee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees/updatefee","routeSlug":"/api/fees/updatefee","metadata":{"seo":{"title":"Update Fee","description":"Update the details of a Fee."}},"httpPath":"/fees/{fee_id}"}]},{"type":"group","label":"Fee Profiles","link":"/api/fee-profiles","routeSlug":"/api/fee-profiles","items":[{"label":"Create a Fee Profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fee-profiles/createfeeprofile","routeSlug":"/api/fee-profiles/createfeeprofile","metadata":{"seo":{"title":"Create a Fee Profile","description":"Create a Fee Profile."}},"httpPath":"/fee_profiles"},{"label":"List Fee Profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fee-profiles/listfeeprofiles","routeSlug":"/api/fee-profiles/listfeeprofiles","metadata":{"seo":{"title":"List Fee Profiles","description":"Retrieve a list of Fee Profile resources."}},"httpPath":"/fee_profiles"},{"label":"Fetch a Fee Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fee-profiles/getfeeprofile","routeSlug":"/api/fee-profiles/getfeeprofile","metadata":{"seo":{"title":"Fetch a Fee Profile","description":"Retrieve the details of an existing Fee Profile."}},"httpPath":"/fee_profiles/{fee_profile_id}"}]},{"type":"group","label":"Files","link":"/api/files","routeSlug":"/api/files","items":[{"label":"Create a File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/createfile","routeSlug":"/api/files/createfile","metadata":{"seo":{"title":"Create a File","description":"Before uploading a file, you must create a File resource."}},"httpPath":"/files"},{"label":"List Files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/listfiles","routeSlug":"/api/files/listfiles","metadata":{"seo":{"title":"List Files","description":"Retrieve a list of File resources."}},"httpPath":"/files"},{"label":"Fetch a File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/getfile","routeSlug":"/api/files/getfile","metadata":{"seo":{"title":"Fetch a File","description":"Retrieve the details of an existing File."}},"httpPath":"/files/{file_id}"},{"label":"List External Links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/listexternallinks","routeSlug":"/api/files/listexternallinks","metadata":{"seo":{"title":"List External Links","description":"List the previously created External Link resources for a File."}},"httpPath":"/files/{file_id}/external_links"},{"label":"Create an External Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/createexternallink","routeSlug":"/api/files/createexternallink","metadata":{"seo":{"title":"Create an External Link","description":"Create an External Link to share with users so they can upload files directly from their browser. For more info, see Uploading files to Finix."}},"httpPath":"/files/{file_id}/external_links"},{"label":"Upload a File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/uploadfile","routeSlug":"/api/files/uploadfile","metadata":{"seo":{"title":"Upload a File","description":"Upload files directly with a multipart/form-data request."}},"httpPath":"/files/{file_id}/upload"},{"label":"Download a File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/downloadfile file that was uploaded to a `file` resource.","routeSlug":"/api/files/downloadfile file that was uploaded to a `file` resource.","metadata":{"seo":{"title":"Download a File","description":"Download a File"}},"httpPath":"/files/{file_id}/download"},{"label":"Fetch an External Link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/getexternallink","routeSlug":"/api/files/getexternallink","metadata":{"seo":{"title":"Fetch an External Link","description":"Fetch a previously created External Link resource."}},"httpPath":"/files/{file_id}/external_links/{external_link_id}"}]},{"type":"group","label":"Identities","link":"/api/identities","routeSlug":"/api/identities","items":[{"label":"Create an Identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/createidentity","routeSlug":"/api/identities/createidentity","metadata":{"seo":{"title":"Create an Identity","description":"Create an Identity for your Buyer, Recipient, or Seller, using identity_roles and type to indicate the type of Identity you're creating."}},"httpPath":"/identities"},{"label":"List Identities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/listidentities","routeSlug":"/api/identities/listidentities","metadata":{"seo":{"title":"List Identities","description":"Retrieve a list the previously created Identities."}},"httpPath":"/identities"},{"label":"Fetch an Identity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/getidentity","routeSlug":"/api/identities/getidentity","metadata":{"seo":{"title":"Fetch an Identity","description":"Retrieve the details of a previously created Identity."}},"httpPath":"/identities/{identity_id}"},{"label":"Update an Identity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/updateidentity","routeSlug":"/api/identities/updateidentity","metadata":{"seo":{"title":"Update an Identity","description":"Update an existing Identity."}},"httpPath":"/identities/{identity_id}"},{"label":"Create an Associated Identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/createassociatedidentity","routeSlug":"/api/identities/createassociatedidentity","metadata":{"seo":{"title":"Create an Associated Identity","description":"Create an associated Identity for every owner with 25% or more ownership over the merchant."}},"httpPath":"/identities/{identity_id}/associated_identities"},{"label":"List Associated Identities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/listidentityassociatedidentities","routeSlug":"/api/identities/listidentityassociatedidentities","metadata":{"seo":{"title":"List Associated Identities","description":"Retrieve a list of Associated Identities for an Identity."}},"httpPath":"/identities/{identity_id}/associated_identities"},{"label":"Fetch an Identity's Merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/getidentitymerchant","routeSlug":"/api/identities/getidentitymerchant","metadata":{"seo":{"title":"Fetch an Identity's Merchant","description":"Retrieve the Merchant resource for an Identity."}},"httpPath":"/identities/{identity_id}/merchants"}]},{"type":"group","label":"Merchants","link":"/api/merchants","routeSlug":"/api/merchants","items":[{"label":"Create a Merchant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/merchants/createmerchant","routeSlug":"/api/merchants/createmerchant","metadata":{"seo":{"title":"Create a Merchant","description":"Create a Merchant to start the underwriting (also called provisioning) process for your seller. Merchants must be created under an Identity."}},"httpPath":"/identities/{identity_id}/merchants"},{"label":"List Merchants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/merchants/listmerchants","routeSlug":"/api/merchants/listmerchants","metadata":{"seo":{"title":"List Merchants","description":"Retrieve a list of Merchant resources."}},"httpPath":"/merchants"},{"label":"Fetch a Merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/merchants/getmerchant","routeSlug":"/api/merchants/getmerchant","metadata":{"seo":{"title":"Fetch a Merchant","description":"Retrieve the details of a Merchant."}},"httpPath":"/merchants/{merchant_id}"},{"label":"Update a Merchant","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/merchants/updatemerchant","routeSlug":"/api/merchants/updatemerchant","metadata":{"seo":{"title":"Update a Merchant","description":"Update a Merchant to:"}},"httpPath":"/merchants/{merchant_id}"},{"label":"Verify a Merchant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/merchants/createmerchantverification","routeSlug":"/api/merchants/createmerchantverification","metadata":{"seo":{"title":"Verify a Merchant","description":"Create a Verification on a Merchant to get them Approved. This request will create a new PENDING Verification. Listen to updates and re-fetch the Verification when it is SUCCEEDED or FAILED."}},"httpPath":"/merchants/{merchant_id}/verifications"}]},{"type":"group","label":"Microdeposits","link":"/api/microdeposits","routeSlug":"/api/microdeposits","items":[{"label":"List Microdeposits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/microdeposits/listmicrodeposits","routeSlug":"/api/microdeposits/listmicrodeposits","metadata":{"seo":{"title":"List Microdeposits","description":"Retrieve a list of Microdeposit resources. Filter by payment_instrument_id to find microdeposits for a specific Payment Instrument."}},"httpPath":"/microdeposits"},{"label":"Fetch a Microdeposit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/microdeposits/getmicrodeposit","routeSlug":"/api/microdeposits/getmicrodeposit","metadata":{"seo":{"title":"Fetch a Microdeposit","description":"Retrieve the details of a Microdeposit to check the verification's status, remaining submission tries, and expiration."}},"httpPath":"/microdeposits/{microdeposit_id}"}]},{"type":"group","label":"Onboarding Forms","link":"/api/onboarding-forms","routeSlug":"/api/onboarding-forms","items":[{"label":"Create an Onboarding Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/onboarding-forms/createonboardingform","routeSlug":"/api/onboarding-forms/createonboardingform","metadata":{"seo":{"title":"Create an Onboarding Form","description":"Create an Onboarding Form by entering the processor’s name you want to onboard users to. Also, provide the links to send users after they finish or leave the form."}},"httpPath":"/onboarding_forms"},{"label":"Fetch an Onboarding Form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/onboarding-forms/getonboardingform","routeSlug":"/api/onboarding-forms/getonboardingform","metadata":{"seo":{"title":"Fetch an Onboarding Form","description":"Retrieve the details of an existing Onboarding Form."}},"httpPath":"/onboarding_forms/{onboarding_form_id}"},{"label":"Create an Onboarding Form Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/onboarding-forms/createonboardingformlink","routeSlug":"/api/onboarding-forms/createonboardingformlink","metadata":{"seo":{"title":"Create an Onboarding Form Link","description":"Create a link that lets users resume their Onboarding Form."}},"httpPath":"/onboarding_forms/{onboarding_form_id}/links"}]},{"type":"group","label":"Payment Instruments","link":"/api/payment-instruments","routeSlug":"/api/payment-instruments","items":[{"label":"Create a Payment Instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/createpaymentinstrument","routeSlug":"/api/payment-instruments/createpaymentinstrument","metadata":{"seo":{"title":"Create a Payment Instrument","description":"Create a Payment Instrument resource using a card or bank account."}},"httpPath":"/payment_instruments"},{"label":"List Payment Instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/listpaymentinstruments","routeSlug":"/api/payment-instruments/listpaymentinstruments","metadata":{"seo":{"title":"List Payment Instruments","description":"Retrieve a list of Payment Instrument resources."}},"httpPath":"/payment_instruments"},{"label":"Fetch a Payment Instrument","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/getpaymentinstrument","routeSlug":"/api/payment-instruments/getpaymentinstrument","metadata":{"seo":{"title":"Fetch a Payment Instrument","description":"Retrieve the details of an existing Payment Instrument."}},"httpPath":"/payment_instruments/{payment_instrument_id}"},{"label":"Update a Payment Instrument","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/updatepaymentinstrument","routeSlug":"/api/payment-instruments/updatepaymentinstrument","metadata":{"seo":{"title":"Update a Payment Instrument","description":"Update a Payment Instrument to:"}},"httpPath":"/payment_instruments/{payment_instrument_id}"},{"label":"List Instrument History Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/listinstrumenthistoryentries","routeSlug":"/api/payment-instruments/listinstrumenthistoryentries","metadata":{"seo":{"title":"List Instrument History Entries","description":"Whenever a stored payment card's details are updated, an Instrument History Entry is created. Use this endpoint to retrieve a list of Instrument History Entries for a specific Payment Instrument."}},"httpPath":"/payment_instruments/{payment_instrument_id}/instrument_history"},{"label":"Verify CVV, AVS, and Name","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/createpaymentinstrumentverification","routeSlug":"/api/payment-instruments/createpaymentinstrumentverification","metadata":{"seo":{"title":"Verify CVV, AVS, and Name","description":"Verify a Payment Instrument to determine CVV, AVS, and name verification results."}},"httpPath":"/payment_instruments/{payment_instrument_id_verify}"},{"label":"Verify Push-to-Card Eligibility","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/createpaymentinstrumentverificationpushtocard","routeSlug":"/api/payment-instruments/createpaymentinstrumentverificationpushtocard","metadata":{"seo":{"title":"Verify Push-to-Card Eligibility","description":"Determine Push To Card eligibility for Push To Card customers."}},"httpPath":"/payment_instruments/{payment_instrument_id_verify}/verifications"},{"label":"Create an Apple Pay Session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/createapplepaysession","routeSlug":"/api/payment-instruments/createapplepaysession","metadata":{"seo":{"title":"Create an Apple Pay Session","description":"Create an apple_pay_session to process Apple Pay transactions on the web."}},"httpPath":"/apple_pay_sessions"}]},{"type":"group","label":"Payment Instrument Associations","link":"/api/payment-instrument-associations","routeSlug":"/api/payment-instrument-associations","items":[{"label":"Create a Payment Instrument Association","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instrument-associations/createpaymentinstrumentassociation","routeSlug":"/api/payment-instrument-associations/createpaymentinstrumentassociation","metadata":{"seo":{"title":"Create a Payment Instrument Association","description":"Create a Payment Instrument Association to associate a Payment Instrument with a Merchant for fee assignment purposes."}},"httpPath":"/payment_instrument_associations"},{"label":"List Payment Instrument Associations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instrument-associations/listpaymentinstrumentassociations","routeSlug":"/api/payment-instrument-associations/listpaymentinstrumentassociations","metadata":{"seo":{"title":"List Payment Instrument Associations","description":"Retrieve a list of Payment Instrument Association resources."}},"httpPath":"/payment_instrument_associations"},{"label":"Fetch a Payment Instrument Association","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instrument-associations/getpaymentinstrumentassociation","routeSlug":"/api/payment-instrument-associations/getpaymentinstrumentassociation","metadata":{"seo":{"title":"Fetch a Payment Instrument Association","description":"Retrieve the details of an existing Payment Instrument Association."}},"httpPath":"/payment_instrument_associations/{payment_instrument_association_id}"},{"label":"Update a Payment Instrument Association","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instrument-associations/updatepaymentinstrumentassociation","routeSlug":"/api/payment-instrument-associations/updatepaymentinstrumentassociation","metadata":{"seo":{"title":"Update a Payment Instrument Association","description":"Update the tags of an existing Payment Instrument Association."}},"httpPath":"/payment_instrument_associations/{payment_instrument_association_id}"}]},{"type":"group","label":"Settlements","link":"/api/settlements","routeSlug":"/api/settlements","items":[{"label":"List Settlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlements","routeSlug":"/api/settlements/listsettlements","metadata":{"seo":{"title":"List Settlements","description":"Retrieve a list of Settlement resources."}},"httpPath":"/settlements"},{"label":"Fetch a Settlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/getsettlement","routeSlug":"/api/settlements/getsettlement","metadata":{"seo":{"title":"Fetch a Settlement","description":"Retrieve the details of an existing Settlement."}},"httpPath":"/settlements/{settlement_id}"},{"label":"Close a Settlement","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/closesettlements","routeSlug":"/api/settlements/closesettlements","metadata":{"seo":{"title":"Close a Settlement","description":"Close an accruing Settlement. Finix, by default, creates accruing settlements then closes them based on your payout configurations. Use this endpoint to manually close a specific settlement."}},"httpPath":"/settlements/{settlement_id}"},{"label":"List all Entries in a Settlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlemententries","routeSlug":"/api/settlements/listsettlemententries","metadata":{"seo":{"title":"List all Entries in a Settlement","description":"Retrieve a list of every Settlement Entry in a Settlement. A Settlement Entry is an object that describes the item inside of a Settlement."}},"httpPath":"/settlements/{settlement_id}/entries"},{"label":"Delete Settlement Entries","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/removesettlemententries","routeSlug":"/api/settlements/removesettlemententries","metadata":{"seo":{"title":"Delete Settlement Entries","description":"Remove a Settlement Entry or list of Settlement Entries that make up a Settlement."}},"httpPath":"/settlements/{settlement_id}/entries"},{"label":"List Settlement Fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlementfees","routeSlug":"/api/settlements/listsettlementfees","metadata":{"seo":{"title":"List Settlement Fees","description":"Retrieve a list of Fee resources belonging to a Settlement."}},"httpPath":"/settlements/{settlement_id}/fees"},{"label":"List Settlement Funding Transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlementfundingtransfers","routeSlug":"/api/settlements/listsettlementfundingtransfers","metadata":{"seo":{"title":"List Settlement Funding Transfers","description":"List the funding Transfer resources created when a Settlement was approved with a type of CREDIT or DEBIT."}},"httpPath":"/settlements/{settlement_id}/funding_transfers"},{"label":"Delete Settlement Transfers","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/removesettlementtransfers","routeSlug":"/api/settlements/removesettlementtransfers","metadata":{"seo":{"title":"Delete Settlement Transfers","description":"This endpoint is deprecated.Use Delete Settlement Entries instead."}},"httpPath":"/settlements/{settlement_id}/transfers"},{"label":"List all Transfers in a Settlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlementtransfers","routeSlug":"/api/settlements/listsettlementtransfers","metadata":{"seo":{"title":"List all Transfers in a Settlement","description":"This endpoint is deprecated.Use List all Entries in a Settlement instead."}},"httpPath":"/settlements/{settlement_id}/transfers"},{"label":"List Settlement Funding Transfer Attempts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlementfundingtransferattempts","routeSlug":"/api/settlements/listsettlementfundingtransferattempts","metadata":{"seo":{"title":"List Settlement Funding Transfer Attempts","description":"Lists all settlement Funding Transfer Attempt resources associated for the Settlement. A Funding Transfer Attempt resource is created when requesting an instant payout of funds for the Settlement."}},"httpPath":"/settlements/{settlement_id}/funding_transfer_attempts"},{"label":"Create Settlement Funding Transfer Attempt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/createsettlementfundingtransferattempt","routeSlug":"/api/settlements/createsettlementfundingtransferattempt","metadata":{"seo":{"title":"Create Settlement Funding Transfer Attempt","description":"Create a Funding Transfer Attempt for this Settlement. Funding transfer attempts are used to submit funds for instant payout."}},"httpPath":"/settlements/{settlement_id}/funding_transfer_attempts"}]},{"type":"group","label":"Settlement Queue Entries","link":"/api/settlement-queue-entries","routeSlug":"/api/settlement-queue-entries","items":[{"label":"List Settlement Queue Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlement-queue-entries/listsettlementqueueentries","routeSlug":"/api/settlement-queue-entries/listsettlementqueueentries","metadata":{"seo":{"title":"List Settlement Queue Entries","description":"Retrieve a list of Settlement Queue Entry resources."}},"httpPath":"/settlement_queue_entries"},{"label":"Release Settlement Queue Entries","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlement-queue-entries/updatesettlementqueueentries","routeSlug":"/api/settlement-queue-entries/updatesettlementqueueentries","metadata":{"seo":{"title":"Release Settlement Queue Entries","description":"This action is used to release a number of Settlement Queue Entry resources, allowing them to be included in a Settlement as Settlement Entry resources."}},"httpPath":"/settlement_queue_entries"},{"label":"Fetch a Settlement Queue Entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlement-queue-entries/getsettlementqueueentry","routeSlug":"/api/settlement-queue-entries/getsettlementqueueentry","metadata":{"seo":{"title":"Fetch a Settlement Queue Entry","description":"Retrieve the details of a Settlement Queue Entry created from a Transfer, Fee, or Reversal."}},"httpPath":"/settlement_queue_entries/{settlement_queue_entry_id}"}]},{"type":"group","label":"Split Transfers","link":"/api/split-transfers","routeSlug":"/api/split-transfers","items":[{"label":"List Fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/split-transfers/listfees","routeSlug":"/api/split-transfers/listfees","metadata":{"seo":{"title":"List Fees","description":"Retrieve a list of Fee resources."}},"httpPath":"/fees"},{"label":"List Split Transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/split-transfers/listsplittransfers","routeSlug":"/api/split-transfers/listsplittransfers","metadata":{"seo":{"title":"List Split Transfers","description":"Retrieve a list of Split Transfer resources created for a specific split Transfer."}},"httpPath":"/split_transfers"},{"label":"Fetch a Split Transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/split-transfers/getsplittransfer","routeSlug":"/api/split-transfers/getsplittransfer","metadata":{"seo":{"title":"Fetch a Split Transfer","description":"Fetch a Split Transfer that was created from a split transaction."}},"httpPath":"/split_transfers/{split_transfer_id}"}]},{"type":"group","label":"Transfers","link":"/api/transfers","routeSlug":"/api/transfers","items":[{"label":"Create a Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/createtransfer","routeSlug":"/api/transfers/createtransfer","metadata":{"seo":{"title":"Create a Transfer","description":"Create a Transfer."}},"httpPath":"/transfers"},{"label":"List Transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/listtransfers","routeSlug":"/api/transfers/listtransfers","metadata":{"seo":{"title":"List Transfers","description":"Retrieve a list of Transfers."}},"httpPath":"/transfers"},{"label":"Fetch a Transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/gettransfer","routeSlug":"/api/transfers/gettransfer","metadata":{"seo":{"title":"Fetch a Transfer","description":"Retrieve a Transfer."}},"httpPath":"/transfers/{transfer_id}"},{"label":"Update a Transfer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/updatetransfer","routeSlug":"/api/transfers/updatetransfer","metadata":{"seo":{"title":"Update a Transfer","description":"Update a Transfer."}},"httpPath":"/transfers/{transfer_id}"},{"label":"Refund or Reverse a Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/createtransferreversal","routeSlug":"/api/transfers/createtransferreversal","metadata":{"seo":{"title":"Refund or Reverse a Transfer","description":"Reverse a transfer with a type of DEBIT. This reversal creates a new Transfer resource with a type of REVERSAL."}},"httpPath":"/transfers/{transfer_id}/reversals"},{"label":"List Transfer Reversals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/listtransferreversals","routeSlug":"/api/transfers/listtransferreversals","metadata":{"seo":{"title":"List Transfer Reversals","description":"Retrieve a list of reversals for a Transfer."}},"httpPath":"/transfers/{transfer_id}/reversals"}]},{"type":"group","label":"Users","link":"/api/users","routeSlug":"/api/users","items":[{"label":"List Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/listusers","routeSlug":"/api/users/listusers","metadata":{"seo":{"title":"List Users","description":"Retrieve a list of User resources."}},"httpPath":"/users"},{"label":"Fetch a User by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/getuser","routeSlug":"/api/users/getuser","metadata":{"seo":{"title":"Fetch a User by ID","description":"Retrieve the details of an existing User."}},"httpPath":"/users/{user_id}"},{"label":"Update a User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/updateuser","routeSlug":"/api/users/updateuser","metadata":{"seo":{"title":"Update a User","description":"Update a User with new tags or disable the User and their credentials."}},"httpPath":"/users/{user_id}"}]},{"type":"group","label":"Verifications","link":"/api/verifications","routeSlug":"/api/verifications","items":[{"label":"List Merchant Verifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/verifications/listmerchantverifications","routeSlug":"/api/verifications/listmerchantverifications","metadata":{"seo":{"title":"List Merchant Verifications","description":"Retrieve a list of all the Verifications for a Merchant resource."}},"httpPath":"/merchants/{merchant_id}/verifications"},{"label":"List Verifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/verifications/listverifications","routeSlug":"/api/verifications/listverifications","metadata":{"seo":{"title":"List Verifications","description":"Retrieve a list of Verification resources."}},"httpPath":"/verifications"},{"label":"Fetch a Verification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/verifications/getverification","routeSlug":"/api/verifications/getverification","metadata":{"seo":{"title":"Fetch a Verification","description":"Retrieve the details of an existing Verification."}},"httpPath":"/verifications/{verification_id}"}]},{"type":"group","label":"Webhooks","link":"/api/webhooks","routeSlug":"/api/webhooks","items":[{"label":"Create a Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhooks/createwebhook","routeSlug":"/api/webhooks/createwebhook","metadata":{"seo":{"title":"Create a Webhook","description":"Create a Webhook to receive webhook events for specified entities (e.g., transfer, merchant) to a URL provided by you. When an enabled event occurs, Finix sends a POST request to this URL with the webhook event payload."}},"httpPath":"/webhooks"},{"label":"List Webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhooks/listwebhooks","routeSlug":"/api/webhooks/listwebhooks","metadata":{"seo":{"title":"List Webhooks","description":"Retrieve a list of Webhook resources."}},"httpPath":"/webhooks"},{"label":"Fetch a Webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhooks/getwebhook","routeSlug":"/api/webhooks/getwebhook","metadata":{"seo":{"title":"Fetch a Webhook","description":"Retrieve the details of an existing Webhook."}},"httpPath":"/webhooks/{webhook_id}"},{"label":"Update Webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhooks/updatewebhook","routeSlug":"/api/webhooks/updatewebhook","metadata":{"seo":{"title":"Update Webhook","description":"Update an existing Webhook to:"}},"httpPath":"/webhooks/{webhook_id}"}]},{"type":"separator","label":"Low-Code / No-Code Resources"},{"type":"group","label":"Gateway Integrations","link":"/api/gateway-integrations","routeSlug":"/api/gateway-integrations","items":[{"label":"Create a Gateway Integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/gateway-integrations/creategatewayintegration","routeSlug":"/api/gateway-integrations/creategatewayintegration","metadata":{"seo":{"title":"Create a Gateway Integration","description":"Create a Gateway Integration that connects a Merchant to a third-party payment gateway. At this time, the only supported gateway is Cybersource."}},"httpPath":"/gateway_integrations"},{"label":"List Gateway Integrations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/gateway-integrations/listgatewayintegrations","routeSlug":"/api/gateway-integrations/listgatewayintegrations","metadata":{"seo":{"title":"List Gateway Integrations","description":"Retrieve a list of Gateway Integration resources."}},"httpPath":"/gateway_integrations"},{"label":"Fetch a Gateway Integration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/gateway-integrations/getgatewayintegration","routeSlug":"/api/gateway-integrations/getgatewayintegration","metadata":{"seo":{"title":"Fetch a Gateway Integration","description":"Retrieve the details of an existing Gateway Integration."}},"httpPath":"/gateway_integrations/{gateway_integration_id}"}]},{"type":"group","label":"Receipts","link":"/api/receipts","routeSlug":"/api/receipts","items":[{"label":"Create a Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/receipts/createreceipt","routeSlug":"/api/receipts/createreceipt","metadata":{"seo":{"title":"Create a Receipt","description":"Create a Receipt resource to generate a receipt for aTransfer or Authorization. Receipts aresupported for DEBIT and REVERSAL transfers, as well as CREDIT transfersfrom unreferenced refunds."}},"httpPath":"/receipts"},{"label":"Fetch a Receipt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/receipts/getreceipt","routeSlug":"/api/receipts/getreceipt","metadata":{"seo":{"title":"Fetch a Receipt","description":"Retrieve the details of an existing Receipt."}},"httpPath":"/receipts/{receipt_id}"},{"label":"Create a Delivery Attempt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/receipts/createreceiptdeliveryattempt","routeSlug":"/api/receipts/createreceiptdeliveryattempt","metadata":{"seo":{"title":"Create a Delivery Attempt","description":"Create a Delivery Attempt on an existing Receipt resource."}},"httpPath":"/receipts/{receipt_id}/delivery_attempts"},{"label":"List Receipt Delivery Attempts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/receipts/listreceiptdeliveryattempts","routeSlug":"/api/receipts/listreceiptdeliveryattempts","metadata":{"seo":{"title":"List Receipt Delivery Attempts","description":"List Delivery Attempts for a Receipt resource."}},"httpPath":"/receipts/{receipt_id}/delivery_attempts"}]},{"type":"group","label":"Subscriptions","link":"/api/subscriptions","routeSlug":"/api/subscriptions","items":[{"label":"Create a Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/createsubscription","routeSlug":"/api/subscriptions/createsubscription","metadata":{"seo":{"title":"Create a Subscription","description":"Create a Subscription to charge a Payment Instrument on a recurring schedule. Without a trial period, the first Transfer is created within 60 minutes of the Subscription being created."}},"httpPath":"/subscriptions"},{"label":"List Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/listsubscriptions","routeSlug":"/api/subscriptions/listsubscriptions","metadata":{"seo":{"title":"List Subscriptions","description":"Retrieve a list of Subscription resources."}},"httpPath":"/subscriptions"},{"label":"Fetch a Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/getsubscription","routeSlug":"/api/subscriptions/getsubscription","metadata":{"seo":{"title":"Fetch a Subscription","description":"Retrieve the details of a previously created Subscription."}},"httpPath":"/subscriptions/{subscription_id}"},{"label":"Update Subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/updatesubscription","routeSlug":"/api/subscriptions/updatesubscription","metadata":{"seo":{"title":"Update Subscription","description":"Update an existing Subscription resource, typically used for subscriptions created without a Subscription Plan. Note that you can only update specific resource fields."}},"httpPath":"/subscriptions/{subscription_id}"},{"label":"Cancel a Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/removesubscription","routeSlug":"/api/subscriptions/removesubscription","metadata":{"seo":{"title":"Cancel a Subscription","description":"Cancel a Subscription."}},"httpPath":"/subscriptions/{subscription_id}"},{"label":"Create a Subscription Balance Entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/createsubscriptionbalanceentry","routeSlug":"/api/subscriptions/createsubscriptionbalanceentry","metadata":{"seo":{"title":"Create a Subscription Balance Entry","description":"Create a Subscription Balance Entry. A Subscription Balance Entry represents a credit applied to a Subscription."}},"httpPath":"/subscriptions/{subscription_id}/subscription_balance_entries"},{"label":"List Subscription Balance Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/listsubscriptionbalanceentries","routeSlug":"/api/subscriptions/listsubscriptionbalanceentries","metadata":{"seo":{"title":"List Subscription Balance Entries","description":"Retrieve a list of Subscription Balance Entry resources to view a timeline of all changes to a Subscription balance by a user. Currently, only credits can modify a Subscription balance."}},"httpPath":"/subscriptions/{subscription_id}/subscription_balance_entries"},{"label":"Update Subscription Balance Entry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/updatesubscriptionbalanceentry","routeSlug":"/api/subscriptions/updatesubscriptionbalanceentry","metadata":{"seo":{"title":"Update Subscription Balance Entry","description":"Update the tags for an existing Subscription Balance Entry."}},"httpPath":"/subscriptions/{subscription_id}/subscription_balance_entries/{subscription_balance_entry_id}"}]},{"type":"group","label":"Subscription Plans","link":"/api/subscription-plans","routeSlug":"/api/subscription-plans","items":[{"label":"Create a Subscription Plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscription-plans/createsubscriptionplan","routeSlug":"/api/subscription-plans/createsubscriptionplan","metadata":{"seo":{"title":"Create a Subscription Plan","description":"Create a Subscription Plan resource to group and manage recurring payments for individual Subscription resources. You can create a Subscription Plan with or without a trial period."}},"httpPath":"/subscription_plans"},{"label":"List Subscription Plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscription-plans/listsubscriptionplans","routeSlug":"/api/subscription-plans/listsubscriptionplans","metadata":{"seo":{"title":"List Subscription Plans","description":"Retrieve a list of Subscription Plan resources."}},"httpPath":"/subscription_plans"},{"label":"Fetch a Subscription Plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscription-plans/getsubscriptionplan","routeSlug":"/api/subscription-plans/getsubscriptionplan","metadata":{"seo":{"title":"Fetch a Subscription Plan","description":"Retrieve the details of an existing Subscription Plan."}},"httpPath":"/subscription_plans/{subscription_plan_id}"},{"label":"Update Subscription Plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscription-plans/updatesubscriptionplan","routeSlug":"/api/subscription-plans/updatesubscriptionplan","metadata":{"seo":{"title":"Update Subscription Plan","description":"Update an existing Subscription Plan."}},"httpPath":"/subscription_plans/{subscription_plan_id}"}]},{"type":"group","label":"Transfer Attempts","link":"/api/transfer-attempts","routeSlug":"/api/transfer-attempts","items":[{"label":"List Transfer Attempts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfer-attempts/listtransferattempts","routeSlug":"/api/transfer-attempts/listtransferattempts","metadata":{"seo":{"title":"List Transfer Attempts","description":"Retrieve a list of all Transfer Attempt resources, or filter the results to a specific Checkout Form, Payment Link, and Payout Link using the entity_id query parameter."}},"httpPath":"/transfer_attempts"},{"label":"Fetch a Transfer Attempt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfer-attempts/gettransferattempt","routeSlug":"/api/transfer-attempts/gettransferattempt","metadata":{"seo":{"title":"Fetch a Transfer Attempt","description":"Retrieve the details of a Transfer Attempt initiated from a Checkout Form, Payment Link or Payout Link."}},"httpPath":"/transfer_attempts/{transfer_attempt_id}"}]},{"type":"separator","label":"Payout Resources"},{"type":"group","label":"Balances","link":"/api/balances","routeSlug":"/api/balances","items":[{"label":"List Balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balances/listbalances","routeSlug":"/api/balances/listbalances","metadata":{"seo":{"title":"List Balances","description":"Retrieve a list of Balance resources."}},"httpPath":"/balances"},{"label":"Fetch a Balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balances/getbalance","routeSlug":"/api/balances/getbalance","metadata":{"seo":{"title":"Fetch a Balance","description":"Retrieve the details of an existing Balance."}},"httpPath":"/balances/{balance_id}"},{"label":"List Balance Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balances/listbalanceentries","routeSlug":"/api/balances/listbalanceentries","metadata":{"seo":{"title":"List Balance Entries","description":"A Balance Entry reflects a change to an application's Balance due to a Transfer or a Balance Adjustment (i.e., \"top-up\")."}},"httpPath":"/balances/{balance_id}/balance_entries"},{"label":"Fetch a Balance Entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balances/getbalanceentry","routeSlug":"/api/balances/getbalanceentry","metadata":{"seo":{"title":"Fetch a Balance Entry","description":"Retrieve the details of a specific Balance Entry."}},"httpPath":"/balance_entries/{balance_entry_id}"}]},{"type":"group","label":"Balance Adjustments","link":"/api/balance-adjustments","routeSlug":"/api/balance-adjustments","items":[{"label":"Create a Balance Adjustment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balance-adjustments/createbalanceadjustment","routeSlug":"/api/balance-adjustments/createbalanceadjustment","metadata":{"seo":{"title":"Create a Balance Adjustment","description":"Create a Balance Adjustment to increase (i.e., 'Top-up') or decrease your account balance for Payouts."}},"httpPath":"/balance_adjustments"},{"label":"List Balance Adjustments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balance-adjustments/listbalanceadjustments","routeSlug":"/api/balance-adjustments/listbalanceadjustments","metadata":{"seo":{"title":"List Balance Adjustments","description":"Retrieve a list of Balance Adjustment resources for an Application."}},"httpPath":"/balance_adjustments"}]},{"type":"group","label":"Disbursement Rules","link":"/api/disbursement-rules","routeSlug":"/api/disbursement-rules","items":[{"label":"List Disbursement Rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disbursement-rules/listdisbursementrules","routeSlug":"/api/disbursement-rules/listdisbursementrules","metadata":{"seo":{"title":"List Disbursement Rules","description":"Retrieve a list of Disbursement Rule resources linked to an Application / Platform. Currently, there is only one Disbursement Rule object per application / platform."}},"httpPath":"/disbursement_rules"},{"label":"List Current Usages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disbursement-rules/listcurrentusages","routeSlug":"/api/disbursement-rules/listcurrentusages","metadata":{"seo":{"title":"List Current Usages","description":"Retrieve the current usage for disbursements."}},"httpPath":"/disbursement_rules/current_usages"}]}]}