--- title: "Get payout" method: GET path: "/payment/v2/payouts/{transactionId}" tags: ["Fiat Payments"] --- # Get payout `GET /payment/v2/payouts/{transactionId}` ## Request - Base URL: `https://api.sandbox.bvnk.com` - URL: `https://api.sandbox.bvnk.com/payment/v2/payouts/{transactionId}` - Auth: API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieves a specific payout. You can also use this endpoint to check the status of the crypto or fiat payout. ## Path parameters - `transactionId` string, uuid, required ## Response `200` Payout retrieved successfully. - PayoutGetResponse - `id` string, uuid, required: Unique payout identifier. - `method` 'SEPA_CT' | 'SEPA_INST' | 'FASTER_PAYMENT' | 'BACS' | 'TARGET2' | 'TIPS' | 'SWIFT' | 'ACH' | 'ACH_SAME_DAY' | 'FEDWIRE' | 'FEDNOW' | 'RTP' | 'BOOK' | 'UNKNOWN' | 'BANK_TRANSFER' | 'WIRE' | 'SEPA', required: Payment method used in the transaction. Note: This list can be changed in the future. - `reference` string: Free text reference provided during payout creation (used mostly for reconciliation reasons). - `status` 'PENDING' | 'PROCESSING' | 'PENDING_APPROVAL' | 'ON_HOLD' | 'COMPLETED' | 'CANCELLED' | 'FAILED' | 'RETURNED', required: Current payout status. - `statusDetails` string: Additional details about the current payout status. Returned only when `status` is `FAILED`. - `fees` FeesResponse, required - `customerFee` MoneyFeeV2 - `amount` number, required: Fee amount in fiat or crypto currency units. - `currency` string, required: Currency code. Supports both fiat (ISO-4217) and cryptocurrencies. - `processingFee` MoneyFeeV2, required - `amount` number, required: Fee amount in fiat or crypto currency units. - `currency` string, required: Currency code. Supports both fiat (ISO-4217) and cryptocurrencies. - `originator` object, required - `amount` number, float, required: Amount of the payout. - `currency` string, required: Currency of the payout. - `walletId` string, required: The ID of the originator's wallet associated with the payout. - `customerId` string: The ID of the originator's customer associated with the payout. - `entity` union, required - Individual - `type` 'INDIVIDUAL', required: Entity type. Always present. - `firstName` string, required: First name - `lastName` string, required: Last name - `dateOfBirth` string: Date of birth in DD-MM-YYYY format - `address` BeneficiaryAddress: Address of the beneficiary. At a minimum, the following fields are always required: - `addressLine1` - `city` - `country` Additional address fields may be mandatory depending on the payment method. For example: - Fedwire, FedNow, RTP, ACH and ACH_SAME_DAY (US local rails): `postCode` and `region` - SWIFT: `postCode` **Important**: `city`, `region`, `country`, and `postCode` must be provided in their dedicated fields and not repeated in `addressLine1` or `addressLine2`. Including these values in the address lines may cause payment rejection for certain payment methods. - `addressLine1` string: Recipient's primary address line. Typically contains the street name and building number. Do not include the city, country, region/state, or postal code in this field; these values must be provided in their respective dedicated fields. - `addressLine2` string: Recipient's secondary address line. Typically contains additional details such as apartment, suite, or floor number. Do not include the city, country, region/state, or postal code in this field; these values must be provided in their respective dedicated fields. - `region` string: Recipient's state or region of the address. If the region is a US state, provide the two-letter state code (minimum and maximum length is 2 characters), for example, `NY`. - `city` string: Recipient's city of the address. - `country` string, required: Recipient's two-letter country code in the ISO 3166-1 alpha-2 format. - `postCode` string: Postal or ZIP code of the recipient's address. - `relationshipType` 'SELF_OWNED' | 'THIRD_PARTY', required: Relationship type. - Company - `type` 'COMPANY', required: Entity type. - `legalName` string, required: Legal company name - `address` BeneficiaryAddress: Address of the beneficiary. At a minimum, the following fields are always required: - `addressLine1` - `city` - `country` Additional address fields may be mandatory depending on the payment method. For example: - Fedwire, FedNow, RTP, ACH and ACH_SAME_DAY (US local rails): `postCode` and `region` - SWIFT: `postCode` **Important**: `city`, `region`, `country`, and `postCode` must be provided in their dedicated fields and not repeated in `addressLine1` or `addressLine2`. Including these values in the address lines may cause payment rejection for certain payment methods. - `addressLine1` string: Recipient's primary address line. Typically contains the street name and building number. Do not include the city, country, region/state, or postal code in this field; these values must be provided in their respective dedicated fields. - `addressLine2` string: Recipient's secondary address line. Typically contains additional details such as apartment, suite, or floor number. Do not include the city, country, region/state, or postal code in this field; these values must be provided in their respective dedicated fields. - `region` string: Recipient's state or region of the address. If the region is a US state, provide the two-letter state code (minimum and maximum length is 2 characters), for example, `NY`. - `city` string: Recipient's city of the address. - `country` string, required: Recipient's two-letter country code in the ISO 3166-1 alpha-2 format. - `postCode` string: Postal or ZIP code of the recipient's address. - `relationshipType` 'SELF_OWNED' | 'THIRD_PARTY', required: Relationship type. - `beneficiary` BeneficiaryResponse, required - `remittanceInformation` string, required: Payment reference information. Can contain only alphanumeric characters (a-z, A-Z, 0-9), whitespaces, or the `.,-` symbols. Other allowed characters vary depending on the used payment method or currency. Always required for payouts. - `amount` number, float, required: Amount received by the beneficiary. - `currency` string, required: Currency of the transaction received by the beneficiary. - `entity` union, required - Individual - `type` 'INDIVIDUAL', required: Entity type. Always present. - `firstName` string, required: First name - `lastName` string, required: Last name - `dateOfBirth` string: Date of birth in DD-MM-YYYY format - `address` BeneficiaryAddress: Address of the beneficiary. At a minimum, the following fields are always required: - `addressLine1` - `city` - `country` Additional address fields may be mandatory depending on the payment method. For example: - Fedwire, FedNow, RTP, ACH and ACH_SAME_DAY (US local rails): `postCode` and `region` - SWIFT: `postCode` **Important**: `city`, `region`, `country`, and `postCode` must be provided in their dedicated fields and not repeated in `addressLine1` or `addressLine2`. Including these values in the address lines may cause payment rejection for certain payment methods. - `addressLine1` string: Recipient's primary address line. Typically contains the street name and building number. Do not include the city, country, region/state, or postal code in this field; these values must be provided in their respective dedicated fields. - `addressLine2` string: Recipient's secondary address line. Typically contains additional details such as apartment, suite, or floor number. Do not include the city, country, region/state, or postal code in this field; these values must be provided in their respective dedicated fields. - `region` string: Recipient's state or region of the address. If the region is a US state, provide the two-letter state code (minimum and maximum length is 2 characters), for example, `NY`. - `city` string: Recipient's city of the address. - `country` string, required: Recipient's two-letter country code in the ISO 3166-1 alpha-2 format. - `postCode` string: Postal or ZIP code of the recipient's address. - `relationshipType` 'SELF_OWNED' | 'THIRD_PARTY', required: Relationship type. - Company - `type` 'COMPANY', required: Entity type. - `legalName` string, required: Legal company name - `address` BeneficiaryAddress: Address of the beneficiary. At a minimum, the following fields are always required: - `addressLine1` - `city` - `country` Additional address fields may be mandatory depending on the payment method. For example: - Fedwire, FedNow, RTP, ACH and ACH_SAME_DAY (US local rails): `postCode` and `region` - SWIFT: `postCode` **Important**: `city`, `region`, `country`, and `postCode` must be provided in their dedicated fields and not repeated in `addressLine1` or `addressLine2`. Including these values in the address lines may cause payment rejection for certain payment methods. - `addressLine1` string: Recipient's primary address line. Typically contains the street name and building number. Do not include the city, country, region/state, or postal code in this field; these values must be provided in their respective dedicated fields. - `addressLine2` string: Recipient's secondary address line. Typically contains additional details such as apartment, suite, or floor number. Do not include the city, country, region/state, or postal code in this field; these values must be provided in their respective dedicated fields. - `region` string: Recipient's state or region of the address. If the region is a US state, provide the two-letter state code (minimum and maximum length is 2 characters), for example, `NY`. - `city` string: Recipient's city of the address. - `country` string, required: Recipient's two-letter country code in the ISO 3166-1 alpha-2 format. - `postCode` string: Postal or ZIP code of the recipient's address. - `relationshipType` 'SELF_OWNED' | 'THIRD_PARTY', required: Relationship type. - `bankAccount` BankAccountV2 - `accountNumber` string, required: Bank account number. - `accountType` 'CHEQUE' | 'CHECKING' | 'SAVINGS' | 'TRANSMISSION': Type of bank account. Mandatory for the `USD` payouts. - `bank` BankV2, required - `identificationCode` string: Bank identification code (SWIFT/BIC). Mandatory for non-IBAN accounts, for example, use it as a routing number for local `USD` payments. Optional for local payments in EUR. - `nid` string: National bank identifier. For the SWIFT USD payments, this is the account routing number: a nine-digit code that identifies your specific financial institution for electronic transactions. Mandatory for the Swift USD payments. We recommend providing `nid` at any time, as some banks may not process the payments without it. - `address` object: Bank branch address. For SWIFT payments, `addressLine1`, `city`, `postCode`, and `country` are required. - `addressLine1` string: Bank branch primary address line. - `addressLine2` string: Bank branch secondary address line. - `region` string: Bank branch state or region. If the region is a US state, provide the two-letter state code (minimum and maximum length is 2 characters), for example, `NY`. - `city` string: Bank branch city. - `country` string, required: Bank branch country code. - `postCode` string: Postal or ZIP code of the bank branch. - `intermediaryBanks` BankV2[]: List of intermediary banks. - `identificationCode` string: Bank identification code (SWIFT/BIC). Mandatory for non-IBAN accounts, for example, use it as a routing number for local `USD` payments. Optional for local payments in EUR. - `nid` string: National bank identifier. For the SWIFT USD payments, this is the account routing number: a nine-digit code that identifies your specific financial institution for electronic transactions. Mandatory for the Swift USD payments. We recommend providing `nid` at any time, as some banks may not process the payments without it. - `address` object: Bank branch address. For SWIFT payments, `addressLine1`, `city`, `postCode`, and `country` are required. - `addressLine1` string: Bank branch primary address line. - `addressLine2` string: Bank branch secondary address line. - `region` string: Bank branch state or region. If the region is a US state, provide the two-letter state code (minimum and maximum length is 2 characters), for example, `NY`. - `city` string: Bank branch city. - `country` string, required: Bank branch country code. - `postCode` string: Postal or ZIP code of the bank branch. - `metadata` Metadata, required: Custom metadata key-value pairs. Structure: key: value. Restrictions: - Maximum five keys. - Each key maximum length 50 characters. - Each value maximum length 100 characters. - Keys and values must be simple strings. - `createdAt` string, date-time, required: Creation timestamp. - `updatedAt` string, date-time, required: Last update timestamp. - `type` 'payment:payout:fiat', required: Payment type constant. - `direction` 'OUT', required: Payment direction constant. - `trackingDetails` object[]: External identifiers for the payment transaction, including tracking references for different payment methods. These can be used to trace transactions across global payment networks such as Fedwire and ACH. - `externalTransactionId` string: External identifier for the payout. - `imad` string: Input Message Accountability Data. Used as the originator's tracking reference for WIRE transfers. Generated by the sending bank when a wire transfer is initiated in the US banking system. - `omad` string: Output Message Accountability Data. Used as beneficiary's tracking reference for WIRE transfers. Generated by the receiving bank upon delivery of a wire transfer in the US banking system. - `traceNumber` string: Payment reference used for ACH payments. - `uetr` string: Unique End-to-End Transaction Reference. Used in SWIFT payments. Remains consistent throughout the entire international payment journey across all participating banks. ## Other responses - `400`: Bad request - `401`: Unauthorized - `403`: Forbidden ## Changes - **2026-11-06** `c386d436bf2c`: 2 breaking, 2 warning, 1 info - the `beneficiary/entity/oneOf[#/components/schemas/Individual]/dateOfBirth` response's property format changed from `date` to no format for status `200` - the `originator/entity/oneOf[#/components/schemas/Individual]/dateOfBirth` response's property format changed from `date` to no format for status `200` - removed the optional property `beneficiary/bankAccount/bank/country` from the response with the `200` status - removed the optional property `beneficiary/bankAccount/intermediaryBanks/items/country` from the response with the `200` status - …1 more [Operation history](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/changes/payment/v2/payouts/:transactionId/get.md) --- [API](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints.md) - [All operations](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/revisions/c386d436bf2c?raw)