Create an invoice

POSThttps://api.radom.com/invoice

Authorization

Send your API key in the Authorization header. Scheme: radomToken.

Request body

customerIdsstring[]required

Unique identifiers of customers of the invoice.

productsProductReq[]required

productProductWithIdrequired

idstring<uuid>required

Unique identifier for the product.

namestringrequired

Name of the product.

descriptionstringrequired

Product description.

productTypeProductTypenullable

PresalePresalerequired

TokenTokenPresalerequired

tickerstringrequired

decimalsinteger<int32>required>= 0

organizationIdstring<uuid>required

Product's owning organization ID.

addOnsAddOn[]required

Additional cost add ons for the product.

idstring<uuid>required

Unique identifier for the add on.

namestringrequired

Name of the add on.

pricenumber<float>required

Price of the add on.

chargingIntervalSecondsinteger<int64>required>= 0

Frequency of subscription payments.

currencyCurrencyrequired

AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC

pricenumber<float>required>= 0

Product price (either one time payment or susbcription charge).

imageUrlstringrequired

URL of image to use for the product.

createdAtstring<date-time>required

Time at which product was created.

updatedAtstring<date-time>required

Time at which product was last updated.

isArchivedbooleanrequired

True if product is archived on dashboard

sendSubscriptionEmailsbooleannullable

quantityinteger<int64>required

Size of collection of products.

lineItemsInvoiceLineReq[]required

namestringrequired

Name of the line item.

pricenumber<float>required>= 0

Price of line item.

quantityinteger<int64>required

Size of collection of invoice lines.

currencyCurrencynullable

AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC

overdueAtstring<date-time>nullable

Time at which invoice is past due.

inputDataKeyValuePairEntity[]required

keystringrequired

valuestringrequired

memostringnullable

Notes to be added to the invoice.

gatewayPaymentGatewayrequired

managedobjectrequired

methodsManagedPaymentMethod[]required

networkNetworkrequired

AllowedBitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiat

tokenstringnullable

discountPercentOffnumber<float>nullable>= 0

selfCustodialobjectrequired

tokensAcceptedToken[]required

tokenAddressstring<address>required

Seller's default token selection.

chainIdinteger<int64>required>= 1

Seller's default EVM-based chain ID.

sellerPaymentAddressstring<address>nullable

openBankingobjectrequired

emailstringrequired

kycDataKycDataRequestnullable

namestringrequired

dateOfBirthstring<date>required

addressstringrequired

residenceCountrystringrequired

phonestringrequired

passportFilestringnullable

idCardFilestringnullable

selfieFilestringnullable

openBankingCheckoutUrlstringnullable

bankIdstringnullable

Radom bank identifier returned by GET /open_banking/banks.

marketCountryCodenullable

AllowedACADAEAFAGAIALAMANAOAPAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBXBYBZCACCCDCFCGCHCICKCLCMCNCOCPCQCRCSCUCVCWCXCYCZDEDGDJDKDMDODYDZEAECEEEFEGEHEMEPERESETEUEVEWEZFIFJFKFLFMFOFRFXGAGBGCGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIBICIDIEILIMINIOIQIRISITJAJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLFLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOAOMPAPEPFPGPHPIPKPLPMPNPRPSPTPWPYQARARBRCRERHRIRLRMRNRORPRSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUMUNUSUYUZVAVCVEVGVIVNVUWFWGWLWOWSWVYEYTYUYVZAZMZRZW

localeLocalenullable

Alloweddenlenfresitptsvplsk

instantPaymentStatusbooleannullable

destinationCryptoAddressstringnullable

onrampAmountstringnullable

existingUserPaidSuccessbooleannullable

Responses

200Invoice created successfully

idstring<uuid>required

Unique identifier of an invoice.

organizationIdstring<uuid>required

Organization ID.

sellerSellerProfilenullable

organizationIdstring<uuid>required

Organization ID.

namestringnullable

Seller's name.

logoUrlstringnullable

URL of seller's logo.

websitestringnullable

URL of seller's website.

telegramstringnullable

URL of seller's telegram

discordstringnullable

URL of seller's discord.

twitterstringnullable

URL of seller's twitter.

