Pular para o conteúdo

POST /v1/conversations/{id}/charges

POST
/v1/conversations/{id}/charges
curl --request POST \
--url https://seu-endereco-da-api/v1/conversations/example/charges \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "templateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "variables": [ "example" ], "provider": "asaas", "valueCents": 1, "dueDate": "example", "description": "example", "document": "example", "expireAfterDays": 1, "dealId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "methods": [ "pix" ], "manual": { "pixCode": "example", "boletoLine": "example", "paymentUrl": "example" }, "order": { "items": [ { "retailerId": "example", "name": "example", "amountCents": 1, "quantity": 1 } ], "taxCents": 1, "shippingCents": 1, "discountCents": 1 }, "idempotencyKey": "example", "confirmDuplicate": true }'

Permissão que a Chave de acesso precisa: Enviar mensagem e atender (conversations:write) e Emitir e cancelar cobranças pelo Asaas (charges:manage).

id
required
string
Media typeapplication/json
object
templateId
required
string format: uuid
variables
required
Array<string>
provider
required
string
Allowed values: asaas manual
valueCents
required
number
>= 1 <= 100000000
dueDate
string
<= 10 characters
description
string
<= 500 characters
document
string
<= 32 characters
expireAfterDays
number
<= 60
dealId
string format: uuid
methods
Array<string>
>= 1 items
Allowed values: pix boleto payment_link
manual
object
pixCode
string
<= 512 characters
boletoLine
string
<= 64 characters
paymentUrl
string
<= 2000 characters
order
object
items
required
Array<object>
>= 1 items
object
retailerId
string
<= 100 characters
name
required
string
>= 1 characters <= 60 characters
amountCents
required
number
>= 1 <= 100000000
quantity
required
number
>= 1 <= 999
taxCents
required
number
<= 100000000
shippingCents
required
number
<= 100000000
discountCents
required
number
<= 100000000
idempotencyKey
required
string
>= 8 characters <= 64 characters
confirmDuplicate
boolean
Media typeapplication/json
object
charge
required
object
id
required
string
provider
required
string
Allowed values: asaas manual
contactId
required
string
dealId
required
string
nullable
status
required
string
Allowed values: creating pending overdue paid refunded chargeback canceled expired failed
environment
required

Null for a manual charge

string
nullable
Allowed values: sandbox production
valueCents
required
number
description
required
string
dueDate
required
string format: date
methods
required

Methods the charge offers, in the order they are sent

Array<string>
Allowed values: pix boleto payment_link
invoiceUrl
required

Payment link: the Asaas invoice page, or the link typed for a manual charge

string
nullable
pixCode
required

Pix copy and paste code

string
nullable
boletoLine
required

Boleto digitable line

string
nullable
order
required

Order items, only for a charge sent as order details

object
items
required
Array<object>
object
retailerId
required
string
name
required
string
amountCents
required
number
quantity
required
number
taxCents
required
number
shippingCents
required
number
discountCents
required
number
receiptUrl
required

Asaas page with the proof of payment, known once the payment is confirmed

string
nullable
failureReason
required
string
nullable
expiresAt
required

When the charge stops accepting payment

string format: date-time
nullable
paidAt
required
string format: date-time
nullable
availableAt
required

When the money became available in the Asaas account

string format: date-time
nullable
refundedAt
required
string format: date-time
nullable
canceledAt
required
string format: date-time
nullable
expiredAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
createdByName
required
string
nullable
markedPaidByName
required
string
nullable
lastResentAt
required
string format: date-time
nullable
lastResentByName
required
string
nullable
resendCount
required

How many times the payment message was sent again to the customer

number
messageId
required
string

Example

{
"charge": {
"provider": "asaas",
"status": "creating",
"environment": "sandbox",
"methods": [
"pix"
]
}
}

Not an approved payment template, wrong variables, invalid code or link, or order total that does not match

Conversation, template, deal or Asaas connection not found

The channel is not WhatsApp Business, an open charge exists without confirmDuplicate, or the charge is still being created

A method has no code or link, the Pix receiver is missing, the payer CPF/CNPJ is missing, or Asaas refused

Asaas did not answer