Create Charge

Generate a new QR Code Pix or Boleto payment request.

Request Body

merchant_id

integer

Merchant id of the account that is creating the payin. The custom number will be different for sandbox and production environment. Is mandatory if there is more than one account under your umbrella (sellers).Min: 2, Max: 10000

invoice

string

required

Your identification number, it must be unique on our database.Max length: 255 characters

notification_url

string

The url where we will submit the callbacks.Min: 1 character, Max: 255 characters

payment_method

string

required

Payment method that will be used in payin.Allowed values: pix, boleto

amount

integer

required

The charge total amount in the smallest currency unit (e.g., 100 cents to charge R$1.00). When payment_method is pix, the minimum value is 1. When payment_method is boleto, the minimum value is 500.Min: 1, Max: 15000000

currency

string

required

Currency code of the amount (ISO 4217).Length: 3 charactersExample: BRL

country

string

required

Country code (ISO 3166-1 alpha-2).Length: 2 charactersExample: BR

description

string

Instructions that will be displayed to the user.Max length: 140 characters

buyer

object

required

The person you are charging object.

Show Buyer Object

name

string

required

The buyer name.Max length: 100 characters

string

required

Buyer email address. Required for PIX and Boleto payment methods.Max length: 191 characters

document

object

required

The buyer document.

Show Document Object

type

string

required

Document type. Example: CPF, CNPJ

number

string

required

Document number.

address

object

The buyer’s address. Required when payment_method is boleto.

Show Address Object

country

string

Country code.

city

string

City name.

street

string

Street name.

number

string

Street number.

complement

string

Address complement.

zipcode

string

ZIP/Postal code.

district

string

District/Neighborhood.

state_code

string

State code.

originator_legal_entity

object

Use this object to inform the legal name of the final beneficiary. Required when payment_method is boleto.

Show Originator Legal Entity

name

string

The final beneficiary name to appear in the payin.Max length: 45 characters

document

string

The tax ID to appear in the charge. If Brazilian, CPF or CNPJ number.Min: 11 characters, Max: 15 characters

helpdesk

string

Website, e-mail address or other customer channel to appear in the payin.Max length: 45 characters

pix

object

Pix QRCode specific instructions. Required when payment_method is PIX.

Show Pix Object

expire_date

string

required

The charge expiration date. Format: YYYY-MM-DDTHH:MM:SSImportant: When using time 00:00:00 means BEGINNING of the day, NOT end of the day.Min: 10 characters, Max: 19 charactersExample: 2024-12-31T23:59:59

refund_mode

string

FULL_REFUND_MERCHANT: The refund amount will be fully debited from the wallet of the issuer of the payin
FULL_REFUND_CLIENT: The refund amount will be fully debited from the client wallet
FULL_REFUND_RECIPIENT: The refund amount will be fully debited from the seller informed in the split
REFUND_BY_SPLIT: Allows you to indicate at the time of the refund which wallets will be debited

Allowed values: FULL_REFUND_MERCHANT, FULL_REFUND_CLIENT, FULL_REFUND_RECIPIENT, REFUND_BY_SPLITDefault: FULL_REFUND_MERCHANT

fine

object

Fine when the expiration date is reached.

Show Fine Object

percent

number

Fine percentage. Required if interest is not provided.Min: 0.1

interest

number

Interest percentage. Required if percent is not provided.Min: 0.1

discount

object

Schedule a discount for early payment, before the due date.

Show Discount Object

percent

number

Discount percentage. Required if amount is not provided.

amount

integer

Discount amount. Required if percent is not provided.Min: 1

date

string

required

Discount date. Required when percent or amount is provided. Format: YYYY-MM-DDMust be today or a future date.Example: 2025-12-31

automatic_pix

object

Automatic Pix configuration object. Required when creating an Automatic Pix charge.

Show Automatic Pix Object

frequency

string

required

Recurrence frequency.Allowed values: weekly, monthly, quarterly, semiannual, annual

amount

integer

The fixed amount to be charged in each cycle. Required if minimum_authorization_amount is not provided.Min: 1

minimum_authorization_amount

integer

The minimum amount for authorization. Required if amount is not provided.Min: 1

authorization_amount

integer

The amount to be authorized. Required when minimum_authorization_amount is provided.Min: 1

type

string

required

The type of the automatic pix.Allowed values: immediate, optional

contract_id

string

required

Unique identifier for the contract (invoice ID).Max length: 35 characters

contract_name

string

required

Name of the contract (invoice name).Max length: 35 characters

authorization_notification_url

string

URL to receive authorization notifications.Max length: 255 characters

start_date

string

required

The start date of the automatic pix. Format: YYYY-MM-DD

number_of_cycles

integer

Number of cycles for the automatic pix.Min: 1

boleto

object

Boleto specific instructions. Required when payment_method is BOLETO.

Show Boleto Object

expire_date

string

required

The payin expiration date. Format: YYYY-MM-DDExample: 2024-12-31

fine

object

Fine when the expiration date is reached.

Show Fine Object

percent

number

Fine percentage. Required if interest is not provided.Min: 0.1

interest

number

Interest percentage. Required if percent is not provided.Min: 0.1, Max: 20

date

string

Fine date. Format: YYYY-MM-DDMust be today or a future date.

discount

object

Discount when a certain date is reached.

Show Discount Object

percent

number

Discount percentage.

amount

integer

Discount amount.

date

string

Discount date.

Response

integer

WEpayment’s auto generated id, use this id to perform conciliation or perform queries via API / Dashboard.

merchant

object

Merchant object.

Show Merchant

integer

