Antes de começar
API para cobranças
A API do Affise fornece a você diferentes métodos para trabalhar com cobranças. Por exemplo, você pode obter informações sobre faturas de pagamento, criar uma fatura de pagamento, removê-la etc. Neste artigo, você encontrará exemplos das solicitações (métodos) de API mais populares para cobranças com exemplos de cURL e exemplos da resposta.
O recurso Faturamento via API está disponível apenas para determinados planos. Entre em contato com o gerente da sua conta Affise para obter o recurso.
Obter lista de pagamentos
Use esse método para obter a lista de pagamentos de acordo com suas propriedades, que você pode indicar em sua solicitação de API.
O método: GET /3.1/payments.
A solicitação para obter a lista de pagamentos com o período especificado:
https://api-rocketcompany.affise.com/3.1/payments?date_from=2022-08-08&date_to=2022-12-12
Criar fatura de pagamento
Use esse método para gerar o faturamento de uma determinada quantia em dinheiro para um determinado afiliado de acordo com suas propriedades, que você pode indicar em sua solicitação de API.
O método: POST /3.1/payments/create-for-affiliate.
A solicitação cURL para a criação de uma fatura de pagamento com as seguintes propriedades:
o ID do afiliado
a soma da fatura de pagamento
o ID da moeda
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/create-for-affiliate' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \--data-urlencode 'aid=2' \--data-urlencode 'sum=2' \--data-urlencode 'currency=150'
Gerar faturas de pagamento para afiliados
Use esse método para gerar o faturamento para um determinado período de tempo de acordo com suas propriedades, que você pode indicar em sua solicitação de API.
O método: POST /3.1/payments/generate.
A solicitação cURL para a criação de uma fatura de pagamento para afiliados com as seguintes propriedades:
a data
o ID do afiliado
o ID do afiliado excluído
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/generate' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \--data-urlencode 'date=2022-05-23' \--data-urlencode 'aid=2' \--data-urlencode 'exclude_aids[]=8'
Atualizar fatura de pagamento
Use esse método para atualizar a fatura de pagamento de acordo com suas propriedades, que você pode indicar em sua solicitação de API.
O método: POST /3.1/payments/{ID}.
A solicitação cURL para atualização da fatura de pagamento com as seguintes propriedades:
as informações da conta de pagamento
o status Parcialmente pago
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/2926' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn' \--data-urlencode 'payment_account=payment account' \--data-urlencode 'status=3'
Adicionar valor de correção para fatura de pagamento
Use esse método para adicionar o valor de correção para a fatura de pagamento de acordo com suas propriedades, que você pode indicar em sua solicitação de API.
O método: POST /3.1/payments/{ID}/add-correction.
A solicitação cURL para adicionar o valor de correção com as seguintes propriedades:
a receita = 22
o comentário
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/2921/add-correction' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \--data-urlencode 'revenue=22' \--data-urlencode 'comment=example'
Remover várias faturas de pagamento
Use esse método para remover várias faturas de pagamento de acordo com suas propriedades, que você pode indicar em sua solicitação de API.
O método: POST /3.1/payments/bulk-delete.
⚠️ Você pode remover o faturamento com qualquer status, exceto Complete. Se você tentar remover o faturamento com o status Complete, receberá o seguinte erro:
A solicitação cURL para várias faturas de pagamento removendo com os ids de fatura de pagamento = 2925 e 2924:
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/bulk-delete' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn' \--data-urlencode 'ids[0]=2925' \--data-urlencode 'ids[1]=2924'
Editar sistemas de pagamento
Use esse método para editar sistemas de pagamento para um afiliado de acordo com suas propriedades, que você pode indicar em sua solicitação de API.
O método: POST /3.0/admin/partner/{ID}.
⚠️ A opção de edição está disponível somente quando o faturamento tem qualquer status, exceto Completo.
A solicitação cURL para editar sistemas de pagamento com ID de sistemas de afiliados = 13, código de moeda = USD e campos avançados = 1b765:
curl --location --request POST 'https://api-rocketcompany.affise.com/3.0/admin/partner/2' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn' \--data-urlencode 'payment_systems[0][system_id]=13' \--data-urlencode 'payment_systems[0][currency]=USD' \--data-urlencode 'payment_systems[0][fields][4]=1b765'
Entre em contato com a equipe de Suporte ao Cliente da Affise sobre todas as questões levantadas por meio do e-mail: [email protected].