Transfer

Payout Transfer Funding Scheduled

Description: Transfer funding scheduled.

Description

The funding is scheduled to be processed on the transfer date.

Funding Details

Indicates scheduled processing
Contains complete transfer details
Includes fee breakdown
Shows both payer and beneficiary information
Provides transfer timing information

📦 Event Details

id string

Unique event identifier.

name string

Event name: payout.transfer.funding.scheduled.

account_id string

Unique identifier of the account associated with the payout transfer.

data object

Event payload containing payout transfer and funding details.

id string

Unique identifier of the payout transfer request.

amount_beneficiary_receives double

Amount the beneficiary will receive.

amount_payer_pays double

Total amount the payer will pay.

beneficiary object

Details of the beneficiary receiving the payout.

address object

Beneficiary's address details.

street_address string

Street address of the beneficiary.

city string

City of the beneficiary.

state string

State of the beneficiary.

country_code string

Country code of the beneficiary (2-letter ISO 3166-2 code).

postcode string

Postal code of the beneficiary.

bank_details object

Bank account details of the beneficiary.

account_name string

Name on the beneficiary's bank account.

account_number string

Beneficiary's bank account number.

account_currency string

Currency of the beneficiary's bank account (3-letter ISO-4217 code).

bank_name string

Beneficiary's bank name.

bank_country_code string

Country code of the bank (2-letter ISO 3166-2 code).

swift_code string

SWIFT/BIC code of the beneficiary's bank.

company_name string

Beneficiary's company name.

entity_type string

Entity type of the beneficiary. Value: COMPANY.

type string

Beneficiary account type. Value: BANK_ACCOUNT.

fee_amount double

Fee amount charged for the transfer.

fee_currency string

Currency of the fee (3-letter ISO-4217 code).

fee_paid_by string

Indicates who pays the fee. Value: PAYER.

payer object

Details of the payer initiating the transfer.

additional_info object

Additional business information about the payer.

business_registration_number string

Payer's business registration number.

business_registration_type string

Type of business registration. Value: COMPANY.

business_incorporation_date string

Incorporation date of the payer's business (ISO 8601 date format: YYYY-MM-DD).

address object

Address details of the payer.

street_address string

Street address of the payer.

city string

City of the payer.

state string

State of the payer.

country_code string

Country code of the payer (2-letter ISO 3166-2 code).

postcode string

Postal code of the payer.

company_name string

Company name of the payer.

entity_type string

Entity type of the payer. Value: COMPANY.

funding object

Funding status of the payout transfer.

status string

Current funding status. Value: SCHEDULED.

transfer_date string

Scheduled date for the transfer (ISO 8601 date format: YYYY-MM-DD).

transfer_amount double

Amount to be transferred.

transfer_currency string

Currency of the transfer (3-letter ISO-4217 code).

transfer_method string

Method used to transfer the funds. Value: SWIFT.

source_currency string

Source currency of the transfer (3-letter ISO-4217 code).

swift_charge_option string

Option for who bears the SWIFT transfer charges. Value: SHARED.

short_reference_id string

Human-readable short reference for the transfer.

request_id string

Unique identifier of the request associated with the payout transfer.

reason string

Reason for the payout. Value: professional_business_services.

reference string

Client-provided reference for the payout transfer.

remarks string

Additional remarks provided for the payout transfer.

updated_at string

ISO 8601 timestamp indicating when the payout transfer was last updated.

created_at string

ISO 8601 timestamp indicating when the event was created.

version string

API version associated with the event.

Request Body Example

{
  "id": "c7096585-ea08-460a-a404-794a7b7c3051",
  "name": "payout.transfer.funding.scheduled",
  "account_id": "acct_i74Os0HwMhmqPw9ND12TRQ",
  "data": {
    "amount_beneficiary_receives": 1000.0,
    "amount_payer_pays": 153.32,
    "beneficiary": {
      "address": {
        "street_address": "4456 Boyle Dale",
        "city": "Altamonte Springs",
        "state": "Brisaside",
        "country_code": "CN",
        "postcode": "25000"
      },
      "bank_details": {
        "account_currency": "CNY",
        "account_name": "Sylvia Hayes",
        "account_number": "75312643",
        "bank_country_code": "CN",
        "bank_name": "Denesik Inc",
        "swift_code": "ABOCCNBJ"
      },
      "company_name": "Considine - Jones",
      "entity_type": "COMPANY",
      "type": "BANK_ACCOUNT"
    },
    "created_at": "2025-04-30T12:31:37+0000",
    "fee_amount": 15.32,
    "fee_currency": "USD",
    "fee_paid_by": "PAYER",
    "funding": {
      "status": "SCHEDULED"
    },
    "id": "0ae18279-3260-4fb5-9658-61fb74cec888",
    "payer": {
      "additional_info": {
        "business_incorporation_date": "2024-02-19",
        "business_registration_number": "SG-444-32-9207",
        "business_registration_type": "COMPANY"
      },
      "address": {
        "city": "Melbourne",
        "country_code": "SG",
        "postcode": "3000",
        "state": "VIC",
        "street_address": "Melbourne St, Melbourne St"
      },
      "company_name": "demo_zoqq",
      "entity_type": "COMPANY"
    },
    "reason": "professional_business_services",
    "reference": "Test 5672b696-418e-4f56-a6cb-f3c77403409f",
    "remarks": "",
    "request_id": "4f5eaad9-35a6-4f4d-8a88-5d9e7d390113",
    "short_reference_id": "P250430-2PR7PF3",
    "source_currency": "USD",
    "status": "SCHEDULED",
    "swift_charge_option": "SHARED",
    "transfer_amount": 1000.0,
    "transfer_currency": "CNY",
    "transfer_date": "2025-04-30",
    "transfer_method": "SWIFT",
    "updated_at": "2025-04-30T12:31:37+0000"
  },
  "created_at": "2025-04-30T12:31:38+0000",
  "version": "2025-02-14"
}

