Pular para o conteúdo

POST /v1/charges

POST
/v1/charges
curl --request POST \
--url https://seu-endereco-da-api/v1/charges \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "provider": "asaas", "manual": { "pixCode": "example", "boletoLine": "example", "paymentUrl": "example" }, "contactId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "dealId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "valueCents": 1, "dueDate": "example", "description": "example", "document": "example", "idempotencyKey": "example", "confirmDuplicate": true, "newDealPipelineId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

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

Media typeapplication/json
object
provider
string
Allowed values: asaas manual
manual
object
pixCode
string
<= 512 characters
boletoLine
string
<= 64 characters
paymentUrl
string
<= 2000 characters
contactId
string format: uuid
dealId
string format: uuid
valueCents
required
number
>= 1 <= 100000000
dueDate
string
<= 10 characters
description
string
<= 500 characters
document
string
<= 32 characters
idempotencyKey
required
string
>= 8 characters <= 64 characters
confirmDuplicate
boolean
newDealPipelineId
string format: uuid
Media typeapplication/json
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
bankSlipAttached
required

Whether the boleto PDF was saved in the files of the charge’s deal

boolean

Example

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

Invalid CPF/CNPJ, due date in the past, or contact not linked to the deal

Asaas not connected, or contact/deal not found

Open charge already exists, charging is off, or the charge is still being created

Payer CPF/CNPJ missing, Asaas refused the charge, or a manual charge without a code or link

Asaas did not answer