Miss any of our Open RFC calls?Watch the recordings here! »

picpay-sdk

1.0.0 • Public • Published

picpay-sdk

Client de integração com PicPay

MIT license Open Source Love svg2

Índice

Início

Fazendo uma requisição

Fazendo uma consulta de status

Fazendo um cancelamento

API Reference

Autor

License

Instalando o pacote

npm install --save picpay-sdk

Como utilizar?

Iniciando

import { ConstructorInterface, Picpay } from 'picpay-sdk';
 
const constructorInterface: ConstructorInterface = {
    picpayToken: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    sellerToken: 'yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy'
}
 
const picpay = new Picpay(constructorInterface);

Paramêtros de criação

Campo Descrição Obrigatório? Default
picpayToken token gerado e fornecido pelo PicPay Sim null
sellerToken token gerado e fornecido pelo PicPay Não null

Fazendo uma requisição

const requestParams: PaymentRequestInterface = {
    buyer: {
        document: '12345678909',
        email: 'email@gmail.com',
        firstName: 'Flavio',
        lastName: 'Takeuchi',
        phone: '+5511912345678',
    },
    value: 7.36,
    referenceId: 'compra-abcd',
    callbackUrl: 'https://callback',
};
 
picpay.payment.request(requestParams)
    .then((response: PaymentResponseInterface) => {
        ...
    })
    .catch((err) => {
        (err as ResponseErrorInterface).message;
    })

Fazendo uma consulta de status

const statusRequest: StatusRequestInterface = {
    referenceId: 'compra-abcd',
}
 
picpay.payment.status(statusRequest)
    .then((response: StatusResponseInterface) => {
        ...
    })
    .catch((err) => {
        (err as ResponseErrorInterface).message;
    })

Fazendo um cancelamento

const cancelarParams: CancelRequestInterface = {
    referenceId: 'compra-abcd',
};
 
picpay.payment.cancel(cancelarParams)
    .then((response: CancelResponseInterface) => {
        ...
    })
    .catch((err) => {
        (err as ResponseErrorInterface).message;
    })

API Reference

Consulte os campos necessários na documentação da PicPay

PT-Br

Autor

Flavio Takeuchi <flavio@banzeh.com.br>

Github

Twitter

Picpay

License

MIT License

Copyright (c) 2017 banzeh

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Install

npm i picpay-sdk

DownloadsWeekly Downloads

5

Version

1.0.0

License

MIT

Unpacked Size

31.8 kB

Total Files

62

Last publish

Collaborators

  • avatar