FatoriPay

Capturar Fatura para Pix

POST

http://{{app_url}}/api/v1/invoices/capture/48acf31b-7e5a-4e2a-8273-157a50dfdd51

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/json

method

string

requerido

Exemplo

{
    "method": "pix"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://{{app_url}}/api/v1/invoices/capture/48acf31b-7e5a-4e2a-8273-157a50dfdd51' \
--header 'Content-Type: application/json' \
--data-raw '{
    "method": "pix"
}'

Respostas

🟢200Capturar Fatura para Pix

application/json

Body

string

requerido

ref

string

requerido

description

null

requerido

status

string

requerido

subtotal_amount

string

requerido

total_amount

string

requerido

tax_amount

null

requerido

discount_amount

null

requerido

link_token

string

requerido

link

string

requerido

customer

object

requerido

string

requerido

name

string

requerido

string

requerido

description

null

requerido

cellphone

string

requerido

cpfcnpj

string

requerido

address

object

requerido

items

array [object {4}]

requerido

string

opcional

product

object

opcional

quantity

integer

opcional

total

string

opcional

payment

object

requerido

string

requerido

status

string

requerido

method

string

requerido

interest_amount

string

requerido

fee_amount

string

requerido

discount_amount

string

requerido

total_amount

string

requerido

transaction

object

requerido

next_withdraw_available

string

requerido

withdraw_agenda

null

requerido

paid_at

null

requerido

payable_with

object

requerido

pix

boolean

requerido

boleto

boolean

requerido

credit_card

boolean

requerido

credit_card_with_interest

boolean

requerido

shipping

null

requerido

due_date

string

requerido

paid_at

null

requerido

notification_url

null

requerido

created_at

string

requerido

notifications

array [object {5}]

requerido

title

string

opcional

message

string

opcional

type

string

opcional

created_at

string

opcional

meta

array[string]

opcional

Exemplo

