Payout Integration

Introduction

  • Item Name : DevDocs - Documentation for Developers
  • Author : FastSwiff
  • Copyright : 2024 by FastSwiff

The product suite- Payouts, a crucial aspect of financial transactions, serve as the mechanism by which funds are distributed or disbursed to individuals or entities. Whether it's salaries for employees, dividends for investors, or payments for services rendered, payouts facilitate the transfer of money from one party to another.


Create Account


Begin your journey with FastSwiff by establishing a FastSwiff Account. Sign up using your phone number and email Address.


  1. 1. Prerequisites - FastSwiff account with MerchantKeyId, Authentication Key, Authentication Token. The Authentication Key and Authentication Token are available in the Merchant Panel.(MerchantLogin - Settings- Authentication keys)

  2. 2. UniqueRequestId for every order/transaction


CustomerData:

  • Authorizationbasic FastSwiffAuthentication

    FastSwiffAuthentication = base64 encoded (MerchantAuthenticationKey:MerchantAuthenticationToken:M:MerchantKeyId)
    OR generate Authorization Header value in FastSwiff Dashboard.

  • Content-Typeapplication/json
    required

Account Balance


REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/CheckBalance

Prod URL: https://api.fastswiff.com/payment/api/Payout/CheckBalance


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

    required
  • PayoutAccountKeyIdstring(50)

    Provided by FastSwiff for Virtual Account

    required

Response:

  • MerchantKeyIdinteger

    Echo from request

  • PayoutAccountKeyIdstring(20)

    Echo from request

  • AccountNostring(25)

    Virtual account number provided by bank

  • BankCodestring(20)

    IFSC Code

  • AccountHolderNamestring(50)

    Account holder name of the virtual account

  • Addressstring(50)

    Address of the bank

  • Citystring(20)

    City of the Bank

  • Statestring(20)

    State of the bank

  • ZipCodestring(20)

    ZipCode of the bank

  • CurrentBalancedecimal(18,2)

    Current balance or your virtual account

  • Statusstring(20)

    Status of the api call - "Success"

  • UpdatedDateTimedate & time

    Updated date & time of the account balance

# Add Payout Contact

REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/AddContact

Prod URL: >https://api.fastswiff.com/payment/api/Payout/AddContact


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

    required
  • RequestUniqueIdstring(10)

    Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.

    required
  • CustomerIdstring(20)

    Unique Id generated for that customer, alphanumeric only

  • CompanyNamestring(50)

    Name of the Company

    required
  • FirstNamestring(50)

    Name of the customer

    required
  • LastNamestring(50)

    Customer's last name

    required
  • Addressstring(50)

    Address

    required
  • Citystring(20)

    City

    required
  • Statestring(20)

    State

    required
  • ZipCodedecimal(18,2)

    Zip

    required
  • Countrystring(50)

    Country

  • MobileNo2string(20)

    Alternate Contact Number

  • Email requiredstring(20)

    Email id

  • Email2string(20)

    Alternate email id

  • UserDefined1string(20)

    Optional Parameter, to be used later

  • UserDefined2string(20)

    Optional Parameter, to be used later

  • UserDefined3string(20)

    Optional Parameter, to be used later

  • UserDefined4string(20)

    Optional Parameter, to be used later

  • UserDefined5string(20)

    Optional Parameter, to be used later

  • UserDefined6string(20)

    Optional Parameter, to be used later

  • UserDefined7string(20)

    Optional Parameter, to be used later

  • UserDefined8string(20)

    Optional Parameter, to be used later

  • UserDefined9string(20)

    Optional Parameter, to be used later

  • UserDefined10string(20)

    Optional Parameter, to be used later

Response:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

  • PayoutCustomerkeyIdinteger

    Unique id provided by FastSwiff for the contact

  • RequestUniqueIdstring(10)

    Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.

  • CustomerIdstring(20)

    Unique Id generated for that customer, alphanumeric only

  • CompanyNamestring(50)

    Name of the Company

  • FirstNamestring(50)

    Name of the customer

  • LastNamestring(50)

    Customer's last name

  • Addressstring(50)

    Address

  • Citystring(20)

    City

  • Statestring(20)

    State

  • ZipCodestring(20)

    Zip

  • Countrystring(20)

    Country

  • MobileNo2string(20)

    Alternate Contact Number

  • Email requiredstring(20)

    Email id

  • Email2string(20)

    Alternate email id

  • UserDefined1string(20)

    Optional Parameter, to be used later

  • UserDefined2string(20)

    Optional Parameter, to be used later

  • UserDefined3string(20)

    Optional Parameter, to be used later

  • UserDefined4string(20)

    Optional Parameter, to be used later

  • UserDefined5string(20)

    Optional Parameter, to be used later

  • UserDefined6string(20)

    Optional Parameter, to be used later

  • UserDefined7string(20)

    Optional Parameter, to be used later

  • UserDefined8string(20)

    Optional Parameter, to be used later

  • UserDefined9string(20)

    Optional Parameter, to be used later

  • UserDefined10string(20)

    Optional Parameter, to be used later

  • UpdatedDateTimedate & time

    Updated date & time

# Update Payout Contact

REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact

