CooperPay

#### AppLess Payment API

# Authentication

#### 🇺🇸 Authentication is created using your clientId and clientSecret, on the /auth endpoint, to generate a token, valid for up to 5 minutes

#### 🇺🇸 The token must be sent in the header of all requests, with the name parameter "Authorization" and value "Bearer "

#### 🇧🇷 A autenticação é feita utilizando seu clientId e clientSecret, no endpoint /auth, para gerar um token, com validade de até 5 minutos.

#### 🇧🇷 O token deverá ser enviado no cabeçalho de todas as requisições, com o parâmetro de nome "Authorization" e valor "Bearer {{token}}"

# Environment

#### 🇺🇸 The environment variable for approval, present in the API host (env) must be defined as _**hml**_.

#### 🇺🇸 The environment variable for production, present in the API host (env) must be set to _**prd**_.

#### 🇧🇷 A variável de ambiente para homologação, presente no host da API (env) deve ser definida como _**hml**_.

#### 🇧🇷 A variável de ambiente para produção presente no host da API (env) deve ser definida como _**prd**_.

# Headers

- X-ClientId
    

#### 🇺🇸 All requests must contain the X-ClientId parameter in the Header. The value of this parameter must be the clientId belonging to the credentials used in the request.

#### 🇧🇷 Todas as requisições, obrigatoriamente, precisam conter no Header o parâmetro X-CllientId. O valor deste parâmetro deve ser o clientId pertencente as credenciais utilizadas na requisição.

# Return Codes

- 200 - Successfully executed method
    
- 400 - Execution failure or error in sent data
    
- 5XX - Internal server error

API Documentation

Authenticaton

#### 🇺🇸 Create a token.
#### 🇧🇷 Cria um token.

**clientId**  
🇺🇸 Unique company identifier.  
🇧🇷 Identificador único da empresa.

**clientSecret**  
🇺🇸 Company secret key.  
🇧🇷 Chave secreta da empresa.

auth

Webhook

#### 🇺🇸 Defines the URL that will receive all changes from a billing. It is also at this URL that all deposit or transfer notices will be triggered.

#### 🇧🇷 Define a URL que receberá todos as mudanças de uma cobrança. É também nesta URL que serão disparados todos os avisos de depósito ou transferências.

## Order Return Codes

- 0 = created
    
- 1 = payed
    
- 2 = waiting
    
- 3 = canceled
    
- 4 = error
    
- 5 = refunded
    

## Transfer Return Codes

- 0 = created
    
- 1 = transferred
    
- 2 = error
    
- 3 = scheduled
    
- 4 = refunded

webhook

#### 🇺🇸 Defines the URL that will receive all changes from a billing. It is also at this URL that all deposit or transfer notices will be triggered.

#### 🇧🇷 Define a URL que receberá todos as mudanças de uma cobrança. É também nesta URL que serão disparados todos os avisos de depósito ou transferências.

## Order Return Codes

- 0 = created
- 1 = payed
- 2 = waiting
- 3 = canceled
- 4 = error
- 5 = refunded
    

## Transfer Return Codes

- 0 = created
- 1 = transferred
- 2 = error
- 3 = scheduled
- 4 = refunded

webhook with header

#### 🇺🇸 By adding the type, it is possible to filter the receipt of requests by product scope.

#### 🇧🇷 Adicionando o tipo, é possível filtrar o recebimento de requisições por escopo de produto.

**Webhook Types**

_pix_order_  
🇺🇸 This is a type of webhook that will send to the destination url only pay-in status changes.  
🇧🇷 Este é um tipo de webhook que enviará para a url de destino somente mudanças de status de pay-in.

_pix_transfer_  
🇺🇸 This is a type of webhook that will send to the destination url only payout status changes.  
🇧🇷 Este é um tipo de webhook que enviará para a url de destino somente mudanças de status de pay-out.

_bankslip_  
🇺🇸 This is a type of webhook that will send to the destination url only bank-slip status .  
🇧🇷 Este é um tipo de webhook que enviará para a url de destino somente mudanças de status de boletos.

