Velo Payments APIs
  1. Login
Velo Payments APIs
  • Login
    • Authentication endpoint
      POST
    • Logout
      POST
    • Reset password
      POST
    • validate
      POST
  • Funding Manager
    • Get Funding Audit Delta
      GET
    • Get Funding Accounts
      GET
    • Get Funding Account
      GET
    • Get list of source accounts
      GET
    • Get details about given source account.
      GET
    • Create Funding Request
      POST
    • Set notifications
      POST
    • Get Funding Accounts
      GET
    • Get Funding Account
      GET
    • Get list of source accounts
      GET
    • Get details about given source account.
      GET
    • Create Funding Request
      POST
    • Transfer Funds between source accounts
      POST
    • Get list of source accounts
      GET
    • Get details about given source account.
      GET
    • Create Funding Request
      POST
    • Transfer Funds between source accounts
      POST
  • Payment Audit Service (Deprecated)
    • V1 List Payment Changes
      GET
    • V1 Get Fundings for Payor
      GET
    • V1 Get Payout Statistics
      GET
    • V3 Get List of Payments
      GET
    • V3 Get Payment
      GET
    • V3 Get Payouts for Payor
      GET
    • V3 Get Payments for Payout
      GET
    • V3 Export Transactions
      GET
  • Countries
    • List Payment Channel Country Rules
    • List Supported Countries
    • List Supported Countries
  • Payout Service
    • Withdraw a Payment
    • Submit Payout
    • Withdraw Payout
    • Get Payout Summary
    • Instruct Payout
    • Retrieve payments for a payout
    • Create a quote for the payout
  • Payors
    • List Payor Links
    • Get Payor
    • Create Application
    • Create API Key
    • Get Branding
    • Add Logo
    • Reminder Email Opt-Out
    • Get Payor
  • Payors Private
    • Create a Payor Link
  • Webhooks
    • List the details about the webhooks for the given payor.
    • Create Webhook
    • Get details about the given webhook.
    • Update Webhook
    • /v1/webhooks/{webhookId}/ping
  • Currencies
    • List Supported Currencies
  • Funding Manager Private
    • Create Funding Account
    • Delete a source account by ID
  • Users
    • List Users
    • Invite a User
    • Register SMS Number
    • Get Self
    • Unregister MFA for Self
    • Update Password for self
    • Validate the proposed password
    • Update User Details for self
    • Delete a User
    • Get User
    • Disable a User
    • Enable a User
    • Unregister MFA for the user
    • Update User Role
    • Unlock a User
    • Update User Details
  • Tokens
    • Resend a token
  • Payees
    • List Payees
    • List Payee Changes
    • Delete Payee by Id
    • Get Payee by Id
    • Update Payee Details
    • Update Payee Remote Id
    • List Payees
    • List Payee Changes
    • Delete Payee by Id
    • Get Payee by Id
    • Update Payee Details
    • Update Payee Remote Id
  • Payee Invitation
    • Initiate Payee Creation
    • Query Batch Status
    • Get Payee Invitation Status
    • Resend Payee Invite
    • Initiate Payee Creation
    • Query Batch Status
    • Get Payee Invitation Status
    • Resend Payee Invite
  • Payment Audit Service
    • Get Fundings for Payor
    • Get List of Payments
    • Get Payment
    • Get Payout Statistics
    • Get Payouts for Payor
    • Get Payments for Payout
    • Export Transactions
    • List Payment Changes
  • Schemas
    • Schemas
      • AcceptedPaymentV3
      • AccessTokenResponse
      • AccessTokenValidationRequest
      • AuthResponse
      • AutoTopUpConfig
      • AutoTopUpConfig_2
      • Category
      • Challenge
      • Challenge_2
      • Company
      • Company_2
      • CreateFundingAccountRequestV2
      • CreateIndividual
      • CreateIndividual_2
      • CreateIndividual_name
      • CreatePayee
      • CreatePayeeAddress
      • CreatePayeeAddress_2
      • CreatePayee_2
      • CreatePayeesCSVRequest
      • CreatePayeesCSVRequest_2
      • CreatePayeesCSVResponse
      • CreatePayeesCSVResponse_2
      • CreatePayeesCSVResponse_rejectedCsvRows
      • CreatePayeesRequest
      • CreatePayeesRequest_2
      • CreatePaymentChannel
      • CreatePaymentChannel_2
      • CreatePayorLinkRequest
      • CreatePayoutRequestV3
      • CreateWebhookRequest
      • DebitEvent
      • DebitEvent_allOf
      • DebitStatusChanged
      • DebitStatusChanged_allOf
      • Error
      • ErrorData
      • ErrorResponse
      • FailedPayee
      • FailedPayee_2
      • FailedSubmission
      • FailedSubmission_2
      • FundingAccountResponse
      • FundingAccountResponse_2
      • FundingAccountType
      • FundingAudit
      • FundingEvent
      • FundingEventType
      • FundingPayorStatusAuditResponse
      • FundingRequestV1
      • FundingRequestV2
      • FundingRequestV3
      • FxSummary
      • FxSummaryV3
      • GetFundingsResponse
      • GetFundingsResponse_links
      • GetPayeeListResponse
      • GetPayeeListResponseCompany
      • GetPayeeListResponseCompany_2
      • GetPayeeListResponseIndividual
      • GetPayeeListResponseIndividual_2
      • GetPayeeListResponse_2
      • GetPaymentsForPayoutResponseV3
      • GetPaymentsForPayoutResponseV3_page
      • GetPaymentsForPayoutResponseV3_summary
      • GetPaymentsForPayoutResponseV4
      • GetPaymentsForPayoutResponseV4_summary
      • GetPayoutStatistics
      • GetPayoutsResponse
      • GetPayoutsResponseV3
      • GetPayoutsResponseV3_links
      • GetPayoutsResponseV3_page
      • Individual
      • Individual_2
      • Individual_name
      • InvitationStatus
      • InvitationStatus_2
      • InvitePayeeRequest
      • InvitePayeeRequest_2
      • InviteUserRequest
      • ISO 3166 2 Character Country Code
      • ISO Currency Code
      • KycState
      • Language
      • Language_2
      • LinkForResponse
      • ListFundingAccountsResponse
      • ListFundingAccountsResponse_2
      • ListPaymentsResponseV3
      • ListPaymentsResponseV3_page
      • ListPaymentsResponseV4
      • ListSourceAccountResponse
      • ListSourceAccountResponseV2
      • ListSourceAccountResponseV2_links
      • ListSourceAccountResponseV3
      • ListSourceAccountResponseV3_links
      • ListSourceAccountResponse_links
      • ListSourceAccountResponse_page
      • LocalisationDetails
      • MFADetails
      • MFAType
      • Name
      • Name_2
      • Notification
      • Notifications
      • Notifications_2
      • OfacStatus
      • OnboardedStatus
      • OnboardedStatus_2
      • OnboardingStatusChanged
      • PageForResponse
      • PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse
      • PagedPayeeInvitationStatusResponse
      • PagedPayeeInvitationStatusResponse_2
      • PagedPayeeInvitationStatusResponse_page
      • PagedPayeeResponse
      • PagedPayeeResponse_2
      • PagedPayeeResponse_links
      • PagedPayeeResponse_page
      • PagedPayeeResponse_summary
      • PagedPaymentsResponseV3
      • PagedUserResponse
      • PagedUserResponse_links
      • PagedUserResponse_page
      • PasswordRequest
      • PayableIssue
      • PayableIssue_2
      • PayableStatusChanged
      • PayeeAddress
      • PayeeAddress_2
      • PayeeDelta
      • PayeeDeltaResponse
      • PayeeDeltaResponse_2
      • PayeeDeltaResponse_2_links
      • PayeeDeltaResponse_links
      • PayeeDeltaResponse_page
      • PayeeDelta_2
      • PayeeDetailResponse
      • PayeeDetailResponse_2
      • PayeeDetailsChanged
      • PayeeEvent
      • PayeeEvent_allOf
      • PayeeEvent_allOf_reasons
      • PayeeInvitationStatusResponse
      • PayeeInvitationStatusResponse_2
      • PayeePayorRef
      • PayeePayorRefV3
      • PayeeType
      • PayeeUserSelfUpdateRequest
      • PaymentAuditCurrency
      • PaymentAuditCurrencyV3
      • PaymentChannelCountry
      • PaymentChannelRule
      • PaymentChannelRulesResponse
      • PaymentDelta
      • PaymentDeltaResponse
      • PaymentDeltaResponseV1
      • PaymentDeltaV1
      • PaymentEvent
      • PaymentEventResponse
      • PaymentEventResponseV3
      • PaymentEvent_allOf
      • PaymentInstructionV3
      • PaymentRails
      • PaymentRejectedOrReturned
      • PaymentRejectedOrReturned_allOf
      • PaymentResponseV3
      • PaymentResponseV4
      • PaymentResponseV4_payout
      • PaymentStatusChanged
      • PaymentStatusChanged_allOf
      • PaymentV3
      • PayorAddress
      • PayorAddressV2
      • PayorAmlTransaction
      • PayorAmlTransactionV3
      • PayorBrandingResponse
      • PayorCreateApiKeyRequest
      • PayorCreateApiKeyResponse
      • PayorCreateApplicationRequest
      • PayorEmailOptOutRequest
      • PayorLinksResponse
      • PayorLinksResponse_links
      • PayorLinksResponse_payors
      • PayorLogoRequest
      • PayorV1
      • PayorV2
      • PayoutCompanyV3
      • PayoutIndividualV3
      • PayoutNameV3
      • PayoutPayeeV3
      • PayoutPayor
      • PayoutPayorIds
      • PayoutPrincipal
      • PayoutStatus
      • PayoutStatusV3
      • PayoutSummaryAudit
      • PayoutSummaryAuditV3
      • PayoutSummaryResponseV3
      • PayoutType
      • Ping
      • PingResponse
      • QueryBatchResponse
      • QueryBatchResponse_2
      • QuoteFxSummaryV3
      • QuoteResponseV3
      • RegionV2
      • RegisterSmsRequest
      • RejectedPaymentV3
      • ResendTokenRequest
      • ResetPasswordRequest
      • Role
      • RoleUpdateRequest
      • SelfMFATypeUnregisterRequest
      • SelfUpdatePasswordRequest
      • SetNotificationsRequest
      • SourceAccountResponse
      • SourceAccountResponseV2
      • SourceAccountResponseV3
      • SourceAccountSummary
      • SourceAccountSummaryV3
      • SourceAccountType
      • SourceAccountV3
      • SourceEvent
      • SupportedCountriesResponse
      • SupportedCountriesResponseV2
      • SupportedCountry
      • SupportedCountryV2
      • SupportedCurrencyResponseV2
      • SupportedCurrencyV2
      • SupportedLanguage
      • TransferRequest
      • TransferRequest_2
      • TransmissionType
      • TransmissionTypes
      • TransmissionTypes_2
      • UnregisterMFARequest
      • UpdatePayeeDetailsRequest
      • UpdatePayeeDetailsRequest_2
      • UpdateRemoteIdRequest
      • UpdateRemoteIdRequest_2
      • UpdateWebhookRequest
      • UserDetailsUpdateRequest
      • UserInfo
      • UserResponse
      • UserStatus
      • UserType
      • UserType_2
      • ValidatePasswordResponse
      • VerificationCode
      • WatchlistStatus
      • WatchlistStatus_2
      • WebhookResponse
      • WebhooksResponse
      • WithdrawPaymentRequest
      • inline_response_400
      • inline_response_401
      • inline_response_403
      • inline_response_404
      • inline_response_409
      • inline_response_412
  1. Login

Authentication endpoint

Velo Payments Sandbox for testing
https://api.sandbox.velopayments.com/
Velo Payments Sandbox for testing
https://api.sandbox.velopayments.com/
POST
/v1/authenticate
Use this endpoint to obtain an access token for calling Velo Payments APIs. Use HTTP Basic Auth. String value of
Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API
secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529

Request

Query Params

Responses

🟢200Valid Authenication response
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.sandbox.velopayments.com//v1/authenticate'
Response Response Example
{
    "access_token": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "entityIds": [
        "entityIds",
        "entityIds"
    ],
    "expires_in": 1799,
    "refresh_token": "IwOGYzYTlmM2YxOTQ5MGE3YmNmMDFkNTVk",
    "scope": "example_scope",
    "token_type": "bearer"
}
Modified at 2022-09-11 21:50:18
Next
Logout
Built with