Criar QRCode Dinâmico

Através desse endpoint será possível criar um QRCode Pix dinâmico imediato.

POST https://sandbox-api.openbank.stone.com.br/api/v1/pix_payment_invoices

HEADERS

authorization* string
Bearer token de autenticação.

x-stone-idempotency-key* string
Chave de idempotência.

BODY PARAMS

amount integer

account_id* string

key* string

transaction_id* string
Validação: “^[a-zA-Z0-9]{26,35}$”

customer string
name string
document string

additional_data object

    name string
    Tamanho: min 1 / max 50
    value string
    Tamanho: min 1 / max 200

metadata object

    name string
    Tamanho: min 1 / max 50
    value string
    Tamanho: min 1 / max 200

expiration integer
Tempo de expiração. O valor padrão é de 24h caso não seja enviado

request_for_payer string
Descrição opcional do QRCode.

Exemplo:

{
    "amount":"100",
    "account_id":"7e785e98-c859-46c6-9dc7-37ea522ceadf",
    "key":"92961229022",
    "transaction_id":"1234567898745236521478edrfth4r",
    "customer": {
        "name": "Maria",
        "document": "12409265606"
    },
    "request_for_payer":"Pague"
}

Response

201 OK

{
  "id": "<uuid>",
  "account_id": "<uuid>",
  "participant_ispb": "<string>",
  "key": "<string>",
  "key_type": "<string>",
  "transaction_id": "<string>",
  "amount": "<integer>",
  "additional_data": "<object>",  
  "metadata": "<object>",
  "location": "<string>",
  "request_for_payer": "<string>",
  "expiration": "<integer>",
  "status": "<string>",
  "request_id": "<string>",
  "created_at": "<datetime_iso8601>",
  "paid_at": "<datetime_iso8601>",
  "cancelled_at": "<datetime_iso8601>",
  "updated_at": "<datetime_iso8601>",
  "created_by": "<string>",
  "last_updated_by": "<string>",
  "qr_code_content": "<string>",
  "qr_code_image": "<string>"
}

400 Bad Request

{
  "reason": [
    {
      "error": "is invalid",
      "path": [
        "amount"
      ]
    },
    {
      "error": "is invalid",
      "path": [
        "status"
      ]
    }
  ],
  "type": "srn:error:validation"
}

401 Unauthorized

{
  "type": "srn:error:unauthenticated"
}

403 Forbidden

{
  "type": "srn:error:unauthorized"
}

Última modificação: 19.09.2021