Withdrawal

Withdrawal is a process of transferring money from your wallet to your customer.

At the moment, we can offer you:

🇧🇷 Pix
🇲🇽 SPEI / CLABE
🇵🇪 Cash
💳 Visa / MC
🇮🇳 India
Skrill
Binance Pay
Crypto

Looking for something?
Feel free to contact us if you are looking for some other options.

API

Request

🇧🇷 Pix

🇲🇽 SPEI / CLABE

🇵🇪 Cash

💳 Visa / MC

🇮🇳 India

Skrill

Binance Pay

Crypto

POST /api/v3/order/withdrawal/create

{
  # A unique id on the merchant side. Required
  "merchantOrderId": "1697637323",

  # Amount of money to withdraw. Required
  "amount": "100.54",

  # Three-letter ISO currency code, in lowercase. Required
  "currency": "brl",

  # Represents various types of requisites. Required
  "counterparty": {
    # Type of counterparty. Required
    "type": "pixKey",

    # Beneficiary's Pix key
    # It is registered by the Brazilian user himself in his bank and can be either the user's taxId, cellphone number, e-mail, or random key.
    # Required
    "pixKey": "[email protected]"
  },
  "client": {
    # Name of withdrawal beneficiary. Required.
    "name": "John Doe",

    "taxpayer": {
      # A CPF number is the Tax ID issued when you register with the Brazilian Revenue
      "number": "85517053009"
    }
  },
  # Endpoint that is expected to receive webhook. Optional
  "webhookUrl": "https://example.com/webhook-url/1697637323"
}

Response

RESPONSE

{
  "data": {
    # An identifier of the order on the LaFinteca side
    "id": "d68ed1c2-1cf9-40f5-b997-3b31d1495904",

    # Provided identifier
    "merchantOrderId": "1697637323",

    # Type of order
    "type": "payout",

    "createdAt": "2023-10-18T13:55:25+00:00",

    # Status of order
    "status": "new"
  },
  "error": null
}

Status

Refer to the Status & Webhook section for generic guidance.

New

Processing

Completed

Rejected

The new order status means that the order has not yet been processed.

This status is not final and will change.

RESPONSE

{
  "data": {
    "id": "e300df2c-5692-4efd-8c3b-b1f498709a01",
    "merchantOrderId": "1697637323",
    "type": "payout",
    "createdAt": "2023-10-18T12:56:39+00:00",

    # Status of order
    "status": "new",
    "merchantSourceWallet": null,
    "merchantTargetWallet": null,
    "transactions": [
      {
        "type": "payout",
        "id": "de071bb1-60be-4c8c-9b3e-e5c2b5f19483",

        # Status of transaction
        "status": "new",

        # Amount of money that will be withdrawn from merchant
        "merchantWallet": {
          "amount": "100.54",
          "currency": "brl"
        },

        # Amount of money that will be received by customer
        "paidOut": {
          "amount": "100.54",
          "currency": "brl"
        },
        "counterpartyInfo": null,
        "paymentInfo": null,
        "createdAt": "2023-10-18T12:56:39+00:00",
        "completedAt": null,
        "rejectReason": null
      }
    ]
  },
  "error": null
}

Withdrawal

API

Request

Response

Status

Are there any inquiries still outstanding?

Withdrawal