# GlobalStack API

## Docs

- [Authentication](https://docs.globalstack.io/api-reference/authentication.md): Authenticate every request with your secret API key.
- [Create a beneficiary](https://docs.globalstack.io/api-reference/beneficiaries/create-a-beneficiary.md): Create a beneficiary for `fiat` payouts (offramp) or `crypto` outbound transfers.
- [Deactivate a beneficiary](https://docs.globalstack.io/api-reference/beneficiaries/deactivate-a-beneficiary.md): Deactivates a beneficiary by changing its `status` to `archived`. The beneficiary record is preserved — list and get continue to return it.
- [Fetch a beneficiary](https://docs.globalstack.io/api-reference/beneficiaries/fetch-a-beneficiary.md): Returns a single beneficiary scoped to the calling merchant.
- [List beneficiaries](https://docs.globalstack.io/api-reference/beneficiaries/list-beneficiaries.md): List beneficiaries for your merchant account.
- [Update a beneficiary](https://docs.globalstack.io/api-reference/beneficiaries/update-a-beneficiary.md): Partially updates an existing beneficiary. Returns the beneficiary in the same shape as `POST /v1/beneficiaries`.
- [Execute a conversion](https://docs.globalstack.io/api-reference/conversions/execute-a-conversion.md): Execute a conversion from a previously created conversion quote: converts the balance of the quote's source wallet into the quote's destination wallet.
- [Fetch a conversion](https://docs.globalstack.io/api-reference/conversions/fetch-a-conversion.md): Fetches a single conversion by its external id (prefixed `con_`), scoped to the calling integration.
- [List conversions](https://docs.globalstack.io/api-reference/conversions/list-conversions.md): Returns the calling integration's conversions, newest first. Results are scoped to the authenticated integration; conversions belonging to other integrations are never returned.
- [Create a customer](https://docs.globalstack.io/api-reference/customers/create-a-customer.md): Creates a new customer scoped to the calling merchant's integration.
- [Fetch a customer](https://docs.globalstack.io/api-reference/customers/fetch-a-customer.md): Returns a single customer scoped to the calling integration.
- [Get customer's verification status](https://docs.globalstack.io/api-reference/customers/get-customers-verification-status.md): Return the current or most recent verification session for the customer.
- [List customers](https://docs.globalstack.io/api-reference/customers/list-customers.md): List customers for your merchant. Filter by `type` and `kyc_status` to narrow results.
- [Start verification for a customer](https://docs.globalstack.io/api-reference/customers/start-verification-for-a-customer.md): Creates a hosted verification session for a customer scoped to the calling integration. The returned `hosted_url` is the hosted verification link that the merchant must surface to their customer to complete verification.
- [Errors](https://docs.globalstack.io/api-reference/errors.md): How the API signals failures, and the error codes you can branch on.
- [Idempotency](https://docs.globalstack.io/api-reference/idempotency.md): Safely retry write requests without creating duplicates.
- [Create a webhook endpoint](https://docs.globalstack.io/api-reference/notification-webhooks/create-a-webhook-endpoint.md): Register an HTTPS endpoint to receive webhook events for your integration.
- [Delete a webhook endpoint](https://docs.globalstack.io/api-reference/notification-webhooks/delete-a-webhook-endpoint.md): Delete a webhook endpoint. After deletion the endpoint stops receiving events and its signing secret is invalidated. Returns `404` if the endpoint does not exist in your integration.
- [Fetch a webhook endpoint](https://docs.globalstack.io/api-reference/notification-webhooks/fetch-a-webhook-endpoint.md): Fetch a single webhook endpoint by its `whr_…` id.
- [List delivery logs](https://docs.globalstack.io/api-reference/notification-webhooks/list-delivery-logs.md): Returns the delivery-attempt history for a webhook endpoint, newest first. Each row records one attempt to deliver one event: which event (`event_idempotency_key` + `topic`), the delivery leg's status, the attempt number, whether it succeeded, the HTTP status the endpoint returned, any error message…
- [List upcoming (queued) events](https://docs.globalstack.io/api-reference/notification-webhooks/list-upcoming-queued-events.md): Returns the events currently queued for delivery to a webhook endpoint (pending, not yet delivered), oldest first. Each entry identifies the event by its `event_idempotency_key` and `topic`, how many delivery attempts have been made so far, when the last attempt ran, and the `payload` that will be d…
- [List webhook endpoints](https://docs.globalstack.io/api-reference/notification-webhooks/list-webhook-endpoints.md): Returns all webhook endpoints registered for the calling integration.
- [Rotate the signing secret](https://docs.globalstack.io/api-reference/notification-webhooks/rotate-the-signing-secret.md): Rotate the signing secret for a webhook endpoint. Returns a **new** `signing_secret` (prefixed `whsec_`) in plaintext — this is the only time it is shown, so store it immediately.
- [Send (replay) an event to the endpoint](https://docs.globalstack.io/api-reference/notification-webhooks/send-replay-an-event-to-the-endpoint.md): Manually (re)send an existing event to this webhook endpoint. Identify the event by its `event_idempotency_key` (the id of an event already known to the system). The request is accepted for asynchronous delivery and the response echoes the queued event's `topic` and `status`.
- [Update a webhook endpoint](https://docs.globalstack.io/api-reference/notification-webhooks/update-a-webhook-endpoint.md): Update a webhook endpoint. This is a partial update — supply only the fields you want to change. At least one field is required.
- [Execute an offramp](https://docs.globalstack.io/api-reference/offramps/execute-an-offramp.md): Execute a previously created **offramp quote**: pays out the quote's source crypto to the quote's fiat beneficiary.
- [Fetch an offramp](https://docs.globalstack.io/api-reference/offramps/fetch-an-offramp.md): Fetches a single offramp by its external id (prefixed `ofr_`).
- [List offramps](https://docs.globalstack.io/api-reference/offramps/list-offramps.md): List offramps, newest first.
- [Execute an onramp](https://docs.globalstack.io/api-reference/onramps/execute-an-onramp.md): Execute an onramp from a previously created **onramp quote** to convert external fiat into crypto in a GlobalStack wallet.
- [Fetch an onramp](https://docs.globalstack.io/api-reference/onramps/fetch-an-onramp.md): Fetches a single onramp by its external id (prefixed `onr_`).
- [List onramps](https://docs.globalstack.io/api-reference/onramps/list-onramps.md): List onramps, newest first. Results are scoped to the authenticated integration.
- [Pagination](https://docs.globalstack.io/api-reference/pagination.md): Page through list endpoints with page and per_page.
- [Create a conversion quote](https://docs.globalstack.io/api-reference/quotes/create-a-conversion-quote.md): Creates a **conversion quote** — a short-lived, priced offer to convert the balance of one wallet (`source_wallet_id`) into another wallet (`destination_wallet_id`).
- [Create an offramp quote](https://docs.globalstack.io/api-reference/quotes/create-an-offramp-quote.md): Creates an **offramp quote** — a short-lived, priced offer to convert the crypto held by the wallet identified by `wallet_id` into fiat paid out to `beneficiary_id`.
- [Create an onramp quote](https://docs.globalstack.io/api-reference/quotes/create-an-onramp-quote.md): Creates an **onramp quote** — a short-lived, priced offer to convert fiat into the crypto held by the wallet identified by `wallet_id`.
- [Fetch a quote](https://docs.globalstack.io/api-reference/quotes/fetch-a-quote.md): Fetch a quote by ID. Use this after you create a quote with `POST /v1/onramps/quotes`, `POST /v1/offramps/quotes`, or `POST /v1/conversions/quotes`.
- [List countries](https://docs.globalstack.io/api-reference/supported-countries/list-countries.md): List countries where GlobalStack operates. Each row includes supported ISO currency codes and the payment networks available in that country.
- [List network providers](https://docs.globalstack.io/api-reference/supported-countries/list-network-providers.md): List network providers available in a country. Filter by `network` to narrow to banks, mobile money operators, or other payment networks.
- [Get currency rates](https://docs.globalstack.io/api-reference/supported-currencies/get-currency-rates.md): Get buy and sell rates for a currency against every currency it pairs with directly.
- [List currencies](https://docs.globalstack.io/api-reference/supported-currencies/list-currencies.md): List supported currencies with networks, directional transaction limits (inbound / outbound), and capability flags (`can_onramp`, `can_offramp`, `can_deposit`, `can_convert`). Flag meaning depends on `type` — see the API overview.
- [Get a transaction](https://docs.globalstack.io/api-reference/transactions/get-a-transaction.md): Fetch a transaction by its txn_… external id, scoped to the authenticated merchant. Returns 404 not_found when the id is unknown.
- [List transactions](https://docs.globalstack.io/api-reference/transactions/list-transactions.md): Unified view across `onramps`, `offramps`, `conversions`, `deposits`, and `transfers` for reconciliation and history.
- [Execute a transfer](https://docs.globalstack.io/api-reference/transfers/execute-a-transfer.md): Execute a **crypto transfer**: pay out crypto from one of your wallets to a crypto beneficiary on the wallet's currency and network. This is the crypto outbound equivalent of an offramp.
- [Fetch a transfer](https://docs.globalstack.io/api-reference/transfers/fetch-a-transfer.md): Fetch a single transfer by its `tfr_…` id. Returns `404 not_found` when the transfer does not exist.
- [List transfers](https://docs.globalstack.io/api-reference/transfers/list-transfers.md): List transfers, most recent first. Filter by `customer_id` (the sender/wallet owner), `status`, and a `created_after`/`created_before` date range. Each date filter accepts either a `YYYY-MM-DD` calendar date (UTC, inclusive of the full day) or a full ISO 8601 UTC timestamp ending in `Z` (used as the…
- [Create a wallet](https://docs.globalstack.io/api-reference/wallets/create-a-wallet.md): Create a wallet — a ledger balance in a single currency for a customer.
- [Create a wallet credential](https://docs.globalstack.io/api-reference/wallets/create-a-wallet-credential.md): Create a fiat or crypto funding credential on a wallet identified by the `wal_…` id in the path.
- [Create a wallet deposit address](https://docs.globalstack.io/api-reference/wallets/create-a-wallet-deposit-address.md): Create an on-chain receive address on a wallet for external crypto deposits.
- [Deactivate a wallet credential](https://docs.globalstack.io/api-reference/wallets/deactivate-a-wallet-credential.md): Deactivates a wallet credential by flipping its `status` to `disabled`. The credential record is preserved — list and get continue to return it.
- [Deactivate a wallet deposit address](https://docs.globalstack.io/api-reference/wallets/deactivate-a-wallet-deposit-address.md): Deactivates a wallet deposit address by flipping its `status` to `disabled`. The record is preserved — list and get continue to return it.
- [Fetch a wallet](https://docs.globalstack.io/api-reference/wallets/fetch-a-wallet.md): Returns a single wallet, including its credentials.
- [Fetch a wallet credential](https://docs.globalstack.io/api-reference/wallets/fetch-a-wallet-credential.md): Returns a single credential by its `wcr_…` external id, scoped to the wallet identified by the `wal_…` id in the path.
- [Fetch a wallet deposit address](https://docs.globalstack.io/api-reference/wallets/fetch-a-wallet-deposit-address.md): Returns a single deposit address by its `da_…` external id, scoped to the wallet identified by the `wal_…` id in the path.
- [List wallet credentials](https://docs.globalstack.io/api-reference/wallets/list-wallet-credentials.md): List funding credentials linked to a wallet. Each row is either `fiat` (bank) or `crypto` (on-chain receive identity).
- [List wallet deposit addresses](https://docs.globalstack.io/api-reference/wallets/list-wallet-deposit-addresses.md): List deposit addresses for a wallet. Filter by `status` or `network`.
- [List wallets](https://docs.globalstack.io/api-reference/wallets/list-wallets.md): Returns the calling merchant's wallets, newest first.
- [Update a wallet](https://docs.globalstack.io/api-reference/wallets/update-a-wallet.md): Partially updates an existing wallet. Returns the wallet in the same shape as `POST /v1/wallets`.
- [Build with GlobalStack](https://docs.globalstack.io/index.md): One API to accept, hold, convert, and pay out funds across 12 currencies in 18 African markets — powered by stablecoin infrastructure.
- [Quickstart](https://docs.globalstack.io/quickstart.md): From an API key to your first wallet in a few minutes.

## OpenAPI Specs

- [openapi](https://docs.globalstack.io/api-reference/openapi.json)

## Optional

- [Website](https://globalstack.io)
- [Dashboard](https://dashboard.globalstack.io)