Payout Transfer Funded

Triggered when funds for a payout transfer have been successfully allocated and are ready for processing.

Description

Sent when the funding stage of a payout transfer is complete, indicating funds are secured for the upcoming transfer.

Funding Details

Confirms funds are secured for transfer
Shows complete fee breakdown
Includes beneficiary bank details
Contains payer information
Provides transfer method details

📦 Event Details

id string

Unique event identifier.

name string

Event name: payout.transfer.funding.funded.

account_id string

Unique identifier of the account associated with the payout transfer.

data object

Event payload containing payout transfer and funding details.

id string

Unique identifier of the payout transfer request.

amount_beneficiary_receives double

Amount the beneficiary will receive.

amount_payer_pays double

Total amount the payer will pay.

beneficiary object

Details of the beneficiary receiving the payout.

bank_details object

Bank account details of the beneficiary.

account_name string

Name on the beneficiary's bank account.

account_number string

Beneficiary's bank account number.

account_currency string

Currency of the beneficiary's bank account (3-letter ISO-4217 code).

bank_name string

Beneficiary's bank name.

bank_country_code string

Country code of the bank (2-letter ISO 3166-2 code).

swift_code string

SWIFT/BIC code of the beneficiary's bank.

company_name string

Beneficiary's company name.

entity_type string

Entity type of the beneficiary. Value: COMPANY.

fee_amount double

Fee amount charged for the transfer.

fee_currency string

Currency of the fee (3-letter ISO-4217 code).

payer object

Details of the payer initiating the transfer.

company_name string

Company name of the payer.

entity_type string

Entity type of the payer. Value: COMPANY.

funding object

Funding status of the payout transfer.

status string

Current funding status. Value: FUNDED.

transfer_amount double

Amount to be transferred.

transfer_currency string

Currency of the transfer (3-letter ISO-4217 code).

transfer_method string

Method used to transfer the funds. Value: SWIFT.

source_currency string

Source currency of the transfer (3-letter ISO-4217 code).

reference string

Client-provided reference for the payout transfer.

short_reference_id string

Human-readable short reference for the transfer.

updated_at string

ISO 8601 timestamp indicating when the payout transfer was last updated.

created_at string

ISO 8601 timestamp indicating when the event was created.

version string

API version associated with the event.

Request Body Example

{
  "id": "a16aba92-7ff3-49fd-91f0-5109c8391f9f",
  "name": "payout.transfer.funding.funded",
  "account_id": "acct_i74Os0HwMhmqPw9ND12TRQ",
  "data": {
    "amount_beneficiary_receives": 1000.0,
    "amount_payer_pays": 153.32,
    "beneficiary": {
      "bank_details": {
        "account_currency": "CNY",
        "account_name": "Sylvia Hayes",
        "account_number": "75312643",
        "bank_country_code": "CN",
        "bank_name": "Denesik Inc",
        "swift_code": "ABOCCNBJ"
      },
      "company_name": "Considine - Jones",
      "entity_type": "COMPANY"
    },
    "fee_amount": 15.32,
    "fee_currency": "USD",
    "funding": {
      "status": "FUNDED"
    },
    "id": "0ae18279-3260-4fb5-9658-61fb74cec888",
    "payer": {
      "company_name": "demo_zoqq",
      "entity_type": "COMPANY"
    },
    "reference": "Test 5672b696-418e-4f56-a6cb-f3c77403409f",
    "short_reference_id": "P250430-2PR7PF3",
    "source_currency": "USD",
    "status": "SCHEDULED",
    "transfer_amount": 1000.0,
    "transfer_currency": "CNY",
    "transfer_method": "SWIFT",
    "updated_at": "2025-04-30T12:31:38+0000"
  },
  "created_at": "2025-04-30T12:31:38+0000",
  "version": "2025-02-14"
}

Payout Transfer Funding Scheduled​

Description

Funding Details

📦 Event Details

Request Body Example

Payout Transfer Funded​

Description

Funding Details

📦 Event Details

Request Body Example

Payout Transfer Funding Scheduled

Payout Transfer Funded