Prod URL: https://api.fastswiff.com/payment/api/Payout/UpdateContact


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

    required
  • PayoutCustomerkeyIdstring

    Unique id provided by FastSwiff for the contact

    required
  • RequestUniqueIdstring(10)

    Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.

    required
  • CustomerIdstring(20)

    Unique Id generated for that customer, alphanumeric only

    required
  • CompanyNamestring(50)

    Name of the Company

  • FirstNamestring(50)

    Name of the customer

    required
  • LastNamestring(50)

    Customer's last name

    required
  • Addressstring(50)

    Address

    required
  • Citystring(20)

    City

    required
  • Statestring(20)

    State

    required
  • ZipCodestring(20)

    Zip

    required
  • Countrystring(50)

    Country

  • MobileNostring(20)

    Contact Number

    required
  • MobileNo2string(20)

    Alternate Contact Number

  • Email requiredstring(20)

    Email id

    required
  • Email2string(20)

    Alternate email id

  • UserDefined1string(20)

    Optional Parameter, to be used later

  • UserDefined2string(20)

    Optional Parameter, to be used later

  • UserDefined3string(20)

    Optional Parameter, to be used later

  • UserDefined4string(20)

    Optional Parameter, to be used later

  • UserDefined5string(20)

    Optional Parameter, to be used later

  • UserDefined6string(20)

    Optional Parameter, to be used later

  • UserDefined7string(20)

    Optional Parameter, to be used later

  • UserDefined8string(20)

    Optional Parameter, to be used later

  • UserDefined9string(20)

    Optional Parameter, to be used later

  • UserDefined10string(20)

    Optional Parameter, to be used later

# Update Payout Contact

REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact

Prod URL: >https://api.fastswiff.com/payment/api/Payout/UpdateContact


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

    required
  • PayoutCustomerkeyIdstring

    Unique id provided by FastSwiff for the contact

    required
  • RequestUniqueIdstring(10)

    Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.

    required
  • CustomerIdstring(20)

    Unique Id generated for that customer, alphanumeric only

    required
  • CompanyNamestring(50)

    Name of the Company

  • FirstNamestring(50)

    Name of the customer

    required
  • LastNamestring(50)

    Customer's last name

    required
  • Addressstring(50)

    Address

    required
  • Citystring(20)

    City

    required
  • Statestring(20)

    State

    required
  • ZipCodestring(20)

    Zip

    required
  • Countrystring(50)

    Country

  • MobileNostring(20)

    Contact Number

    required
  • MobileNo2string(20)

    Alternate Contact Number

  • Email requiredstring(20)

    Email id

    required
  • Email2string(20)

    Alternate email id

  • UserDefined1string(20)

    Optional Parameter, to be used later

  • UserDefined2string(20)

    Optional Parameter, to be used later

  • UserDefined3string(20)

    Optional Parameter, to be used later

  • UserDefined4string(20)

    Optional Parameter, to be used later

  • UserDefined5string(20)

    Optional Parameter, to be used later

  • UserDefined6string(20)

    Optional Parameter, to be used later

  • UserDefined7string(20)

    Optional Parameter, to be used later

  • UserDefined8string(20)

    Optional Parameter, to be used later

  • UserDefined9string(20)

    Optional Parameter, to be used later

  • UserDefined10string(20)

    Optional Parameter, to be used later

Response:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

  • PayoutCustomerkeyIdinteger

    Unique id provided by FastSwiff for the contact

  • RequestUniqueIdstring(10)

    Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.

  • CustomerIdstring(20)

    Unique Id generated for that customer, alphanumeric only

  • CompanyNamestring(50)

    Name of the Company

  • FirstNamestring(50)

    Name of the customer

  • LastNamestring(50)

    Customer's last name

  • Addressstring(50)

    Address

  • Citystring(20)

    City

  • Statestring(20)

    State

  • ZipCodestring(20)

    Zip

  • Countrystring(20)

    Country

  • MobileNostring(20)

    Contact Number

  • MobileNo2string(20)

    Alternate Contact Number

  • Email requiredstring(20)

    Email id

  • Email2string(20)

    Alternate email id

  • UserDefined1string(20)

    Optional Parameter, to be used later

  • UserDefined2string(20)

    Optional Parameter, to be used later

  • UserDefined3string(20)

    Optional Parameter, to be used later

  • UserDefined4string(20)

    Optional Parameter, to be used later

  • UserDefined5string(20)

    Optional Parameter, to be used later

  • UserDefined6string(20)

    Optional Parameter, to be used later

  • UserDefined7string(20)

    Optional Parameter, to be used later

  • UserDefined8string(20)

    Optional Parameter, to be used later

  • UserDefined9string(20)

    Optional Parameter, to be used later

  • UserDefined10string(20)

    Optional Parameter, to be used later

  • UpdatedDateTimedate & time

    Updated date & time

# Get Payout Contact

REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/GetContact

Prod URL: https://api.fastswiff.com/payment/api/Payout/GetContact


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

    required
  • PayoutCustomerkeyIdstring

    Unique id provided by FastSwiff for the contact

    required

Response:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

  • PayoutCustomerkeyIdinteger

    Unique id provided by FastSwiff for the contact

  • RequestUniqueIdstring(10)

    Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.

  • CustomerIdstring(20)

    Unique Id generated for that customer, alphanumeric only

  • CompanyNamestring(50)

    Name of the Company

  • FirstNamestring(50)

    Name of the customer

  • LastNamestring(50)

    Customer's last name

  • Addressstring(50)

    Address

  • Citystring(20)

    City

  • Statestring(20)

    State

  • ZipCodestring(20)

    Zip

  • Countrystring(20)

    Country

  • MobileNostring(20)

    Contact Number

  • MobileNo2string(20)

    Alternate Contact Number

  • Email requiredstring(20)

    Email id

  • Email2string(20)

    Alternate email id

  • UserDefined1string(20)

    Optional Parameter, to be used later

  • UserDefined2string(20)

    Optional Parameter, to be used later

  • UserDefined3string(20)

    Optional Parameter, to be used later

  • UserDefined4string(20)

    Optional Parameter, to be used later

  • UserDefined5string(20)

    Optional Parameter, to be used later

  • UserDefined6string(20)

    Optional Parameter, to be used later

  • UserDefined7string(20)

    Optional Parameter, to be used later

  • UserDefined8string(20)

    Optional Parameter, to be used later

  • UserDefined9string(20)

    Optional Parameter, to be used later

  • UserDefined10string(20)

    Optional Parameter, to be used later

  • UpdatedDateTimedate & time

    Updated date & time

