Sokin Embedded API
  1. Payments Reference Data
Sokin Embedded API
  • Getting Started
    • Sokin Definitions
    • Guides
      • Authentication
      • Receiving Payments
      • FX Payments
      • Payments
      • Unfunded Payments
      • Unfunded FX Payments
      • Corporate Onboarding
        • Data Requirements
        • Step 1: Create a corporate profile
        • Step 2: Add associates
        • Step 3: Add a parent entity (if applicable)
        • Step 4: Upload company documents
        • Step 5: Upload associate documents
        • Real-time Status Updates via Webhook
        • Conditional Step: Upload Parent Entity documents (if applicable)
        • Step 6: Finalise onboarding submission
        • Uploading supporting documents using Pre-signed URLs
        • Onboarding Reference Data
        • Onboarding Models
          • Data-Only model
          • Supported Jurisdictions & National ID Requirements
      • Payments Reference Data
        • Purpose of Payment
        • Transfer Reasons
        • Beneficiary Fields
  • Authentication
    • Get Token
      POST
    • Get Token on behalf of corporate
      POST
    • Schemas
      • TokenResponse
  • Corporates
    • v2025-12-01
      • Create a new Corporate
      • Add a parent entity (corporate associate) to an onboarding request
      • Add an associate to a corporate onboarding request
      • Request pre-signed URLs for onboarding document uploads
      • Request pre-signed URLs for parent entity document uploads
      • Request pre-signed URLs for associate document uploads
      • Finalise corporate onboarding submission
    • Schemas
      • NumericRange
      • ApiResponse[AddIndividualAssociateResponse]
      • ApiResponse[AddAssociateDocumentsResponse]
      • ApiResponse[AddOnboardingDocumentsResponse]
      • AddOnboardingDocumentsResponse
      • AssociateDocumentPresignedUrlResponse
      • AssociateType
      • ErrorResponse
      • MessageResponse
      • FinaliseSubmissionResponse
      • AddParentEntityRequest
      • MoneyRange
      • AddOnboardingDocumentsRequest
      • ApiResponse[CreateCorporateResponse]
      • CreateCorporateRequest
      • CreateCorporateResponse
      • FinaliseSubmissionRequest
      • PresignedUrlResponse
      • AddressTypeEnum
      • OwnershipType
      • AddAssociateDocumentsResponse
      • ErrorDetail
      • AddIndividualAssociateRequest
      • UboDetails
      • AddParentEntityResponse
      • AddIndividualAssociateResponse
      • CorporateAssociateType
      • AddParentEntityDocumentsRequest
      • AssociateDocumentPresignedUrlResponseItem
      • ApiResponse[AddParentEntityResponse]
      • AssociateIdentityType
      • AddAssociateDocumentsRequest
  • Corporate Currency Accounts
    • v2025-12-01
      • Get Corporate Currency Accounts
      • Get Corporate Currency Account By Reference
    • Schemas
      • ErrorResponse
      • PaginationInfo
      • ErrorDetail
      • ApiResponse[GetCCAByReferenceResponse]
      • GetCCAByReferenceResponse
      • GetCCAByReferenceResponsePayInDetail
      • GetCCAsResponseItem
      • PaginatedApiResponse[GetCCAsResponseItem]
  • Beneficiaries
    • v2025-12-01
      • Get Beneficiary Fields
      • Create External Beneficiary
      • Get Beneficiary List
      • Get Beneficiary Details
      • Delete Beneficiary
    • Schemas
      • ErrorResponse
      • FieldType
      • IdentifierType
      • TransactionTypeEnum
      • BeneficiaryType
      • AccountType
      • ApiResponse[BeneficiaryDetails]
      • ApiResponse[CreateExternalBeneficiaryData]
      • ApiResponse[DeleteBeneficiaryData]
      • ApiResponse[GetBeneficiaryFieldsResponse]
      • BeneficiaryField
      • BeneficiaryListItem
      • CreateExternalBeneficiaryData
      • CreateExternalBeneficiaryRequest
      • DeleteBeneficiaryData
      • GetBeneficiaryFieldsResponse
      • PaginatedApiResponse[BeneficiaryListItem]
      • StateOrProvince
      • PaginationInfo
      • PaginatedBeneficiaryFieldsResponse
      • ErrorDetail
      • BeneficiaryDetails
  • Instruction Requests
    • v2025-12-01
      • Get Instruction Request By Reference
      • Create Payment Instruction Request
      • Create Fx Instruction Request
      • Create Fx Payment Instruction Request
      • Create Unfunded Payment Instruction Request
      • Create Unfunded Fx Payment Instruction Request
    • Schemas
      • ErrorResponse
      • ApiResponse[CreateInstructionRequestResponse]
      • ErrorDetail
      • ApiResponse[GetInstructionRequestResponse]
      • CreateFXInstructionRequest
      • CreateFxPaymentInstructionRequest
      • CreateInstructionRequestResponse
      • CreatePaymentInstructionRequest
      • CreateUnfundedFxPaymentInstructionRequest
      • CreateUnfundedPaymentInstructionRequest
      • GetInstructionRequestResponse
  • Instructions
    • v2025-12-01
      • Get Instruction By Reference
    • Schemas
      • ErrorDetail
      • ErrorResponse
      • ApiResponse[GetInstructionResponse]
      • GetInstructionResponse
  • Foreign Exchange
    • v2025-12-01
      • Get Fx Rate
    • Schemas
      • ErrorResponse
      • FxRateData
      • FixedSide
      • ApiResponse[FxRateData]
      • ErrorDetail
      • FxRateRequest
  • Webhooks
    • Webhooks
    • v2025-12-01
      • Create Subscription
      • Update Subscription Status
      • Update Subscription
      • Delete Subscription
      • Get Subscription By Id
      • List Notification Logs
      • Retry Notification
    • Schemas
      • ApiResponse[CreateSubscriptionResponse]
      • NotificationStatus
      • ApiResponse[NotificationLogList]
      • NotificationAttemptResponse
      • ApiResponse[UpdateSubscriptionResponse]
      • NotificationLogList
      • ErrorResponse
      • NotificationLogResponse
      • SubscriptionCreateOrUpdate
      • SubscriptionStatusUpdate
      • CreateSubscriptionResponse
      • UpdateSubscriptionResponse
      • InstructionCreated
      • ErrorDetail
      • InstructionReqeustRejected
      • InstructionProcessedWebhook
      • InstructionRejectedWebhook
      • OnboardingRequestApproved
      • OnboardingRequestRejected
      • CorporateActivated
      • CorporateDeactivated
      • CorporateCurrencyAccountFundingReceived
      • WebhookSubscription
      • WebhookNotificationLogs
  1. Payments Reference Data

