Skip to main content

Create a Payout

Create a new payout.

Endpoint​

POST /v1/payouts

Scope​

payouts:create

Request​

Request Body​

NameTypeDescription
preferred_channelTURBO
SAVE (default)		The payout preferred channel to create the payout.

TURBO means that the payout will try to use the turbo channel.

SAVE means that the payout will be sent using the standard channel.
fee_typeDEDUCTED_FROM_ITEM_AMOUNT
STANDARD		The fee type to create the payout.

DEDUCTED_FROM_ITEM_AMOUNT means that the fee will be deducted from the item amount.

STANDARD means that the fee will charged to the customer in the transfer_amount.
origin_source_iduuidThe Id of the wallet from the tokens come from. To get this id you need to call the endpoint Get Wallets before.
itemsArray<New Payout Item>The items to create the payout.
info

You can see more about the items property for create payout clicking on this link.

List of Available Banks​

The item.bank_account_details.bank_name property must be filled with one of the banks in the following list. Using any other bank will return an error.

warning

IMPORTANT: The list of available banks is different for production and sandbox environments. Please use one of the options listed below.

Click here to view the Available Banks list
  • BANCAMIA
  • BANCIEN
  • BANCO_AGRARIO
  • BANCO_AV_VILLAS
  • BANCO_BBVA
  • BANCO_BTG_PACTUAL
  • BANCO_CAJA_SOCIAL_BCSC
  • BANCO_COMPARTIR
  • BANCO_CONTACTAR
  • BANCO_COOPERATIVO_COOPCENTRAL
  • BANCO_DAVIVIENDA
  • BANCO_DE_BOGOTA
  • BANCO_DE_OCCIDENTE
  • BANCO_FALABELLA
  • BANCO_GNB_SUDAMERIS
  • BANCO_JP_MORGAN
  • BANCO_MULTIBANK
  • BANCO_MUNDO_MUJER
  • BANCO_PICHINCHA
  • BANCO_POPULAR
  • BANCO_PROCREDIT
  • BANCO_SANTANDER
  • BANCO_SERFINANZA
  • BANCO_UNION
  • BANCO_W
  • BANCOLDEX
  • BANCOLOMBIA
  • BANCOOMEVA
  • BNP_PARIBAS
  • BOLD
  • CITIBANK
  • COINK
  • COLTEFINANCIERA
  • CONFIAR
  • DAVIPLATA
  • DING_TECNIPAGOS_SA
  • GLOBAL66
  • IRIS
  • ITAU_CORPBANCA_COLOMBIA_S_A
  • ITAU
  • JFK_COOPERATIVA_FINANCIERA
  • JP_MORGAN_CORPORACION_FINANCION
  • LULO_BANK
  • MOVII_SA
  • NEQUI
  • NU
  • PIBANK
  • POWWI
  • RAPPIPAY
  • SANTANDER_CONSUMER
  • SCOTIABANK_COLPATRIA
  • UALA

Example Request Body​

{
  "fee_type": "DEDUCTED_FROM_ITEM_AMOUNT",
  "origin_source_id": "2af83836-43ea-407b-ab4e-9c64ee817b28",
  "items": [
    {
      "amount": "2000",
      "full_name": "John Doe",
      "token": "COPM",
      "legal_identifier_type": "CC",
      "legal_identifier": "123456789",
      "country_iso": "CO",
      "network": "BANK",
      "bank_account_details": {
        "bank_name": "BANCO_FALABELLA",
        "type": "SAVINGS",
        "number": "2109309321"
      }
    }
  ]
}

Response​

Below you can find an example of what a successful response of a Payout object looks like.

{
  "output": {
    "id": "d5e5262c-5697-408d-bb9b-48c3cf8c2f89",
    "created_at": "2024-10-18T01:43:02.763Z",
    "updated_at": "2024-10-18T01:43:02.763Z",
    "finished_at": null,
    "fee_type": "DEDUCTED_FROM_ITEM_AMOUNT",
    "fee_amount": "700",
    // 👇 This is the amount that you need to send to the wallet address
    "transfer_amount": "2000",
    "refunded_amount": null,
    "status": "PENDING",
    "status_code": "AWAIT_PROCESSING",
    "origin_source_id": "d0866d0f-7532-44bc-9466-126764682a0b",
    "public_data": {
      "creator_type": "SYSTEM",
      "creator_identifier": "pKwqg9A7F832CAIX",
      // 👇 This is the wallet address where you need to send the tokens
      "deposit_wallet_address": "0x6f2D66cF59Cf6C1c2609f0127c91A480020dC2fd"
    },
    "activities": [
      {
        "type": "CREATE_PAYOUT",
        "status": "SUCCEEDED",
        "last_update_at": "2024-10-18T01:43:02.761Z"
      },
      {
        "type": "AWAIT_PROCESSING",
        "status": "PENDING",
        "last_update_at": "2024-10-18T01:43:02.761Z"
      }
    ]
  },
  "code": "CREATED"
}

Test the endpoint​

curl -X POST 'https://api.minteo.finance/v1/payouts' \
-H 'Authorization: Bearer <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{
  "fee_type": "DEDUCTED_FROM_ITEM_AMOUNT",
  "origin_source_id": "2af83836-43ea-407b-ab4e-9c64ee817b28",
  "items": [
    {
      "amount": "2000",
      "full_name": "John Doe",
      "token": "COPM",
      "legal_identifier_type": "CC",
      "legal_identifier": "123456789",
      "country_iso": "CO",
      "network": "BANK",
      "bank_account_details": {
        "bank_name": "BANCO_FALABELLA",
        "type": "SAVINGS",
        "number": "2109309321",
      }
    }
  ]
}'