---
title: "Payout"
method: POST
path: "/payout"
tags: ["Payout"]
---

# Payout

`POST /payout`

## Headers

- `X-Request-ID` string

## Request body

- object
  - `consumerId` string — Gateway consumer ID (user ID)
  - `consumer` object
    - `email` string, email — Email address. Required if you do not use **consumerId** parameter in request.
    - `ip` string — IPv4 or IPv6. Required if you do not use **consumerId** parameter in request.
  - `paymentAccountId` string, uuid — ID of the encoded user payment details
  - `siteId` string — Payout will be linked to the passed <b>siteId</b>, otherwise – to the first merchant site
  - `parameters` union — Payout method
    - object
      - `type` 'card', required
      - `number` string, required — Full card number
      - `firstName` string, required — First name
      - `lastName` string, required — Last name
      - `expirationMonth` string, required — The expiry month of the card
      - `expirationYear` string, required — The expiry year of the card
      - `birthday` string, nullable — Date of birth
    - object
      - `type` 'payid', required
      - `payid` string, required — Valid email or phone number should be provided in this parameter.
    - object
      - `type` 'crypto', required
      - `address` string — Blockchain address
      - `blockchain` 'BTC' | 'ETH' | 'LTC' | 'BCH' | 'DOGE' | 'DASH' | 'TRX' | 'BNB' | 'XMR' | 'USDT-TRC20' | 'USDT-ERC20' | 'USDT-BEP20' — Blockchain
    - object
      - `type` 'ach', required
      - `fullName` string, required — Full name
      - `phone` string — Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).
      - `email` string, email — Email address
      - `address` string — Address
      - `city` string — City name
      - `state` string — State name
      - `accountType` 'С' | 'S', required — Specify account type. C - for checking account, S - for savings account
      - `abaNumber` string, required — Specify the ABA routing number of the bank account
      - `accountNumber` string, required — Account number
      - `code` union — Use CCD for business accounts, PPD - for private
        - unknown
        - unknown
    - object
      - `type` 'sepa', required
      - `iban` string, required — International bank account number in ISO-13616 format
      - `fullName` string, required — Full name
    - object
      - `type` 'pix', required
      - `address` string, required — Address
      - `city` string, required — City name
      - `zip` string, required — Postal code
      - `phone` string — Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).
      - `firstName` string, required — First name
      - `lastName` string, required — Last name
      - `email` string, email — Email address
      - `cpf` string — CPF - valid Brazil tax ID, 11-digit number
      - `cnpj` integer — CNPJ - a 14-digit Brazil national registry of legal entities number
      - `evp` string — EVP - Endereço Virtual de Pagamento é um tipo de chave gerado pelo DICT
    - object
      - `type` 'banktransfer', required
      - `firstName` string, required — First name
      - `lastName` string, required — Last name
      - `email` string, email, required — Email address
      - `phone` string, required — Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).
      - `address` string — Address
      - `city` string — City name
      - `state` string, required — State name
      - `zip` string, required — Postal code
      - `countryCode` string, ISO2, required — Country name in ISO2 format
      - `bankCode` string, required — Bank code
      - `bankName` string, required — Bank name
      - `bankBranch` string, required — Spaces (" ") are not allowed. Use an underscore ("_") if a separator is needed.
      - `bankBranchCode` string, required — Bank branch code
      - `bankAddress` string — Bank address
      - `accountNumber` string, required — Account number
      - `documentId` string — Document ID
      - `documentType` string — Document type
    - object
      - `type` 'token', required
      - `value` string, required — Token you have generated after using the Tokenization method.
      - `firstName` string, required — First name
      - `lastName` string, required — Last name
    - object
      - `type` 'chile_transfers', required
      - `email` string, email — Email address
      - `account` string, required — Customer's bank account number
      - `accountType` 'CC' | 'SVGS' | 'VISTA' | 'RUT' | 'SLRY' | 'CORRIENTE' | 'AHORRO' — Customer's account type
      - `accountBank` '29' | '30' | '32' | '33' | '34' | '35' | '36' | '38' | '39' | '58' | '64' | '65' | '67' | '69' | '113', required — Customer's bank code <br> 29 - Banco de Chile/Banco A Edwards/Credichile/Citibank <br> 30 - Banco del Estado de Chile <br> 32 - Banco de Crédito e Inversiones (BCI)/Tbank<br> 33 - Banco Corpbanca<br> 34 - Banco Bice<br> 35 - Banco Santander (Santiago)/Santander/Banefe<br> 36 - Banco Itaú Chile<br> 38 - Banco Security<br> 39 - Banco Falabella<br> 58 - BBVA<br> 64 - Banco Consorcio<br> 65 - Banco Ripley<br> 67 - Banco Coopeuch<br> 69 - Banco Internacional<br> 113 - Scotiabank Sudamericano
      - `accountDocType` 'RUT' | 'RUN', required — RUT (Rol Único Tributario) – tax ID number (8–9 digits)<br> RUN (Rol Único Nacional) – national ID number (8–9 digits)
      - `accountDocId` string, required
      - `firstName` string, required — First name
      - `lastName` string, required — Last name
  - `amount` number, double, required — Amount of operation
  - `currency` string, ISO3, required — Operation currency. If your currency is not supported, we will automatically convert it to USD
  - `url` object
    - `ipnUrl` string, url — The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase
  - `metadata` object — Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal

