Skip to main content
POST
/
api
/
v1
/
payment
Create a payment
curl --request POST \
  --url http://localhost:45000/api/v1/payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "customerId": "<string>",
  "beneficiaryId": "<string>",
  "amount": "<string>",
  "purposeOfPayment": "<string>",
  "documentIds": [
    "<string>"
  ],
  "paymentQuoteId": "<string>",
  "internalReference": "<string>",
  "invoiceNumber": "<string>",
  "memo": "<string>"
}
'
{
  "id": "<string>",
  "customerId": "<string>",
  "beneficiaryId": "<string>",
  "amount": "<string>",
  "currencyCode": "<string>",
  "internalReference": "<string>",
  "invoiceNumber": "<string>",
  "purposeOfPayment": "<string>",
  "memo": "<string>",
  "paymentToken": "<string>",
  "paymentNetwork": "<string>",
  "paymentQuoteId": "<string>",
  "status": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "customer": {
    "companyName": "<string>",
    "status": "<string>",
    "orgId": "<string>"
  },
  "beneficiary": {
    "companyName": "<string>",
    "bankBic": "<string>",
    "status": "<string>"
  },
  "sourceFunding": {
    "type": "<string>",
    "bankAccountId": "<string>",
    "bankName": "<string>",
    "countryCode": "<string>",
    "currencyCode": "<string>",
    "accountNumber": "<string>",
    "iban": "<string>"
  },
  "rail": {
    "method": "<string>",
    "countryCode": "<string>"
  },
  "receiptUrl": "<string>",
  "paymentQuote": {
    "id": "<string>",
    "paymentAmount": "<string>",
    "paymentCurrencyCode": "<string>",
    "totalTarget": "<string>",
    "targetCurrencyCode": "<string>",
    "createdAt": "<string>",
    "expiresAt": "<string>",
    "usedAt": "<string>",
    "priceBreakdown": {
      "payout": {
        "label": "<string>",
        "amountUsd": "<string>"
      },
      "platformFees": {
        "feeProfileId": "<string>",
        "feeProfileName": "<string>",
        "subtotalUsd": "<string>",
        "lines": [
          {
            "feeRuleId": "<string>",
            "name": "<string>",
            "feeValue": "<string>",
            "baseAmountUsd": "<string>",
            "rawAmountUsd": "<string>",
            "minAmountUsd": "<string>",
            "maxAmountUsd": "<string>",
            "finalAmountUsd": "<string>",
            "paymentSystemId": "<string>"
          }
        ]
      },
      "partnerFees": {
        "feeProfileId": "<string>",
        "feeProfileName": "<string>",
        "subtotalUsd": "<string>",
        "lines": [
          {
            "feeRuleId": "<string>",
            "name": "<string>",
            "feeValue": "<string>",
            "baseAmountUsd": "<string>",
            "rawAmountUsd": "<string>",
            "minAmountUsd": "<string>",
            "maxAmountUsd": "<string>",
            "finalAmountUsd": "<string>",
            "paymentSystemId": "<string>"
          }
        ]
      },
      "funding": {
        "subtotalUsd": "<string>",
        "lines": [
          {
            "feeRuleId": "<string>",
            "name": "<string>",
            "feeValue": "<string>",
            "baseAmountUsd": "<string>",
            "rawAmountUsd": "<string>",
            "minAmountUsd": "<string>",
            "maxAmountUsd": "<string>",
            "finalAmountUsd": "<string>",
            "paymentSystemId": "<string>"
          }
        ]
      },
      "totals": {
        "fundingType": "<string>",
        "feesUsd": "<string>",
        "totalTarget": "<string>",
        "targetCurrencyCode": "<string>",
        "effectivePriceUsdPerToken": "<string>",
        "quotedTokenAmount": "<string>"
      }
    },
    "fundingType": "<string>",
    "networkFeeUsd": "<string>",
    "effectivePriceUsdPerToken": "<string>",
    "quotedTokenAmount": "<string>",
    "paymentSystemId": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Nuvera API application secret key

Authorization
string
header
required

RS256 per-request signed JWT

Body

application/json
customerId
string
required

Customer making the payment

beneficiaryId
string
required

Beneficiary receiving the payment

amount
string
required

Payment amount

currencyCode
enum<string>
required

ISO 4217 currency code

Available options:
USD,
BRL,
MXN,
COP,
HKD,
CNY,
NGN,
KES,
MWK,
ZAR,
XOF,
XAF,
UGX,
TZS,
ZMW,
BWP,
SGD,
USDT,
USDC,
DAI,
BTC
purposeOfPayment
string
required

Purpose of payment

Minimum string length: 1
documentIds
string[]
required

IDs of uploaded documents (invoice required)

Minimum array length: 1
paymentQuoteId
string
required

ID of the active payment quote used for the payment

internalReference
string | null

Client's internal reference number

invoiceNumber
string

Invoice number

memo
string | null

Optional payment memo

Maximum string length: 64

Response

default - application/json
id
string
required
customerId
string
required
beneficiaryId
string
required
amount
string
required
currencyCode
string
required
internalReference
string | null
required
invoiceNumber
string | null
required
purposeOfPayment
string
required
memo
string | null
required
paymentToken
string | null
required
paymentNetwork
string | null
required
paymentQuoteId
string | null
required
status
string
required
createdAt
string
required
updatedAt
string
required
customer
object
beneficiary
object
sourceFunding
object
rail
object
receiptUrl
string | null
paymentQuote
object