{
    "id": "643f6c87-1e78-4547-aa32-6a91444c3601",
    "ref": "6",
    "description": null,
    "status": "processing",
    "subtotal_amount": "100,00",
    "total_amount": "100,00",
    "tax_amount": null,
    "discount_amount": null,
    "link_token": "GluQuoh1hJwkRmloI9yWp4nL8berhL",
    "link": "http://localhost:5180/hapo-code-ltda./public/fatura/GluQuoh1hJwkRmloI9yWp4nL8berhL",
    "customer": {
        "id": "da55e5ed-c073-4dce-b649-14e4fe382a11",
        "name": "João da Silva",
        "email": "joao@testeste.com.br",
        "description": null,
        "cellphone": "11999999999",
        "cpfcnpj": "07120188917",
        "address": {
            "street": "Rua Reverendo Paulo Hecke",
            "number": "123",
            "complement": "Sala 1",
            "neighborhood": "Ahú",
            "city": "Curitiba",
            "state": "PR",
            "zip_code": "82200-300"
        }
    },
    "items": [
        {
            "id": "a53552f3-c334-49ac-b692-09a1c162ec95",
            "product": {
                "id": "8c214358-46c3-4d90-991e-e12708deb114",
                "name": "Produto redondo",
                "description": "Desc",
                "price": "50,00"
            },
            "quantity": 2,
            "total": "100,00"
        }
    ],
    "payment": {
        "id": "a1deae9a-cd76-450c-bc2f-a054a29867ac",
        "status": "processing",
        "method": "pix",
        "interest_amount": "0",
        "fee_amount": "2",
        "discount_amount": "0",
        "total_amount": "10000",
        "transaction": {
            "pix_key_text": "00020101021226830014BR.GOV.BCB.PIX2561qrcode-h.bancoarbi.com.br/gi/6036e0fd93ca45f580b4c053781545fb5204000053039865802BR5909FatoriPay6008Curitiba610982200-30062070503***6304693E",
            "pix_key_qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA+gAAAPoAQAAAABl2OlJAAAInElEQVR4Xu2cMXLryA5F6ZrA4SxBS9HSpKVpKVzChA6m3MN7gQabkp1M8PuLc05iCkTfA2YoSu8tbSbLc+F/CvZZYJ8F9llgnwX2WWCfBfZZYJ8F9llgnwX2WWCfBfZZYJ8F9llgnwX2WWCfBfZZYJ8F9llgnwX2WWCfBfZZYJ8F9lkM9nU5cN1Kf21//3CbuWyFz/3AYyuIv5ePvaNYlltT6J/tqzLNn0PPfrkem64NO3aDvcCOHTv24M3sQ/2+2df9RO8IStZx4VYdf7RvHbn7g+x+gp6B3WB/rWMvekeAfQB7dWDH/j72r0gLe/B3lG65yijK2bHbaPtJbs4QQ0e3f0ePHgm7wW6wG+wBduwN+3/ArqjP5vciotsPHXEkl51rJv08cHRgT7Ab7Ids7NixP3dgP599QFHq0DhZ2PF7kbi8ZP+3MjrYDfYCu8FusA9gXxfsLuycxF7Ivu7Z4rF90Hwlu7pcA/ftR5QsOirjyYL9tY4de4IdO3aXsb+9/YDsIftWdozzLwsHsGPHjv3Ar1H/onAAO3bs8+0/UlFiXerNSWQPHUKy4PBVzu9g/x3s2LH3O9ixY39jez+5SHbPq8OvPgb2DuEOFS7u9K8+Yr51qQx9t/M0DnajxgS7wG4e+33sO9gX7NjfzT689YjCcHLZogai0DsSFfRe5En21e9jH1P2S+zYs4AdO/ZOl2FP3tcuyn6vKBOn45+/Pv2EQ9kfe0nYLiSr//5rnC/BXmDHjj3Ajh27OY2917/VdnOhdpsYJ3AhOnph0cBCRxJ9lF2PlNy2woI9wG6wY8e+YMd+anvz5pIn73n1mW0bV19VVDBE3bePscrkOFEYUAF7gj3BXicFduy+wl5gN/flne1PrG7MqFhUlG1iUbn4umTXpifIjp18HTMeSbD/DHbsDTv2hh37aexqNBElnK2TvSPpUSr43UrMNxTu28Vh4GULjUdKsBfYG/YAO3Z3YMeehRPYqzFYF705qa9hlD1Edbv47tuPOGSIYWCFYjfYE+wFduzYsYvT2dVYu83OR7+7+qNfg8T2EwV3xEXM53Wod+hXp8PChD3BXmBv2DvYG3bsJ7bvm8vXMVt42YmotsvGDi87P2SM65DBXmDHjh07dhWwt5PZ+9bxHXuJooYfmbbt5HLsuPpIZkfHcKTLYr607xaD3WDHjh27UP2xYMd+RnsuKrcsKPsQJSqqHWU6Ut/L7DeKODKA3WDHjh17L2AX2H3oJHaRb05it1lsz69hmu3xGmTZd5uS9Q6Nc/jmRo+UvBSwF9gbduzYG3bs57S/kOO8bC4juQ51sqOvQzFwrkNRKLD/Dnbs2I/3BXbs2MVb2ZX9G7r/WIZl58hHJBw6fgi9ufDzbnNofEL3Hwt27AewY8eOHXtxc+H/0R54UYnLoVHFa0VZptcgomT3vJs/8hCPReMID3xr2AvsA9gNdqMidoEd+znsytZbj4ySTI1PUSkT0fG15DjquPhvPsHdXcOys4cm2A127NixY8d+XnvU3dgLOrkRstaGf34SBe02tsdAkpW9Dyw88M2XA9gNduxVwI69YceehZPYlf3CIFu8ueQ4fXMp9hR1WKb51mPHY+njGOwJ9gPYsWPHjn1gT3lHuxo/22ENqXFCdmnabYyKPdsydagQ2YeMOhKFAexGUdiHkwl27EZF7Nixv7G9XpRElMhCyH4cR/bksRWE35x0FGriiAoFdoMdO/aGvWFXAXtFncYe2UOU+GxeVKJwacM4t6aBRc0X1MuW25CR9PkS7An2ZD+JHTt27NhPYVdUnuy7jcZJbu6J+XKcKNSRjuargWO3OQz8826DHTt27Nhv7sGOPQunspcsCt5tgkur7E5kW7YPPMhiPoMde4LdrAt2c6sCdnNp2LGbE9kTRUmmkx6nd0iW3LbN5eKyd5so9sJLhzM0H/YEu1kzNhuxY8eOvfdgFyewt5Q56tZinM9sy2x1ZEHZgVeZyI6MIuzafloPPYA9wY69YceOHXsvnM4uPnR5t0wnsxBRQ8dOrTIaeNh+AhXyZUsM/PtuI7Av2LEb7NWxgx079pE3sR84yPrJwIVlW2XWKi0aWIXItkwdeqTPCMSOPcH+E9gFdux7AXvx3vYhqlN7ie5rHC07w6IS8+V7EdEHLnQktx/NJ7Ab7GYdDiXYsWPHrnvYT2NX3Y2RLZ6+qIlxdC4L8c2Nx+nLjgqHjpovBh7AbrBjx+4o7Nix+9y57K0NLzkCjZPce22pZacPbPveqfk8TjzBy8BDKPYEu6oJdnPvNexRxI69wL68nV18xIfHcvFf7zbButvF1VElC4Zx7lvH4ZH6OAX2BDt27A17svo+9gX7SeyrT3sNiZNRqHFe7DvV0Z/AhKzoodgNdrO6Bzv2PIZ96MA+gN28p/2F1YcG2cXlXHYUJb6WtEdBq4y/21Hpsf0NmTM0zsUfE+w/s1qJ3Vxcxo69YceO/S3ta5cE162g9yJDIbIdFbLesdmVHehVSlMhqHcr3RLjGOxZP4AdexawY8eO/Qz2oa7sIBeVsWBZjCNZos1F5Hy9EKFZwF5gN9gT7AI79ixgP5s9o0IWjbaLaxt2mxGvMuKxXPy3Bj7QC9gNdoO9GrFjN9eGHfvAWe3DW4/IHt6LXOtojaOOA0NoLDuHDuwGu8GOHXvDjl3nlrPb9RokF5VAvxj1OBG1LLH9fOwpms9f1ChD48Q61DTwbeiK0n6JHTt27NgD7NjPZi/CrnEG2SVvfvf5OlkINHCOE0dqHbq1Jwt2gz3Bjh07doP9XPYDsh+i4uRXvx/jaNnxKhNHtP18thxHdqGCufsjdoPdrL5XYMdeHdgNduxvb58A9llgnwX2WWCfBfZZYJ8F9llgnwX2WWCfBfZZYJ8F9llgnwX2WWCfBfZZYJ8F9llgnwX2WWCfBfZZYJ8F9llgnwX2WfyX7f8AnA2Cw/0TcqIAAAAASUVORK5CYII=",
            "pix_due_date": null
        },
        "next_withdraw_available": "24/04/2023",
        "withdraw_agenda": null,
        "paid_at": null
    },
    "payable_with": {
        "pix": true,
        "boleto": true,
        "credit_card": true,
        "credit_card_with_interest": true
    },
    "shipping": null,
    "due_date": "27/04/2023",
    "paid_at": null,
    "notification_url": null,
    "created_at": "24/04/2023",
    "notifications": [
        {
            "title": "Nova fatura criada",
            "message": "Fatura com id: 643f6c87-1e78-4547-aa32-6a91444c3601 criada com sucesso.",
            "type": "success",
            "created_at": "24/04/2023 15:32",
            "meta": []
        }
    ]
}

Modificado em 2025-06-17 19:25:30

Página anterior

Capturar Fatura para Boleto

Próxima página

Capturar Fatura para Cartão de Crédito