Request:

# Get All Payout Contacts

REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/GetContact

Prod URL: https://api.fastswiff.com/payment/api/Payout/GetContact


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

    required

Response:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

  • PayoutCustomerkeyIdinteger

    Unique id provided by FastSwiff for the contact

  • RequestUniqueIdstring(10)

    Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.

  • CustomerIdstring(20)

    Unique Id generated for that customer, alphanumeric only

  • CompanyNamestring(50)

    Name of the Company

  • FirstNamestring(50)

    Name of the customer

  • LastNamestring(50)

    Customer's last name

  • Addressstring(50)

    Address

  • Citystring(20)

    City

  • Statestring(20)

    State

  • ZipCodestring(20)

    Zip

  • Countrystring(20)

    Country

  • MobileNostring(20)

    Contact Number

  • MobileNo2string(20)

    Alternate Contact Number

  • Email requiredstring(20)

    Email id

  • Email2string(20)

    Alternate email id

  • UserDefined1string(20)

    Optional Parameter, to be used later

  • UserDefined2string(20)

    Optional Parameter, to be used later

  • UserDefined3string(20)

    Optional Parameter, to be used later

  • UserDefined4string(20)

    Optional Parameter, to be used later

  • UserDefined5string(20)

    Optional Parameter, to be used later

  • UserDefined6string(20)

    Optional Parameter, to be used later

  • UserDefined7string(20)

    Optional Parameter, to be used later

  • UserDefined8string(20)

    Optional Parameter, to be used later

  • UserDefined9string(20)

    Optional Parameter, to be used later

  • UserDefined10string(20)

    Optional Parameter, to be used later

  • UpdatedDateTimedate & time

    Updated date & time

# Add Beneficiary

REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/GetContact

Prod URL: https://api.fastswiff.com/payment/api/Payout/GetContact


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

    required
  • PayoutCustomerkeyIdstring

    Unique id provided by FastSwiff for the contact

    required
  • AccountNumberstring

    AccountNumber

    required
  • BeneficiaryNamestring

    BeneficiaryName

    required
  • BankNamestring

    BankName

    required
  • BranchNamestring

    BranchName

    required
  • BankCodestring

    IFSC Code

    required
  • BankCodeTypeinteger

    default 5 (it is for IFSC code)

    required
  • BankCountrystring

    Country

    required

Response:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

  • PayOutBeneficiaryKeyIdstring

    Unique Id provided by FastSwiff for the beneficiary

  • PayoutCustomerkeyIdstring

    Unique id provided by FastSwiff for the contact

  • AccountNumberstring

    AccountNumber

  • BeneficiaryNamestring

    BeneficiaryName

  • BankNamestring

    BankName

  • BranchNamestring

    BranchName

  • BankCodestring

    IFSC Code

  • BankCodeTypeinteger

    default 5 (it is for IFSC code)

  • BankCountrystring

    Country

  • VerificationStatusstring

    Verification Status. Please refer for Verification Status codes

  • VerificationResponsestring

    Verification Response

  • Statusinteger

    Status. Please refer for Response Codes

  • UpdatedDateTimedate & time

    Updated date & time

# Verify Beneficiary

REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/GetContact

Prod URL: https://api.fastswiff.com/payment/api/Payout/GetContact


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

  • RequestUniqueIdstring(10)

    Unique Id generated for that particular Request and it should not be repeated, alphanumeric only

  • PayOutTypestring

    Immediate (default)

  • TransactionTypestring

    Debit (default)

  • PaymentTypestring

    IMPS (default)

  • Amountstring

    amount

  • PayOutBeneficiaryKeyIdstring

    Unique id provided by FastSwiff for the Beneficiary

  • PayoutCustomerkeyIdstring

    Unique id provided by FastSwiff for the contact

  • PayOutDatedate & time

    payout date & time

Response:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

  • PayOutBeneficiaryKeyIdstring

    Unique Id provided by FastSwiff for the beneficiary

  • PayoutCustomerkeyIdstring

    Unique id provided by FastSwiff for the contact

  • AccountNumberstring

    AccountNumber

  • BeneficiaryNamestring

    BeneficiaryName

  • BankNamestring

    BankName

  • BranchNamestring

    BranchName

  • BankCodestring

    IFSC Code

  • BankCodeTypeinteger

    default 5 (it is for IFSC code)

  • BankCountrystring

    Country

  • VerificationStatusstring

    Verification Status. Please refer for Verification Status codes

  • VerificationResponsestring

    Verification Response

  • Statusinteger

    Status. Please refer for Response Codes

  • UpdatedDateTimedate & time

    Updated date & time

# Get Beneficiary Details

REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/GetContact

Prod URL: https://api.fastswiff.com/payment/api/Payout/GetContact


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

    required
  • PayOutBeneficiaryKeyIdstring

    CustomerkeyId provided by FastSwiff

    required

Response:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

  • PayOutBeneficiaryKeyIdstring

    Unique Id provided by FastSwiff for the beneficiary

  • PayoutCustomerkeyIdstring

    Unique id provided by FastSwiff for the contact

  • AccountNumberstring

    AccountNumber

  • BeneficiaryNamestring

    BeneficiaryName

  • BankNamestring

    BankName

  • BranchNamestring

    BranchName

  • BankCodestring

    IFSC Code

  • BankCodeTypeinteger

    default 5 (it is for IFSC code)

  • BankCountrystring

    Country

  • VerificationStatusstring

    Verification Status. Please refer for Verification Status codes

  • VerificationResponsestring

    Verification Response

  • Statusinteger

    Status. Please refer for Response Codes

  • UpdatedDateTimedate & time

    Updated date & time

# Get All Beneficiaries

REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/GetContact

Prod URL: https://api.fastswiff.com/payment/api/Payout/GetContact


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

    required

