Pagamentos

API de pagamento de contas, titulos e boletos

A rota da API para sandbox é: https://apigw-sandbox.zoop.ws/v2

post
Pagamento de contas

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/accounts/:account_id/payments
Este serviço permite a criação de uma operação de pagamento de contas através de código de barras referentes a títulos de cobrança, tributos ou boletos bancários.
Request
Response
Request
Path Parameters
account_id
required
string
ID da conta pagadora
marketplace_id
required
string
ID do marketplace
Headers
Content-Type
required
string
application/json
Body Parameters
interest
optional
integer
Valor discriminado de juros pela operação utilizado no calculo no valor
discount
optional
integer
Valor discriminado de desconto utilizado no calculo do valor
bar_code
required
string
Dados do código de barras do pagamento a ser realizado
amount
required
integer
Valor total a ser repassado ao banco incluindo taxa e juros em centavos do pagamento a ser realizado
statement_descriptor
optional
string
Descrição a ser exibida no extrato de lançamentos da conta debitada
reference_id
optional
string
Valor de referência do pagamento no seu sistema
metadata
optional
object
Metadados associados ao pagamento
Response
200: OK
Boleto pago com sucesso
{
"id": "string",
"account_id": "string",
"marketplace_id":"12d9e4b370e9441ea578d562a9b735f3",
"amount": "3.50",
"discount": "2.00",
"interest": "0.50",
"fine":"0.00",
"statement_descriptor": "Pagamento de contas",
"bar_code": "23793000000000000003391090109000078600076640",
"status": "created",
"payment_id":"579e68359d7b4af0bc625bb61699d69a",
"resource": "billing_payment",
"recipient": "Company",
"recipient_document": "1234",
"referenc_id":"1234",
"operation": {
"id": "b9602ec221a64f8897eb883eed72592e",
"amount": "-3.50",
"gross_amount": "-3.50",
"nsu": 11,
"date": "2019-08-15T15:04:29.848403",
"fee": "0.00",
"current_balance": "1.06",
"object_type": "payment",
"object_id": "442b0729ff874c0d84deb905dbb18745",
"type": "payment",
"created_at": "2019-08-15T15:04:29.729921",
"updated_at": "2019-08-15T15:04:29.729921",
"dflag": "active",
"authorization": {
"external_key": "2ed672d431054261913d0e16daf6024a",
"type": "payment",
"status": "payment"
},
"resource": "payment_account.payment"
}
}

get
Busca de detalhes do pagamento pelo ID do pagamento

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/accounts/:account_id/payments/:payment_id
Serviço que retorna os detalhes do pagamento atrvés do ID do pagamento.
Request
Response
Request
Path Parameters
payment_id
required
string
ID do pagamento realizado
account_id
required
string
ID da conta pagadora
marketplace_id
required
string
ID do marketplace
Response
200: OK
{
"id": "string",
"account_id": "string",
"marketplace_id":"12d9e4b370e9441ea578d562a9b735f3",
"amount": "3.50",
"discount": "2.00",
"interest": "0.50",
"fine":"0.00",
"statement_descriptor": "Pagamento de contas",
"bar_code": "23793000000000000003391090109000078600076640",
"status": "created",
"payment_id":"579e68359d7b4af0bc625bb61699d69a",
"resource": "billing_payment",
"recipient": "Company",
"recipient_document": "1234",
"referenc_id":"1234",
"operation": {
"id": "b9602ec221a64f8897eb883eed72592e",
"amount": "-3.50",
"gross_amount": "-3.50",
"nsu": 11,
"date": "2019-08-15T15:04:29.848403",
"fee": "0.00",
"current_balance": "1.06",
"object_type": "payment",
"object_id": "442b0729ff874c0d84deb905dbb18745",
"type": "payment",
"created_at": "2019-08-15T15:04:29.729921",
"updated_at": "2019-08-15T15:04:29.729921",
"dflag": "active",
"authorization": {
"external_key": "2ed672d431054261913d0e16daf6024a",
"type": "payment",
"status": "payment"
},
"resource": "payment_account.payment"
}
}

get
Busca de detalhes do pagamento pelo código de barras

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/accounts/:account_id/payments/barcode/:barcode
Serviço que retorna os detalhes do pagamento através da busca pelo código de barras.
Request
Response
Request
Path Parameters
marketplace_id
required
string
ID do marketplace
account_id
required
string
ID da conta pagadora
barcode
required
string
Código de barras do pagamento realizado
Response
200: OK
{
"id": "string",
"account_id": "string",
"marketplace_id":"12d9e4b370e9441ea578d562a9b735f3",
"amount": "3.50",
"discount": "2.00",
"interest": "0.50",
"fine":"0.00",
"statement_descriptor": "Pagamento de contas",
"bar_code": "23793000000000000003391090109000078600076640",
"status": "created",
"payment_id":"579e68359d7b4af0bc625bb61699d69a",
"resource": "billing_payment",
"recipient": "Company",
"recipient_document": "1234",
"referenc_id":"1234",
"operation": {
"id": "b9602ec221a64f8897eb883eed72592e",
"amount": "-3.50",
"gross_amount": "-3.50",
"nsu": 11,
"date": "2019-08-15T15:04:29.848403",
"fee": "0.00",
"current_balance": "1.06",
"object_type": "payment",
"object_id": "442b0729ff874c0d84deb905dbb18745",
"type": "payment",
"created_at": "2019-08-15T15:04:29.729921",
"updated_at": "2019-08-15T15:04:29.729921",
"dflag": "active",
"authorization": {
"external_key": "2ed672d431054261913d0e16daf6024a",
"type": "payment",
"status": "payment"
},
"resource": "payment_account.payment"
}
}

get
Validação de código de barras para pagamento

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/accounts/:account_id/payments/validation/:barcode
Serviço que permite validar se um determinado código de barras é válido além de retornar os dados para pagamento.
Request
Response
Request
Path Parameters
account_id
required
string
ID da conta pagadora
bar_code
required
string
Dados do código de barras para validação dos dados de pagamento
marketplace_id
required
string
ID do marketplace
Response
200: OK
Retorno de boleto tipo registrado
{
"bar_code": "23793000000000000003391090109000078600076640", # Numero do código de barras
"amount": "3.50", # Valor do boleto formatado em reais
"type": "registred", # Tipo do boleto
"due_date": "2019-08-29", # Data limite de vencimento do boleto
"payment_limit_date": null, # Data limite de pagamento de boleto registrado
"payment_opening_schedule": "07:00h", # Horário mínimo para aceitar o pagamento
"payment_closing_schedule": "16:00h", # Horário máximo para aceitar o pagamento
"recipient": "Company", # Nome do beneficiário
"recipient_document": "1234", # Documento do beneficiário
"valid_date": true, # Determina se a data é válida para pagamento
"valid_window": true, # Determina se o horário é válido para pagamento
"computed_bill_values": {
"discount_value": "0.00", # Valor calculado de desconto formatado em reais
"interest_amount": "0.00", # Valor calculado de juros formatado em reais
"late_fee_value": "0.00", # Valor calculado de multa formatado em reais
"total_amount": 0 # Valor total a ser pago pelo boleto já acrescido de juros, multa e desconto, formatado em reais
},
"receive_divergent_value": {
"code": 3, # Determinar quais as possibilidades de pagamento (1: permite pagamento em qualquer valor, 2: permite pagamento apenas com os valores mínimo e máximo, 3: permite pagamento apenas com valor máximo, 4: permite pagamento apenas com valor mínimo)
"description": "Não aceitar pagamento com valor divergente",
"min_payment_value": "0.00",
"max_payment_value": "0.00"
}
}