PIX

Aprenda a integrar su solución para procesar pagos con PIX.

Info

El estado de la compra para Medios Alternativos de Pago permanecerá en Pending hasta que el cliente complete el pago.

PIX

PIX es un medio de pago oficial brasileño lanzado por el Banco Central local. Permite la confirmación inmediata del pago y está disponible 24 horas al día, 7 días a la semana. Para completar un pago, el pagador puede utilizar cualquier Home Banking o Wallet copiando y pegando el ID de transacción o escaneando el código QR.

Parámetros del Request

Para procesar pagos en efectivo, necesitas incluir campos específicos en tu solicitud. Para información sobre autenticación, idiomas de respuesta y parámetros básicos como monto y moneda, consulta el artículo sobre operación de compra.

Propiedad	Tipo	¿Obligatorio?	Descripción
`PaymentMethod`	`string`	Sí	Consulta el identificador en la tabla de Medios de pago.
`TargetCountryISO`	`string`	Sí	Indica el país destino.
`Customer` → `Email`	`string`	Sí	Correo electrónico del cliente.
`Customer` → `FirstName`	`string`	Sí	Nombre del cliente.
`Customer` → `LastName`	`string`	Sí	Apellido del cliente.
`Customer` → `DocumentType`	`string`	Sí	Tipo de documento del cliente. Consulte la tabla de tipos de documento para ver los posibles valores.
`Customer` → `DocumentNumber`	`string`	Sí	Número de documento del cliente.
`Customer` → `PhoneNumber`	`string`	No	Número de teléfono del cliente.
`Customer` → `Address` → `Country`	`string`	No	País del cliente.
`Customer` → `Address` → `State`	`string`	No	Estado del cliente.
`Customer` → `Address` → `City`	`string`	No	Ciudad del cliente.
`Customer` → `Address` → `AddressDetail`	`string`	No	Detalle de la dirección del cliente.
`Customer` → `Address` → `PostalCode`	`string`	No	Código postal del cliente.
`MetaDataIn` → `PaymentExpirationInMinutes`	`numeric`	Sí	Configure el tiempo de expiración del pago a través de este campo, especificando la duración en minutos.
`MetadataIn.` → `AddressStreet`	`string`	No	Calle de la dirección del cliente.
`MetadataIn` → `AddressNumber`	`string`	No	Número, piso o apartamento de la dirección del cliente.
`MetadataIn` → `AddressDistrict`	`string`	No	Distrito de la dirección del cliente.

Ejemplo del Request {#request-example}>

{
    "PaymentMethod": "PIX",
    "Order": "paymentID3022",
    "Amount": 20000,
    "Currency": "BRL",
    "Description": "Purchase Test",
    "MetaDataIn": {
        "PaymentExpirationInMinutes": "7200",
        "AddressStreet": "Avenida Anisio Fernandes Coelho",
        "AddressNumber": "661",
        "AddressDistrict": "PR"
    },
    "TargetCountryISO": "BR",
    "Customer": {
        "Address": {
            "AddressDetail": "Avenida Anisio Fernandes Coelho, 661 ",
            "PostalCode": "29060670",
            "City": "Vitoria",
            "State": "ES",
            "Country": "Brasil"
        },
        "FirstName": "Jhon",   
        "LastName": "Doe",
        "DocumentNumber": "47168892703",
        "DocumentType": "CPF.BR",
        "PhoneNumber": "3188060418",
        "Email": "john@mail.com"
    }
}

Parámetros del Response

En el Response, se encuentran los siguientes parámetros:

Propiedad	Tipo	Descripción
`Response` → `MetadataOut` → `PaymentCode`	`string`	Código del pago generado por PIX.
`Response` → `MetadataOut` → `PaymentBarCode`	`string`	Este código, que corresponde en Brasil al copia e cola, permite a los pagadores copiarlo en su app bancaria. Este parámetro es útil para generar el código QR cuando cree su propio checkout.
`Response` → `MetadataOut` → `PaymentBarCodeUrl`	`string`	URL de la página de pago. Esta página tiene el código QR generado en la cadena devuelta en el parámetro `PaymentBarCode`. También puede redirigir al pagador a esta página para completar el pago.
`Response` → `MetadataOut` → `PaymentExpirationDate`	`date`	Fecha de expiración del pago. Formato DD/MM/AAAA HH:MM:SS.

Página de pago en PIX

PrintScreen

Ejemplo del Response

{
    "TransactionId": "128635201747174176",
    "Result": "COMPLETED",
    "Status": "PENDING",
    "ErrorCode": null,
    "ErrorDescription": null,
    "Created": "2024-12-20T20:46:20.199",
    "AuthorizationDate": "2024-12-20T20:46:20.674",
    "AuthorizationCode": "",
    "Amount": 1000,
    "Currency": "BRL",
    "Installments": 1,
    "TaxableAmount": null,
    "Tip": null,
    "Url": "https://api.stage.bamboopayment.com/Purchase/128635201747174176",
    "MetadataOut": {
        "PaymentCode": "b961a342fa172d22f22767134b0aebf1e86fa337038d4634f470ab894d71f9fc",
        "PaymentBarCode": "00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/7cc95f1a-743e-4f4a-a3ad-e2ba14f5f6f8520400005303986540510.005802BR5908Wepayout6014Belo Horizonte61083038040362070503***63049F6B",
        "PaymentDigitableLine": "api-pix-h.bancobs2.com.br/spi/v2/7cc95f1a-743e-4f4a-a3ad-e2ba14f5f6f8",
        "PaymentBarCodeUrl": "https://pagar.sandbox.goboleto.com/?hash=b961a342fa172d22f22767134b0aebf1e86fa337038d4634f470ab894d71f9fc",
        "PaymentExpirationDate": "21/12/2024 20:09"
    },
    "Action": null,
    "PaymentMethod": {
        "Brand": "Pix",
        "CardOwner": null,
        "Bin": null,
        "IssuerBank": null,
        "Type": "BankTransfer",
        "Expiration": null,
        "Last4": null
    }
}

Última modificación 20 de diciembre de 2024