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

    Errors

    Partner API errors use application/problem+json.

    Response Format#

    {
      "type": "https://api.oceafin.com/problems/partner-auth-failed",
      "title": "PARTNER_AUTH_FAILED",
      "status": 401,
      "code": "PARTNER_AUTH_FAILED",
      "detail": "Missing X-Partner-Client-Id header.",
      "requestId": "partner-request-id",
      "errors": []
    }
    FieldMeaning
    typeStable problem URI.
    titleHuman-readable problem title.
    statusHTTP status code.
    codeStable machine-readable partner error code.
    detailPartner-safe explanation.
    requestIdRequest id for support correlation.
    errorsOptional field-level validation details.

    Common Error Codes#

    CodeTypical cause
    PARTNER_AUTH_FAILEDMissing/unknown/inactive API client or required auth header.
    PARTNER_SIGNATURE_INVALIDSignature does not match the request.
    PARTNER_SIGNATURE_EXPIREDTimestamp is outside the freshness window.
    PARTNER_NONCE_REPLAYEDNonce was already used for this client.
    PARTNER_SCOPE_DENIEDClient does not have the required route scope.
    PARTNER_PRODUCT_DISABLEDProduct slice is not enabled for the partner.
    PARTNER_CUSTOMER_NOT_FOUNDCustomer does not exist or does not belong to the partner.
    PARTNER_RESOURCE_NOT_FOUNDResource does not exist or is not visible to the partner.
    PARTNER_RESOURCE_STATE_INVALIDResource is not in a valid state for the action.
    PARTNER_IDEMPOTENCY_CONFLICTSame idempotency key was reused with a different request body.
    PARTNER_OPERATION_NOT_APPROVEDMissing or mismatched operation authorization evidence.
    PARTNER_QUOTE_EXPIREDQuote can no longer be used.
    PARTNER_TRAVEL_RULE_REQUIREDCrypto deposit needs Travel Rule information.
    PARTNER_PROCESSING_UNAVAILABLEOceafin product processing is temporarily unavailable.

    Retry Guidance#

    Retry with the same Idempotency-Key and same request body when:
    The connection times out before a response is received.
    The response is PARTNER_PROCESSING_UNAVAILABLE.
    Oceafin support advises retry after investigating a transient failure.
    Do not retry unchanged when:
    The signature is invalid.
    The timestamp is stale.
    The nonce was replayed.
    The idempotency key conflicts with a different request body.
    The client lacks a required scope or product enablement.
    The resource state is invalid for the requested action.
    Include X-Request-Id, endpoint, timestamp, partnerCustomerRef, customerId
    when available, and the problem code when contacting Oceafin support. Do not
    send client secrets, webhook secrets, raw KYC/KYB files, or raw private keys.
    Modified at 2026-06-28 01:20:25
    Previous
    Webhooks
    Next
    Create partner customer
    Built with