API Pix DFranquias Pay (1.0.0)

API REST para pagamentos via Pix da DFranquias Pay

Cobrança Imediata

Retorna lista de cobranças Pix.

query Parameters

page	number Example: page=1 Página sendo mostrada atualmente.

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"current_page": 1,
"data": [{"id": "e61cb303213f4762b420a33a2361fc53",
"amount": "4.00",
"paid_amount": "0.00",
"message": "Serviço realizado",
"txid": "wTl1Tyn720pcv92PAp82Gb20w6",
"brcode": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000 5204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D",
"due_date": "2024-02-25T03:00:00.000000Z",
"created_at": "2024-02-15T03:00:00.000000Z",
"taxa": "1.50",
"statusCob": 1,
"statusLabel": "ATIVA",
"devedor": {"cnpj": "12345678000195",
"cpf": "12345678909",
"nome": "Pricilo silva"
},
"status": 201
}
],
"first_page_url": "https://minha.dfranquiaspay.com.br/api/pix/cob/links?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://minha.dfranquiaspay.com.br/api/pix/cob/links?page=2",
"links": [{"url": "string",
"label": "string",
"active": true
}
],
"next_page_url": "https://minha.dfranquiaspay.com.br/api/pix/cob/links?page=2",
"path": "https://minha.dfranquiaspay.com.br/api/pix/cob/links",
"per_page": 10,
"prev_page_url": "null",
"to": 10,
"total": 20
}

Cria nova cobrança Pix imediata.

Request Body schema: application/json

Cria uma nova cobrança Pix

	object
	object É obrigatório informar um devedor, sendo um cnpj ou cpf
	object
	Array of objects
solicitacaoPagador	string

Responses

Request samples

Payload

Content type

application/json

{"calendario": {"expiracao": 3600
},
"devedor": {"cnpj": "12345678000195",
"cpf": "12345678909",
"nome": "Pricilo silva"
},
"valor": {"original": "2900.00"
},
"splits": [{"cnpj": "00.000.000/0001-00",
"porcentagem": 44.44
}
],
"solicitacaoPagador": "Mensalidade curso tecnico contabilidade"
}

Response samples

201
400
401
403
500

Content type

application/json

{"id": "e61cb303213f4762b420a33a2361fc53",
"amount": "4.00",
"paid_amount": "0.00",
"message": "Serviço realizado",
"txid": "wTl1Tyn720pcv92PAp82Gb20w6",
"brcode": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000 5204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D",
"due_date": "2024-02-25T03:00:00.000000Z",
"created_at": "2024-02-15T03:00:00.000000Z",
"taxa": "1.50",
"statusCob": 1,
"statusLabel": "ATIVA",
"devedor": {"cnpj": "12345678000195",
"cpf": "12345678909",
"nome": "Pricilo silva"
},
"status": 201
}

Retorna uma cobrança Pix imediata.

path Parameters

charge

required

string

O id da cobrança.

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "e61cb303213f4762b420a33a2361fc53",
"amount": "4.00",
"paid_amount": "0.00",
"message": "Serviço realizado",
"txid": "wTl1Tyn720pcv92PAp82Gb20w6",
"brcode": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000 5204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D",
"due_date": "2024-02-25T03:00:00.000000Z",
"created_at": "2024-02-15T03:00:00.000000Z",
"taxa": "1.50",
"statusCob": 1,
"statusLabel": "ATIVA",
"devedor": {"cnpj": "12345678000195",
"cpf": "12345678909",
"nome": "Pricilo silva"
},
"status": 201
}

Cobrança com vencimento

Retorna lista de cobranças Pix com vencimento.

query Parameters

