Pular para o conteúdo

Create payment

Creates a payment request for the white-label initiation portal. The response returns an id (payment request identifier) and a redirectUrl where you must send the payer’s browser to continue consent and settlement.

Use redirectUri for the URL on your site that receives the user after the portal completes the journey. It must belong to an allow-listed domain for your sub-tenant.

POST/api/v1/payments

Create payment

Creates a payment request and returns redirectUrl and the new payment request id for the hosted portal journey.

Auth: Bearer Token

Corpo da requisição

9 campos
redirectUri●
bodystring

HTTPS URL on your domain where the portal redirects after completion. Must be allow-listed for the sub-tenant.

value●
bodynumber

Payment amount in BRL.

details
bodystring

Free-text payment description shown where applicable.

document
bodystring

Reference document identifier.

externalId
bodystring

Your own correlation id for the payment request (also usable with Get payment by external ID).

cpfCnpj
bodystring

Payer CPF or CNPJ when known.

creditor●
bodyobject

Receiver (creditor) account details.

name●
bodystring

Creditor legal name.

personType●
bodystring

PESSOA_NATURAL or PESSOA_JURIDICA.

cpfCnpj●
bodystring

Creditor CPF or CNPJ.

accountNumber●
bodystring

Creditor account number.

accountIssuer●
bodystring

Creditor branch.

accountPixKey
bodystring

Creditor Pix key when applicable.

accountIspb●
bodystring

Creditor institution ISPB.

accountType●
bodystring

CACC | SVGS | TRAN.

debitor
bodyobject

Optional payer account hints when you already collected them.

accountNumber●
bodystring

Debtor account number.

accountIssuer●
bodystring

Debtor branch.

accountIspb●
bodystring

Debtor ISPB.

accountType●
bodystring

CACC | SVGS | TRAN.

schedule
bodyobject

Optional schedule. Send only one of single, daily, weekly, monthly, or custom. Start dates must be at least D+1; max 60 installments within two years from consent creation (per API contract).

single
bodyobject

One-shot future date.

date●
bodystring
daily
bodyobject

Daily recurrence.

startDate●
bodystring
quantity●
bodynumber
weekly
bodyobject

Weekly recurrence.

dayOfWeek●
bodystring
startDate●
bodystring
quantity●
bodynumber
monthly
bodyobject

Monthly recurrence.

dayOfMonth●
bodynumber
startDate●
bodystring
quantity●
bodynumber
custom
bodyobject

Explicit list of dates.

dates●
bodyarray<[object Object]>

ISO date strings.

additionalInformation●
bodystring
curl --request POST \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/payments' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --data '{
  "redirectUri": "https://your-app.example.com/payments/return",
  "value": 150.5,
  "details": "Invoice 2024-001",
  "document": "document123",
  "externalId": "ext-order-991",
  "cpfCnpj": "12345678901",
  "creditor": {
    "name": "Acme Ltda",
    "personType": "PESSOA_JURIDICA",
    "cpfCnpj": "12345678000195",
    "accountNumber": "1234567",
    "accountIssuer": "0001",
    "accountPixKey": "cobranca@acme.com.br",
    "accountIspb": "12345678",
    "accountType": "CACC"
  },
  "debitor": {
    "accountNumber": "7654321",
    "accountIssuer": "0001",
    "accountIspb": "87654321",
    "accountType": "CACC"
  },
  "schedule": {
    "single": {
      "date": "2024-09-01"
    },
    "daily": {
      "startDate": "2024-09-01",
      "quantity": 2
    },
    "weekly": {
      "dayOfWeek": "QUARTA_FEIRA",
      "startDate": "2024-09-01",
      "quantity": 2
    },
    "monthly": {
      "dayOfMonth": 10,
      "startDate": "2024-09-01",
      "quantity": 2
    },
    "custom": {
      "dates": [
        "2024-08-23",
        "2024-09-26"
      ],
      "additionalInformation": "Custom schedule note"
    }
  }
}'

Response

201Payment request created. Redirect the browser to data.redirectUrl.
Response body
object
  • dataobjectrequired

    Created payment identifiers.

    • idstringrequired

      Payment request id (same as paymentLinkId on redirect callback).

    • redirectUrlstringrequired

      Hosted portal URL for the payer.

  • messagestring

    Human-readable message.

  • typestring

    success | error | warning | info.

  • statusCodeinteger· nullable

    Optional status inside envelope.

201 · Payment request created. Redirect the browser to data.redirectUrl.
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "redirectUrl": "https://embedded-payment-manager.hml.linaob.com.br/hpp/example-session"
  },
  "message": "",
  "type": "success",
  "statusCode": null
}

Next steps