defaultTokensDefaultToken[]nullable

tokenAddressstring<address>required

Seller's default token selection. Default token used for product listings and orders.

chainIdinteger<int64>required>= 1

EVM-based chain id used by the default token.

imageBytesstring<binary>nullable

Seller's profile image

customerCustomerrequired

idstring<uuid>required

Unique identifier for the customer.

organizationIdstring<uuid>required

Organization id.

namestringrequired

Customer's name.

emailstringrequired

Customer's e-mail.

billingAddressstringnullable

Customer's meatspace address.

phonestringnullable

Customer's phone number.

telegramstringnullable

URL of customer's telegram.

discordstringnullable

URL of customer's discord.

evmAddressesAddress[]required

EVM addresses associated with the customer.

streetLine1stringrequired

streetLine2stringnullable

citystringrequired

subdivisionstringnullable

postalCodestringnullable

countrystringrequired

paymentsPaymentDetails[]required

managedobjectrequired

idstring<uuid>required

paymentEventIdstring<uuid>nullable

networkNetworkrequired

tokenstringnullable

amountnumber<float>required>= 0

networkFeenumber<float>required>= 0

transactionsManagedTransaction[]required

networkNetworkrequired

transactionHashstringrequired

tokenstringnullable

amountnumber<float>required>= 0

blockTimestampstring<date-time>required

tickerstringnullable

senderAddressesSenderAddress[]required

addressstringrequired

conversionRatesConversionRate[]required

fromstringrequired

tostringrequired

ratenumber<float>required>= 0

managedTokenDelegatePaymentobjectrequired

networkNetworkrequired

tokenstringnullable

amountnumber<float>required>= 0

transactionsManagedTransaction[]required

networkNetworkrequired

transactionHashstringrequired

tokenstringnullable

amountnumber<float>required>= 0

blockTimestampstring<date-time>required

tickerstringnullable

senderAddressesSenderAddress[]required

addressstringrequired

conversionRatesConversionRate[]required

fromstringrequired

tostringrequired

ratenumber<float>required>= 0

openBankingobjectrequired

idstring<uuid>required

paymentEventIdstring<uuid>nullable

networkNetworkrequired

tokenstringnullable

amountnumber<float>required>= 0

onrampStatusOnrampStatusrequired

AllowedAwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelled

onrampGrossAmountstringnullable

onrampNetAmountstringnullable

onrampNetworkNetworknullable

onrampTokenstringnullable

onrampFeestringnullable

openBankingPaymentDataOpenBankingPaymentDatanullable

statusstringnullable

Provider payment lifecycle status for open-banking payments. This is optional and remains a string so Radom can pass through future provider statuses without breaking clients.

Allowedprocessingwaiting_for_paymentauthorizedfinalizingpaidfailedcanceledcancelledin_refundpartially_refundedrefundedrefund_failed

bankStatementReferencestringrequired

onrampStatusOnrampStatusrequired

AllowedAwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelled

payerFinancialAddressPayerFinancialAddressnullable

ibanIbannullable

ibanstringrequired

accountHolderNamestringnullable

bicstringnullable

sortCodeSortCodenullable

sortCodestringrequired

accountNumberstringrequired

accountHolderNamestringnullable

bankCodeBankCodenullable

codestringrequired

accountNumberstringrequired

accountHolderNamestringnullable

bbanBbannullable

bbanstringrequired

accountHolderNamestringnullable

bicstringnullable

bankIdstringnullable

bankNamestringnullable

bankMarketstringnullable

paymentSchemestringnullable

instantPaymentSchemebooleannullable

statusHistoryListOrderStatusHistoryEntry[]nullable

currentStatusstring

reasonstring

createdAtstring

updatedAtstring

previousStatusstringnullable

shopperShoppernullable

emailstringnullable

phoneNumberstringnullable

paymentReferencestringnullable

endToEndIdstringnullable

remittanceInformationstringnullable

senderNamestringnullable

senderIbanstringnullable

senderBicstringnullable

senderSortCodestringnullable

senderAccountNumberstringnullable

senderBankCodestringnullable

senderBbanstringnullable

totalSpendnumber<float>nullable>= 0

tagsstring[]required