Response:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

  • PayOutBeneficiaryKeyIdstring

    Unique Id provided by FastSwiff for the beneficiary

  • PayoutCustomerkeyIdstring

    Unique id provided by FastSwiff for the contact

  • AccountNumberstring

    AccountNumber

  • BeneficiaryNamestring

    BeneficiaryName

  • BankNamestring

    BankName

  • BranchNamestring

    BranchName

  • BankCodestring

    IFSC Code

  • BankCodeTypeinteger

    default 5 (it is for IFSC code)

  • BankCountrystring

    Country

  • VerificationStatusstring

    Verification Status. Please refer for Verification Status codes

  • VerificationResponsestring

    Verification Response

  • Statusinteger

    Status. Please refer for Response Codes

  • UpdatedDateTimedate & time

    Updated date & time

# Payout Transfer

REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/GetContact

Prod URL: https://api.fastswiff.com/payment/api/Payout/GetContact


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

  • RequestUniqueIdstring(10)

    Unique Id generated for that particular Request and it should not be repeated, alphanumeric only

  • PayOutTypestring

    Immediate (default)

  • TransactionTypestring

    Debit (default)

  • PaymentTypestring

    IMPS (default)

  • Amountdecimal(18,2)

    Amount

  • PayOutBeneficiaryKeyIdstring

    Unique id provided by FastSwiff for the Beneficiary

  • PayoutCustomerkeyIdstring

    Unique id provided by FastSwiff for the contact

  • ProductDatastring - Json Object

    Product/Service detail related to the order, please review ProductData for more detail and example

  • PayOutDatedate & time

    Payout date & time

Response:

  • TransactionIdinteger

    Id of the transaction

  • PayOutKeyIdinteger

    Unique Id provided by FastSwiff for the beneficiary

  • MerchantKeyIdinteger

    Unique id provided by FastSwiff for the contact

  • PayOutTypestring

    AccountNumber

  • PayOutDatedate & time

    BeneficiaryName

  • TransactionTypestring

    BankName

  • PaymentTypestring

    BranchName

  • Amountdecimal(18,2)

    IFSC Code

  • PayOutBeneficiaryKeyIdinteger

    default 5 (it is for IFSC code)

  • PayoutCustomerkeyIdstring

    Country

  • RequestUniqueIdstring(10)

    Verification Status. Please refer for Verification Status codes

  • Statusstring

    Verification Response

  • ResponseCodeinteger

    Status. Please refer for Response Codes

  • ResponseTextdate & time

    Updated date & time

  • FeeCodedate & time

    Updated date & time

  • FeeAmountdate & time

    Updated date & time

  • GSTPercentagedate & time

    Updated date & time

  • GSTAmountdate & time

    Updated date & time

  • TotalFeeAmountdate & time

    Updated date & time

  • AdditionalFeedate & time

    Updated date & time

  • BuyAmountdate & time

    Updated date & time

  • BuyGSTAmountdate & time

    Updated date & time

  • BatchIddate & time

    Updated date & time

  • UpdatedDateTimedate & time

    Updated date & time

# Advanced Payout Transfer

REST Post Urls:

UAT URL: https://uatapi.fastswiff.com/payment/api/Payout/GetContact

Prod URL: https://api.fastswiff.com/payment/api/Payout/GetContact


Request:

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

    required
  • RequestUniqueIdstring(10)

    Unique Id generated for that particular Request and it should not be repeated, alphanumeric only

    required
  • PayOutTypestring

    Immediate (default)

    required
  • TransactionTypestring

    Debit (default)

    required
  • PaymentTypestring

    IMPS (default)

    required
  • Amountdecimal(18,2)

    amount

    required
  • PayOutBeneficiaryKeyIdstring

    Unique id provided by FastSwiff for the Beneficiary

    required
  • AccountNumberstring

    AccountNumber

    required
  • BeneficiaryNamestring

    BeneficiaryName

    required
  • BankNamestring

    BankName

    required
  • BranchNamestring

    BranchName

    required
  • BankCodestring

    IFSC Code

    required
  • ProductDatastring - Json Object

    Product/Service detail related to the order, please review ProductData for more detail and example

    required
  • BankCountrystring

    Country

    required
  • PayOutDatedate & time

    payout date & time

    required
  • KycDatastring

    Kyc data

    required
  • BeneficiaryVerificationinteger

    0 (default)

    required
  • BankNamestring

    BankName

    required

Response:

  • TransactionIdinteger

    Id of the transaction

  • PayOutKeyIdinteger

    Unique id provided by FastSwiff

  • MerchantKeyIdinteger

    Please get this MerchantKeyId from FastSwiff Dashboard

  • PayOutTypestring

    Echo from request

  • PayOutDatedate & time

    date & time

  • TransactionTypestring

    Debit (default)

  • PaymentTypestring

    IMPS (default)

  • Amountdecimal(18,2)

    Echo from request

  • PayOutBeneficiaryKeyIdinteger

    Unique Id provided by FastSwiff for the beneficiary

  • PayoutCustomerkeyIdstring

    CustomerkeyId provided by FastSwiff

  • RequestUniqueIdstring(10)

    Echo from the request

  • Statusstring

    Status

  • ResponseCodestring

    Response Please refer for Response Codes

  • ResponseTextstring

    Response text

  • FeeCodestring

    fee code

  • FeeAmountdecimal(18,2)

    fee amount

  • GSTPercentageinteger

    gst percentage

  • GSTAmountdecimal(18,2)

    gst amount

  • TotalFeeAmountdecimal(18,2)

    total feeamount

  • AdditionalFeedecimal(18,2)

    additional charges

  • BuyAmountdecimal(18,2)

    bank fee

  • BuyGSTAmountdecimal(18,2)

    bank gst

  • BatchIddate & time

    Batchid

  • UpdatedDateTimedate & time

    Updated date & time

ProductData Object:

