Skip to main content

PayOutRequest

client_idintegerrequired

Account ID you obtained from PagaSul when integrating

Example: 123
client_payment_idstringrequired

Payment ID unique within your system

Example: payment_35
payment_methodstringrequired

Payment method's code

Possible values: [BR.PIX, AR.BT, AR.QR, CO.BT, CO.PSE, CO.NEQUI, CO.BC, CO.TF, CO.EF, CO.TP, CO.BREB, BO.BT, BO.QR, EC.BT, EC.CASH, EC.MOBILE, VE.BT, VE.PAGOMOVIL]

Example: BR.PIX
currencystringrequired

Code of the pay-out currency in the ISO-4217 alpha-3 format

Possible values: [BRL, ARS, COP, BOB, USD, VES]

Example: BRL
amountnumberrequired

Pay-out amount in major currency units

Example: 12.34
referencestring

Arbitrary reference or note you can attach to the pay-out

payee object

Customer's data section

idstringrequired

Unique ID of the customer within your system

Example: customer_1234
namestring

Customer's full name

Example: John Doe
emailstring

Customer's email

Example: johndoe@example.com
countrystring

Customer's country in the ISO 3166-1 alpha-2 format

Example: BR
statestring

Customer's state

citystring

Customer's city

addressstring

Customer's address

phonestring

Customer's phone

languagestring

Customer's preferred language

Example: pt
cpfstring

Customer's CPF (Cadastro de Pessoas Físicas) for Brazilian payment methods

Example: 231.002.999-00
cuitstring

Customer's CUIT (Clave Única de Identificación Tributaria) for Argentinian payment methods

Example: 30-69330706-2
citizenship_cardstring

Customer's citizenship card (Cédula de Ciudadanía) for Colombian payment methods

Example: 12.34.56.789
nitstring

Customer's NIT (Número de Identificación Tributaria) for Colombian payment methods

Example: 12.34.56.789
is_trustedboolean

Set to true if the customer is already verified on your side

first_namestring

Customer's first name

last_namestring

Customer's last name

middle_namestring

Customer's middle name

regionstring

Customer's region

districtstring

Customer's district

streetstring

Customer's street

buildingstring

Customer's building

zipstring

Customer's postal/ZIP code

birthdatestring

Customer's date of birth

ip_addressstring

Customer's IP address

documentstring

Customer's generic identification document number

cestring

Customer's Cédula de Extranjería for Colombian payment methods

cistring

Customer's Cédula de Identidad

tistring

Customer's Tarjeta de Identidad for Colombian payment methods

passtring

Customer's passport number

rucstring

Customer's RUC (Registro Único de Contribuyentes) for Ecuadorian/Peruvian payment methods

rifstring

Customer's RIF (Registro de Información Fiscal) for Venezuelan payment methods

payee_account object

Customer's account data

pix_keystring

Customer's key for the Pix account. It may be the cusomer's CPF, CNPJ, email, phone, or EVP

Example: johndoe@example.com
pix_key_typestring

Type of the customer's Pix key

Possible values: [CPF, CNPJ, EMAIL, PHONE, EVP]

Example: EMAIL
account_typestring

Customer's bank account type

Possible values: [CACC, SVGS]

Example: CACC
numberstring

Customer's bank account number

Example: 11-342-3
bank_codestring

Customer's bank code

Example: CO.BDNEQ
holder_namestring

Bank account's holder name

Example: John Doe
payment_options object

Optional section for extra parameters used for payment flow adjustment

callback_urlstring

The URL to send callbacks to. If not passed, callbacks will be sent to the URL you provided PagaSul with when integrating

allow_amount_changeboolean

Whether the amount is allowed to change during processing

is_testboolean

Marks the pay-out as a test operation

PayOutRequest
{
  "client_id": 123,
  "client_payment_id": "payment_35",
  "payment_method": "BR.PIX",
  "currency": "BRL",
  "amount": 12.34,
  "reference": "string",
  "payee": {
    "id": "customer_1234",
    "name": "John Doe",
    "email": "johndoe@example.com",
    "country": "BR",
    "state": "string",
    "city": "string",
    "address": "string",
    "phone": "string",
    "language": "pt",
    "cpf": "231.002.999-00",
    "cuit": "30-69330706-2",
    "citizenship_card": "12.34.56.789",
    "nit": "12.34.56.789",
    "is_trusted": true,
    "first_name": "string",
    "last_name": "string",
    "middle_name": "string",
    "region": "string",
    "district": "string",
    "street": "string",
    "building": "string",
    "zip": "string",
    "birthdate": "string",
    "ip_address": "string",
    "document": "string",
    "ce": "string",
    "ci": "string",
    "ti": "string",
    "pas": "string",
    "ruc": "string",
    "rif": "string"
  },
  "payee_account": {
    "pix_key": "johndoe@example.com",
    "pix_key_type": "EMAIL",
    "account_type": "CACC",
    "number": "11-342-3",
    "bank_code": "CO.BDNEQ",
    "holder_name": "John Doe"
  },
  "payment_options": {
    "callback_url": "string",
    "allow_amount_change": true,
    "is_test": true
  }
}