createdAtstring<date-time>required

residenceCountrystringnullable

Customer's Residence Country

dobstring<date>nullable

Customer date of birth

companyNumberstringnullable

Customer company number

accountTypeCustomerAccountTypenullable

AllowedIndividualBusiness

kycDataJsonnullable

companyNamestringnullable

Company Name should only be populated for business customers

gatewayPaymentGatewayrequired

managedobjectrequired

methodsManagedPaymentMethod[]required

networkNetworkrequired

tokenstringnullable

discountPercentOffnumber<float>nullable>= 0

selfCustodialobjectrequired

tokensAcceptedToken[]required

tokenAddressstring<address>required

Seller's default token selection.

chainIdinteger<int64>required>= 1

Seller's default EVM-based chain ID.

sellerPaymentAddressstring<address>nullable

openBankingobjectrequired

emailstringrequired

kycDataKycDataRequestnullable

namestringrequired

dateOfBirthstring<date>required

addressstringrequired

residenceCountrystringrequired

phonestringrequired

passportFilestringnullable

idCardFilestringnullable

selfieFilestringnullable

openBankingCheckoutUrlstringnullable

bankIdstringnullable

Radom bank identifier returned by GET /open_banking/banks.

marketCountryCodenullable

localeLocalenullable

Alloweddenlenfresitptsvplsk

instantPaymentStatusbooleannullable

destinationCryptoAddressstringnullable

onrampAmountstringnullable

existingUserPaidSuccessbooleannullable

productsProductWithQuantity[]required

productProductWithIdrequired

idstring<uuid>required

Unique identifier for the product.

namestringrequired

Name of the product.

descriptionstringrequired

Product description.

productTypeProductTypenullable

PresalePresalerequired

TokenTokenPresalerequired

tickerstringrequired

decimalsinteger<int32>required>= 0

organizationIdstring<uuid>required

Product's owning organization ID.

addOnsAddOn[]required

Additional cost add ons for the product.

idstring<uuid>required

Unique identifier for the add on.

namestringrequired

Name of the add on.

pricenumber<float>required

Price of the add on.

chargingIntervalSecondsinteger<int64>required>= 0

Frequency of subscription payments.

currencyCurrencyrequired

AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC

pricenumber<float>required>= 0

Product price (either one time payment or susbcription charge).

imageUrlstringrequired

URL of image to use for the product.

createdAtstring<date-time>required

Time at which product was created.

updatedAtstring<date-time>required

Time at which product was last updated.

isArchivedbooleanrequired

True if product is archived on dashboard

sendSubscriptionEmailsbooleannullable

quantityinteger<int64>required

Size of collection of products.

lineItemsInvoiceLine[]required

invoiceIdstring<uuid>required

Unique identifier of an invoice line item.

namestringrequired

Name of the line item.

quantityinteger<int64>required

Number of items in the line item.

pricenumber<float>required

Price of line item.

currencyCurrencynullable

AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC

issuedAtstring<date-time>required

Time at which invoice was issued.

paidAtstring<date-time>nullable

Time at which invoice was paid.

voidedAtstring<date-time>nullable

Time at which invoice was voided.

overdueAtstring<date-time>nullable

Time at which invoice is past due.

inputDataKeyValuePairEntity[]required

keystringrequired

valuestringrequired

statusstringrequired

Status of the invoice.

memostringnullable

Notes to be added to the invoice.

urlstringrequired

URL of invoice

paymentPaymentDetailsnullable

managedobjectrequired

idstring<uuid>required

paymentEventIdstring<uuid>nullable

networkNetworkrequired

tokenstringnullable

amountnumber<float>required>= 0

networkFeenumber<float>required>= 0

transactionsManagedTransaction[]required

networkNetworkrequired

transactionHashstringrequired

tokenstringnullable

amountnumber<float>required>= 0

blockTimestampstring<date-time>required

tickerstringnullable

senderAddressesSenderAddress[]required

addressstringrequired

conversionRatesConversionRate[]required

fromstringrequired

tostringrequired

ratenumber<float>required>= 0

managedTokenDelegatePaymentobjectrequired

networkNetworkrequired

tokenstringnullable

amountnumber<float>required>= 0