Note: Product/service detail of the order, this detail will be displayed on payment page (by default, and can be configured, please check settings in merchant portal) and the transaction receipt.
example "ProductData":"{'PaymentReason':'OnlineOrder for OrderNo- 1234', 'ItemId':'T-shirt', 'Size':'medium', 'AppName':'yourAppName'}" Suggestion: please refer below table contents as suggestion and you can add as per your requirement. however it should be valid json object
  • PaymentReasonstring(50)

    Reason for this payment

  • ServiceTypestring(50)

    Type of the service

  • ProductNamestring(50)

    Name of the product

Payout Client

  • Authorizationbasic FastSwiffAuthentication

    FastSwiffAuthentication = base64 encoded (MerchantAuthenticationKey:MerchantAuthenticationToken:M:MerchantKeyId) Base64 Encode.

    required
  • Content-Type

    application/json

    required

Please refer

Payout API Documentation for more details.

1. Get Account Balance


Use the below url for your check balance


URL:https://uatapi.fastswiff.com/payment/api/Payout/CheckBalance 



{
	"MerchantKeyId": 7771,
	"PayoutAccountKeyId": "FastSwiffM7771AID000002"
}
 
											

 {
	"MerchantKeyId": 7771,
	"PayoutAccountKeyId": "FastSwiffM7771AID000002",
	"AccountNo": "FastSwiffX000000011113",
	"BankCode": "A000001",
	"AccountHolderName": "TEST",
	"Address": "Hyderabad",
	"City": null,
	"State": null,
	"ZipCode": null,
	"CurrentBalance": 5000,
	"Status": "Success",
	"UpdatedDateTime": "2023-11-24T20:12:44"
 }

2. Add Payout Contact


URL: https://uatapi.fastswiff.com/payment/api/Payout/AddContact 



    {
		"MerchantKeyId": 2,
		"RequestUniqueId":  "Test123",
		"CustomerId":  "Customer123",
		"CompanyName":  "Xsilica",
		"FirstName":  "First Name",
		"LastName":  "Last Name",
		"Address":  "Banjara Hills ",
		"City":  "Hyderabad",
		"State":  "Telangana",
		"ZipCode":  "500034",
		"Country":  "India",
		"MobileNo":  "90XXXXXXXX",
		"MobileNo2":  "",
		"Email":  "test@abc.com",
		"Email2":  "",
		"UserDefined1":  "",
		"UserDefined2":  "",
		"UserDefined3":  "",
		"UserDefined4":  "",
		"UserDefined5":  "",
		"UserDefined6":  "",
		"UserDefined7":  "",
		"UserDefined8":  "",
		"UserDefined9":  “",
		"UserDefined10":  ""
    }
      
											

    {
		"MerchantKeyId":  2,
		"PayoutCustomerkeyId":  "M7771C1801",
		"RequestUniqueId":  "Test123",
		"CustomerId":  "Customer123",
		"CompanyName":  "Xsilica",
		"FirstName":  "First Name",
		"LastName":  "Last Name",
		"Address":  "Banjara Hill ",
		"City": " Hyderabad",
		"State":  "Telangana",
		"ZipCode":  "500034",
		"Country":  "India",
		"MobileNo":  "90XXXXXXXX",
		"MobileNo2":  "",
		"Email":  "test@abc.com",
		"Email2":  "",
		"UserDefined1":  "",
		"UserDefined2":  "",
		"UserDefined3":  "",
		"UserDefined4":  "",
		"UserDefined5":  "",
		"UserDefined6":  "",
		"UserDefined7":  "",
		"UserDefined8":  "",
		"UserDefined9":  “",
		"UserDefined10":  "",
		"UpdatedDateTime":  "2023-11-24T19:02:03.757"
    }

3. Update Payout Contact


URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact



    {
		"MerchantKeyId":  2,
		"PayoutCustomerkeyId":  "M7771C1801",
		"RequestUniqueId":  "Test123",
		"CustomerId":  "Customer123",
		"CompanyName":  "Xsilica",
		"FirstName":  "First Name",
		"LastName":  "Last Name",
		"Address":  "Banjara Hill ",
		"City":  "Hyderabad",
		"State":  "Telangana",
		"ZipCode":  "500034",
		"Country":  "India",
		"MobileNo":  "90XXXXXXXX",
		"MobileNo2":  "",
		"Email":  "test@abc.com",
		"Email2":  "",
		"UserDefined1":  "",
		"UserDefined2":  "",
		"UserDefined3":  "",
		"UserDefined4":  "",
		"UserDefined5":  "",
		"UserDefined6":  "",
		"UserDefined7":  "",
		"UserDefined8":  "",
		"UserDefined9":  “",
		"UserDefined10":  ""
    }
       
											

    {
		"MerchantKeyId":  2,
		"PayoutCustomerkeyId":  "M7771C1801",
		"RequestUniqueId":  "Test123",
		"CustomerId":  "Customer123",
		"CompanyName":  "Xsilica",
		"FirstName":  "First Name",
		"LastName":  "Last Name",
		"Address":  "Banjara Hill ",
		"City":  "Hyderabad",
		"State":  "Telangana",
		"ZipCode":  "500034",
		"Country":  "India",
		"MobileNo":  "90XXXXXXXX",
		"MobileNo2":  "",
		"Email":  "test@abc.com",
		"Email2":  "",
		"UserDefined1":  "",
		"UserDefined2":  "",
		"UserDefined3":  "",
		"UserDefined4":  "",
		"UserDefined5":  "",
		"UserDefined6":  "",
		"UserDefined7":  "",
		"UserDefined8":  "",
		"UserDefined9":  “",
		"UserDefined10":  "" ,
		"UpdatedDateTime":  "2023-11-24T19:02:03.757",
    }

4. Get Payout Contact


URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact



{
	"MerchantKeyId":  2,
	"PayoutCustomerkeyId":  "M7771C1801"
}
  
											

