> ## Documentation Index > Fetch the complete documentation index at: https://docs.y.uno/llms.txt > Use this file to discover all available pages before exploring further. # The Payout Object This object represents the payout created after generating a transaction to transfer funds from your account to another account or recipient. The unique identifier of the payout (MAX 64 ; MIN 36). Example: 5404911d-5df9-429e-8488-ad41abea1a4b The unique identifier of the account (MAX 64 ; MIN 36). Example: 2404911d-5df9-429e-8488-ad41abea1a4b The status of the Payout (MAX 255; MIN 3). Example: SUCCEEDED The unique identifier of the customer's order (MAX 255; MIN 3). Example: 4234 The description of the payout (MAX 255; MIN 3). Example: marketplace payment Indicates the purpose for the payout. Possible enum values: Check the Purpose list. Country where the transaction must be processed (MAX 2; MIN 2; ISO 3166-1 ). Possible enum values: Check the Country reference. Specifies the payout amount object, with the value and currency. The payout amount (multiple of 0.0001). Example: 10000 The currency used to make the payout (MAX 3; MIN 3; ISO 4217 ). Possible enum values: Check the Country reference. Specifies the beneficiary object with their identification. Unique identifier of the beneficiary defined by the merchant. Example: AAAA01 Beneficiary's national entity type. Possible enum values: `INDIVIDUAL` or `ENTITY` The beneficiary's first name (MAX 80; MIN 1). Example: John The beneficiary's last name (MAX 80; MIN 1). Example: Doe The beneficiary's name (Max: 80). Only necessary when `national_entity` is `ENTITY` . Example: Arcos dorados S.A. The beneficiary's email (MAX 255; MIN 3). Example: [john.doe@email.com](mailto:john.doe@email.com) The beneficiary's country (MAX 2; MIN 2; ISO 3166-1 ). Possible enum values: Check the Country reference. The beneficiary's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10). Example: 1990-02-28 Specifies the beneficiary's document object, including its number and type. The beneficiary's document number (MAX 40; MIN 3). Example: 1093333333 The beneficiary's document type (MAX 6, MIN 2). Possible enum values: Check the Country reference. Specifies the beneficiary's phone number object. The country calling code of the beneficiary's phone (MAX 3; MIN 1). Possible values: Check the Country reference . Example: 57 The beneficiary's phone number, without the country calling code (MAX 32; MIN 1). Example: 3132450765 Specifies the beneficiary's address object. The beneficiary's primary address line (MAX 255; MIN 3). Example: Calle 34 # 56 - 78 The beneficiary's secondary address line (MAX 255; MIN 3). Example: Apartamento 502, Torre I The city considered for the beneficiary address (MAX 255; MIN 3). Example: Bogotá The country of the beneficiary address (MAX 2; MIN 2; ISO 3166-1 ). Possible enum values: Check the Country reference. The beneficiary's state or province address (MAX 255; MIN 3). Example: Cundinamarca The zipcode considered for the beneficiary address (MAX 11; MIN 4). Example: 111111 Specifies the beneficiary's withdrawal\_method object. The withdrawal\_method type. Example: ASTROPAY\_WALLET The provider to process the payout with. Example: ASTROPAY The vaulted\_token represents a securely stored payment\_method. Mainly for credti/debit cards in Payouts. Example: 41032411d-5df9-429e-1238-ad41abea1cft Id of the referenced payment transaction. Only for payouts to CARD. (MAX 64 ; MIN 36). Example: 9104911d-5df9-429e-8488-ad41abea1a4b Defines if the merchant wants to hold the payout and sets it to be processed later using the Release payout endpoint. False by default. Example: false Specifies the withdrawal\_method details. Specifies the beneficiary's withdrawal\_method object. The beneficiary's financial institution code (MAX 3; MIN 3). Example: 246 The beneficiary's specific financial institution branch (MAX 3; MIN 3). Example: XXX The beneficiary's specific financial institution branch digit (MAX 3; MIN 3). Example: 123 Specifies the beneficiary's bank\_transfer account object. Beneficiary's financial institution account number or financial institution account alias, such as Clabe for MX (MAX 255; MIN 3). Example: 1093333333 Beneficiary's financial institution account digit (MAX 3; MIN 1). Example: 123 Beneficiary's account type (MAX 255; MIN 3). Possible enum values: `CHECKINGS`, `SAVINGS`, `VISTA`, `PIX_EMAIL`, `PIX_PHONE`, `PIX_DOCUMENT_ID`, `PIX_BANK_ACCOUNT` Specifies the beneficiary's address object. The beneficiary's primary address line (MAX 255; MIN 3). Example: Calle 34 # 56 - 78 The beneficiary's secondary address line (MAX 255; MIN 3). Example: Apartamento 502, Torre I The city considered for the beneficiary address (MAX 255; MIN 3). Example: Bogotá The country of the beneficiary address (MAX 2; MIN 2; ISO 3166-1 ). Possible enum values: Check the Country reference. The beneficiary's state or province address (MAX 255; MIN 3). Example: Cundinamarca The zipcode considered for the beneficiary address (MAX 11; MIN 4). Example: 111111 Specifies the beneficiary's withdrawal\_method object. The beneficiary's wallet code (MAX 3; MIN 3). Example: 246 The beneficiary's specific wallet email (MAX 3; MIN 3). Example: [john.doe@gmail.com](mailto:john.doe@gmail.com) The beneficiary's wallet country (MAX 2; MIN 2; ISO 3166-1 ). Possible enum values: Check the Country reference. Specifies the beneficiary's document object, including its number and type. The beneficiary's document number (MAX 40; MIN 3). Example: 1093333333 The beneficiary's document type (MAX 6, MIN 2). Possible enum values: Check the Country reference. Specifies the beneficiary's phone number object. The country calling code of the beneficiary's phone (MAX 3; MIN 1). Possible values: Check the Country reference . Example: 57 The beneficiary's phone number, without the country calling code (MAX 32; MIN 1). Example: 3132450765 Specifies a list of payouts objects. The unique identifier for the payout intent (MAX 64 ; MIN 36). Example: 9104911d-5df9-429e-8488-ad41abea1a4b The payout intent type (MAX 255; MIN 3). The payout intent status (MAX 255; MIN 3). The response code indicates the status of the payout intent request (MAX 255; MIN 3). The payout transaction identification defined by the merchant (MAX 255; MIN 3). Example: AAB01-432245 Specifies the payout amount object, with the value and currency. The payout amount (multiple of 0.0001). Example: 10000 The currency used to make the payout (MAX 3; MIN 3; ISO 4217 ). Possible enum values: Check the Country reference. Specifies the purpose for the payout. Description for the payout (MAX 255; MIN 3). Example: Salary Specifies the data provider. The data provider identification. Possible values: `ADDI`, `MERCADO_PAGO`, `SPINPAY`, `WOMPI` The unique identifier of the payment from the provider. Example: 12345678 The merchant's payment provider account id. Example: 9990128 Provider's status of the transaction (MAX 255; MIN 3). Example: accredited The data provider's detailed status of the transaction (MAX 255; MIN 3). Example: approved The data provider raw response. The format depends on the provider's response. The response will vary for each data provider. Transactions creation date (MAX 27; MIN 27, ISO 8601 ). Example: 2022-05-09T20:46:54.786342Z The last transactions update date (MAX 27; MIN 27, ISO 8601 ). Example: 2022-05-09T20:46:54.786342Z Specifies a list of custom key–value pairs associated with the payout (for internal references, reconciliation, or workflow tags). You can add up to 50 metadata objects. Specifies a metadata key and the respective value. Use to attach merchant-defined context (for example: `batch_id`, `payout_reason`). Avoid sending sensitive or personal data. The metadata key (MAX 48 ; MIN 1). Example: order\_id The metadata key value (MAX 512 ; MIN 1). Example: AA001 Transactions creation date (MAX 27; MIN 27, ISO 8601 ). Example: 2022-05-09T20:46:54.786342Z The last transactions update date (MAX 27; MIN 27, ISO 8601 ). Example: 2022-05-09T20:46:54.786342Z