transactionsManagedTransaction[]required

networkNetworkrequired

transactionHashstringrequired

tokenstringnullable

amountnumber<float>required>= 0

blockTimestampstring<date-time>required

tickerstringnullable

senderAddressesSenderAddress[]required

addressstringrequired

conversionRatesConversionRate[]required

fromstringrequired

tostringrequired

ratenumber<float>required>= 0

openBankingobjectrequired

idstring<uuid>required

paymentEventIdstring<uuid>nullable

networkNetworkrequired

tokenstringnullable

amountnumber<float>required>= 0

onrampStatusOnrampStatusrequired

AllowedAwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelled

onrampGrossAmountstringnullable

onrampNetAmountstringnullable

onrampNetworkNetworknullable

onrampTokenstringnullable

onrampFeestringnullable

openBankingPaymentDataOpenBankingPaymentDatanullable

statusstringnullable

Provider payment lifecycle status for open-banking payments. This is optional and remains a string so Radom can pass through future provider statuses without breaking clients.

Allowedprocessingwaiting_for_paymentauthorizedfinalizingpaidfailedcanceledcancelledin_refundpartially_refundedrefundedrefund_failed

bankStatementReferencestringrequired

onrampStatusOnrampStatusrequired

AllowedAwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelled

payerFinancialAddressPayerFinancialAddressnullable

ibanIbannullable

ibanstringrequired

accountHolderNamestringnullable

bicstringnullable

sortCodeSortCodenullable

sortCodestringrequired

accountNumberstringrequired

accountHolderNamestringnullable

bankCodeBankCodenullable

codestringrequired

accountNumberstringrequired

accountHolderNamestringnullable

bbanBbannullable

bbanstringrequired

accountHolderNamestringnullable

bicstringnullable

bankIdstringnullable

bankNamestringnullable

bankMarketstringnullable

paymentSchemestringnullable

instantPaymentSchemebooleannullable

statusHistoryListOrderStatusHistoryEntry[]nullable

currentStatusstring

reasonstring

createdAtstring

updatedAtstring

previousStatusstringnullable

shopperShoppernullable

emailstringnullable

phoneNumberstringnullable

paymentReferencestringnullable

endToEndIdstringnullable

remittanceInformationstringnullable

senderNamestringnullable

senderIbanstringnullable

senderBicstringnullable

senderSortCodestringnullable

senderAccountNumberstringnullable

senderBankCodestringnullable

senderBbanstringnullable

400Bad Request

errorstringrequired

401Unauthorized

errorstringrequired

500Internal server error

errorstringrequired

RequestManaged crypto gateway

{
  "customerIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "products": [],
  "lineItems": [
    {
      "name": "Implementation support",
      "price": 500,
      "quantity": 1,
      "currency": "USD"
    }
  ],
  "inputData": [],
  "gateway": {
    "managed": {
      "methods": [
        {
          "network": "Ethereum",
          "token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
        }
      ]
    }
  }
}

Self-custodial crypto gateway

{
  "customerIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "products": [],
  "lineItems": [
    {
      "name": "Implementation support",
      "price": 500,
      "quantity": 1,
      "currency": "USD"
    }
  ],
  "inputData": [],
  "gateway": {
    "selfCustodial": {
      "tokens": [
        {
          "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "chainId": 1
        }
      ],
      "sellerPaymentAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
    }
  }
}

Open banking gateway

{
  "customerIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "products": [],
  "lineItems": [
    {
      "name": "Implementation support",
      "price": 500,
      "quantity": 1,
      "currency": "USD"
    }
  ],
  "inputData": [],
  "gateway": {
    "openBanking": {
      "email": "customer@example.com",
      "market": "GB",
      "locale": "en-GB"
    }
  }
}

Shell

curl -X POST https://api.radom.com/invoice \
  -H 'Authorization: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "customerIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "products": [],
  "lineItems": [
    {
      "name": "Implementation support",
      "price": 500,
      "quantity": 1,
      "currency": "USD"
    }
  ],
  "inputData": [],
  "gateway": {
    "managed": {
      "methods": [
        {
          "network": "Ethereum",
          "token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
        }
      ]
    }
  }
}'

Try it