Skip to main content

Payouts

Learn more about the Payout resource

The Payout resource is created when you are scheduled to receive money from PayRex. Payouts are made depending on the payout schedule for your PayRex merchant account.

The Payout Resource​

{
  "id": "po_sdGtgXC3XNhjpsxWd5j7ijWhde7xb4sn",
  "resource": "payout",
  "amount": 1520294,
  "destination": {
    "account_name": "My Company XYZ",
    "account_number": "123123217362122",
    "bank_name": "My Test Bank"
  },
  "livemode": true,
  "net_amount": 14000,
  "status": "successful",
  "created_at": 1747235098,
  "updated_at": 1747263620
}

Attributes​

id string

Unique identifier for the resource. The prefix is po_.

resource string

Represents the resource's type. The value is payout.

amount string

The gross amount of the Payout. This is the amount before PayRex deducts the fees and tax from the money to be settled in your bank account. This is a positive integer in the smallest currency unit, cents. If the gross amount is ₱ 120.50, the amount of the Payout should be 12050.

destination hash

The destination attribute holds the information of the bank account that you nominated for your PayRex merchant account.

Show child attributes

account_name string

The account name of the bank account

account_number string

The account number of the bank account.

bank_name string

The name of the bank.

livemode boolean

The value is true if the resource's mode is live or the value is false if the resource is in test mode.

net_amount string

The net_amount of the Payout is the final computed amount that will be transferred to the bank account associated with the PayRex merchant account. This is a positive integer in the smallest currency unit, cents. If the net_amount is ₱ 120.50, the net_amount of the Payout should be 12050.

status string

The status of the Payout. Possible values are pending, in_transit, failed, or successful.

created_at timestamp

The time the resource was created and measured in seconds since the Unix epoch.

updated_at timestamp

The time the resource was updated and measured in seconds since the Unix epoch.