## Response `201`

Created

- object
  - `payment` object
    - `code` '0' | '1001' | '1002' | '5000' | '5001' | '5003' | '5004' | '5005' | '5006' | '5007' | '5008' | '5010' | '5012' | '5013' | '5014' | '5015' | '5016' | '5019' | '5030' | '5041' | '5043' | '5046' | '5051' | '5053' | '5054' | '5055' | '5057' | '5058' | '5059' | '5061' | '5062' | '5063' | '5065' | '5070' | '5075' | '5078' | '5079' | '5080' | '5082' | '5085' | '5086' | '5091' | '5093' | '5094' | '5096' | '5099' | '5220' | '5221' | '5222' | '5223' | '5224' | '5225' | '5226' | '5227' | '5228' | '5300' — | code | description |---|---| | 0 | success | | 1001 | Underpayment. Paid amount is less than the requested amount. Indicates a successful transaction | | 1002 | Overpayment. Paid amount is greater than the requested amount. Indicates a successful transaction | | 5000 | General bank decline | | 5001 | Refer to Issuer | | 5003 | Invalid merchant | | 5004 | Pick up card(no fraud) | | 5005 | Do not honor | | 5006 | Payment could not be authorised | | 5007 | Pick up card, special condition (fraud account) | | 5008 | Reattempt not permitted | | 5010 | Partial approval | | 5012 | Invalid transaction | | 5013 | Invalid amount | | 5014 | Invalid card number | | 5015 | No such issuer | | 5016 | Invalid cardholder name | | 5019 | Re-enter transaction | | 5030 | Format error | | 5041 | Lost card, pick up (fraud account) | | 5043 | Stolen card, pick up (fraud account) | | 5046 | Closed account | | 5051 | Insufficient funds | | 5053 | Wrong expiration date | | 5054 | Expired card | | 5055 | Invalid PIN | | 5057 | Transaction not permitted - Card | | 5058 | Transaction not permitted - Terminal | | 5059 | Suspected fraud | | 5061 | Withdrawal amount limit exceeded | | 5062 | Invalid service code, restricted | | 5063 | Security Violation | | 5065 | Activity limit exceeded | | 5070 | PIN data required | | 5075 | PIN tries exceeded | | 5078 | Invalid/nonexistent account specified (general) | | 5079 | Blocked, first used | | 5080 | Credit issuer unavailable | | 5082 | Negative online CAM, dCVV, iCVV, CVV, or CAVV results or offline PIN authentication interrupted | | 5085 | No reason to decline | | 5086 | Cannot verify PIN | | 5091 | Issuer or switch is unavailable | | 5093 | Violation, cannot complete | | 5094 | Duplicate transaction | | 5096 | System error | | 5099 | Expired payment | | 5220 | Authentication failed by card issuer | | 5221 | Authentication is unavailable at the moment | | 5222 | Payment attempt failed or canceled | | 5223 | Rejected authentication by the issuer | | 5224 | Card not enrolled | | 5225 | Attempts processing performed | | 5226 | Card account number not found in the card ranges from the Directory Server | | 5227 | 3D Secure SCA required | | 5228 | Verification not completed, timeout | | 5300 | BIC is not SDD compliant | | 5031 | Invalid cardholder address | | 5032 | Invalid phone number | | 5034 | Invalid currency |
    - `description` string — Processing details
    - `action` 'charge'
    - `mode` 'payout'
    - `status` 'success' | 'fail' | 'pending'
    - `amount` number, double — Amount of operation
    - `currency` string, ISO3 — Currency of operation in ISO3 format
    - `orderId` string — Gateway transaction ID
    - `transactionId` string — Payment transaction ID
    - `source` object
      - `method` 'card' — Payment method
      - `number` string — Masked card number (PAN)
      - `brand` string — Card brand
  - `consumer` object
    - `id` string, required — Gateway consumer ID (user ID)
    - `externalId` string — Merchant consumer ID (user ID)
    - `email` string, email — Email address
    - `firstName` string — First name
    - `lastName` string — Last name
    - `phone` string — Consumer's phone number. Must start with an optional '+' sign, followed by up to 16 digits. The first digit (after '+' if present) must be between 1 and 9 (i.e., no leading zeros).
    - `country` string, ISO3 — Country name in ISO3 format
    - `state` string — State name
    - `city` string — City name
    - `zip` string — Postal code
  - `metadata` object — Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.dev/centrobill/apis/centrobill-payment-api.md) · [All operations](https://skmtc.dev/centrobill/apis/centrobill-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/centrobill/centrobill-payment-api/revisions/d0334aeb55ce/schema)