1. Partner Crypto
oceafin
  • Oceafin Partner API V1
  • Getting Started
  • Authentication
  • Customers And Onboarding
  • Product Workflows
  • Webhooks
  • Errors
  • Partner Customers
    • Create partner customer
    • Upload or link a file to a partner customer
    • Submit partner-attested KYC or KYB evidence
    • List partner customer balances
    • List partner customer transactions
    • Get partner transaction
  • Partner Conversion
    • List partner conversion quotes
    • Create partner conversion quote
    • Get partner conversion quote
    • List partner conversions
    • Create partner conversion approval draft
    • Get partner conversion
  • Partner Fiat
    • Get partner fiat account capabilities
    • Create partner fiat account application
    • Submit additional information for a partner fiat account application
    • List partner fiat accounts
    • Get partner fiat deposit instructions
    • List partner fiat deposits
    • Get partner fiat deposit
    • List partner bank accounts
    • Create partner bank account
    • Get partner fiat withdrawal capabilities
    • Activate partner fiat withdrawal capability
    • Submit fiat withdrawal capability activation additional information
    • Create partner fiat withdrawal quote
    • Create partner fiat withdrawal approval draft
    • List partner fiat withdrawals
    • Submit an approved partner fiat withdrawal for processing
    • Submit additional information for a partner fiat withdrawal
    • Get partner fiat withdrawal
  • Partner Crypto
    • List partner crypto deposit wallets
      GET
    • List partner crypto deposits
      GET
    • Get partner crypto deposit
      GET
    • Submit partner crypto deposit Travel Rule information
      POST
    • Create partner crypto withdrawal quote
      POST
    • List partner crypto wallet beneficiaries
      GET
    • Create partner crypto wallet beneficiary
      POST
    • Get partner crypto wallet beneficiary
      GET
    • Remove partner crypto wallet beneficiary
      POST
    • Sync partner crypto wallet beneficiary
      POST
    • Create partner crypto withdrawal approval draft
      POST
    • List partner crypto withdrawals
      GET
    • Submit an approved partner crypto withdrawal for processing
      POST
    • Get partner crypto withdrawal
      GET
    • List partner crypto refunds
      GET
    • Create partner crypto refund approval draft
      POST
    • Get partner crypto refund
      GET
    • Submit an approved partner crypto refund for processing
      POST
    • Confirm partner crypto refund
      POST
    • List partner crypto checkouts
      GET
    • Create partner crypto checkout
      POST
    • Get partner crypto checkout
      GET
    • Create partner checkout link
      POST
    • Create partner checkout POS payment request
      POST
    • Close partner crypto checkout
      POST
    • List partner collection buyers
      GET
    • Create partner collection buyer
      POST
    • Get partner collection buyer
      GET
    • Update partner collection buyer
      POST
    • List partner collection wallets
      GET
    • Create partner collection wallet
      POST
    • Get partner collection wallet
      GET
    • Update partner collection wallet expiry
      POST
    • Deactivate partner collection wallet
      POST
    • List partner collection payments
      GET
    • Get partner collection payment
      GET
  • Schemas
    • CreatePartnerCustomerRequest
    • PartnerCustomerType
    • PartnerCustomerStatus
    • PartnerCustomer
    • LinkPartnerCustomerFileRequest
    • UploadPartnerCustomerFileRequest
    • PartnerCustomerFile
    • PartnerOnboardingSubmissionRequest
    • PartnerOnboardingEvidenceSubmission
    • PartnerIndividualKycSubmission
    • PartnerKycPersonalDetails
    • PartnerKycAdditionalPersonalDetails
    • PartnerCorporateKybSubmission
    • PartnerKybCorporationDetails
    • PartnerKybAdditionalCorporationDetails
    • PartnerOnboardingSupportingDocument
    • PartnerOnboardingAddress
    • PartnerOnboardingContactNumber
    • PartnerOnboardingContactPerson
    • PartnerOnboardingKeyPerson
    • PartnerOnboardingSubmission
    • PartnerBalancePage
    • PartnerBalance
    • PartnerTransactionPage
    • PartnerTransaction
    • CreatePartnerFiatAccountApplicationRequest
    • SubmitPartnerFiatAccountAdditionalInfoRequest
    • PartnerFiatCapabilities
    • PartnerFiatCapabilitiesData
    • PartnerFiatCapabilityRoute
    • PartnerFiatAccountApplication
    • PartnerFiatAccountPage
    • PartnerFiatAccount
    • PartnerFiatAccountBankDetails
    • PartnerFiatDepositInstructions
    • PartnerFiatDepositInstruction
    • PartnerFiatDepositPage
    • PartnerFiatDeposit
    • PartnerCryptoDepositWalletPage
    • PartnerCryptoDepositWallet
    • PartnerCryptoDepositPage
    • PartnerCryptoDeposit
    • SubmitPartnerCryptoTravelRuleInfoRequest
    • PartnerCryptoTravelRuleInfo
    • CreatePartnerCryptoWithdrawalQuoteRequest
    • PartnerCryptoWithdrawalQuote
    • CreatePartnerWalletBeneficiaryRequest
    • PartnerWalletBeneficiarySupportFile
    • PartnerCryptoWalletBeneficiaryActionRequest
    • PartnerWalletBeneficiaryPage
    • PartnerWalletBeneficiary
    • CreatePartnerCryptoWithdrawalRequest
    • SubmitPartnerCryptoWithdrawalRequest
    • PartnerCryptoWithdrawalPage
    • PartnerCryptoWithdrawal
    • CreatePartnerCryptoRefundRequest
    • SubmitPartnerCryptoRefundRequest
    • PartnerCryptoRefundPage
    • PartnerCryptoRefund
    • CreatePartnerConversionQuoteRequest
    • CreatePartnerConversionRequest
    • PartnerConversionQuotePage
    • PartnerConversionQuote
    • PartnerConversionPage
    • PartnerConversion
    • CreatePartnerCheckoutRequest
    • PartnerCheckoutPage
    • PartnerCheckout
    • CreatePartnerCheckoutLinkRequest
    • PartnerCheckoutLink
    • CreatePartnerCheckoutPosPaymentRequest
    • PartnerCheckoutPosPaymentRequest
    • PartnerCheckoutActionRequest
    • CreatePartnerBuyerRequest
    • UpdatePartnerBuyerRequest
    • PartnerBuyerDocument
    • PartnerBuyerPage
    • PartnerBuyer
    • CreatePartnerCollectionWalletRequest
    • UpdatePartnerCollectionWalletExpiryRequest
    • PartnerCollectionWalletActionRequest
    • PartnerCollectionWalletPage
    • PartnerCollectionWallet
    • PartnerCollectionWalletAddress
    • PartnerCollectionPaymentPage
    • PartnerCollectionPayment
    • CreatePartnerBankAccountRequest
    • PartnerBankAccountThirdPartyBeneficiary
    • PartnerBankAccountThirdPartyAddress
    • PartnerBankAccountPage
    • PartnerBankAccount
    • PartnerFiatWithdrawalCapabilities
    • PartnerFiatWithdrawalCapabilitiesData
    • PartnerFiatWithdrawalCapabilityRoute
    • ActivatePartnerFiatWithdrawalCapabilityRequest
    • SubmitPartnerFiatWithdrawalCapabilityAdditionalInfoRequest
    • PartnerFiatWithdrawalCapabilityActivation
    • CreatePartnerFiatWithdrawalQuoteRequest
    • PartnerFiatWithdrawalQuote
    • PartnerBalanceAvailability
    • CreatePartnerFiatWithdrawalRequest
    • SubmitPartnerFiatWithdrawalRequest
    • SubmitPartnerFiatWithdrawalAdditionalInfoRequest
    • PartnerFiatWithdrawalAdditionalInfo
    • PartnerFiatWithdrawalPage
    • PartnerFiatWithdrawal
    • PartnerOperationAuthorizationEvidence
    • PageInfo
    • PartnerProblem
    • PartnerProblemCode
  1. Partner Crypto

