> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wepayout.co/llms.txt
> Use this file to discover all available pages before exploring further.
# Create Charge
> Create a new credit card charge with payment page or transparent checkout
## Request Body
The url where we will submit the callbacks.
Your identification number, it must be unique on our database.
The use of clientID to create payments. Is mandatory if there is more than one account under the same clientId.
Payment instructions.
Expiration date in format `YYYY-MM-DDTHH:SS`. Ex.: 2021-12-31T23:59:59
Amount in cents (e.g., 8652 = R\$ 86.52)
Payment instructions text
The person that you are charging object.
Buyer's full name
CPF or CNPJ number
Document type: `CPF` or `CNPJ`
Street name
Street number
Address complement
ZIP code
City name
District/neighborhood
State code (2 letters, e.g., "PR")
Default: `FULL_REFUND_CLIENT`
Enum: `FULL_REFUND_CLIENT`, `FULL_REFUND_RECIPIENT`, `REFUND_BY_SPLIT`
Enum of some refund options.
**REQUIRED FOR CREDIT-CARD CHARGES.**
Use this object to inform the legal name of the final beneficiary, it could be your company's name or the company you are proving a service for.
Final Beneficiary is a person or a company that will receive the amount paid trough the boleto.
Sender name
Sender document (CPF or CNPJ)
Sender helpdesk contact
Payer informations for transparent checkout. Use `token` for new card payment or `card_id` for saved card payment.
Card token generated by the tokenization process. Required if `card_id` is not provided. Max length: 190 characters.
ID of a previously saved credit card. Required if `token` is not provided.
Number of installments (1 for single payment). Required unless checkout is null.
Payment method identifier (e.g., "master", "visa", "elo"). Max length: 30 characters. Required if `card_id` is not provided.
Payer's full name. Max length: 100 characters. Required unless checkout is null.
Payer's phone number. Must be numeric with 5 to 45 digits.
Payer's CPF or CNPJ number. Must be a valid tax number.
ZIP code. Max length: 45 characters. Required if payer\_address is provided.
Street name. Max length: 100 characters. Required if payer\_address is provided.
Street number. Max length: 45 characters. Required if payer\_address is provided.
Payer's email address. Required if `save_card` is set to `1`.
Flag to save card for future use. `0` = do not save, `1` = save card. Must be 0 or 1.
Short description shown at the credit-card bill.
Array with product metadata.
Default: `null`
Enum: `0`, `1`, `null`
Flag to inform that the charge must validate through three d secure mode
## Response
Charge ID
Unique key for payment page access
Client ID
Client name
Sender name
Sender helpdesk
Buyer name
Buyer document
Buyer email
Your custom number
Our internal number
Digitable line (for boleto)
Bar code number (for boleto)
Current status
Status ID
Status name
Sender information
Type of payment (e.g., "credit-card")
Payment instructions
Amount in cents
Paid amount in cents
Payment date
Expiration date
Creation date
Fine information
Discount information
Status change history
Refund mode
Refunded amount in cents
Refund records
Sub-status
KYC information
Installment information
Has advancement flag
3D Secure flag
```json 201 theme={null}
{
"id": "28018",
"key": "e1ebf9d914174902a76a5af436f091d09cca0b1e9ad8984b5dcdfeead67ce6b8",
"clientId": 1,
"clientName": "Your company",
"senderName": null,
"senderHelpdesk": null,
"buyerName": "Maria da Silva",
"buyerDocument": "34960826312",
"buyerEmail": "buyer-email@wepayments.com.br",
"customNumber": "YOUR-CODE1234",
"ourNumber": null,
"digitableLine": null,
"barCodeNumber": null,
"status": {
"id": 1,
"name": "awaiting approval"
},
"sender": {
"name": null,
"document": null,
"helpdesk": null
},
"typePayin": "credit-card",
"instructions": "Esse Pagamento é referente ao pedido 123 na loja abcd",
"amountCents": 8652,
"paidAmountCents": null,
"paidAt": null,
"expiresAt": "2024-12-31 23:59:59",
"createdAt": "2024-02-21T19:15:00.000000Z",
"fine": null,
"discount": null,
"statusHistory": [
{
"status": {
"id": 1,
"name": "Created"
}
},
{
"status": {
"id": 6,
"name": "awaiting approval"
},
"id": 48859,
"updatedAt": "2024-02-21T19:15:04.000000Z"
}
],
"refundMode": "FULL_REFUND_CLIENT",
"refundAmountCents": 0,
"payinRefunds": [],
"payin_substatus": null,
"kyc": null,
"installments": [],
"hasAdvancement": true,
"use3ds": false
}
```
```json 400 theme={null}
{
"message": "Bad Resquest message"
}
```
```json 401 theme={null}
{
"error": "Unauthorized"
}
```
```json 403 theme={null}
{
"error": "Forbidden resource"
}
```
```json 404 theme={null}
{
"status": false,
"message": "Payin not found",
"data": "No result were found for the given parameters. Please try again using other suported keys: id, key, ourNumber or end_to_end"
}
```
```json 422 theme={null}
{
"status": false,
"message": "Validation error",
"data": {
"title.expireDate": [
"The title.expire date must be a date after now."
],
"product_info": [
"The product info field is required."
]
}
}
```
```json 500 Internal Server Error theme={null}
{
"status": false,
"message": "Server error"
}
```