Settle a payment

Settles an x402 payment using the quote ID and a signed payment authorization. The payment signature can be provided via the PAYMENT-SIGNATURE header or the payment_signature body parameter. Settlement is idempotent — submitting the same quote ID multiple times returns the existing transaction.

POST /x402/credit_account

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.x402.creditAccount.settle({
  id: 'id',
});

console.log(response.data);

200

Example

{
  "data": {
    "id": "<string>",
    "record_type": "x402_transaction",
    "amount": "<string>",
    "currency": "<string>",
    "status": "settled",
    "quote_id": "<string>",
    "tx_hash": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

PAYMENT-SIGNATURE · string

Signed payment authorization for the quote. Alternative to providing payment_signature in the request body.

Body

application/json

id · string · required

The quote ID to settle.

payment_signature · string

Base64-encoded signed payment authorization (x402 PaymentPayload). Can alternatively be provided via the PAYMENT-SIGNATURE header.

Response

200

application/json

Payment already settled (idempotent response)

data · object

Show child attributes