Beneficiary Fields

Below are the possible beneficiary fields to create beneficiaries.
FieldnameDescriptionFor the beneficiary creator
Bank CountryBank CountryMandatory
CurrencyCurrencyMandatory
Beneficiary NameBeneficiary NameMandatory
TypeTypeMandatory
Beneficiary TypeBeneficiary Type Enum: "Individual" "Company"Conditional
Identifier TypeFinancial Institution Type Enum: "BIC/SWIFT" "NCC CODE" "SORT CODE" "ABA" "ROUTING NO" "BSB" "BRANCH CODE" "TRANSIT CODE"Conditional
Identifier ValueFinancial Institution ValueConditional
ProviderIDProvider IDConditional
Bank NameBeneficiary Bank NameConditional
BankIDBank IDConditional
BankAccountTypeBank Account TypeConditional
BankRoutingTypeBank Routing TypeConditional
BankBranchNameBank Branch NameConditional
BankBranchNoBank Branch NumberConditional
BankBranchCityBank Branch CityConditional
BankAccountCountryBank Account CountryConditional
Account NameAccount NameConditional
Account First NameAccount First NameConditional
Account Last NameAccount Last NameConditional
Account NumberAccount NumberConditional
Account TypeAccount Type Enum: "IBAN" "ACCOUNT"Conditional
Financial InstitutionFinancial InstitutionConditional
Financial Institution BranchFinancial Institution BranchConditional
Address Line 1Address Line 1Conditional
Address Line 2Address Line 2Conditional
Address Line 3Address Line 3Conditional
House/ Building NumberHouse/ Building NumberConditional
Street NameStreet NameConditional
Postal CodePostal CodeConditional
CityCityConditional
CountryCountryConditional
State or ProvinceState or ProvinceConditional
EmailEmailConditional
Mobile NumberMobile NumberConditional
IBANIBANConditional
BIC SWIFTBIC SWIFTConditional
Routing NumberRouting NumberConditional
OrderNoOrder NumberConditional
OrderDateOrder DateConditional
CountryFromCountry FromConditional
CountryToCountry toConditional
PaymentReferenceNumberPayment Reference NumberConditional
PaymentCurrencyPayment CurrencyConditional
PaymentAmountPayment AmountConditional
CommissionCurrencyCommission CurrencyConditional
CommissionAmountCommission AmountConditional
PromoCodePromo CodeConditional
DateFromDate FromConditional
DateToDate ToConditional
ProductItemIDProduct Item IDConditional
FlexifundAmountFlexifund AmountConditional
ContributionAmountContribution AmountConditional
RiaCustIDCustomer IDConditional
RIALinkNoLink NumberConditional
RiaBeneIDBeneficiary IDConditional
BeneTypeIDBeneficiary Type IDConditional
AgentBeneIDAgent Beneficiary IDConditional
BeneIDNoBeneficiary ID NumberConditional
BeneIndustrySubCategoryIDBeneficiary Industry Sub Category IDConditional
BeneIDTypeBeneficiary ID TypeConditional
BeneTaxIDBeneficiary Tax IDConditional
BeneIndustryCategoryIDBeneficiary Industry Category IDConditional
BeneAmountBeneficiary AmountConditional
BeneQuestionBeneficiary QuestionConditional
BeneAnswerBeneficiary AnswerConditional
BeneMiddleNameBeneficiary Middle NameConditional
BeneLastName2Beneficiary Last Name 2Conditional
BeneNationalityBeneficiary NationalityConditional
BeneDateOfBirthBeneficiary Date Of BirthConditional
BeneFatherNameBeneficiary Father NameConditional
BeneMotherNameBeneficiary Mother NameConditional
BeneStateBeneficiary StateConditional
BeneCountryOfBirthBeneficiary Country Of BirthConditional
BeneDateOfIncorporationBeneficiary Date Of IncorporationConditional
BeneCellNoBeneficiary Cell NumberConditional
BenePhoneNoBeneficiary Phone NumberConditional
BeneEmailAddressBeneficiary Email AddressConditional
BeneMessageBeneficiary MessageConditional
VirtualPaymentAccountNoVirtual Payment Account NumberConditional
PayingCorrespIDPaying Corresponding IDConditional
PayingCorrespLocIDPaying Corresponding Location IDConditional
PayingCorrespSequenceIDPaying Corresponding Sequence IDConditional
SendingCorrespBranchNoSending Corresponding Branch NumberConditional
PaymentInstructionPayment InstructionConditional
DeliveryMethodDelivery MethodConditional
TransferReasonIDTransfer Reason IDConditional
VirtualPaymentProviderIDVirtual Payment Provider IDConditional
MobileWalletAccountNoMobile Wallet Account NumberConditional
UnitaryTypeUnitary TypeConditional
ValuetypeValue typeConditional
CustGenderCustomer GenderConditional
CustIncomePaymentMethodCustomer Income Payment MethodConditional
CustIncomeFrequencyCustomer Income FrequencyConditional
Modified at 2026-02-23 08:52:15
Previous
Transfer Reasons
Next
Get Token
Built with