Create a customer
POST
https://api.radom.com/customerAuthorization
Send your API key in the Authorization header. Scheme: radomToken.
Request body
namestringrequiredCustomer's name.
emailstringrequiredbillingAddressstringnullableCustomer's meatspace address.
phonestringnullableCustomer's phone number.
telegramstringnullableURL of customer's telegram.
discordstringnullableURL of customer's discord.
evmAddressesAddress[]nullable
EVM addresses associated with the customer.
streetLine1stringrequiredstreetLine2stringnullablecitystringrequiredsubdivisionstringnullablepostalCodestringnullablecountrystringrequiredresidenceCountrystringnullableCustomer's Residence Country
dobstring<date>nullableCustomer date of birth
companyNumberstringnullableCustomer company number
accountTypeCustomerAccountTypenullableAllowed
IndividualBusinesskycDataKycDataRequestnullable
namestringrequireddateOfBirthstring<date>requiredaddressstringrequiredresidenceCountrystringrequiredphonestringrequiredpassportFilestringnullableidCardFilestringnullableselfieFilestringnullablecompanyNamestringnullableCompany Name
Responses
200Customer created successfully
idstring<uuid>requiredUnique identifier for the customer.
organizationIdstring<uuid>requiredOrganization id.
namestringrequiredCustomer's name.
emailstringrequiredCustomer's e-mail.
billingAddressstringnullableCustomer's meatspace address.
phonestringnullableCustomer's phone number.
telegramstringnullableURL of customer's telegram.
discordstringnullableURL of customer's discord.
evmAddressesAddress[]required
EVM addresses associated with the customer.
streetLine1stringrequiredstreetLine2stringnullablecitystringrequiredsubdivisionstringnullablepostalCodestringnullablecountrystringrequiredpaymentsPaymentDetails[]required
managedobjectrequired
idstring<uuid>requiredpaymentEventIdstring<uuid>nullablenetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0networkFeenumber<float>required>= 0transactionsManagedTransaction[]required
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattransactionHashstringrequiredtokenstringnullableamountnumber<float>required>= 0blockTimestampstring<date-time>requiredtickerstringnullablesenderAddressesSenderAddress[]required
addressstringrequiredconversionRatesConversionRate[]required
fromstringrequiredtostringrequiredratenumber<float>required>= 0managedTokenDelegatePaymentobjectrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0transactionsManagedTransaction[]required
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattransactionHashstringrequiredtokenstringnullableamountnumber<float>required>= 0blockTimestampstring<date-time>requiredtickerstringnullablesenderAddressesSenderAddress[]required
addressstringrequiredconversionRatesConversionRate[]required
fromstringrequiredtostringrequiredratenumber<float>required>= 0openBankingobjectrequired
idstring<uuid>requiredpaymentEventIdstring<uuid>nullablenetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0onrampStatusOnrampStatusrequiredAllowed
AwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelledonrampGrossAmountstringnullableonrampNetAmountstringnullableonrampNetworkNetworknullableAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiatonrampTokenstringnullableonrampFeestringnullableopenBankingPaymentDataOpenBankingPaymentDatanullable
statusstringnullableProvider 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.
Allowed
processingwaiting_for_paymentauthorizedfinalizingpaidfailedcanceledcancelledin_refundpartially_refundedrefundedrefund_failedbankStatementReferencestringrequiredonrampStatusOnrampStatusrequiredAllowed
AwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelledpayerFinancialAddressPayerFinancialAddressnullable
ibanIbannullable
ibanstringrequiredaccountHolderNamestringnullablebicstringnullablesortCodeSortCodenullable
sortCodestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebankCodeBankCodenullable
codestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebbanBbannullable
bbanstringrequiredaccountHolderNamestringnullablebicstringnullablebankIdstringnullablebankNamestringnullablebankMarketstringnullablepaymentSchemestringnullableinstantPaymentSchemebooleannullablestatusHistoryListOrderStatusHistoryEntry[]nullable
currentStatusstringreasonstringcreatedAtstringupdatedAtstringpreviousStatusstringnullableshopperShoppernullable
emailstringnullablephoneNumberstringnullablepaymentReferencestringnullableendToEndIdstringnullableremittanceInformationstringnullablesenderNamestringnullablesenderIbanstringnullablesenderBicstringnullablesenderSortCodestringnullablesenderAccountNumberstringnullablesenderBankCodestringnullablesenderBbanstringnullabletotalSpendnumber<float>nullable>= 0tagsstring[]requiredcreatedAtstring<date-time>requiredresidenceCountrystringnullableCustomer's Residence Country
dobstring<date>nullableCustomer date of birth
companyNumberstringnullableCustomer company number
accountTypeCustomerAccountTypenullableAllowed
IndividualBusinesskycDataJsonnullablecompanyNamestringnullableCompany Name should only be populated for business customers
400Invalid image
errorstringrequired401Unauthorized
errorstringrequired500Internal server error
errorstringrequired