Create payload location

Creates a location (loc) for a cob- or cobv-type charge. Pix API POST /loc.

POST /api/v1/brcode/loc

Create payload location

cURL

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/loc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tipoCob": "cob"
}
'

201

{
  "criacao": "<string>",
  "id": 123,
  "location": "<string>",
  "tipoCob": "cob"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key · string

Idempotency key, max 255 characters.

Body

application/json

tipoCob · enum<string> · required

Tipo de cobrança que a location endereça.

Available options: cob, cobv

Example:

"cob"

Response

201

application/json

Created

criacao · string · required

Data de criação da location (RFC 3339).

id · integer<int64> · required

Id da location (gerado pelo servidor).

location · string · required

Localização do payload (URI).

Maximum string length: 77

tipoCob · enum<string> · required

cob | cobv.

Available options: cob, cobv