Create partner checkout link

POST
/partner/v1/crypto/checkouts/{checkoutId}/links

Request

Path Params

Header Params

Body Params application/jsonRequired

Example
{
    "clientReference": "string",
    "defaultLanguage": 0,
    "isPos": false,
    "posCheckoutCurrency": "string",
    "posCheckoutBlockchain": "string",
    "logoFileAssetId": "d60560ef-aca6-4909-becb-0cfe2447e8ff",
    "redirectUrl": "string",
    "customerSupportEmail": "string"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/partner/v1/crypto/checkouts//links' \
--header 'X-Partner-Client-Id;' \
--header 'X-Partner-Timestamp;' \
--header 'X-Partner-Nonce;' \
--header 'X-Partner-Signature;' \
--header 'X-Request-Id;' \
--header 'Idempotency-Key;' \
--header 'Content-Type: application/json' \
--data '{
    "clientReference": "string",
    "defaultLanguage": 0,
    "isPos": false,
    "posCheckoutCurrency": "string",
    "posCheckoutBlockchain": "string",
    "logoFileAssetId": "d60560ef-aca6-4909-becb-0cfe2447e8ff",
    "redirectUrl": "string",
    "customerSupportEmail": "string"
}'

Responses

🟢200OK
application/json
Checkout link created or replayed.
Bodyapplication/json

Example
{
    "checkoutLinkId": "00fd42b3-ef98-4780-b5d6-e0f74b4c3800",
    "checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
    "checkoutUrl": "string",
    "clientReference": "string",
    "defaultLanguage": 0,
    "isPos": true,
    "posCheckoutCurrency": "string",
    "posCheckoutBlockchain": "string",
    "redirectUrl": "string",
    "customerSupportEmail": "string",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠409
Modified at 2026-06-28 00:04:35
Previous
Get partner crypto checkout
Next
Create partner checkout POS payment request
Built with