API integration guide for developers

Authentication and Setup

All API requests must include an Authorization header with a Bearer token. Generate your API key from the Developer section of your Yousewire dashboard. Keys are environment-scoped — use sandbox keys for testing and production keys only in live environments.

Request and response bodies use JSON. Set Content-Type: application/json on all POST and PATCH requests. The API supports idempotency keys on transfer creation — include an Idempotency-Key header to safely retry failed requests without creating duplicate transfers.

Making Your First Transfer

A complete transfer flow involves four steps: get a quote, create a beneficiary (if new), create a transfer, and then poll for status or use webhooks for real-time updates.

  • POST /v1/conversions/quote – Get FX rate and fees for a currency pair
  • POST /v1/beneficiaries – Register the recipient's bank account
  • POST /v1/transfers – Create the transfer using the quote ID
  • GET /v1/transfers/{id} or webhook – Monitor transfer status