{
    "MerchantKeyId":  2,
    "PayoutCustomerkeyId":  "M7771C1801",
    "RequestUniqueId":  "Test123",
    "CustomerId":  "Customer123",
    "CompanyName":  "Xsilica",
    "FirstName":  "First Name",
    "LastName":  "Last Name",
    "Address":  "Banjara Hill ",
    "City":  "Hyderabad",
    "State":  "Telangana",
    "ZipCode":  "500034",
    "Country":  "India",
    "MobileNo":  "90XXXXXXXX",
    "MobileNo2":  "",
    "Email":  "test@abc.com",
    "Email2":  "",
    "UserDefined1":  "",
    "UserDefined2":  "",
    "UserDefined3":  "",
    "UserDefined4":  "",
    "UserDefined5":  "",
    "UserDefined6":  "",
    "UserDefined7":  "",
    "UserDefined8":  "",
    "UserDefined9":  “",
    "UserDefined10" : "" ,
    "UpdatedDateTime":  "2023-11-24T19:02:03.757",
}

5. Get All Payout Contacts


URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact



 {
	"MerchantKeyId":  2,
	"PayoutCustomerkeyId":  "M7771C1801"
 }
   
											

    {
		"Id":  2,
		"MerchantKeyId":  7771,
		"PayoutCustomerkeyId":  "M7771Ca7ae1",
		"RequestUniqueId":  "a7ae13cf-d1c2-4804-8290-fac109d48c0c",
		"CustomerId":  "SKT@11321",
		"CompanyName":  "Test Company",
		"FirstName": "Suryapal",
		"LastName":  "",
		"Address":  "Surjapol",
		"City":  "Hyderabad",
		"State":  "Telangana",
		"ZipCode":  "555555",
		"Country":  "India",
		"MobileNo":   "80XXXXXX",
		"MobileNo2":  "",
		"Email":  "abc@xsilica.com",
		"Email2":  "",
		"Status":  1,
		"UserDefined1":  "",
		"UserDefined2":  "",
		"UserDefined3":  "",
		"UserDefined4":  "",
		"UserDefined5":  "",
		"UserDefined6":  "",
		"UserDefined7":  "",
		"UserDefined8":  "",
		"UserDefined9":  "",
		"UserDefined10":  "",
		"UpdatedUserName":  "0b8f90ac-0987-4bb5-a4a6-6bf67fa39529",
		"UpdatedDateTime":  "2023-11-24T20:54:08.657",
    },
    {
		"Id":  8,
		"MerchantKeyId":  7771,
		"PayoutCustomerkeyId":  "M7771CTEst13",
		"RequestUniqueId":  "TEst13",
		"CustomerId":  "3214",
		"CompanyName":  "R.D.T",
		"FirstName":  "Sai",
		"LastName":  "",
		"Address":  "Ameerpet",
		"City":  "hyd",
		"State":  "tel",
		"ZipCode":  "530590",
		"Country":  "India",
		"MobileNo":  "80XXXX",
		"MobileNo2":  "",
		"Email":  "test@abc.com",
		"Email2":  "",
		"Status":  1,
		"UserDefined1":  "",
		"UserDefined2":  "",
		"UserDefined3":  "",
		"UserDefined4":  "",
		"UserDefined5":  "",
		"UserDefined6":  "",
		"UserDefined7":  "",
		"UserDefined8":  "",
		"UserDefined9":  "",
		"UserDefined10":  "",
		"UpdatedUserName":  "",
		"UpdatedDateTime":  "2023-11-24T19:02:03.757",
    },
    etc…..
    

											
    
    {
		"MerchantKeyId":  2,
		"PayoutCustomerkeyId":  "M7771C1801"
    }
        
											

    
    {
		"Id":  2,
		"MerchantKeyId":  7771,
		"PayoutCustomerkeyId":  "M7771Ca7ae1",
		"RequestUniqueId":  "a7ae13cf-d1c2-4804-8290-fac109d48c0c",
		"CustomerId":  "SKT@11321",
		"CompanyName":  "Test Company",
		"FirstName": "Suryapal",
		"LastName":  "",
		"Address":  "Surjapol",
		"City":  "Hyderabad",
		"State":  "Telangana",
		"ZipCode":  "555555",
		"Country":  "India",
		"MobileNo":   "80XXXXXX",
		"MobileNo2":  "",
		"Email":  "abc@xsilica.com",
		"Email2":  "",
		"Status":  1,
		"UserDefined1":  "",
		"UserDefined2":  "",
		"UserDefined3":  "",
		"UserDefined4":  "",
		"UserDefined5":  "",
		"UserDefined6":  "",
		"UserDefined7":  "",
		"UserDefined8":  "",
		"UserDefined9":  "",
		"UserDefined10":  "",
		"UpdatedUserName":  "0b8f90ac-0987-4bb5-a4a6-6bf67fa39529",
		"UpdatedDateTime":  "2023-11-24T20:54:08.657",
    },
    {
		"Id":  8,
		"MerchantKeyId":  7771,
		"PayoutCustomerkeyId":  "M7771CTEst13",
		"RequestUniqueId":  "TEst13",
		"CustomerId":  "3214",
		"CompanyName":  "R.D.T",
		"FirstName":  "Sai",
		"LastName":  "",
		"Address":  "Ameerpet",
		"City":  "hyd",
		"State":  "tel",
		"ZipCode":  "530590",
		"Country":  "India",
		"MobileNo":  "80XXXX",
		"MobileNo2":  "",
		"Email":  "test@abc.com",
		"Email2":  "",
		"Status":  1,
		"UserDefined1":  "",
		"UserDefined2":  "",
		"UserDefined3":  "",
		"UserDefined4":  "",
		"UserDefined5":  "",
		"UserDefined6":  "",
		"UserDefined7":  "",
		"UserDefined8":  "",
		"UserDefined9":  "",
		"UserDefined10":  "",
		"UpdatedUserName":  "",
		"UpdatedDateTime":  "2023-11-24T19:02:03.757",
    },
    etc…..

