Skip to main content

​
Object Structure

Swift Bank Payout
{
  "amount": 100000,
  "balance_transaction": "btr_d35pv4qcl8imrv60",
  "beneficiary": "bnf_d3inm6ami8u10oqfg",
  "beneficiary_details": {
        "address": {
        	"city": "Shanghai",
  			"country": "CN",
  			"line1": "Room 1208, No. 88 Century Avenue",
  			"postal_code": "200120",
  			"state": "Shanghai"
          },
        "date_of_birth": "2003-04-04",
        "nationality": "CN",
        "destination": "bnk_crv7k337eoqgk10pqp40",
        "destination_details": {
            "bank": {
                "account_number": "33050167624000001030",
                "account_type": "savings",
                "bank_codes": {
                    "swift_code": "PCBCCNBJZJX"
                  },
                "bank_name": "CHINA CONSTRUCTION BANK, ZHEJIANG BRANCH",
                "branch_name": "Century Avenue",
                "country": "CN",
                "currency": "USD",
                "firc_required": false,
                "purpose_code": "",
                "transfer_type": "swift"
              },
            "type": "bank"
          },
        "documents": [{
           "type": "identity_proof",
           "url": "https://drive.google.com/file/d/1q5kk5YKcCojdTYir-rONXjN7szuXE16m/view?usp=sharing"
        }],
        "email": "importandexport@gmail.com",
        "name": "IMPORT AND EXPORT CO., LTD",
        "name_local": "进出口有限公司",
        "national_identification_number": "",
        "party_classification": "",
        "phone": {
            "calling_code": "86"
			"number": "9231231231"
          },
        "registration_number": "648302704",
        "tax_id": "",
        "type": "business"
      },
  "charge_type": "ours",
  "confirmation_documents": [
    {
      "key": "mt103",
      "type": "string",
      "value": "{1:FHFLEND0XXX0000000000}{2:I103SCBLUS33XXXXN}{3:{108:ST10302510092922}{111:001}{121:372ff3b1-\nd12d-431c-8c9f-f19eb2507285}}{4:\n:20:ST1050254092922\n:23B:CRED\n:32A:251009USD4863,52\n:33B:USD4863,52\n:50K:/10096543269\nTrade Pe Tech Private Limited\nBarrister Rajni Patel Marg, Nariman\nPoint 61, Mittal Chambers 400021 Mu\nmbai Maharashtra/INDIA\n:52D:/0105552976\nTAZAPAY PTE. LTD.\n8 VEDAEK BOULEVARD,15-02, SUFEC T\nOWYT THREE,SINGAPORE,ZIP 038988\n/SINGAPORE\n:57A:ICICINBBCTS\n:59:/119405003646\nTRADE PE TECH PVT LTD-OPGSP MRROR N\nOSTRO A/C\nIN\n/INDIA\n:70:Nostro Payout for settlement\n:71A:OUR\n:72:/ACC/INCKIEBCTS/CITI BANK N.A./\n-}"
    }
  ],
  "created_at": "2025-09-18T10:07:35.101708Z",
  "currency": "USD",
  "documents": [{
      "type": "invoice",
      "url": "https://drive.google.com/file/d/1q5kk5YKcCojdTYir-rONXjN7szuXE16m/view?usp=sharing"
  }],
  "holding_currency": "USD",
  "holding_fx_quote": "fx_d35tjpnfigp2dt2hgg",
  "holding_fx_transaction": {
        "exchange_rate": 1,
        "final": {
            "amount": 10000000,
            "currency": "USD"
          },
        "id": "fx_d35tjpnfigp2dt2hgg",
        "initial": {
            "amount": 10000000,
            "currency": "USD"
          },
        "object": "fx_transaction"
      },
  "id": "pot_d35tjpn4qcl8iv30",
  "logistics_tracking_details": [
    {
     	"tracking_number":"5436789",
      "logistics_provider":{"name":"DHL Express","code":"UH783"}
     }
	],
  "metadata": null,
  "mt103": "{1:FHFLEND0XXX0000000000}{2:I103SCBLUS33XXXXN}{3:{108:ST10302510092922}{111:001}{121:372ff3b1-\nd12d-431c-8c9f-f19eb2507285}}{4:\n:20:ST1050254092922\n:23B:CRED\n:32A:251009USD4863,52\n:33B:USD4863,52\n:50K:/10096543269\nTrade Pe Tech Private Limited\nBarrister Rajni Patel Marg, Nariman\nPoint 61, Mittal Chambers 400021 Mu\nmbai Maharashtra/INDIA\n:52D:/0105552976\nTAZAPAY PTE. LTD.\n8 VEDAEK BOULEVARD,15-02, SUFEC T\nOWYT THREE,SINGAPORE,ZIP 038988\n/SINGAPORE\n:57A:ICICINBBCTS\n:59:/119405003646\nTRADE PE TECH PVT LTD-OPGSP MRROR N\nOSTRO A/C\nIN\n/INDIA\n:70:Nostro Payout for settlement\n:71A:OUR\n:72:/ACC/INCKIEBCTS/CITI BANK N.A./\n-}",
  "object": "payout",
  "on_behalf_of": "ent_d68uqetjd0fmussfd1q0",
  "payout_fx_transaction": {
        "exchange_rate": 1,
        "final": {
            "amount": 10000000,
            "currency": "USD"
          },
        "id": "fx_d35tfigo4p2dt2hh0",
        "initial": {
            "amount": 10000000,
            "currency": "USD"
          },
        "object": "fx_transaction"
      },
  "purpose": "PYR003",
  "quote": "poq_d3inm6ami8u10oqfh",
  "reference_id": "INV-2024-CN-8923",
  "statement_descriptor": "Import Payment",
  "status": "succeeded",
  "status_description": "",
  "tracking_details": {
        "tracking_number": "7833d-34b4-478-aac8-1184beae",
        "tracking_type": "uetr"
      },
  "transaction_description": "Payment for goods acc 125",
  "type": "swift"
}
Local Bank Payout
{
  "status": "success",
  "message": "",
  "data": {
    "amount": 3000000,
    "balance_transaction": "btr_dhuvflvi5frlneafr0",
    "beneficiary": "bnf_d0dla9u8dpp4edio0",
    "beneficiary_details": {
      "address": null,
      "date_of_birth": "",
      "nationality": "DE",
      "destination": "",
      "destination_details": {
        "bank": {
          "account_type": "",
          "bank_codes": {
            "swift_code": "FBDEFF"
          },
          "bank_name": "ER VOLKSBANK EG",
          "branch_name": "",
          "country": "DE",
          "currency": "EUR",
          "firc_required": false,
          "iban": "DE535019045650474185",
          "purpose_code": "",
          "transfer_type": "any"
        },
        "type": "bank"
      },
      "documents": [],
      "email": "",
      "name": "GMBH",
      "name_local": "",
      "national_identification_number": "",
      "party_classification": "",
      "phone": {
        "calling_code": "49"
      },
      "registration_number": "",
      "tax_id": "",
      "type": "business"
    },
    "charge_type": "",
    "confirmation_documents": [],
    "created_at": "2025-09-16T08:27:41.832790Z",
    "currency": "EUR",
    "documents": [],
    "holding_currency": "USD",
    "holding_fx_quote": "fx_d34hc7loipp34fmg",
    "holding_fx_transaction": {
      "exchange_rate": 0.846438,
      "final": {
        "amount": 3000000,
        "currency": "EUR"
      },
      "id": "fx_d34flc7loipp34fmg",
      "initial": {
        "amount": 3544266,
        "currency": "USD"
      },
      "object": "fx_transaction"
    },
    "id": "pot_d34hlvi5frlneafo0",
    "local": {
      "fund_transfer_network": "sepa"
    },
    "logistics_tracking_details": [
      {
     	"tracking_number":"5436789",
      "logistics_provider":{"name":"DHL Express","code":"UH783"}
      }
    ],
    "metadata": null,
    "mt103": "",
    "object": "payout",
    "on_behalf_of": "ent_d68uq89jd0fvsnsfd1q0",
    "payout_fx_transaction": {
      "exchange_rate": 1,
      "final": {
        "amount": 3000000,
        "currency": "EUR"
      },
      "id": "fx_d34huvflc7pp34fm0",
      "initial": {
        "amount": 3000000,
        "currency": "EUR"
      },
      "object": "fx_transaction"
    },
    "purpose": "PYR001",
    "quote": "poq_d3inm6ami8u10oqfk",
    "reference_id": "DE-LOG-2024-0909",
    "statement_descriptor": "Logistics Payment",
    "status": "succeeded",
    "status_description": "",
    "tracking_details": {
      "tracking_number": "098771252590P9A",
      "tracking_type": "UTR"
    },
    "transaction_description": "Payment for logistic services 9-09",
    "type": "local"
  }
}
Local Payment Network Payout
{
  "status": "success",
  "message": "",
  "data": {
    "amount": 144,
    "balance_transaction": "btr_d35v6ddendp1ul1p0",
    "beneficiary": "bnf_d2pkuchg06m8tvjg",
    "beneficiary_details": {
      "address": null,
      "date_of_birth": "",
      "nationality": "BR",
      "destination": "",
      "destination_details": {
        "local_payment_network": {
          "currency": "BRL",
          "deposit_key": "fep@gmail.com",
          "type": "pix_brl"
        },
        "type": "local_payment_network"
      },
      "documents": [],
      "email": "fep@gmail.com",
      "name": "Feete Pereira",
      "name_local": "",
      "national_identification_number": "",
      "party_classification": "",
      "phone": null,
      "registration_number": "",
      "tax_id": "3879876743",
      "type": "individual"
    },
    "charge_type": "",
    "confirmation_documents": [],
    "created_at": "2025-09-18T11:56:35.627500Z",
    "currency": "BRL",
    "documents": [],
    "holding_currency": "USD",
    "holding_fx_quote": "fx_d35vfigo4p2dt8ecg",
    "holding_fx_transaction": {
      "exchange_rate": 5.158393,
      "final": {
        "amount": 144,
        "currency": "BRL"
      },
      "id": "fx_d35vfigo4p2dt8ecg",
      "initial": {
        "amount": 28,
        "currency": "USD"
      },
      "object": "fx_transaction"
    },
    "id": "pot_d35v6sp8dp1ul1m0",
    "local": {
      "fund_transfer_network": "sepa"
    },
    "logistics_tracking_details": [],
    "metadata": null,
    "mt103": "",
    "object": "payout",
    "on_behalf_of": "",
    "payout_fx_transaction": {
      "exchange_rate": 1,
      "final": {
        "amount": 144,
        "currency": "BRL"
      },
      "id": "fx_d35v6go4p2dt8ec0",
      "initial": {
        "amount": 144,
        "currency": "BRL"
      },
      "object": "fx_transaction"
    },
    "payout_quote": "",
    "purpose": "PYR001",
    "quote": "poq_d3inm6ami8u10oqfl",
    "reference_id": "BR-PIX-2024-3879",
    "statement_descriptor": "Freelancer Payment",
    "status": "succeeded",
    "status_description": "",
    "tracking_details": {
      "tracking_number": "E1234567820240918115635627",
      "tracking_type": "pix_id"
    },
    "transaction_description": "Freelance design services payment",
    "type": "local_payment_network"
  }
}
Transfer Within Tazapay
{
  "status": "success",
  "message": "",
  "data": {
    "amount": 44000,
    "balance_transaction": "btr_d35sqe74qcl8im850",
    "beneficiary": "bnf_d35spsnl8imrh3gv0",
    "beneficiary_details": {
      "address": {},
      "date_of_birth": "",
      "nationality": "SG",
      "destination": "",
      "destination_details": {
        "tazapay_account": {
          "deposit_address": "ce4f51ue@tzp"
        },
        "type": "tazapay_account"
      },
      "documents": [],
      "email": "info@trading.com",
      "name": "T Co., Limited",
      "name_local": "",
      "national_identification_number": "",
      "party_classification": "",
      "phone": {},
      "registration_number": "",
      "tax_id": "",
      "type": "business"
    },
    "charge_type": "",
    "confirmation_documents": [],
    "created_at": "2025-09-18T09:13:28.633167Z",
    "currency": "USD",
    "documents": [],
    "holding_currency": "USD",
    "holding_fx_quote": "fx_d35sfigo4p2dsvsvg",
    "holding_fx_transaction": {
      "exchange_rate": 1,
      "final": {
        "amount": 44000,
        "currency": "USD"
      },
      "id": "fx_d35sqe7figo4p2dsvsvg",
      "initial": {
        "amount": 44000,
        "currency": "USD"
      },
      "object": "fx_transaction"
    },
    "id": "pot_d5sqe7cl8imrh4810",
    "local": {
      "fund_transfer_network": "sepa"
    },
    "logistics_tracking_details": [],
    "metadata": null,
    "mt103": "",
    "object": "payout",
    "on_behalf_of": "",
    "payout_fx_transaction": {
      "exchange_rate": 1,
      "final": {
        "amount": 44000,
        "currency": ""
      },
      "id": "fx_d35sqe7figo4psvt00",
      "initial": {
        "amount": 44000,
        "currency": "USD"
      },
      "object": "fx_transaction"
    },
    "payout_quote": "",
    "purpose": "PYR003",
    "quote": "poq_d3inm6ami8u10oqfm",
    "reference_id": "TZP-ACC-2024-1892",
    "statement_descriptor": "Trading Payment",
    "status": "succeeded",
    "status_description": "",
    "tracking_details": {
      "tracking_number": "TZP-001-2024-9876",
      "tracking_type": "internal"
    },
    "transaction_description": "Payment for goods acc 001",
    "type": "tazapay_account"
  }
}
Crypto Payout
{
  "status": "success",
  "message": "",
  "data": {
    "amount": 122225,
    "balance_transaction": "btr_dag4eup1ekl94qrlg",
    "beneficiary": "bnf_d35eag4eupl94qrig",
    "beneficiary_details": {
      "address": {
        "city": "Vrtmore",
        "country": "JM",
        "line1": "it12 3cwth",
        "postal_code": "00000",
        "state": "Vortmore"
      },
      "date_of_birth": "2003-04-04",
      "nationality": "JM",
      "destination": "",
      "destination_details": {
        "type": "wallet",
        "wallet": {
          "currency": "USDC",
          "deposit_address": "09e53bcac0f2edxnjsui87f8bb7a9faf64789ed8",
          "type": "ethereum"
        }
      },
      "documents": [],
      "email": "",
      "name": "Scott",
      "name_local": "",
      "national_identification_number": "",
      "party_classification": "third_party",
      "phone": {},
      "registration_number": "",
      "tax_id": "",
      "type": "individual"
    },
    "charge_type": "",
    "confirmation_documents": [],
    "created_at": "2025-09-17T16:43:44.378053Z",
    "currency": "USD",
    "documents": [],
    "holding_currency": "USD",
    "holding_fx_quote": "fx_d35eag74p2drbeug",
    "holding_fx_transaction": {
      "exchange_rate": 1,
      "final": {
        "amount": 122225,
        "currency": "USD"
      },
      "id": "fx_d35eag74p2drbeug",
      "initial": {
        "amount": 122225,
        "currency": "USD"
      },
      "object": "fx_transaction"
    },
    "id": "pot_d35eag4ekl94qri0",
    "local": {
      "fund_transfer_network": "sepa"
    },
    "logistics_tracking_details": [],
    "metadata": null,
    "mt103": "",
    "object": "payout",
    "on_behalf_of": "",
    "payout_fx_transaction": {
      "exchange_rate": 1,
      "final": {
        "amount": 122225,
        "currency": "USDC"
      },
      "id": "fx_d35igo4p2drbeu0",
      "initial": {
        "amount": 122225,
        "currency": "USD"
      },
      "object": "fx_transaction"
    },
    "payout_quote": "",
    "purpose": "PYR030",
    "quote": "poq_d3inm6ami8u10oqfn",
    "reference_id": "CRYPTO-COM-2024-9817",
    "statement_descriptor": "Commission Payment",
    "status": "succeeded",
    "status_description": "",
    "tracking_details": {
      "tracking_number": "0xadef30173d3dd42333779a683c1404e50567e03fb4daef4f850f415789f559f",
      "tracking_type": "transaction_hash"
    },
    "transaction_description": "Commission payment for Q3 2024",
    "type": "wallet"
  }
}

