oceafin
    • Oceafin Partner API V1
    • Getting Started
    • Authentication
    • Customers And Onboarding
    • Product Workflows
    • Webhooks
    • Errors
    • Partner Customers
      • Create partner customer
        POST
      • Upload or link a file to a partner customer
        POST
      • Submit partner-attested KYC or KYB evidence
        POST
      • List partner customer balances
        GET
      • List partner customer transactions
        GET
      • Get partner transaction
        GET
    • Partner Conversion
      • List partner conversion quotes
        GET
      • Create partner conversion quote
        POST
      • Get partner conversion quote
        GET
      • List partner conversions
        GET
      • Create partner conversion approval draft
        POST
      • Get partner conversion
        GET
    • Partner Fiat
      • Get partner fiat account capabilities
        GET
      • Create partner fiat account application
        POST
      • Submit additional information for a partner fiat account application
        POST
      • List partner fiat accounts
        GET
      • Get partner fiat deposit instructions
        GET
      • List partner fiat deposits
        GET
      • Get partner fiat deposit
        GET
      • List partner bank accounts
        GET
      • Create partner bank account
        POST
      • Get partner fiat withdrawal capabilities
        GET
      • Activate partner fiat withdrawal capability
        POST
      • Submit fiat withdrawal capability activation additional information
        POST
      • Create partner fiat withdrawal quote
        POST
      • Create partner fiat withdrawal approval draft
        POST
      • List partner fiat withdrawals
        GET
      • Submit an approved partner fiat withdrawal for processing
        POST
      • Submit additional information for a partner fiat withdrawal
        POST
      • Get partner fiat withdrawal
        GET
    • Partner Crypto
      • List partner crypto deposit wallets
      • List partner crypto deposits
      • Get partner crypto deposit
      • Submit partner crypto deposit Travel Rule information
      • Create partner crypto withdrawal quote
      • List partner crypto wallet beneficiaries
      • Create partner crypto wallet beneficiary
      • Get partner crypto wallet beneficiary
      • Remove partner crypto wallet beneficiary
      • Sync partner crypto wallet beneficiary
      • Create partner crypto withdrawal approval draft
      • List partner crypto withdrawals
      • Submit an approved partner crypto withdrawal for processing
      • Get partner crypto withdrawal
      • List partner crypto refunds
      • Create partner crypto refund approval draft
      • Get partner crypto refund
      • Submit an approved partner crypto refund for processing
      • Confirm partner crypto refund
      • List partner crypto checkouts
      • Create partner crypto checkout
      • Get partner crypto checkout
      • Create partner checkout link
      • Create partner checkout POS payment request
      • Close partner crypto checkout
      • List partner collection buyers
      • Create partner collection buyer
      • Get partner collection buyer
      • Update partner collection buyer
      • List partner collection wallets
      • Create partner collection wallet
      • Get partner collection wallet
      • Update partner collection wallet expiry
      • Deactivate partner collection wallet
      • List partner collection payments
      • Get partner collection payment
    • 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

    Webhooks

    Oceafin can deliver partner events to a registered HTTPS webhook endpoint.
    Webhook delivery is optional and depends on the partner tenant configuration.

    Payload Shape#

    {
      "eventId": "00000000-0000-0000-0000-000000000000",
      "eventType": "conversion.created",
      "customer": {
        "customerId": "00000000-0000-0000-0000-000000000000",
        "partnerCustomerRef": "cust-100001"
      },
      "resource": {
        "resourceType": "conversion",
        "resourceId": "00000000-0000-0000-0000-000000000000"
      },
      "occurredAt": "2026-06-28T00:00:00Z",
      "data": {}
    }

    Signature Headers#

    HeaderNotes
    X-Oceafin-Webhook-TimestampOffset date-time.
    X-Oceafin-Webhook-NonceUnique nonce for this delivery attempt.
    X-Oceafin-Webhook-SignatureLowercase hex HMAC-SHA256 signature.

    Signature Base String#

    timestamp
    nonce
    bodySha256Hex
    Verify the signature with the webhook signing secret provided by Oceafin.

    Node.js Verification Example#

    Use the raw HTTP request body bytes or string exactly as received. Do not
    re-serialize parsed JSON before verifying the signature.

    Event Types#

    Currently published event types:
    customer.onboarding.submitted
    fiat_account.application.submitted
    fiat_deposit.completed
    fiat_withdrawal.created
    crypto.deposit.pending_travel_rule
    crypto_withdrawal.created
    crypto_checkout.created
    collection_wallet.created
    crypto_refund.created
    conversion.created
    customer.transaction.updated
    customer.balance.changed

    Delivery And Retry#

    Any HTTP 2xx response is treated as successful delivery. Non-2xx responses
    are retried up to the configured attempt limit and then marked failed for
    operator inspection.
    Webhook handlers should:
    Verify the signature before parsing business data.
    Store eventId and process each event idempotently.
    Return 2xx only after the event is durably accepted.
    Avoid long-running work in the webhook request path.
    Modified at 2026-06-28 00:49:35
    Previous
    Product Workflows
    Next
    Errors
    Built with