6. Add Beneficiary


URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact


    
    {
		"MerchantKeyId":  7771,
		"PayoutCustomerkeyId":  "M7771C1801",
		"BankCodeType":  0,
		"BankName": " SBI",
		"BranchName":  "Repalle",
		"BankCode":  "SBIN0000183",
		"AccountNumber":  "123XXXXX000000",
		"BankAccountType":  0,
		"BankCountry":  "India",
		"BeneficiaryName":  "Test"
    }
      
											

    {
		"MerchantKeyId":  7771,
		"PayOutBeneficiaryKeyId":  "M7771B58515",
		"PayoutCustomerkeyId":  "M7771C1801",
		"BankCodeType":  5,
		"BankName":  "SBI",
		"BranchName":  "Repalle",
		"BankCode":  "SBIN0000183",
		"AccountNumber":  "123XXXXX000000",
		"BankAccountType":  0,
		"BankCountry":  "India",
		"VerificationStatus":  "Pending for Verification",
		"VerificationResponse":  "4",
		"Status":  1,
		"BeneficiaryName" :  "Test",
		"UpdatedDateTime":  "2023-11-24T18:48:34.4577757+05:30"
    }

7. Verify Beneficiary


URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact


    
    {
		"MerchantKeyId":  7771,
		"UniqueRequestId":  "testpayout",
		"PayOutType":  "Immediate",
		"PayOutDate":  "",
		"TransactionType":  "Debit",
		"PaymentType":  "IMPS",
		"Amount":  1.0,
		"PayOutBeneficiaryKeyId":  "M7771B58515",
		"PayoutCustomerkeyId":  "M7771C1801"
	}
	  
											

    {
		"TransactionId":  2,
		"PayOutKeyId":  "PDD78797",
		"MerchantKeyId":  2,
		"PayOutType":  "Immediate",
		"PayOutDate":  "2023-11-24T12:06:06.8035695+05:30",
		"TransactionType":  "Debit",
		"PaymentType":  "IMPS",
		"Amount":  1,
		"PayOutBeneficiaryKeyId":  "M7771B58515",
		"PayoutCustomerkeyId":  "M7771C1801",
		"UniqueRequestId":  testpayout,
		"Status":  0,
		"ResponseCode":  "1",
		"ResponseText":  Approved,
		"UpdatedDateTime":  "2023-11-24T12:06:19.8834096+05:30"
    }

8. Get Beneficiary Details


URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact


    
    {
		"MerchantKeyId":  7771,
		"PayOutBeneficiaryKeyId":  "M7771B58515"
    }
	
											

    {
		"MerchantKeyId":  7771,
		"PayOutBeneficiaryKeyId" : "M7771B58515",
		"PayoutCustomerkeyId":  "M7771C1801",
		"BankCodeType":  5,
		"BankName":  "SBI",
		"BranchName":  "Repalle",
		"BankCode":  "SBIN0000183",
		"AccountNumber":  "134XXXXX123",
		"BankAccountType":  0,
		"BankCountry":  "India",
		"VerificationStatus":  "Pending for Verification",
		"VerificationResponse":  "4",
		"Status":  1,
		“BeneficiaryName” :  “Test”
		"UpdatedDateTime":  "2023-11-24T18:48:34.457",
    }

9. Get All Beneficiary


URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact


    
    {
		"MerchantKeyId":  7771,
		"PayOutBeneficiaryKeyId":  "M7771B58515"
    }
             
											

    
    {
		"MerchantKeyId":  7771,
		"PayOutBeneficiaryKeyId":  "M7771B58515",
		"PayoutCustomerkeyId":  "M7771C1801",
		"BankCodeType":  5,
		"BankName":  "SBI",
		"BranchName":  "Repalle",
		"BankCode":  "SBIN0000183",
		"AccountNumber":  "134XXXXX123",
		"BankAccountType":  0,
		"BankCountry":  "India",
		"VerificationStatus":  "Pending for Verification",
		"VerificationResponse":  "4",
		"Status":  1,
		“BeneficiaryName” :  “Test”
		"UpdatedDateTime":  "2023-11-24T18:48:34.457",
    }

10. Payout Transfer


URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact


    
     {
		"MerchantKeyId":  7771,
		"UniqueRequestId":  "testpayout",
		"PayOutType":  "Immediate",
		"PayOutDate":  "",
		"TransactionType":  "Debit",
		"PaymentType":  "IMPS",
		"Amount":  1.0,
		"PayOutBeneficiaryKeyId":  "M7771B58515",
		"PayoutCustomerkeyId":  "M7771C1801",
		"ProductData": "{'PaymentReason':'OnlineOrder for OrderNo- 1234','ItemId':'T-shirt',Size':'medium', 'AppName':'XYZApp'}"
     }
              
											

     {
		"TransactionId":  2,
		"PayOutKeyId":  "PDD78797",
		"MerchantKeyId":  2,
		"PayOutType":  "Immediate",
		"PayOutDate":  "2023-11-24T12:06:06.8035695+05:30",
		"TransactionType":  "Debit",
		"PaymentType":  "IMPS",
		"Amount":  1,
		"PayOutBeneficiaryKeyId":  "M7771B58515",
		"PayoutCustomerkeyId":  "M7771C1801",
		"UniqueRequestId":  testpayout,
		"Status":  0,
		"ResponseCode":  "1",
		"ResponseText":  Approved,
		"FeeCode": " sample string 28",
		"FeeAmount":  29.0,
		"GSTPercentage":  30.0,
		"GSTAmount":  31.0,
		"TotalFeeAmount":  32.0,
		"AdditionalFee":  33.0,
		"BuyAmount":  34.0,
		"BuyGSTAmount":  35.0,
		"BatchId":  36
		"UpdatedDateTime":  "2023-11-24T12:06:19.8834096+05:30"
     }

