Transfer Resource

The transfer is created in batching method, meaning you can do 1 transfer or include more transfers in 1 request. It is best to create multiple transfer in 1 request for faster processing. We ensure that the transfer will execute safely by queueing the transfer based on source account in FIFO manner.

{
    "data": {
        "id": "batch_tr_xxxxxxxxxxxxxxxxxxxxxxxx",
        "transfers": [
            {
                "id": "tr_xxxxxxxxxxxxxxxxxxxxxxxx",
                "livemode": true,
                "merchant_id": "org_xxxxxxxxxxxxxxxxxxxxxxxx",
                "source_account": {
                    "number": "xxxxxxxxxxxxxxxxxxxxxxxx",
                    "name": "xxxxxxxxxxxxxxxxxxxxxxxx",
                    "bic": "PAEYPHM2XXX"
                },
                "destination_account": {
                    "number": "xxxxxxxxxxxxxxxxxxxxxxxx",
                    "name": "xxxxxxxxxxxxxxxxxxxxxxxx",
                    "bic": "PAEYPHM2XXX"
                },
                "amount": 10000,
                "fee": 0,
                "currency": "PHP",
                "provider": "instapay",
                "provider_reference_number": "ref-xxxxxxxxxxxxxxxxxxxxxxxx",
                "reference_number": "ref xxxxxxxxxxxxxxxxxxxxxxxx",
                "purpose": "transfer fund",
                "callback_url": "",
                "metadata": {
                    "test": "123"
                },
                "status": "pending",
                "batch_transfer_id": "batch_tr_xxxxxxxxxxxxxxxxxxxxxxxx",
                "created_at": "0001-01-01T00:00:00Z",
                "updated_at": "0001-01-01T00:00:00Z"
            }
        ]
    }
}

data.id string Unique ID of the batch transfer resource.

data.transfers.id string Unique ID of the transfer resource.

data.transfers.livemode bool Determines whether or not the transfer is happening in test or live mode environment. The transfer is live and uses live wallet money when livemode is true, and otherwise, it is in test mode when false.

data.transfers.merchant_id string Merchant ID that initiates the transfer

data.transfers.source_account dictionary

data.transfers.destination_account dictionary

data.transfers.amount integer

Represents the amount of money that will be moved (excluding fee) in this transfer

data.transfers.fee string Represents the fee that will be charged for this transfer

data.transfers.currency string Represents the currency in which this transfer is occuring

data.transfers.provider string The entity that will facilitate the method of the transfer

Possible values: paymongo - Transfer will be facilited by PayMongo intraservices instapay - Transfer will be facilited by Instapay 3rd Party Provider pesonet - Transfer will be facilited by Pesonet 3rd Party Provider

data.transfers.provider_reference_number string Represents the reference number generated by the provider for identifying the transfer

data.transfers.reference_number string Merchant provided reference number to identify the transfer. If no value is provided, we will generate a random string.

data.transfers.purpose string Describes the purpose of this transfer

data.transfers.callback_url string URL that will be called by our system for notifying the progress of the transfer via HTTP call

data.transfers.metadata dictionary Optional data to be included as additional information for the transfer

data.transfers.status string The current status of the transfer

Possible values: pending - Transfer is processing succeeded - Transfer is successful failed - Transfer is failed

data.transfers.batch_transfer_id string Correlates to data.id field

data.transfers.created_at date Created date of the transfer

data.transfers.updated_at date Updated date of the transfer