​
Object Parameters

​
Payout

FieldTypeDescription
amountnumberThe total amount for the payout transaction.
available_balanceintegerAvailable balance in the holding currency account after this payout is processed.
balance_transactionstringThe Tazapay ID of the balance transaction associated with the payout.
beneficiarystringThe Tazapay ID of the beneficiary receiving the payout.
beneficiary_detailsobjectThe details of the beneficiary. Beneficiary Details Object
charge_typeenumThe charge type for the payout. [Values: ours, shared]
confirmation_documentsarrayArray of confirmation documents (MT103, MT199, FIRC, etc.). Each contains key (document type), type (MIME type), value (content/URL).
created_atstringThe timestamp when the payout was created (ISO 8601).
currencystringThe currency of the payout amount.
documentsarrayThe list of documents related to the payout.
holding_currencystringThe currency used for holding funds before payout.
holding_fx_quotestringThe FX quote ID used for holding currency.
holding_fx_transactionobjectThe FX transaction details for the holding currency. FX Transaction Object
idstringThe unique Tazapay identifier for the payout.
is_balance_sufficientbooleanIndicates whether the account has sufficient balance to process this payout.
localobjectLocal payout configuration object containing fund_transfer_network (e.g., “chats”, “fps”, “sepa”).
logistics_tracking_detailsarrayArray of logistics tracking information. Each contains tracking_number, logistics_provider, and description.
metadataobjectKey-value metadata attached to the payout.
mt103stringThe MT103 SWIFT message reference for the payout (if applicable).
objectstringThe type of object, always "payout".
on_behalf_ofstringThe account ID if the payout was made on behalf of another entity.
payout_fx_transactionobjectThe FX transaction details for payout currency. (FX Transaction Object)
payout_quotestringThe payout quote reference (if applicable).
purposeenumThe purpose code for the payout. [Values: PYR001–PYR030]. Click here for the detailed list.
quotestringID of the payout quote used to lock exchange rates for this payout. Begins with ‘poq_’.
reference_idstringThe merchant’s reference ID for the payout.
statement_descriptorstringThe statement descriptor that appears on the beneficiary’s bank statement.
statusenumThe current status of the payout. [Values: Processing, Requires Approval, Requires Action, Succeeded, Failed, Cancelled]
status_descriptionstringA description of the current payout status.
tracking_detailsobjectTracking details of the payout. (Tracking Details Object)
transaction_descriptionstringA description of the payout transaction provided by the merchant.
typeenumThe type of payout. [Values: swift, local, wallet, local_payment_network, tazapay_account]

​
Tracking Details

FieldTypeDescription
tracking_numberstringThe tracking number (UETR, UTR, transaction hash, etc.).
tracking_typeenumThe tracking type. [Values: uetr, utr, transaction_hash]

​
Local

FieldTypeDescription
fund_transfer_networkstringThe local fund transfer network used for local payouts (e.g., “chats”, “fps”, “sepa”, “rtgs”, “ach”)