---
title: "Create Exchange Payout"
method: POST
path: "/transactions/exchangePayout"
---

# Create Exchange Payout

`POST /transactions/exchangePayout`

Create a new exchange transaction as well as payout to an external account using a single API. The beneficiary may be created using this endpoint on the fly or an existing one can be used.

## Headers

- `idempotency-key` string

## Request body

- object
  - `accountId` string, required — Encrypted `id` of the account from where the payout will be made. e.g.`cWc4SktyWlkxM0hwcmdYe6FMdXRSQT09`
  - `amount` object, required
    - `currency` 'AED' | 'AUD' | 'CAD' | 'CHF' | 'CZK' | 'DKK' | 'EUR' | 'GBP' | 'HKD' | 'HRK' | 'HUF' | 'ILS' | 'JPY' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'RON' | 'RUB' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'USD' | 'ZAR' | 'BGN', required — Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code e.g. `EUR`
    - `value` number, float, required
  - `paymentType` string — Type of payment that the beneficiary will receive.<br>See [Supported Payment Types](https://apidocs.openpayd.com/docs/payment-types)
  - `reference` string, required — Transaction reference to be sent to the beneficiary bank. The reference will appear on the beneficiary bank statement.
  - `beneficiary` object
    - `bankAccountCountry` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'UK' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required — Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the beneficiary bank account is held. e.g. `GB`
    - `bankName` string
    - `customerType` 'CORPORATE' | 'RETAIL' — `CORPORATE`, `RETAIL`
    - `companyName` string — Required if `customerType` is `CORPORATE`.
    - `firstName` string — Required if `customerType` is `RETAIL`.
    - `middleName` string
    - `lastName` string — Required if `customerType` is `RETAIL`.
    - `beneficiaryAddressLine` string
    - `beneficiaryCity` string
    - `beneficiaryCountry` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'UK' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' — Two-letter ISO 3166-1 alpha-2 country code e.g. `GB`
    - `beneficiaryPostalCode` string
    - `iban` string — IBAN of the bank account.
    - `bic` string — SWIFT BIC of the bank account.
    - `accountNumber` string — Account number of the bank account.
    - `routingCodes` object
      - `SORT_CODE` string — Routing code value
    - `metadata` string[] — Set of key-value pairs that you can attach to the Object. Useful for storing additional, structured information on the Object. e.g your internal ID of your user etc.<br> e.g `"userId": "ABC1234"`
  - `beneficiaryId` string — Bank beneficiary id(UUID format)
  - `externalCustomerId` string — An optional id generated by you to identify the customer or beneficiary on your system.
  - `reasonCode` string — [Payout Reason Code](https://apidocs.openpayd.com/reference/reason-codes) if required for the selected `paymentType`
  - `metadata` object — Set of key-value pairs that you can attach to the Object. Useful for storing additional, structured information on the Object. e.g your internal ID of your user etc.<br> e.g `"userId":"ABC1234, "userName":"Boris Johnson"
  - `exchangeSourceAccountId` string, required — id of the Account from where the exchange will be made. e.g.cWc4SktyWlkxM0hwcmdYe6FMdXRSQT09
  - `fixedSide` 'SELL' | 'BUY', required — The side of the exchange currency pair that you wish to fix. You can fix the SELL or BUY side i.e. the source currency or destination account.
  - `exchangeCurrency` string, required — The currency to which the amount will be exchanged.
  - `quoteId` string — The id of the quote for which the exchange will take place.
  - `purposeCode` 'ACCT' | 'ADCS' | 'AGRT' | 'ALMY' | 'AREN' | 'BENE' | 'BECH' | 'BKFE' | 'BKIP' | 'BKPP' | 'BLDM' | 'BONU' | 'BOCE' | 'BEXP' | 'BNET' | 'CBTV' | 'CBLK' | 'CASH' | 'CHAR' | 'CDBL' | 'CLPR' | 'CMDT' | 'COLL' | 'COMM' | 'COMP' | 'COMC' | 'COMT' | 'CORT' | 'CPYR' | 'CSDB' | 'DEPT' | 'DERI' | 'DBTC' | 'DIVD' | 'DNTS' | 'EDUC' | 'ELEC' | 'EPAY' | 'ESTX' | 'ECPR' | 'EXTD' | 'FEES' | 'FORW' | 'FREX' | 'FAND' | 'FUTR' | 'FNET' | 'FXNT' | 'GAMB' | 'GASB' | 'GDSV' | 'GIFT' | 'GOVT' | 'GSCB' | 'HEDG' | 'HLRP' | 'HLST' | 'HLTI' | 'HREC' | 'HSTX' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INSM' | 'INTE' | 'INTC' | 'INTP' | 'INVS' | 'INTX' | 'IVPT' | 'LICF' | 'LBRI' | 'LIFI' | 'LIMA' | 'LOAN' | 'LOAR' | 'LOTT' | 'LREB' | 'LREV' | 'LTCF' | 'MDCS' | 'NETT' | 'OTCD' | 'PEFC' | 'PENO' | 'PDEP' | 'PENS' | 'PCOM' | 'PHON' | 'PLDS' | 'PLRF' | 'PPTI' | 'PTXP' | 'REFU' | 'RELG' | 'RENT' | 'REOD' | 'REPO' | 'REBT' | 'ROYA' | 'RDTX' | 'SALA' | 'SBSC' | 'SECU' | 'SERV' | 'SAVG' | 'SLEB' | 'SSBE' | 'SUBS' | 'SUPP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'TAXR' | 'TAXS' | 'TCSC' | 'TREA' | 'TRAD' | 'TRFD' | 'UBIL' | 'VATX' | 'VIEW' | 'WHLD' | 'WTER' — Applicable for SWIFT and CHAPS GBP payments. See Supported [Purpose Codes](https://apidocs.openpayd.com/docs/purpose-codes)

## Response `200`

200

- object
  - `transactionId` string
  - `shortId` string
  - `externalCustomerId` unknown
  - `reference` string
  - `paymentType` string
  - `reasonCode` string
  - `amount` object
    - `value` number
    - `currency` string
  - `beneficiary` object
    - `customerType` string
    - `firstName` unknown
    - `lastName` unknown
    - `companyName` string
    - `beneficiaryCountry` string
    - `beneficiaryPostalCode` string
    - `beneficiaryCity` string
    - `beneficiaryState` unknown
    - `beneficiaryAddressLine` string
    - `beneficiaryBirthDate` unknown
    - `bankAccountCountry` string
    - `bankName` unknown
    - `taxId` unknown
    - `phoneNumber` unknown
    - `bankAccountType` unknown
    - `bankAccountHolderName` string
    - `bic` unknown
    - `iban` unknown
    - `accountNumber` string
    - `routingCodes` object
      - `CTN` string
    - `metadata` object
  - `bulkPaymentId` unknown
  - `metadata` object
  - `status` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/openpayd/apis/openpayd-authorization.md) · [All operations](https://skmtc.net/openpayd/apis/openpayd-authorization/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openpayd/openpayd-authorization/versions/354ac572abda/schema)