page	number Example: page=1 Página sendo mostrada atualmente.

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"current_page": 1,
"data": [{"id": "e61cb303213f4762b420a33a2361fc53",
"amount": "4.00",
"paid_amount": "0.00",
"message": "Serviço realizado",
"txid": "wTl1Tyn720pcv92PAp82Gb20w6",
"brcode": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000 5204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D",
"due_date": "2024-02-25T03:00:00.000000Z",
"created_at": "2024-02-15T03:00:00.000000Z",
"taxa": "1.50",
"statusCob": 1,
"statusLabel": "ATIVA",
"devedor": {"cnpj": "12345678000195",
"cpf": "12345678909",
"nome": "Pricilo silva"
},
"status": 201
}
],
"first_page_url": "https://minha.dfranquiaspay.com.br/api/pix/cob/links?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://minha.dfranquiaspay.com.br/api/pix/cob/links?page=2",
"links": [{"url": "string",
"label": "string",
"active": true
}
],
"next_page_url": "https://minha.dfranquiaspay.com.br/api/pix/cob/links?page=2",
"path": "https://minha.dfranquiaspay.com.br/api/pix/cob/links",
"per_page": 10,
"prev_page_url": "null",
"to": 10,
"total": 20
}

Cria nova cobrança Pix com vencimento.

Request Body schema: application/json

Cria uma nova cobrança Pix com vencimento

	object
	object É obrigatório informar um devedor, sendo um cnpj ou cpf
	object
	Array of objects
solicitacaoPagador	string Mensagem emitida pelo cobrador.

Responses

Request samples

Payload

Content type

application/json

{"calendario": {"dataDeVencimento": "2024-02-15",
"validadeAposVencimento": 30
},
"devedor": {"email": "user@mail.com",
"logradouro": "Jacarandá, número 500, bairro: joão são",
"cidade": "Francisco são",
"uf": "MG",
"cep": "39300000",
"cnpj": "12345678000195",
"cpf": "12345678909",
"nome": "Pricilo silva"
},
"valor": {"original": "2900.00",
"desconto": {"valorPerc": "2.00"
}
},
"splits": [{"cnpj": "00.000.000/0001-00",
"porcentagem": 44.44
}
],
"solicitacaoPagador": "Mensalidade curso tecnico contabilidade"
}

Response samples

201
400
401
403
500

Content type

application/json

{"id": "e61cb303213f4762b420a33a2361fc53",
"amount": "4.00",
"paid_amount": "0.00",
"valid_after_due": 30,
"message": "Serviço realizado",
"txid": "wTl1Tyn720pcv92PAp82Gb20w6",
"brcode": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000 5204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D",
"due_date": "2024-02-25T03:00:00.000000Z",
"created_at": "2024-02-15T03:00:00.000000Z",
"taxa": "1.50",
"discount_amount": "3.00",
"statusCobV": 1,
"statusLabel": "ATIVA",
"valorPercJuros": "2.00",
"valorPercMulta": "1.00",
"devedor": {"cnpj": "12345678000195",
"cpf": "12345678909",
"nome": "Pricilo silva"
},
"status": 201
}

Retorna cobrança pix com vencimento.

path Parameters

id

required

string

O id da cobrança.

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "e61cb303213f4762b420a33a2361fc53",
"amount": "4.00",
"paid_amount": "0.00",
"message": "Serviço realizado",
"txid": "wTl1Tyn720pcv92PAp82Gb20w6",
"brcode": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000 5204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D",
"due_date": "2024-02-25T03:00:00.000000Z",
"created_at": "2024-02-15T03:00:00.000000Z",
"taxa": "1.50",
"statusCob": 1,
"statusLabel": "ATIVA",
"devedor": {"cnpj": "12345678000195",
"cpf": "12345678909",
"nome": "Pricilo silva"
},
"status": 201
}

Devolução

Solicita o estorno de um Pix.

path Parameters

id

required

string

Responses

Response samples

Content type

application/json

{"rtrId": "D12345678202009091000abcde123456",
"valor": "23.00",
"horario": "2024-01-09T20:15:00.358Z",
"status": 1,
"statusLabel": "EM_PROCESSAMENTO"
}