_creditcard_  
🇺🇸 This is a type of webhook that will send to the destination url only the credit card status.  
🇧🇷 Este é um tipo de webhook que enviará para a url de destino somente mudanças de status de cartão de crédito.

account_application  
🇺🇸 This is a type of webhook that will send to the destination url only status changes of the payment account application.  
🇧🇷 Este é um tipo de webhook que enviará para a url de destino somente mudanças de status da abertura da conta de pagamento.

webhook with type

#### 🇺🇸 Excludes the URL that will receive all changes from a payment order.

#### 🇺🇸 You must be informed which specific _ID_ of the Webhook you want to delete.

#### 🇧🇷 Exclui a URL que receberá todos as mudanças de uma ordem de pagamento.

#### 🇧🇷 Deverá ser informado qual o _ID_ específico do Webhook que desejará excluir.

#### 🇺🇸 Lists all URLs that will receive changes from a payment order.

#### 🇺🇸 From this endpoint it is possible to find the ID of a specific Webhook.

#### 🇧🇷 Lista todas as URL que receberão as mudanças de uma ordem de pagamento.

#### 🇧🇷 A partir deste endpoint é possível encontrar o ID de um Webhook específico.

Cash-In

#### 🇺🇸 Display the details of a PIX type payment order.
#### 🇧🇷 Exibi os detalhes de um ordem de pagamento do tipo PIX.

**base64QrCode**  
🇺🇸 Displays the PIX QRCode image in base64 format.
🇧🇷 Exibe em formato base64 a imagem do QRCode do PIX.

**urlQrCode**  
🇺🇸 Displays the short-link that directs the PIX QRCode image as the final object.  
_640px Width x 640px Height, type PNG_
🇧🇷 Exibe o short-link que direciona como objeto final a imagem do QRCode do PIX.  
_640px Largura x 640px Altura, tipo PNG_

**pixCopiaECola**  
🇺🇸 Displays the PIX information in EMV-QRCPS-MPM format, for payers who cannot read the QRCode.
🇧🇷 Exibe em formato EMV-QRCPS-MPM as informações do PIX, para o pagador que não possa ler o QRCode.

order by orderId

#### 🇺🇸 Display the details of a PIX type payment order.

#### 🇧🇷 Displays a list of payments filtered by a specific recipient.

**recipientId**  
🇺🇸 Recipient identifier.  
🇧🇷 Identificador do Recebedor.

**status**  
🇺🇸 ENUM that defines the status of a payment order.
🇧🇷 ENUM que define o status de uma ordem de pagamento.
0 = created
1 = payed
2 = waiting
3 = canceled
4 = error
5 = refunded

**initDTCreate**
🇺🇸 Date in UTC format that defines, within a list, the initial date of creation of payment orders.
🇧🇷 Data em formato UTC que define dentro de um lista a data inicial de criação das ordens de pagamento.

**endDTCreate**
🇺🇸 Date in UTC format that defines, within a list, the final date for creating payment orders.
🇧🇷 Data em formato UTC que define dentro de um lista a data final de criação das ordens de pagamento.

**range**
🇺🇸 Total number of items on the current page.
🇧🇷 Quantidade total de itens da página atual.

**skip**
🇺🇸 Current page index.
🇧🇷 Índice da página atual.

order by external ID

#### 🇺🇸 Display the details of a specific payment order, from an EndToEndID code

#### 🇧🇷 Exibi os detalhes de uma ordem de pagamento específica, a partir de um código EndToEndID

order by end to end ID

#### 🇺🇸 Create a payment order.

#### 🇧🇷 Cria uma ordem de pagamento.

**amount**  
🇺🇸 Total order amount.  
🇧🇷 Valor total da cobrança.  
_(required)_

**installments**  
🇺🇸 Total amount of the number of installments of the order.  
🇧🇷 Quantidade total do número de parcelas da cobrança.  
_(opcional)_

**typeOrder**  
🇺🇸 Used to distinguish order types.  
_Possible values: pix, creditcard or bankslip._  
🇧🇷 Usado para distinguir os tipos de cobrança.  
_Valores possíveis: pix, creditcard ou bankslip._  
_(required)_

