API Reference

The Perform a Cash-out endpoint in the Wudi Pay facilitates the initiation of a cash-out transaction, allowing users to withdraw funds from the platform.

✳️

Pix Keys for Cash-Out Simulation!

In order to conduct a Cash-Out simulation in a test environment, it is imperative to utilize Pix keys from the corresponding testing environment. Presented below is a comprehensive list of Pix keys specific to the test environment, facilitating a seamless and accurate Cash-Out simulation.

List of active Pix keys:

  • EVP: fc470f19-7a03-4f45-827f-6dc8cda78e68
  • Phone: 5541997586063
  • E-mail: [email protected]
  • Cnpj: 72723322000170
  • CPF: 40959375805

✳️

Key type and its formats

The supported types are CPF, CNPJ, PHONE, EMAIL, and EVP. You must correctly specify the key in the "Key" field to ensure the transfer is made to the correct account. However, it is not necessary to explicitly specify the key type; just follow the standard format for each key, and the system will automatically identify the type:

  • CPF: Only numbers, 11 digits.
  • CNPJ: Only numbers, 14 digits.
  • Phone: Phone number in international format, including the country code, e.g., 5511999999999. ( “+” is not required )
  • Email: A valid email address.
  • EVP (Virtual Payment Address): A unique identifier provided by the bank or financial institution (UUID).

Cash-out Status

  • CREATED: The cash-out request has been created.
  • PROCESSING: The cash-out request is being processed.
  • DONE: The cash-out request has been successfully processed and completed, with the funds transferred to the destination account.
  • REJECTED: The cash-out request was rejected due to some issue.
  • REFUNDED: The cash-out amount has been refunded to the customer.
  • PARTIALLY_REFUNDED: Part of the cash-out amount has been refunded to the customer.
  • FAILED: The cash-out request failed and could not be completed due to some issue. When this status is returned, it means the transaction was canceled, and a new transaction must be made.

➡️

Practical Tips

  • Pix Key Validation: Check that the Pix key and the holder's document are correct to avoid failures when executing the withdrawal.
  • Testing in the Sandbox Environment: Use Pix keys specific to the testing environment when simulating withdrawal operations.

🚧

HEADERS

Authorization (string, required): The access token generated by the authentication endpoint must be included in the authorization header in the format Bearer {{access_token}}.

Language
Authorization
Header
Click Try It! to start a request and see the response here!