# CFX Platform Docs Documentation

> Documentation for CFX Platform Docs

## Guides: Introduction
- [Platform Overview](https://docs.cfx.to/docs/key-features.md): Explore the core capabilities of the CFX platform and how they can modernise your financial operations.

## Guides: Getting Started
- [Environments](https://docs.cfx.to/docs/environments.md)
- [Transaction Prerequisite](https://docs.cfx.to/docs/copy-of-your-first-transactions.md)
- [Your First Transactions](https://docs.cfx.to/docs/your-first-transactions.md)
- [Idempotency](https://docs.cfx.to/docs/idempotency.md): Idempotency in this API is achieved by using the optional `Idempotency-Key` header

## Guides: Conventions
- [HTTP Responses](https://docs.cfx.to/docs/errors.md)
- [Webhook Events](https://docs.cfx.to/docs/webhook-events.md)

## Guides: Guides
- [Cash Deposits](https://docs.cfx.to/docs/cash-deposit.md): Implement a complete cash deposit flow that allows your customers to deposit cash at retail locations.

## API Reference: Withdraw API
- [Get Withdrawal](https://docs.cfx.to/reference/get_v1-withdrawal-id.md): Retrieve details associated with a specific withdrawal.
- [Search Withdrawal](https://docs.cfx.to/reference/get_v1-withdrawal.md): Search for Withdrawals for a given `identityId` or `organizationId`. The `identityId` or `organizationId` query parameters are mandatory. Withdrawals can be further filtered by populating the…
- [Get Withdrawal Usage](https://docs.cfx.to/reference/get_v1-withdrawal-usage.md): Retrieve withdrawal product usages for a given identity or organization.
- [List Positive Pay Decisions](https://docs.cfx.to/reference/get_v1-withdrawal-positive-pay-decisions.md): Every inbound ACH debit on one of your accounts waits in the bank's positive pay queue before it posts. Approve or deny it before `decisionDeadline` (9:00 AM Central on the presentment date). CFX…
- [Get Positive Pay Decision](https://docs.cfx.to/reference/get_v1-withdrawal-positive-pay-decisions-id.md): Every inbound ACH debit on one of your accounts waits in the bank's positive pay queue before it posts. Approve or deny it before `decisionDeadline` (9:00 AM Central on the presentment date). CFX…
- [Approve Positive Pay Decision](https://docs.cfx.to/reference/post_v1-withdrawal-positive-pay-decisions-id-approve.md): Request that the bank pays this debit. Repeating it is harmless; switching to deny is allowed until the deadline.
- [Deny Positive Pay Decision](https://docs.cfx.to/reference/post_v1-withdrawal-positive-pay-decisions-id-deny.md): Request that the bank returns this debit. Repeating it is harmless; switching to approve is allowed until the deadline.
- [Get Withdrawal Estimate](https://docs.cfx.to/reference/get_v1-withdrawal-estimate.md): Get an estimate for a Withdrawal on the CFX network.  Supply either `sourceAmount` (the amount to be debited from wallet) or `targetAmountAfterFees` (the amount to arrive at the destination) to…
- [Create Quote](https://docs.cfx.to/reference/post_v1-withdrawal-quote.md): Generate a quote for Withdrawal on the CFX network.  The Get Estimate endpoint provides a non-binding estimate for a withdrawal transaction.  This Create Quote generates a binding quote, which…
- [Accept Quote](https://docs.cfx.to/reference/post_v1-withdrawal-quote-id-accept.md): Accepts a withdrawal quote for execution.  This endpoint confirms acceptance of a quote previously generated by the Create Quote endpoint.
- [Reject Quote](https://docs.cfx.to/reference/post_v1-withdrawal-quote-id-reject.md): Rejects a withdrawal quote.
- [Get Withdrawal Quote](https://docs.cfx.to/reference/get_v1-withdrawal-quote-id.md): Retrieves a specific withdrawal quote.
- [Get Withdrawal Rates](https://docs.cfx.to/reference/get_v1-withdrawal-rate.md): Get the indicative conversion rate between a source and target currency before creating a withdrawal. Use this to preview the FX rate; binding amounts and fees are only fixed once a quote is created.
- [Get Blockchain Withdrawal](https://docs.cfx.to/reference/get_v1-withdrawal-blockchain-id.md): Retrieve a blockchain withdrawal by its ID, including its source and target details, fees, current status, settlement receipt, and full status history. Returns `400 INVALID_METHOD` if the referenced…
- [Create Blockchain Withdrawal Quote](https://docs.cfx.to/reference/post_v1-withdrawal-blockchain-quote.md): Create a binding quote to withdraw `MOVEUSD` from a ledger account to a self-custody wallet payment instrument. The quote locks in the amounts and fees and remains valid for 15 minutes; accept it via…
- [Accept Blockchain Withdrawal quote](https://docs.cfx.to/reference/post_v1-withdrawal-blockchain-quote-id-accept.md): Accept an active blockchain withdrawal quote and begin executing the withdrawal. This marks the quote `ACCEPTED`, counts it toward the entity's rolling usage limits, and begins the on-chain transfer.…
- [Get Available Africa Withdrawal Networks](https://docs.cfx.to/reference/get_v1-withdrawal-af-networks.md): List the bank and mobile-money networks that can receive African withdrawals in a given country. Use the returned network IDs and account-number types when constructing a withdrawal to that country.
- [Get Available Africa Withdrawal Channels](https://docs.cfx.to/reference/get_v1-withdrawal-af-channels.md): List the payout channels available for African withdrawals, optionally filtered by country. Each channel exposes its supported currency, minimum and maximum amounts, and fees so you can pick an…

## API Reference: Ledger Account API
- [Search for ledger accounts](https://docs.cfx.to/reference/get_v1-ledger-accounts.md): Return the ledger accounts you manage, optionally filtered by owner, underlying Solana address, or creation date. Results are paginated; if no accounts match, an empty array is returned.  Each…
- [Get a ledger account details](https://docs.cfx.to/reference/get_v1-ledger-accounts-id.md): Retrieve a single ledger account by its ID, including its current MoveUSD balance, on-chain Solana address, visibility, and the identity or organization that owns it.
- [Transfer between ledger accounts](https://docs.cfx.to/reference/post_v1-ledger-accounts-transfer.md): You can supply either Ledger Account IDs or Payment Instrument IDs (`pi_xxxxxx`) when specifying `source` and `target` values.
- [Search existing transfers](https://docs.cfx.to/reference/get_v1-ledger-accounts-transfer.md): Results is ordered by `createdAt` in descending order, if no `orderBy` is specified.
- [Get an existing transfer by ID](https://docs.cfx.to/reference/get_v1-ledger-accounts-transfer-id.md)

## API Reference: Cash Deposit Simulator API
- [Simulate Cash Deposit Barcode Scan (Auth)](https://docs.cfx.to/reference/post_v1-deposit-cash-simulate-id-scan.md): Simulates the scanning of a cash deposit barcode (Auth step). Returns a confirmationId for use with commit or void. Only available in non-production environments. For floating quotes (no amount set),…
- [Simulate Cash Deposit Barcode Commit (AuthCommit)](https://docs.cfx.to/reference/post_v1-deposit-cash-simulate-id-commit.md): Commits a previously scanned cash deposit barcode (AuthCommit step). Requires the confirmationId from the scan step. Only available in non-production environments.
- [Simulate Cash Deposit Barcode Void (AuthVoid)](https://docs.cfx.to/reference/post_v1-deposit-cash-simulate-id-void.md): Voids a previously scanned cash deposit barcode (AuthVoid step). Requires the originalRequestId from the scan step. Only available in non-production environments.

## API Reference: Deposit API
- [Get Deposit](https://docs.cfx.to/reference/get_v1-deposit-id.md): Get deposit details including the financial instrument utilised.
- [Search Deposits](https://docs.cfx.to/reference/get_v1-deposit.md): Search deposits across all payment instruments for a given identityId or organizationId.  Deposits can be further filtered by populating the `status` and `reference` parameters.  Note that cash…
- [Estimate Deposit Fees](https://docs.cfx.to/reference/get_v1-deposit-estimate.md): Preview the effective fees and quote math for a deposit without creating one.  Resolves the fee template for the chosen route. When `sourceAmount` is provided, also returns the concrete amount math…
- [Get Deposit Usage](https://docs.cfx.to/reference/get_v1-deposit-usage.md): Retrieve deposit product usages for a given identity
- [Get Cash Deposit Retailers](https://docs.cfx.to/reference/get_v1-deposit-cash-retailer.md): Retrieve the list of retailers within the CFX Network that will accept cash deposits.
- [Search Cash Deposit Locations](https://docs.cfx.to/reference/get_v1-deposit-cash-location.md): Search for nearest cash deposit locations based on a provided zipcode or latitude and longitude pair.  This endpoint will expect either a single zipcode query parameter or both the latitude and…
- [Search Cash Deposit Request](https://docs.cfx.to/reference/get_v1-deposit-cash.md): Search cash deposits requests for a given `identityId`. The `identityId` query parameter is mandatory. Deposits can be further filtered by populating the `status` and `reference` parameters.…
- [Create Cash Deposit Request](https://docs.cfx.to/reference/post_v1-deposit-cash.md): Create a cash deposit request to enable a nominated identity to subsequently deposit cash at a specified retailer.  This endpoint triggers a workflow which orchestrates the deposit of funds at a…
- [Get Cash Deposit Request](https://docs.cfx.to/reference/get_v1-deposit-cash-id.md): Retrieve a previously submitted cash deposit request.
- [Cancel Cash Deposit Request](https://docs.cfx.to/reference/post_v1-deposit-cash-id-cancel.md): **This endpoint is currently a no-op and cancels nothing.**  It returns `200` with the supplied `id` for any request, in any state. It does not validate that the deposit exists, does not check its…
- [Create US Bank ACH Deposit Request](https://docs.cfx.to/reference/post_v1-deposit-us-bank-ach.md): Creates a request to mint MOVEUSD by debiting a US bank account via ACH.  Source bank accounts need to be registered as Payment Instruments which are associated with an Identity or Organization. ACH…
- [Get US Bank ACH Deposit Request](https://docs.cfx.to/reference/get_v1-deposit-us-bank-ach-id.md): Retrieve a previously submitted US Bank ACH deposit request.

## API Reference: Organization API
- [Register Organization](https://docs.cfx.to/reference/post_v1-organization.md): Register an Organization within the CFX platform. Organizations must provide an Employer Identification Number (EIN).
- [Search Organizations](https://docs.cfx.to/reference/get_v1-organization.md): Search to retrieve organizations associated with the provided customer `referenceId`.
- [Get Organization](https://docs.cfx.to/reference/get_v1-organization-organizationid.md): Retrieve an organization by nominating a specific `organizationId`.
- [Update Organization](https://docs.cfx.to/reference/patch_v1-organization-organizationid.md): Update an organization.
- [Delete Organization](https://docs.cfx.to/reference/delete_v1-organization-organizationid.md): Delete an organization. You can no longer use a deleted organization to transact, but you can still retrieve it by ID. A customer's primary organization cannot be deleted.
- [Get the verification URL for an organization](https://docs.cfx.to/reference/post_v1-organization-id-verification-url.md): This URL can be sent to an organization to fill out.
- [Create Payment Instrument](https://docs.cfx.to/reference/post_v1-organization-organizationid-instrument.md): Create a payment instrument that will be associated with a CFX organization.
- [Search Payment Instruments](https://docs.cfx.to/reference/get_v1-organization-organizationid-instrument.md): Retrieve the list of payment instruments associated with the CFX organization.
- [Get Payment Instrument](https://docs.cfx.to/reference/get_v1-organization-organizationid-instrument-instrumentid.md): Retrieve details for a specific payment instrument.
- [Delete Payment Instrument](https://docs.cfx.to/reference/delete_v1-organization-organizationid-instrument-instrumentid.md): Delete a payment instrument.
- [Update Payment Instrument](https://docs.cfx.to/reference/patch_v1-organization-organizationid-instrument-instrumentid.md): Update the details of an existing payment instrument. Only the fields present in the request body are changed; anything omitted is left as-is. The `type` must match the stored instrument's type.
- [Create a ledger account of an organization](https://docs.cfx.to/reference/post_v1-organization-organizationid-ledger-accounts.md): Ledger accounts can hold MoveUSD and be used in transactions.
- [Search for ledger accounts of an organization](https://docs.cfx.to/reference/get_v1-organization-organizationid-ledger-accounts.md)
- [Update a ledger account of an organization](https://docs.cfx.to/reference/put_v1-organization-organizationid-ledger-accounts-id.md)
- [Get a ledger account details, belonging to an organization](https://docs.cfx.to/reference/get_v1-organization-organizationid-ledger-accounts-id.md)
- [Create a deposit memo for an organization's ledger account](https://docs.cfx.to/reference/post_v1-organization-organizationid-ledger-accounts-accountid-deposit-memos.md): Include this memo in your deposit and the funds will be sent to the given ledger account.  Only one recurring memo can be created for the same method and currency type.  **Important:** When using the…
- [Search for deposit memos for a ledger account of an organization](https://docs.cfx.to/reference/get_v1-organization-organizationid-ledger-accounts-accountid-deposit-memos.md)
- [Get a deposit memo details for an organization's ledger account](https://docs.cfx.to/reference/get_v1-organization-organizationid-ledger-accounts-accountid-deposit-memos-memo.md)
- [Initiate an organization document upload](https://docs.cfx.to/reference/post_v1-organization-organizationid-documents.md): Reserve a presigned PUT URL for uploading an organization document. After the client uploads the bytes, call the complete endpoint.
- [List organization documents](https://docs.cfx.to/reference/get_v1-organization-organizationid-documents.md): List all documents associated with an organization.
- [Complete an organization document upload](https://docs.cfx.to/reference/post_v1-organization-organizationid-documents-uploadid-complete.md): Call after the client has uploaded the file bytes to the presigned `uploadUrl`. Verifies the upload landed and activates the document.
- [Get an organization document](https://docs.cfx.to/reference/get_v1-organization-organizationid-documents-documentid.md): Fetch a single document. The response includes a short-lived presigned `downloadUrl`.
- [Delete an organization document](https://docs.cfx.to/reference/delete_v1-organization-organizationid-documents-documentid.md): Soft-delete a document and remove its stored file.
- [Add a related person to an organization](https://docs.cfx.to/reference/post_v1-organization-organizationid-related-person.md): Register a control person or beneficial owner against an organization. The person is forwarded to the KYB provider and attached to the organization's verification profile.
- [List an organization's related persons](https://docs.cfx.to/reference/get_v1-organization-organizationid-related-person.md)
- [Get a related person](https://docs.cfx.to/reference/get_v1-organization-organizationid-related-person-relatedpersonid.md)
- [Update a related person](https://docs.cfx.to/reference/patch_v1-organization-organizationid-related-person-relatedpersonid.md)
- [Remove a related person](https://docs.cfx.to/reference/delete_v1-organization-organizationid-related-person-relatedpersonid.md): Soft-delete the related person and remove the association from the KYB provider.
- [Initiate a related person document upload](https://docs.cfx.to/reference/post_v1-organization-organizationid-related-person-relatedpersonid-document.md): Reserve a presigned PUT URL for uploading a related person's identity document. After the client uploads the bytes, call the complete endpoint.
- [List a related person's documents](https://docs.cfx.to/reference/get_v1-organization-organizationid-related-person-relatedpersonid-document.md)
- [Get a related person document](https://docs.cfx.to/reference/get_v1-organization-organizationid-related-person-relatedpersonid-document-documentid.md): Fetch a single document. The response includes a short-lived presigned `downloadUrl`.
- [Delete a related person document](https://docs.cfx.to/reference/delete_v1-organization-organizationid-related-person-relatedpersonid-document-documentid.md): Soft-delete a document and remove its stored file.
- [Complete a related person document upload](https://docs.cfx.to/reference/post_v1-organization-organizationid-related-person-relatedpersonid-document-uploadid-complete.md): Call after the client has uploaded the file bytes to the presigned `uploadUrl`. Verifies the upload landed and activates the document.
- [List products available to an organization](https://docs.cfx.to/reference/get_v1-organization-organizationid-products.md): Returns every product configured for this customer with the organization's effective activation status.  Use this for product menus and route gates. For limits and usage, call `GET…

## API Reference: Identity API
- [Create a new identity](https://docs.cfx.to/reference/post_v1-identity.md): An individual/person must be registered and verified as an identity before it can perform transactions on this platform.  If you have an agreement to verify an identity yourself, please provide…
- [Search for identities](https://docs.cfx.to/reference/get_v1-identity.md): If no results are found, an empty array is returned.  To return deleted identities, `DELETED` status must be supplied explicitly for `statuses` query param.
- [Get an identity](https://docs.cfx.to/reference/get_v1-identity-id.md)
- [Update an identity](https://docs.cfx.to/reference/patch_v1-identity-id.md)
- [Delete an identity](https://docs.cfx.to/reference/delete_v1-identity-id.md): You can no longer use a deleted identity to transact, and deleting is idempotent — a second delete of the same identity returns `404`. A deleted identity is excluded from `GET /v1/identity/{id}`,…
- [Get the verification URL for an identity](https://docs.cfx.to/reference/post_v1-identity-id-verification-url.md): This URL can be send to a person to fill out. Currently, the verification only covers identity documents.
- [Create Payment Instrument](https://docs.cfx.to/reference/post_v1-identity-identityid-instrument.md): Create a payment instrument that will be associated with a CFX identity.
- [Search Payment Instruments](https://docs.cfx.to/reference/get_v1-identity-identityid-instrument.md): Retrieve the list of payment instruments associated with the CFX identity.
- [Get Payment Instrument](https://docs.cfx.to/reference/get_v1-identity-identityid-instrument-instrumentid.md): Retrieve details for a specific payment instrument.
- [Delete Payment Instrument](https://docs.cfx.to/reference/delete_v1-identity-identityid-instrument-instrumentid.md): Delete a payment instrument.
- [Update Payment Instrument](https://docs.cfx.to/reference/patch_v1-identity-identityid-instrument-instrumentid.md): Update the details of an existing payment instrument. Only the fields present in the request body are changed; anything omitted is left as-is. The `type` must match the stored instrument's type.
- [Create a ledger account of an identity](https://docs.cfx.to/reference/post_v1-identity-identityid-ledger-accounts.md): Ledger accounts can hold MoveUSD and be used in transactions.
- [Search for ledger accounts of an identity](https://docs.cfx.to/reference/get_v1-identity-identityid-ledger-accounts.md)
- [Update a ledger account of an identity](https://docs.cfx.to/reference/put_v1-identity-identityid-ledger-accounts-id.md)
- [Get a ledger account details, belonging to an identity](https://docs.cfx.to/reference/get_v1-identity-identityid-ledger-accounts-id.md)
- [Create a deposit memo for an identity's ledger account](https://docs.cfx.to/reference/post_v1-identity-identityid-ledger-accounts-accountid-deposit-memos.md): Include this memo in your deposit and the funds will be sent to the given ledger account.  Only one recurring memo can be created for the same method and currency type.  **Important:** When using the…
- [Search for deposit memos for a ledger account of an identity](https://docs.cfx.to/reference/get_v1-identity-identityid-ledger-accounts-accountid-deposit-memos.md)
- [Get a deposit memo details for an identity's ledger account](https://docs.cfx.to/reference/get_v1-identity-identityid-ledger-accounts-accountid-deposit-memos-memo.md)
- [Initiate an identity document upload](https://docs.cfx.to/reference/post_v1-identity-identityid-documents.md): Reserve a presigned PUT URL for uploading an identity document. After the client uploads the bytes, call the complete endpoint.
- [List identity documents](https://docs.cfx.to/reference/get_v1-identity-identityid-documents.md): List all documents associated with an identity.
- [Complete an identity document upload](https://docs.cfx.to/reference/post_v1-identity-identityid-documents-uploadid-complete.md): Call after the client has uploaded the file bytes to the presigned `uploadUrl`. Verifies the upload landed and activates the document.
- [Get an identity document](https://docs.cfx.to/reference/get_v1-identity-identityid-documents-documentid.md): Fetch a single document. The response includes a short-lived presigned `downloadUrl`.
- [Delete an identity document](https://docs.cfx.to/reference/delete_v1-identity-identityid-documents-documentid.md): Soft-delete a document and remove its stored file.
- [List products available to an identity](https://docs.cfx.to/reference/get_v1-identity-identityid-products.md): Returns every product configured for this customer with the identity's effective activation status.  Use this for product menus and route gates. For limits and usage, call `GET…

## API Reference: Virtual Account API
- [Search virtual accounts](https://docs.cfx.to/reference/get_v1-virtual-accounts.md): Returns a paginated list of virtual accounts owned by your account. Narrow the results by virtual account IDs or by the ledger accounts they are linked to. If no results match, an empty `items` array…
- [Get a virtual account](https://docs.cfx.to/reference/get_v1-virtual-accounts-id.md): Retrieves a single virtual account by ID, including its dedicated account/routing numbers and the per-rail deposit instructions to share with payers.
- [Update a virtual account](https://docs.cfx.to/reference/patch_v1-virtual-accounts-id.md): Updates the customer-controlled metadata of a virtual account. Only the display `name` and `referenceId` can be changed; the account/routing numbers, linked ledger account, and provider are immutable.
- [Delete a virtual account](https://docs.cfx.to/reference/delete_v1-virtual-accounts-id.md): Closes a virtual account so it can no longer receive deposits. The dedicated account and routing numbers are released and should no longer be shared with payers.
- [Create a US deposit virtual account](https://docs.cfx.to/reference/post_v1-virtual-accounts-us-deposit.md): Provisions a new US deposit virtual account linked to the given ledger account. The account is issued by an eligible provider for the ledger account's entity and comes with a dedicated US account…

## API Reference: Escrow Transfer API
- [List Escrow Transfers](https://docs.cfx.to/reference/get_v1-escrow-transfers.md): List escrows the calling customer owns. Filters compose (AND) and the customer scope is enforced server-side.
- [Create Escrow Transfer Quote](https://docs.cfx.to/reference/post_v1-escrow-transfers.md): Create an escrow transfer quote. Name the funding `source` — the sender's self-custody wallet, or one of their own ledger accounts. A wallet source gets an `unsignedTransaction` for the sender client…
- [Get Escrow Transfer](https://docs.cfx.to/reference/get_v1-escrow-transfers-id.md)
- [Accept Escrow Transfer Quote](https://docs.cfx.to/reference/post_v1-escrow-transfers-id-accept.md): Accept a quote. A `WALLET` source submits the fully-signed transaction returned at quote creation (built server-side, signed by the sender client-side); a `LEDGER_ACCOUNT` source omits it and CFX…
- [Attach Recipient](https://docs.cfx.to/reference/post_v1-escrow-transfers-id-recipient.md): Called after the recipient signs up to bind where the escrow releases to — their own wallet, or one of their ledger accounts — so the funds can be claimed. Runs inline: the 200 carries the status the…
- [Claim Escrow Transfer](https://docs.cfx.to/reference/post_v1-escrow-transfers-id-claim.md): Recipient claims the transfer; the funds are released to the recipient's wallet.
- [Reject Escrow Transfer](https://docs.cfx.to/reference/post_v1-escrow-transfers-id-reject.md): Recipient rejects; funds return to sender.
- [Cancel Escrow Transfer (Sender)](https://docs.cfx.to/reference/post_v1-escrow-transfers-id-cancel.md): Sender-initiated recall of an escrow that has not yet been claimed; the on-chain escrow is cancelled and the funds returned to the sender.
- [List Escrow Transfer Requests](https://docs.cfx.to/reference/get_v1-escrow-transfers-requests.md): List escrow transfer requests the calling customer owns. Filter by `senderId` (requests this identity sent) or `recipientPhone` (requests addressed to this phone). Filters compose (AND) and the…
- [Create Escrow Transfer Request](https://docs.cfx.to/reference/post_v1-escrow-transfers-requests.md): Create a request for payment. A request is the intent that precedes an `escrow_transfer`: the recipient (addressed by phone, possibly before sign-up) is asked to be paid. When the sender later pays,…
- [Get Escrow Transfer Request](https://docs.cfx.to/reference/get_v1-escrow-transfers-requests-id.md)
- [Cancel Escrow Transfer Request](https://docs.cfx.to/reference/post_v1-escrow-transfers-requests-id-cancel.md): Mark the request CANCELLED. Only CREATED requests can be cancelled. The caller is responsible for authorizing that the actor is the request's sender — the API enforces customer-scope only.
- [Reject Escrow Transfer Request](https://docs.cfx.to/reference/post_v1-escrow-transfers-requests-id-reject.md): Mark the request REJECTED. Only CREATED requests can be rejected. The caller is responsible for authorizing that the actor is the request's recipient — the API enforces customer-scope only.
- [Accept Escrow Transfer Request](https://docs.cfx.to/reference/post_v1-escrow-transfers-requests-id-accept.md): Record that the recipient accepted the request and was paid: links the fulfilling escrow transfer id and moves the request to SENT. Only CREATED requests can be accepted; an escrow transfer id…

## API Reference: Reward API
- [Claim Reward](https://docs.cfx.to/reference/post_v1-reward-claim.md)
- [Get Reward Claim](https://docs.cfx.to/reference/get_v1-reward-claim-id.md): Retrieve a specific reward claim by nominating the Reward Claim ID.
- [Create Reward](https://docs.cfx.to/reference/post_v1-reward.md): Create a reward for a specific CFX Identity.  Rewards are issued to a recipient through their phone number. Consequently Rewards can be issued to a recipient Identity prior to them registering within…
- [Search Rewards](https://docs.cfx.to/reference/get_v1-reward.md): Search for issued rewards.  This search capability supports the ability to nominate search criteria such as:  - Date ranges - Pagination - Limits - Sorting
- [Get Reward](https://docs.cfx.to/reference/get_v1-reward-id.md): Retrieve a specific reward by nominating the Reward ID.
- [Get Customer Reward Balance](https://docs.cfx.to/reference/get_v1-reward-balance.md): Retrieve the reward balance associated with a CFX customer. The balance illustrates the total financial exposure of the currently issued rewards.  The customer is not explicitly provided as input,…
- [Get Identity Reward Balance](https://docs.cfx.to/reference/get_v1-reward-balance-phone.md): Retrieve the reward balance for a specific recipient Identity by nominating their phone number.
- [Create Reward Event Configuration](https://docs.cfx.to/reference/post_v1-reward-event-config.md): The CFX Rewards Engine supports the automation of reward issuance based off certain CFX Network events. These can be configured to ensure Identities are issued rewards as they perform specific…
- [Search Reward Event Configurations](https://docs.cfx.to/reference/get_v1-reward-event-config.md): The CFX Rewards Engine supports the automation of reward issuance based off certain CFX Network events. This endpoint allows you to search for existing reward event configurations.  The search can be…
- [Get Reward Event Configuration](https://docs.cfx.to/reference/get_v1-reward-event-config-event.md): The CFX Rewards Engine supports the automation of reward issuance based off certain CFX Network events. This endpoint allows you to retrieve the reward configurations for a specific event.…

## API Reference: Transaction API
- [Search transactions](https://docs.cfx.to/reference/get_v1-transaction.md): Returns a unified, customer-scoped view of transactions across every payment rail (deposits, withdrawals, transfers, swaps, card spend, rewards, and more), each normalized into a single transaction…

## API Reference: Swap API
- [Get Swap Estimate](https://docs.cfx.to/reference/get_v1-swap-estimate.md): Get a non-binding estimate for a swap on the CFX network.  Given a source currency, target currency, and source amount, this returns the amount remaining after fees, the projected target amount, and…
- [Create Quote](https://docs.cfx.to/reference/post_v1-swap-quote.md): Generate a binding swap quote on the CFX network.  Unlike the non-binding Get Estimate, this locks in pricing and returns an `ACTIVE` quote together with an `unsignedTransaction` — an unsigned Solana…
- [Accept Quote](https://docs.cfx.to/reference/post_v1-swap-quote-id-accept.md): Accept an `ACTIVE` swap quote and begin execution.  Submit the quote's `unsignedTransaction`, signed with the wallet's key, as `signedTransaction`; its message bytes must match the transaction issued…
- [Reject Quote](https://docs.cfx.to/reference/post_v1-swap-quote-id-reject.md): Reject an `ACTIVE` swap quote so it can no longer be accepted.  The quote transitions to `REJECTED` and the response echoes back its `id`. Use this to explicitly discard a quote before it would…
- [Get Swap Quote](https://docs.cfx.to/reference/get_v1-swap-quote-id.md): Retrieve a single swap quote by its identifier, scoped to the calling customer.  Returns the quote's pricing, fee breakdown, wallet, and current `status`. A quote whose validity window has lapsed is…
- [Get Swap](https://docs.cfx.to/reference/get_v1-swap-id.md): Retrieves a single swap by its identifier, including the quote it was executed against and the current settlement status.  A swap is created once a quote is accepted and progresses through `CREATED`…