Cashout

Cashout in U4C PIX API is very simple. Learn how...

API Reference: Creating Transfer V2

Payment/value transfer transactions via Pix, or Pix cash-out, can occur in the following ways:

  • Manually;
  • By Pix (DICT) key;

Manually

Advantages:

  • Does not consume the client's bucket;
  • Has more checks on the receiver. (Avoids sending the transaction to the wrong account).

Disadvantages:

  • It is necessary to have more information about the receiver.
// Manual PIX transaction
{
  "customerId": "string",
  "externalId": "string", // uuid
  "initiationType": "MANUAL",
  "transfer": {
    "branch": "Joi.string().trim().required()",
    "accountNumber": "string",
    "taxId": "string",
    "accountType": "CACC" | "SLRY" | "SVGS" | "TRAN",
    "ispb": "string",
    "name": "string",
    "value": "number",
    "description": "string" // optional
  }
}

 

PIX Key

Advantages:

  • Only the PIX key needs to be known;
  • If the taxId is sent, it is verified whether the owner of the PIX key has the same taxId provided.

Disadvantages:

  • Consumes bucket tickets if the transfer is not successful.
// PIX Key transaction
{
  "customerId": "string",
  "externalId": "string", // uuid
  "initiationType": "DICT",
  "transfer": {
    "key": "string",
    "keyType": "CPF" | "CNPJ" | "EMAIL" | "PHONE" | "EVP",
    "taxId": "string", // optional
    "value": "number",
    "description": "string" // optional
  }
}

What’s Next