Criar cobrança PIX em BRL

View as Markdown
Endpoint de emissão PIX em BRL para a integração documentada. Este endpoint exige: - `Authorization: Bearer <accessToken>` - `secret-key: btoa(clientKey:clientSecret)` - `Origin` correspondente ao domínio liberado O campo `customerIdentifier` é obrigatório e as taxas PIX seguem a hierarquia: `customer -> user -> settings`.

Authentication

AuthorizationBearer

Token retornado pelo endpoint /auth/login.

secret-keystring

Chave Base64 no formato btoa(clientKey:clientSecret).

Request

This endpoint expects an object.
amountdoubleRequired
payerDocumentstringRequired
payerNamestringRequired
customerIdentifierstringRequired

_id ou taxId do customer.

allowThirdPartyPaymentbooleanOptional
correlationIdstringOptional
isCreditGmcbooleanOptional

Response

Cobrança criada com sucesso.

_idstring
txidstring
amountdouble
creditdouble
payerDocumentstring
payerNamestring
userIdstring
valueCreditInGmcdouble or null
statusstring
isCreditGmcboolean
customerIdentifierstring
pixobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
503
Service Unavailable Error