BVbvnk
Fiat Payments

Get payout

Changed on

Retrieves a specific payout. You can also use this endpoint to check the status of the crypto or fiat payout.

get/payment/v2/payouts/{transactionId}

Request

Path parameters

transactionIdstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

The transaction ID of the payout that you want to retrieve.

Response

Payout retrieved successfully.

idstring 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.

referencestring

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.

statusDetailsstring

Additional details about the current payout status. Returned only when status is FAILED.

metadataMetadata 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.

createdAtstring date-time required

Creation timestamp.

updatedAtstring date-time required

Last update timestamp.

type'payment:payout:fiat' required

Payment type constant.

direction'OUT' required

Payment direction constant.

Example response

{
  "statusDetails": "Beneficiary account number is missing or invalid.",
  "fees": {
    "customerFee": {
      "amount": 100.5,
      "currency": "USD"
    },
    "processingFee": {
      "amount": 100.5,
      "currency": "USD"
    }
  },
  "originator": {
    "entity": {
      "dateOfBirth": "15-01-1990",
      "address": {
        "addressLine1": "123 Main St",
        "addressLine2": "Apt 4B",
        "region": "CA",
        "city": "Los Angeles",
        "country": "US",
        "postCode": "90001"
      }
    }
  },
  "beneficiary": {
    "entity": {
      "dateOfBirth": "15-01-1990",
      "address": {
        "addressLine1": "123 Main St",
        "addressLine2": "Apt 4B",
        "region": "CA",
        "city": "Los Angeles",
        "country": "US",
        "postCode": "90001"
      }
    },
    "bankAccount": {
      "bank": {
        "address": {
          "addressLine1": "123 Bank St",
          "addressLine2": "Suite 100",
          "region": "NY",
          "city": "New York",
          "country": "US",
          "postCode": "10001"
        }
      },
      "intermediaryBanks": [
        {
          "address": {
            "addressLine1": "123 Bank St",
            "addressLine2": "Suite 100",
            "region": "NY",
            "city": "New York",
            "country": "US",
            "postCode": "10001"
          }
        }
      ]
    }
  },
  "metadata": {
    "source": "api",
    "orderId": "ORD-48213"
  },
  "trackingDetails": [
    {
      "externalTransactionId": "123e4567-e89b-12d3-a456-426614174000",
      "imad": "20260304ABCDXXXX012345",
      "omad": "20260304QMQP021000080",
      "traceNumber": "021000080123456",
      "uetr": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

Changes

  • c386d436bf2cRevision changes
    • breaking

      the ////// response's property format changed from date to no format for status

    • breaking

      the ////// response's property format changed from date to no format for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      added the optional property to the response with the status