11. Payout Transfer Status


URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact


    
     {
		"TransactionId": "2",
		"PayOutKeyId":  "PMD3423432",
		"MerchantKeyId":2
     }
            
											

     {
		"TransactionId": 2,
		"PayOutKeyId":  "PDD78797",
		"MerchantKeyId":  2,
		"PayOutType":  "Immediate",
		"PayOutDate":  "2023-11-24T12:06:06.8035695+05:30",
		"TransactionType":  "Debit",
		"PaymentType":  "IMPS",
		"Amount":  1,
		"PayOutBeneficiaryKeyId":  "M7771B58515",
		"PayoutCustomerkeyId":  "M7771C1801",
		"UniqueRequestId":  testpayout,
		"Status":  0,
		"ResponseCode":  "1",
		"ResponseText":  Approved,
		"FeeCode":  "sample string 28",
		"FeeAmount":  29.0,
		"GSTPercentage":  30.0,
		"GSTAmount":  31.0,
		"TotalFeeAmount":  32.0,
		"AdditionalFee":  33.0,
		"BuyAmount":  34.0,
		"BuyGSTAmount":  35.0,
		"BatchId":  36
		"UpdatedDateTime":  "2023-11-24T12:06:19.8834096+05:30"
		"UTRNo":  "IND03458"
     }

12. Advanced Payout Transfer


URL: https://uatapi.fastswiff.com/payment/api/Payout/UpdateContact


    
     {
        "MerchantKeyId":  8463,
        "UniqueRequestId":  "0091928",
        "PayOutType":  "Immediate",
        "PayOutDate":  "2023-11-24T13:03:02.2437907+05:30",
        "PaymentType":  "IMPS",
        "Amount":  5.0,
        "PayoutCustomerkeyId":  "M8463CID284",
        "BankName":  "Idbi",
        "BranchName":  "Hyderabad",
        "BankCode":  "IBKL0000183",
        "AccountNumber":  "100022872707",
        "BankCountry":  "",
        "BeneficiaryName":  "Anil",
        "ProductData":  "",
        "KycData":  "",
        "BeneficiaryVerification": 0,
        "ProductData": "{'PaymentReason':'OnlineOrder for OrderNo- 1234','ItemId':'T-shirt',Size':'medium', 'AppName':'XYZApp'}"
     
     }
     
             
											

     {
		"TransactionId":  2,
		"PayOutKeyId":  "PDD78797",
		"MerchantKeyId":  2,
		"PayOutType":  "Immediate",
		"PayOutDate":  "2023-11-24T12:06:06.8035695+05:30",
		"TransactionType":  "Debit",
		"PaymentType":  "IMPS",
		"Amount":  1,
		"PayOutBeneficiaryKeyId":  "M7771B58515",
		"PayoutCustomerkeyId":  "M7771C1801",
		"UniqueRequestId":  testpayout,
		"Status":  0,
		"ResponseCode":  "1",
		"ResponseText":  Approved,
		"FeeCode":  "sample string 28",
		"FeeAmount":  29.0,
		"GSTPercentage":  30.0,
		"GSTAmount":  31.0,
		"TotalFeeAmount":  32.0,
		"AdditionalFee":  33.0,
		"BuyAmount":  34.0,
		"BuyGSTAmount":  35.0,
		"BatchId":  36
		"UpdatedDateTime":  "2023-11-24T12:06:19.8834096+05:30"
     }

Payout - WebHook

Steps to configure for WebHook Integration


1 Sign In to a FastSwiff Account with username and password.

2 Go to Dashboard > Click on Payout.

3 Go to Reports

4. Click on PayOut PostBack Url: tab as shown in image.

5. Click on Edit button. Enter the PostbackURL for WebHook URL tab as shown in image.

6. You can also specify auth key if required. It is optional parameter.

7. You will get OrderResponse: in PostBackURL in below JSON Format 


    

{
	"TransactionId": 394,
	"PayOutKeyId": "FastSwiffM7451KID000394",
	"MerchantKeyId": 7451,
	"PayOutType": "Immediate",
	"PayOutDate": "2023-04-19T11:32:38.64",
	"TransactionType": "Debit",
	"PaymentType": "NEFT",
	"Amount": 1.00,
	"PayOutBeneficiaryKeyId": "M7451B85905",
	"PayoutCustomerkeyId": "M7451C18885",
	"UniqueRequestId": "sfsdfsdf",
	"Status": 4,
	"ResponseCode": "1",
	"ResponseText": "Approved",
	"ResponseReasonCode": null,
	"ResponseReferenceNo": null,
	"UpdatedDateTime": "2023-04-19T12:04:43.42",
	"FeeCode": null,
	"FeeAmount": 0.00,
	"GSTPercentage": 0.00,
	"GSTAmount": 0.00,
	"TotalFeeAmount": 0.00,
	"TotalAmount": 1.00,
	"AdditionalFee": 0.00,
	"IFSCCode": "IBKL0000183",
	"AccountNumber": "1234567891",
	"BeneficiaryName": "Suryapal Rathore",
	"CustomerRefNo": null,
	"UTRNo": null,
	"ApprovedBy": null,
	"ErrorResponse": null,
	"VANumber": null,
	"PayoutAccountKeyId": null,
	"AccountBalance": 0.00
}
Tools

Select Color

Modes

light

light

dark

dark

Sidebar

light

light

dark

dark

background

Bg-1

background

Bg-2

background

Bg-3

background

Bg-4

Backgrounds

default

Default

bg-1

Bg-1

bg-2

Bg-2

bg-3

Bg-3

bg-4

Bg-4

bg-5

Bg-5

Box Design

default

Default

box-1

Box-1

box-2

Box-2

box-3

Box-3