Id of the WE account that created the payin.

name

string

Name of the WE account that created the payin.

hash

string

WEpayments auto generated hash, use this hash to send your user to the payment page.

payment_page

string

The WEpayments payment page is the place where you will redirect the end customer to pay the bill.

our_number

string

The bank identification number.

invoice

string

Your identification number.

notification_url

string

The url where we will submit the callbacks.

payment_method

string

Payment method that will be used in payin.Values: pix, boleto

amount

integer

The payin total amount in cents.

paid_amount

integer

The total amount of the payin paid.

refunded_amount

integer

Amount refunded from this charge. Only pix payment_method.

currency

object

Currency object.

Show Currency

integer

Currency id.

name

string

Currency name.

code

string

Currency code (ISO 4217).

symbol

string

Currency symbol.

description

string

Instructions that will be displayed to the user.

buyer

object

The person you are charging object.

originator_legal_entity

object

Final Beneficiary object.

pix

object

Pix QRCode specific instructions object.

Show Pix Response

expire_date

string

Expiration date in format YYYY-MM-DDTHH:MM:SS.

refund_mode

string

Type of refund mode.

qr_code

string

QRCode Pix / Copy and paste that will be used by your end customer to make the payin payment.

end_to_end

string

Unique identifier for a transaction.

fine

object

Fine when the expiration date is reached.

discount

object

Discount when a certain date is reached.

boleto

object

Boleto specific instructions object.

Show Boleto Response

expire_date

string

Expiration date in format YYYY-MM-DD.

digitable_line

string

Typed boleto line that will be used by your end customer to pay payin.

bar_code_number

string

Barcode number for the boleto.

agreement

object

Extra data for billet rendering.

fine

object

Fine when the expiration date is reached.

discount

object

Discount when a certain date is reached.

status

object

Status object.

Show Status

integer

Status id.

name

string

Status name.

status_history

array

Status History object.

substatus

object

Sub status object. Can be null.

refunds

array

Refund object.

automatic_pix

object

Automatic Pix configuration object (if enabled). Returns null when not configured.

Show Automatic Pix Response

authorization_id

string

Authorization ID.

schedule_id

string

Schedule ID.

contract_id

string

Contract ID.

created_at

string

Cash-in created date.

updated_at

string

Cash-in update date.

curl --location 'https://api.sandbox.wepayout.co/v2/payin/payments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN_HERE' \
--data-raw '{
	"pix": {
		"expire_date": "2025-12-31T23:59:59"
	},
	"buyer": {
		"name": "Buyer Name",
		"document": {
			"type": "CPF",
			"number": "34960826312"
		},
		"email": "buyer-email@wepayments.com.br"
	},
	"amount": 3000,
	"invoice": "YOUR-CODE1234",
	"country": "BR",
	"currency": "BRL",
	"payment_method": "pix"
}'

{
  "id": 51687,
  "merchant": {
    "id": 477,
    "name": "Merchant Test Sandbox"
  },
  "hash": "642fadb2dd586c6fe00ed4c47193757c1db23d190378817976391f1c61787847",
  "payment_page": "https://pagar.sandbox.goboleto.com/?hash=642fadb2dd586c6fe00ed4c47193757c1db23d190378817976391f1c61787847",
  "our_number": "30896",
  "invoice": "YOUR-INVOICE-CODE",
  "notification_url": null,
  "payment_method": "pix",
  "amount": 3000,
  "paid_amount": null,
  "refunded_amount": null,
  "currency": {
    "id": 19,
    "name": "Reais",
    "code": "BRL",
    "symbol": "R$"
  },
  "description": "",
  "created_at": "2025-11-19T11:45:27.000000Z",
  "updated_at": "2025-11-19T11:45:28.000000Z",
  "buyer": {
    "name": "Buyer Name",
    "email": "buyer@example.com",
    "document": {
      "type": "cpf",
      "number": "12345678901"
    },
    "address": {
      "country": "BR",
      "city": null,
      "street": null,
      "number": null,
      "complement": null,
      "zipcode": null,
      "district": null,
      "state_code": null
    }
  },
  "originator_legal_entity": {
    "name": null,
    "document": null,
    "helpdesk": null
  },
  "pix": {
    "expire_date": "2025-12-31T23:59:59",
    "refund_mode": "FULL_REFUND_MERCHANT",
    "qr_code": "00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/7cc95f1a-743e-4f4a-a3ad-e2ba14f5f6f8520400005303986540510.005802BR5908Wepayout6014Belo Horizonte61083038040362070503***63049F6B",
    "end_to_end": null,
    "fine": {
      "percent": null,
      "amount": null,
      "date": null
    },
    "discount": {
      "percent": null,
      "amount": null,
      "date": null
    }
  },
  "status": {
    "id": 1,
    "name": "Created"
  },
  "status_history": [
    {
      "status": {
        "id": 1,
        "name": "Created"
      },
      "updated_at": "2025-11-19T11:45:28.000000Z"
    }
  ],
  "substatus": null,
  "refunds": [],
  "automatic_pix": null
}

Payin Webhook

Receive real-time payin status notifications

Test Documents

Test values and documents for payin testing

Get Unique Charge

Retrieve a specific charge by ID

Account

Banks

Payin

Payout

KYC

Markup

Create Charge

Create Charge

Request Body

Response

Payin Webhook

Test Documents

Get Unique Charge

Account

Banks

Payin

Payout

KYC

Markup

Documentation Index

​Create Charge

​Request Body

​Response

​Related Resources

Payin Webhook

Test Documents

Get Unique Charge

Create Charge

Request Body

Response

Related Resources