Create Your First Payment

A payment depends on an existing customer, an existing beneficiary, a payment invoice document, and a live quote. The organization must also be enabled for partner payment initiation. You need:

Flow	Permission
Crypto token and network discovery	`CRYPTO_READ`
Invoice document upload	`DOCUMENTS_WRITE`
Quote and payment creation	`PAYMENTS_WRITE`
Payment read-back, activity, and receipts	`PAYMENTS_READ`

Choose a token and network

Use payment methods to choose an enabled token and network pair. GET /api/v1/crypto/networks is useful for network metadata, but payment-methods is the source for available token/network combinations.

TOKEN="<signed-request-jwt>"

curl https://rest-api.nuvera.global/api/v1/crypto/payment-methods \
  -H "x-api-key: $NUVERA_API_KEY" \
  -H "Authorization: Bearer $TOKEN"

Upload the invoice document

Upload at least one invoice with category=INVOICE, entityType=PAYMENT, and entityId=pending. See Upload Documents for the multipart request.

Create a payment quote

Include the configured paymentSystemId for the payout rail and the target customerId. Partner REST does not expose a payment-system lookup endpoint; use the payment system ID provided during setup or by Nuvera support.

{
  "fundingType": "CRYPTO",
  "amount": "125.00",
  "currencyCode": "USD",
  "paymentToken": "<enabled-token>",
  "paymentNetwork": "<enabled-network>",
  "paymentSystemId": "<payment-system-id>",
  "customerId": "<customer-id>"
}

BODY='{"fundingType":"CRYPTO","amount":"125.00","currencyCode":"USD","paymentToken":"<enabled-token>","paymentNetwork":"<enabled-network>","paymentSystemId":"<payment-system-id>","customerId":"<customer-id>"}'
TOKEN="<signed-request-jwt>"

curl https://rest-api.nuvera.global/api/v1/payment/quote \
  -H "x-api-key: $NUVERA_API_KEY" \
  -H "Authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  --data "$BODY"

Create the payment

Use the quote ID and invoice document ID from the previous steps. The quote amount, currency, customer binding, and payout rail must match the payment request and beneficiary payout rail.

{
  "customerId": "<customer-id>",
  "beneficiaryId": "<beneficiary-id>",
  "amount": "125.00",
  "currencyCode": "USD",
  "purposeOfPayment": "Invoice payment",
  "documentIds": ["<invoice-document-id>"],
  "paymentQuoteId": "<payment-quote-id>"
}

BODY='{"customerId":"<customer-id>","beneficiaryId":"<beneficiary-id>","amount":"125.00","currencyCode":"USD","purposeOfPayment":"Invoice payment","documentIds":["<invoice-document-id>"],"paymentQuoteId":"<payment-quote-id>"}'
TOKEN="<signed-request-jwt>"

curl https://rest-api.nuvera.global/api/v1/payment \
  -H "x-api-key: $NUVERA_API_KEY" \
  -H "Authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  --data "$BODY"

Optional payment metadata

These fields are optional and can help reconcile payments with your internal system.

Field	Required?	Use
`internalReference`	Optional	Your internal payment reference.
`invoiceNumber`	Optional	Invoice number associated with the uploaded invoice.
`memo`	Optional	Short note for the payment record.

Quote and payment lifecycle

Quotes are short-lived. Read expiresAt from the quote response and create the payment before that time. If a quote expires or is used, request a new quote. Payment creation submits the payment into Nuvera’s review flow. Use list, detail, and activity endpoints to track it. GET /api/v1/payment/{id}/receipt is available only after the payment is completed. For complete quote and payment schemas, open the API Reference.

Getting Started

Partner API

Core Workflows

Operations

Create Your First Payment

Optional payment metadata

Quote and payment lifecycle

​Optional payment metadata

​Quote and payment lifecycle

Optional payment metadata

Quote and payment lifecycle