**orderDescription**  
🇺🇸 Used to inform instructions to the payer.  
_(optional)_  
🇧🇷 Utilizado para informar instruções para o pagador.  
_(opcional)_

**expiration**  
🇺🇸 Order lifetime, specified in seconds from the creation date. If not informed, a duration of 86400 seconds is assumed, which corresponds to 24 hours.  
_(optional)_  
🇧🇷 Tempo de vida da cobrança, especificado em segundos a partir da data da criação. Se não for informado, assume-se a duração de 86400 segundos, que corresponde a 24 horas.  
_(opcional)_

**customerSocialName**  
🇺🇸 Name of person/company who will pay the order.  
_(required)_  
🇧🇷 Nome da pessoa ou empresa que vai pagar a cobrança.  
_(required)_

**customerCPF**  
🇺🇸 CPF of the person who will pay the order.  
_(required)_  
🇧🇷 CPF de quem vai pagar a cobrança.  
_(required)_

**customerCNPJ**  
🇺🇸 CNPJ of the company who will pay the order.  
_(required)_  
🇧🇷 CNPJ de quem vai pagar a cobrança.  
_(required)_

**externalId**  
🇺🇸 External code that can be filled with information from the contracting system.  
_(optional)_  
🇧🇷 Código externo que pode ser preenchido com informações do sistema contratante.  
_(opcional)_

_**qrCodeExternalId**_  
🇺🇸 External code that can be filled with information from the contracting system. This code is displayed in PixCopiaECola, as well as in QRCode. It can only contain numbers and letters, totaling up to 25 characters.  
_(optional)_  
🇧🇷 Código externo que pode ser preenchido com informações do sistema contratante. Este código é apresentado no PixCopiaECola, assim como no QRCode. Poderá conter apenas números e letras, totalizando até 25 caracteres.  
_(opcional)_

**channel**  
🇺🇸 Used to inform and control which sales channel is used to generate the order.  
_(optional)_  
🇧🇷 Usado para informar e controlar qual o canal de venda utilizado na geração da cobrança.  
_(opcional)_

**merchantDocument**  
🇺🇸 Identifier of the point of sale, being CNPJ for PJ and CPF for PF.  
_(optional)_  
🇧🇷 Identificador do ponto de venda, sendo CNPJ para PJ e CPF para PF.  
_(opcional)_

**merchantName**  
🇺🇸 Corporate Name or Business Name of the store.  
_(optional)_  
🇧🇷 Razão Social ou Nome Fantasia da loja.  
_(opcional)_

**transferAutomatic**  
🇺🇸 The amount will be automatically transferred to the account registered with accreditation.  
_(optional)_  
🇧🇷 Será transferido automaticamente o valor para a conta registrada no credenciamento.  
_(opcional)_

order

#### 🇺🇸 Create a payment order with Webhook.
#### 🇧🇷 Cria uma ordem de pagamento com Webhook.

_webhook_

**url**  
🇺🇸 URL that will receive all changes from a payment order.
🇧🇷 URL que receberá todos as mudanças de uma ordem de pagamento.

**headers**  
🇺🇸 Header containing the credentials (key/value) that will be used for the request to the URL that will receive all the changes of a payment order.
🇧🇷 Cabeçalho contendo as credenciais (key/value) que serão utilizadas para a requisição à URL que receberá todos as mudanças de uma ordem de pagamento.

order with webhook

#### 🇺🇸 Cancel a payment order.

#### 🇧🇷 Cancela uma ordem de pagamento.

🇺🇸 If the payment order is of the "pix" type and has the status "waiting", that is, awaiting payment, it will only be canceled, changing its status to "canceled".

🇧🇷 Caso a ordem de pagamento seja do tipo "pix" e esteja com o status "waiting", ou seja, aguardando pagamento, ela será apenas cancelada, mudando seu status para "canceled".

🇺🇸 If the payment order is paid, that is, with the status "paid", the total amount will be reversed to the payer and the status will be changed to "refused".

