Fund Payout

Fund a payout which is in requires_funding

POST /v3/payout/{id}/fund

Funding a Payout

cURL

curl --request POST \
  --url https://service-sandbox.tazapay.com/v3/payout/{id}/fund \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "status": "success",
  "message": "",
  "data": {
    "amount": 1000000,
    "available_balance": -1038,
    "is_balance_sufficient": false,
    "balance_transaction": "btr_fahfaniaf0023902",
    "beneficiary": "bnf_cta4erf3l65o6mqvace0",
    "beneficiary_details": {
      "address": null,
      "destination": "",
      "destination_details": {
        "bank": {
          "account_number": "6492749274",
          "account_type": "",
          "bank_codes": {
            "aba_code": "AIOHFAONF",
            "swift_code": "SWIFT CODE"
          },
          "bank_name": "Bank of America",
          "branch_name": "",
          "country": "US",
          "currency": "USD",
          "firc_required": false,
          "purpose_code": ""
        },
        "type": "bank"
      },
      "documents": [],
      "email": "",
      "name": "Test Account USA",
      "phone": {
        "calling_code": "1"
      },
      "tax_id": "",
      "type": "business"
    },
    "charge_type": "shared",
    "created_at": "2024-12-17T07:15:14.691660Z",
    "currency": "USD",
    "documents": [
      {
        "id": "doc_ctgia0ng9n1vh5ns81f0",
        "type": "invoice",
        "url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-payout-document/pot_ctgia0ng9n1vh5ns81cg/1734419711360340856_image%20%281%29.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAUGJYD3OSSENYIX45%2F20241217%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20241217T072015Z&X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHYaDmFwLXNvdXRoZWFzdC0xIkcwRQIhAM9um7eR7Mr0x9x7nPCUHqNfsNQOl%2FGYlyBCZU25t1ZaAiA1Qg%2BnFaZXl0ynXNu9cEvoGFXfz86d%2B2CSrPacMzDaOSr0Awg%2FEAEaDDI4ODQxNzM3MzA5MyIM41LZ42vlF4tAc69tKtED12ChC8dNuaNE3xjx6BuhDm6SFBy58FENrzdHcI%2FBV2AA1cjmom4CzMLgXvv29Sf8Iy7s12Kxq3dz5pct5ya9ZVzh8iFjlIX52iQo%2BslhQNiCUKrQqEpwLMiUmDyAb7OV4tARhttrSvbLUOC51KTdyIS4bKqJrncHKzDlzTIRoO9PdM%2BPEFFXUY786C2a23W1sM5GqgnhKd1EUb1iN3AxO7fd7wPhXC6o%2Fym6Wh2TNTGz0uaxXHtLzcDAZJwMNEeKQDaa1YD%2BG3xWSN9m6yyysaDoGewhqrUAeqr1AQvTR47sbdIkFKn7m%2B6wDjK86cQNxpHU61FpgCYwbXBNCaMKqIrXcmamSAiK8m7C4BfxWlrCz7iQXqR3vKGf3Y%2BHhqpkXGk0mHRk%2FI4VWWAeoDxEogdfarZ%2FMk1BEAThH689NDSiCwrf%2FcWw3B0AlRfXWuy5oKyXgDPlku9WYzN7XnbR3ACCOW8NbzJ0nSCiZb71932okKiEpYyrU10BivAboncdGfHpwcQerBlz40ESSpVzKJFFaIRL6LALRzd8ybzofdFgzs5GAoU%2Bbbn6ZqbGXFIGzsoIh4umuOMMEbhoCJnY3np%2FS5pdSjqaZ%2FhKLMipnAoeMNKuhLsGOqUBBIcJEaO3lTmzl9%2B3Kwkun6q5OVe0fLnarcASVwfK12G4TQEfKimM9EbAoOtGqSbIduTaDaW8PbJndpSVHue%2FC%2BeAgjGhIC%2FoUFpUxoGoVuxBdI%2BAuHEf%2FNKnplTjBTT2YBraCnEGjiRLE38owzZ8M1fU3Iymp9KlBTNhCCkp%2BZKPhUD81sv0T3Rh%2FQTSygt3ML9wakZBxvTFosGDKy%2BIbAUUxQ6h&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B&response-content-type=image%2Fpng&x-id=GetObject&X-Amz-Signature=8be0fdb60f69daad7d4cb4b92b2790b5ff3e8f5ef8a5ecebe6f84140a211ec91"
      }
    ],
    "holding_currency": "SEK",
    "holding_fx_transaction": {
      "exchange_rate": 0.087096,
      "final": {
        "amount": 1000000,
        "currency": "USD"
      },
      "id": "fx_ctgia0lpk5p8ci902fsg",
      "initial": {
        "amount": 11481567,
        "currency": "SEK"
      },
      "object": "fx_transaction"
    },
    "id": "pot_ctgia0ng9n1vh5ns81cg",
    "metadata": null,
    "mt103": "",
    "object": "payout",
    "on_behalf_of": "",
    "payout_fx_transaction": {
      "exchange_rate": 1,
      "final": {
        "amount": 1000000,
        "currency": "USD"
      },
      "id": "fx_ctgia0lpk5p8ci902fs0",
      "initial": {
        "amount": 1000000,
        "currency": "USD"
      },
      "object": "fx_transaction"
    },
    "purpose": "PYR002",
    "reference_id": "",
    "statement_descriptor": "",
    "status": "processing",
    "status_description": "",
    "tracking_details": null,
    "transaction_description": "",
    "type": "swift"
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id · string · required

ID of a payout in the state requires_funding

Response

200

application/json

200

amount · number

Amount of the payout in payout currency

Example:

1000000

available_balance · integer

Available balance in the holding currency account after this payout is processed

Example:

1233333

balance_transaction · string

ID of the balance transaction object linked to this payout

Example:

"btr_fahfaniaf0023902"

beneficiary · string

Unique identifier of the payout beneficiary

Example:

"bnf_cta4erf3l65o6mqvace0"

beneficiary_details · object

Details of the payout beneficiary

Show child attributes

charge_type · string

Charge type for the payout (e.g., ours, shared, beneficiary)

Example:

"shared"

confirmation_documents · object[]

Array of confirmation documents like MT103, MT199, FIRC

Show child attributes

created_at · string

Timestamp when the payout was created

Example:

"2024-12-17T07:15:14.691660Z"

currency · string

Currency of the payout

Example:

"USD"

documents · array

List of payout-related documents

Example:

[
  {
    "id": "doc_ctgia0ng9n1vh5ns81f0",
    "type": "invoice",
    "url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-payout-document/pot_ctgia0ng9n1vh5ns81cg/1734419711360340856_image%20%281%29.png"
  }
]

holding_currency · string

Currency used to hold funds before payout

Example:

"SEK"

holding_fx_transaction · object

Details of FX transaction for holding currency conversion

Show child attributes

id · string

Unique payout ID

Example:

"pot_ctgia0ng9n1vh5ns81cg"

is_balance_sufficient · boolean

Indicates whether the account has sufficient balance to process this payout

Example:

false

local · object

Local payout configuration containing fund transfer network details

Show child attributes

metadata · null

Metadata associated with the payout

Example:

null

mt103 · string

SWIFT MT103 reference (if applicable)

Example:

""

object · string

Type of object (payout)

Example:

"payout"

on_behalf_of · string

Entity on whose behalf the payout is made

Example:

""

payout_fx_transaction · object

FX transaction details for payout currency

Show child attributes

purpose · string

Purpose code for the payout

Example:

"PYR002"

reference_id · string

External reference ID for payout

Example:

""

statement_descriptor · string

Statement descriptor for the payout

Example:

""

status · string

Current status of the payout

Example:

"processing"

status_description · string

Detailed status description

Example:

""

tracking_details · null

Tracking information if applicable

Example:

null

transaction_description · string

Description or memo for the payout transaction

Example:

""

type · string

Type of payout (e.g., swift, local)

Example:

"swift"

logistics_tracking_details · object[]

Logistics tracking details for the payout

Show child attributes

quote · string

Quote ID from the payout quote API

Example:

"poq_d3inm6ami8u10oqfk"

destination_fx_quote · string

ID of the quote to use locked exchange for conversion from payout to destination currency

Example:

"fx_d3inm6ami8u10oqfl"