Payments

The payment endpoints cover the full lifecycle of a transaction: validate the destination code, quote, create, submit, and look up. They require JWT token authentication, except for code validation, which is public.

The complete flow is described in Usage and Examples. The final receipt is also described here, in the Receipts section.

Validate code

Validates a payment code (PIX, boleto, or gift card) before quoting.

string

required

Payment code to validate (for example, a PIX BR Code starting with 00020101...).

object

Details of the validated payment destination (type, amount, beneficiary).

curl -X POST https://app.pag.finance/api/payments/validate-code \
  -H "Content-Type: application/json" \
  -d '{ "code": "00020101..." }'

const transfer = await client.payments.validateCode({ code: '00020101...' });

{
  "success": true,
  "data": {
    "type": "pix",
    "amount": 150.00,
    "currency": "BRL"
  }
}

Quote payment

Requests a quote for the payment, indicating the source asset and blockchain.

string

required

Bearer <tokenJWT>

const quote = await client.payments.quote({
  code: '00020101...',
  assetId: 1,
  blockchain: 'solana',
});

Create payment

Creates the payment from a valid quote.

string

required

Bearer <tokenJWT>

string

required

Identifier of the previously obtained quote.

const payment = await client.payments.create({ quoteId: quote.id });

Submit payment

Submits the on-chain transaction associated with the created payment.

string

required

Bearer <tokenJWT>

await client.payments.submit({ paymentId: payment.id, txHash: '...' });

List payments

Lists the authenticated user’s payments.

string

required

Bearer <tokenJWT>

const payments = await client.payments.list();

Get payment

Returns a specific payment by its identifier.

string

required

Bearer <tokenJWT>

const payment = await client.payments.get(id);

Receipts

Returns the receipt of a transaction. It is agnostic: it works for PIX, boleto, and gift card.

object

Receipt data (proof of payment, status, and settlement details).

const receipt = await client.receipts.get({ type: 'pix', tx: '...', chain: 'solana' });

{
  "success": true,
  "data": {
    "type": "pix",
    "status": "settled",
    "receiptUrl": "https://..."
  }
}

Overview

Authentication

Onramp and Offramp

BRLP

KYC

Webhooks

Payments

Validate code

Quote payment

Create payment

Submit payment

List payments

Get payment

Receipts

​Validate code

​Quote payment

​Create payment

​Submit payment

​List payments

​Get payment

​Receipts

Validate code

Quote payment

Create payment

Submit payment

List payments

Get payment

Receipts