🇧🇷 Caso a ordem de pagamento esteja paga, ou seja, com o status "payed", será feito o estorno do valor total ao pagador e o status será alterado para "refused".

refund

Cash-Out

#### 🇺🇸 View details of a specific transfer.

#### 🇧🇷 Exibi os dados de uma transferência específica.

**status**  
🇺🇸 ENUM that defines the status of a transfer.  
🇧🇷 ENUM que define o status de uma transferência.

- 0 = created
- 1 = transferred
- 2 = error
- 3 = scheduled

transfer

#### 🇺🇸 View details of a specific transfer, from the external ID.

#### 🇧🇷 Exibi os dados de uma transferência específica, a partir do ID externo.

**status**  
🇺🇸 ENUM that defines the status of a transfer.  
🇧🇷 ENUM que define o status de uma transferência.

- 0 = created
    
- 1 = transferred
    
- 2 = error
    
- 3 = scheduled

transfer by externalId

#### 🇺🇸 Obtain a transfer receipt.

#### 🇧🇷 Obter um comprovante de transferência.

**transferId**  
🇺🇸 Transfer code received in the transaction event. The result of the request returns a temporary URL, which will expire in 1 minute.  
🇧🇷 Código da transferência recebido na sucesso da transação. O resultado da requisição retorna uma URL temporária, que expirará em 1 minuto.

voucher - transfer

#### 🇺🇸 Creates a transfer action by PIX.

#### 🇧🇷 Cria uma ação de transferência por PIX.

**amount**  
🇺🇸 Total transfer amount.  
🇧🇷 Valor total da transferência.

**type**  
🇺🇸 Transfer type.  
🇧🇷 Tipo de transferência.

**message**  
🇺🇸 Message for the receiver.  
🇧🇷 Mensagem para o recebedor.

**bankAccount**  
🇺🇸 recipient key-pix type.  
🇧🇷 tipo de chave-pix do destinatário.

**bankAccount Types**

_pixCPF_  
🇺🇸 This is the recipient's pix-key type, that uses the Brazilian identification document number, named CPF.  
🇧🇷 Este é um tipo de chave-pix, do destinatário, que utiliza o número do documento de identificação brasileiro, de nome CPF.

_pixCNPJ_  
🇺🇸 This is the recipient's pix-key type, that uses the identification document number of a company, named CNPJ.  
🇧🇷 Este é um tipo de chave-pix, do destinatário, que utiliza o número do documento de identificação de uma empresa, de nome CNPJ.

_pixCelular_  
🇺🇸 This is the type of key-pix, from the recipient, that uses the Cell Phone..  
🇧🇷 Este é o tipo de chave-pix, do destinatário, que utiliza o Celular.

_pixEmail_  
🇺🇸 This is the type of key-pix, of the recipient, that uses the E-mail.  
🇧🇷 Este é o tipo de chave-pix, do destinatário, que utiliza o E-mail.

_pixAleatorio_  
🇺🇸 This is the recipient's pix-key type, that uses a random key.  
🇧🇷 Este é o tipo de chave-pix, do destinatário, que utiliza uma chave aleatória.

#### 🇺🇸 Creates a transfer action by PIX.

#### 🇧🇷 Cria uma ação de transferência por PIX.

**amount**  
🇺🇸 Total transfer amount.  
🇧🇷 Valor total da transferência.

**type**  
🇺🇸 transfer type.  
🇧🇷 Tipo de transferência.

transfer with webhook

Common

#### 🇺🇸 Displays the current available balance.

#### 🇧🇷 Exibe o saldo atual disponível.

balance

Default

CooperPay - API Documentation

CooperPay API

Production

Sandbox

The Cash-Out section of our API allows users to withdraw funds from their account. With this functionality, users can easily transfer their available funds to their preferred payment method. This section provides a convenient way for users to access and manage their financial resources within our platform.

The Cash-Out section of our API allows users to withdraw funds from their account. With this functionality, users can easily transfer their available funds to their preferred payment method. This section provides a convenient way for users to access and manage their financial resources within our platform.

Sections