Get started

 API Endpoint: Please call Us


Flow transaction



Welcome to the Dhanapatra API.

The Dhanapatra Transfer API offers the following features and is structured in accordance with REST principles:

  • Money Transfer from Indonesia (Outbond)
  • Money Transfer To Indonesia (Inbound)*
  • Retrieve transaction details and process transaction
  • Retrieve services and process all of our services

To use this API, you need an API key and API secret. Please contact us at contact@dhanapatra.co.id to get your own API key.

Authentication

Access to all endpoints of the API requires authentication through
HTTP Basic Authentication.

Basic Authentication

Api-keyString
Api-secretString

Your identity and authorization are represented by your API key and secret.

Please hold onto these and store them safely! Cleartext API credentials shouldn't be disclosed or kept on file. It is your responsibility to protect those credentials once you have them.

Check Connections



GET /api/connection 

                
            

To check connection with our server you need to make a GET call to the following url :
GET /api/connection


Result example :
{
   "status" :  "up"
}
                
            

PARAMETERS

N/A


RETURNS

FieldTypeDescription
statusStringApi Status

List of Transactions



GET /api/auth/transaction 

                
            

Retrieve a list of transactions :
GET /api/auth/transaction


Result example :
[
  {
    "id": "449",
    "firstname": "Test",
    "external_id": "20240624151105151",
    "partner_id": "4197396",
    "status": "VA Generated",
    "payer": "All Banks | LOCAL",
    "destination_country": "AUT",
    "send_amount": "1000000",
     "receive_amount": "56.73",
    "currency": "EUR",
    "createdAt": "2024-06-24T15:22:44.415Z"
  },
  {
    "id": "442",
    "firstname": "Test",
    "external_id": "20240624131235151",
    "partner_id": "4197396",
    "status": "VA Generated",
    "payer": "All Banks | LOCAL",
    "destination_country": "AUT",
    "send_amount": "1000000",
     "receive_amount": "56.73",
    "currency": "EUR",
    "createdAt": "2024-06-24T15:22:44.415Z"
  
  },
]
                
            

PARAMETERS

FieldTypeDescription
pageIntPage number
limitIntNumber of results per page

RETURNS

FieldTypeDescription
idStringID of transaction
firstnameStringFirstname of sender
external_idStringReference number of transaction
partner_idStringPartner id of payer
statusStringStatus
payerStringPayer of transaction
destination_countryStringDestination country
send_amountStringSend amount
receive_amountStringReceive amount
currencyStringCurrency
createdAtStringCreated date of transaction

Quotation



POST /api/transaction/quotations 

                
            

Creates a new quotation:
POST /api/transaction/quotations


Request JSON example :
{
    "destination": 
    {
        "amount": 100,
        "currency": "EUR"
    },
    "email":  "test@dhanapatra.co.id",
    "external_id":  "20240612301012",
    "mode":  "DESTINATION_AMOUNT",
    "payer_id":  2827,
    "source": 
    {
        "country_iso_code": "IDN",
        "currency": "IDR"
    },
    "type": "C2C"
}
                
            

Result example :
{
    "creation_date" : "2024-06-27T07:28:31Z",
    "destination": 
    {
        "amount": 1,
        "currency": "EUR"
    },
    "expiration_date": "2024-06-27T08:28:31Z",
    "external_id": "20240612301012",
    "fee": 
    {
        "amount": 22975.4,
        "currency": "IDR"
    },
    "id": 56607875,
    "mode": "DESTINATION_AMOUNT",
    "payer": 
    {
        "country_iso_code": "BGR",
        "currency": "EUR",
        "id": 2827,
        "name": "All Banks Bulgaria / EUR / Payment System: SEPA",
        "service": 
        {
            "id": 2,
            "name": "BankAccount"
        }
    },
    "sent_amount": 
    {
        "amount": 17586.67,
        "currency": "IDR"
    },
    "source": 
    {
        "amount": 17586.67,
        "country_iso_code": "IDN",
        "currency": "IDR"
    },
    "transaction_type": "C2C",
    "wholesale_fx_rate": 0.0000568612554177702
}
                
            

PARAMETERS

FieldTypeDescription
destinationObjectDestination Amount & Currency
emailStringSender's email
external_idStringExternal id for transaction
modeStringDESTINATION_AMOUNT
payer_idStringPayer id from response list of payers
sourceObjectSource of country: Country iso code & Currency.
typeStringType of transaction:
Business to business: B2B
Business to customer: B2C
Customer to Customer: C2C
Customer to Business: C2B

RETURNS

FieldTypeDescription
creation_dateStringID of transaction
destinationObjectDestination Amount & Currency
expiration_dateStringExpired date of quotation
external_idStringExternal id
feeStringFee
idStringID of transaction
modeStringDESTINATION_AMOUNT
payerObjectPayer information
sent_amountObjectSend amount: amount & currency
sourceObjectSource: amount, country iso code, & currency
transaction_typeStringType of transaction
wholesale_fx_rateStringFX Rate

Transaction



POST /api/transaction/transactions 

                
            

Creates a new transactions based on quotation:
POST /api/transaction/transactions

Requiredness will depend on the chosen transaction_type from quotation:

C2C will require a sender and a beneficiary
C2B will require a sender and a receiving business
B2C will require a sending business and a beneficiary
B2B will require a sending business and a receiving business


Request JSON example :
{
  "beneficiary": {
    "address": "100A Canning Ave",
    "country_iso_code": "BGR",
    "firstname": "David CD",
    "id_expiration_date": "2024-10-05",
    "id_number": "G1234509T",
    "id_type": "PASSPORT",
    "lastname": "James AB",
    "msisdn": "+9718275017100"
  },
  "credit_party_identifier": {
    "iban": "YY97RSLN70873614666196054205058200"
  },
  "external_id": "20240612301012",
  "purpose_of_remittance": "COMPUTER_SERVICES",
  "document_reference_number": "20240612301012",
  "sender": {
    "beneficiary_relationship": "FRIEND",
    "code": "81273732",
    "country_iso_code": "IDN",
    "date_of_birth": "1980-03-01",
    "firstname": "Alan",
    "gender": "MALE",
    "id_number": "191829182CT",
    "lastname": "Smith",
    "occupation": "Pegawai negeri sipil",
    "source_of_funds": "CASH",
    "address": "ALAMAT",
    "city": "CITY"
  }
  "sending_business": {
    "registered_name": "CORP LLC",
    "trading_name": "CORP",
    "country_iso_code": "USA",
    "postal_code": "ABCDEF",
    "msisdn": "1982918991",
    "email": "corp@mail.com",
    "representative_firstname": "Alan",
    "representative_lastname": "Marc",
    "representative_middlename": "Rud",
    "representative_lastname2": "Sam",
    "registration_number": "2818921",
    "address": "ADDRESS YORK",
    "city": "CITY",
    "business_relationship": "EMPLOYEE"
    "source_of_funds": "CASH"
  }
  "receiving_business": {
    "registered_name": "CORP LLC",
    "trading_name": "CORP",
    "country_iso_code": "USA",
    "postal_code": "ABCDEF",
    "msisdn": "1982918991",
    "email": "corp@mail.com",
    "representative_firstname": "Alan",
    "representative_lastname": "Marc",
    "representative_middlename": "Rud",
    "representative_lastname2": "Sam",
    "registration_number": "2818921",
    "address": "ADDRESS YORK",
    "city": "CITY",
    
  }
}
                
            

Result example :
            {
  "additional_information_1": null,
  "additional_information_2": null,
  "additional_information_3": null,
  "beneficiary": {
    "address": "100A Canning Ave",
    "bank_account_holder_name": null,
    "city": null,
    "code": null,
    "country_iso_code": "BGR",
    "country_of_birth_iso_code": null,
    "date_of_birth": null,
    "email": null,
    "firstname": "David CD",
    "gender": null,
    "id_country_iso_code": null,
    "id_delivery_date": null,
    "id_expiration_date": "2024-10-05",
    "id_number": "G1234509T",
    "id_type": "PASSPORT",
    "lastname": "James AB",
    "lastname2": null,
    "middlename": null,
    "msisdn": "9718275017100",
    "nationality_country_iso_code": null,
    "nativename": null,
    "occupation": null,
    "postal_code": null,
    "province_state": null
  },
  "callback_url": null,
  "creation_date": "2024-06-27T07:30:42Z",
  "credit_party_identifier": {
    "iban": "YY97RSLN70873614666196054205058200"
  },
  "destination": {
    "amount": 1,
    "currency": "EUR"
  },
  "document_reference_number": null,
  "expiration_date": "2024-06-27T08:28:31Z",
  "external_code": null,
  "external_id": "20240612301012",
  "fee": {
    "amount": 22975.4,
    "currency": "IDR"
  },
  "id": 4201353,
  "payer": {
    "country_iso_code": "BGR",
    "currency": "EUR",
    "id": 2827,
    "name": "All Banks Bulgaria / EUR / Payment System: SEPA",
    "service": {
        "id": 2,
        "name": "BankAccount"
    }
  },
  "payer_transaction_code": null,
  "payer_transaction_reference": null,
  "purpose_of_remittance": null,
  "reference": null,
  "retail_fee": null,
  "retail_fee_currency": null,
  "retail_rate": null,
  "sender": {
    "address": "alamat aja",
    "bank_account_number": null,
    "beneficiary_relationship": "FRIEND",
     "city": "city",
    "code": "81273732",
    "country_iso_code": "IDN",
    "country_of_birth_iso_code": null,
    "date_of_birth": "1980-03-01",
    "email": null,
    "firstname": "Alan",
    "gender": "MALE",
    "id_country_iso_code": null,
    "id_delivery_date": null,
    "id_expiration_date": null,
    "id_number": "191829182CT",
    "id_type": null,
    "lastname": "Smith",
    "lastname2": null,
    "middlename": null,
    "msisdn": null,
    "nationality_country_iso_code": null,
    "nativename": null,
    "occupation": "Pegawai negeri sipil",
    "postal_code": null,
    "province_state": null,
    "source_of_funds": "CASH"
  },
  "sent_amount": {
    "amount": 17586.67,
    "currency": "IDR"
  },
  "source": {
    "amount": 17586.67,
    "country_iso_code": "IDN",
    "currency": "IDR"
  },
  "status": "10000",
  "status_class": "1",
  "status_class_message": "CREATED",
  "status_message": "CREATED",
  "transaction_type": "C2C",
  "wholesale_fx_rate": 0.0000568612554177702
}
                
            

PARAMETERS

FieldTypeDescription
beneficiaryObjectBeneficiary details
senderObjectsender details
sending_businessObjectSender business details
receiving_businessObjectBeneficiary business details
credit_party_identifierObjectCredit party identifier from quotation response
external_idStringExternal id for transaction
purpose_of_remittanceStringPurpose of transaction
document_reference_numberStringDocument reference number. Required for B2B transaction

RETURNS

FieldTypeDescription
idIntID of transaction
statusStringID of transaction
status_messageStringID of transaction
status_classStringID of transaction
status_class_messageStringID of transaction
beneficiaryObjectID of transaction
senderObjectDestination Amount & Currency
sending_businessObjectExpired date of quotation
receiving_businessObjectExternal id
credit_party_identifierStringFee
external_idStringID of transaction
transaction_typeStringID of transaction
creation_dateStringID of transaction
expiration_dateStringID of transaction
sourceStringID of transaction
destinationStringID of transaction
sent_amountStringID of transaction
wholesale_fx_rateStringID of transaction
feeStringID of transaction
purpose_of_remittanceStringID of transaction
document_reference_numberStringID of transaction

PURPOSE OF REMMITANCE

ParameterDescription
IR001 Transfer to own account
IR002 Family Maintenance
IR003 Education-related student expenses
IR004 Medical Treatment
IR005 Hotel Accommodation
IR006 Travel
IR007 Utility Bills
IR008 Repayment of Loans
IR009 Tax Payment
IR010 Purchase of Residential Property
IR011 Payment of Property Rental
IR012 Insurance Premium
IR013 Product Indemnity Insurance
IR014 Insurance Claims Payment
IR015 Mutual Fund Investment
IR016 Investment in Shares
IR020 Salary
IR01801 Information Service Charges
IR01802 Advertising & Public relations-related expenses
IR01803 Royalty fees, trademark fees, patent fees, and copyright fees
IR01804 Fees for brokers, front end fee, commitment fee, guarantee fee and custodian fee
IR01805 Fees for advisors, technical assistance and academic knowledge, including remuneration for specialists
IR01806 Representative office expenses
IR01807 Construction costs/expenses
IR01808 Transportation fees for goods
IR01809 For payment of exported goods
IR01810 Delivery fees for goods
IR01811 General Goods Trades - Offline trade

BENEFICIARY RELATIONSHIP

ParameterDescription
AUNTAunt
BROTHERBrother
BROTHER_IN_LAWBrother-in-law
COUSINCousin
DAUGHTERDaughter
FATHERFather
FATHER_IN_LAWFather-in-law
FRIENDFriend
GRAND_FATHERGrandfather
GRAND_MOTHERGrandmother
HUSBANDHusband
MOTHERMother
MOTHER_IN_LAWMother-in-law
NEPHEWNephew
NIECENiece
SELFSelf
SISTERSister
SISTER_IN_LAWSister-in-law
SONSon
UNCLEUncle
WIFEWife

SOURCE OF FUNDS

ParameterDescription
CASHCash
BUSINESSBusiness
GIFTGift
SALARYSalary
SAVINGSSavings

BUSINESS RELATIONSHIP

ParameterDescription
BUSINESS_PARTNERBusiness Partner
CUSTOMERCustomer
EMPLOYEEEmployee
PROVIDERProvider
INVESTORInvestor
VENDOR_SERVICEVendor Service

Confirm



POST /api/transaction/confirm 

                
            

Confirm a transaction based on quotation:
POST /api/transaction/confirm


Request JSON example :
{
  "external_id": "20240612301012",
}
                
            

Result example :
            {
  "additional_information_1": null,
  "additional_information_2": null,
  "additional_information_3": null,
  "beneficiary": {
    "address": "100A Canning Ave",
    "bank_account_holder_name": null,
    "city": null,
    "code": null,
    "country_iso_code": "BGR",
    "country_of_birth_iso_code": null,
    "date_of_birth": null,
    "email": null,
    "firstname": "David CD",
    "gender": null,
    "id_country_iso_code": null,
    "id_delivery_date": null,
    "id_expiration_date": "2024-10-05",
    "id_number": "G1234509T",
    "id_type": "PASSPORT",
    "lastname": "James AB",
    "lastname2": null,
    "middlename": null,
    "msisdn": "9718275017100",
    "nationality_country_iso_code": null,
    "nativename": null,
    "occupation": null,
    "postal_code": null,
    "province_state": null
  },
  "callback_url": null,
  "creation_date": "2024-06-27T07:30:42Z",
  "credit_party_identifier": {
    "iban": "YY97RSLN70873614666196054205058200"
  },
  "destination": {
    "amount": 1,
    "currency": "EUR"
  },
  "document_reference_number": null,
  "expiration_date": "2024-06-27T08:28:31Z",
  "external_code": null,
  "external_id": "20240612301012",
  "fee": {
    "amount": 22975.4,
    "currency": "IDR"
  },
  "id": 4201353,
  "payer": {
    "country_iso_code": "BGR",
    "currency": "EUR",
    "id": 2827,
    "name": "All Banks Bulgaria / EUR / Payment System: SEPA",
    "service": {
        "id": 2,
        "name": "BankAccount"
    }
  },
  "payer_transaction_code": null,
  "payer_transaction_reference": null,
  "purpose_of_remittance": null,
  "reference": null,
  "retail_fee": null,
  "retail_fee_currency": null,
  "retail_rate": null,
  "sender": {
    "address": "alamat aja",
    "bank_account_number": null,
    "beneficiary_relationship": "FRIEND",
     "city": "city",
    "code": "81273732",
    "country_iso_code": "IDN",
    "country_of_birth_iso_code": null,
    "date_of_birth": "1980-03-01",
    "email": null,
    "firstname": "Alan",
    "gender": "MALE",
    "id_country_iso_code": null,
    "id_delivery_date": null,
    "id_expiration_date": null,
    "id_number": "191829182CT",
    "id_type": null,
    "lastname": "Smith",
    "lastname2": null,
    "middlename": null,
    "msisdn": null,
    "nationality_country_iso_code": null,
    "nativename": null,
    "occupation": "Pegawai negeri sipil",
    "postal_code": null,
    "province_state": null,
    "source_of_funds": "CASH"
  },
  "sent_amount": {
    "amount": 17586.67,
    "currency": "IDR"
  },
  "source": {
    "amount": 17586.67,
    "country_iso_code": "IDN",
    "currency": "IDR"
  },
  "status": "20000",
  "status_class": "2",
  "status_class_message": "CONFIRMED",
  "status_message": "CONFIRMED",
  "transaction_type": "C2C",
  "wholesale_fx_rate": 0.0000568612554177702
}
                
            

PARAMETERS

FieldTypeDescription
external_idStringexternal_id from quotation

RETURNS

FieldTypeDescription
idIntID of transaction
statusStringID of transaction
status_messageStringID of transaction
status_classStringID of transaction
status_class_messageStringID of transaction
beneficiaryObjectID of transaction
senderObjectDestination Amount & Currency
sending_businessObjectExpired date of quotation
receiving_businessObjectExternal id
credit_party_identifierStringFee
external_idStringID of transaction
transaction_typeStringID of transaction
creation_dateStringID of transaction
expiration_dateStringID of transaction
sourceStringID of transaction
destinationStringID of transaction
sent_amountStringID of transaction
wholesale_fx_rateStringID of transaction
feeStringID of transaction
purpose_of_remittanceStringID of transaction
document_reference_numberStringID of transaction

Confirm



POST /api/transaction/attachment 

                
            

Add attachment based on quotation:
POST /api/transaction/attachment


Request Body example :

  name: filename.pdf
  type: invoice/purchase_order/delivery_slip/contract/customs_declaration/bill_of_landing,
  external_id: "20240612301012",
  file: PDF or Image,
  

                
            

Result example :
{
  "content_type": "application/pdf",
  "id": 3213123,
  "name": "filename.pdf",
  "transaction_id": "invoice"
}
                
            

PARAMETERS

FieldTypeDescription
nameStringfile name
typeStringtype depend on response form required document in payer
fileFileFile PDF / Image only
external_idStringexternal_id from quotation

RETURNS

FieldTypeDescription
idIntID of attachment file
nameStringFile name
content_typeStringType of file
typeStringtype of uploaded document
transaction_idStringID of transaction

Status



POST /api/transaction/status 

                
            

Retrieve a transaction status based on quotation:
POST /api/transaction/status


Request JSON example :
{
  "external_id": "20240612301012",
}
                
            

Result example :
            {
  "additional_information_1": null,
  "additional_information_2": null,
  "additional_information_3": null,
  "beneficiary": {
    "address": "100A Canning Ave",
    "bank_account_holder_name": null,
    "city": null,
    "code": null,
    "country_iso_code": "BGR",
    "country_of_birth_iso_code": null,
    "date_of_birth": null,
    "email": null,
    "firstname": "David CD",
    "gender": null,
    "id_country_iso_code": null,
    "id_delivery_date": null,
    "id_expiration_date": "2024-10-05",
    "id_number": "G1234509T",
    "id_type": "PASSPORT",
    "lastname": "James AB",
    "lastname2": null,
    "middlename": null,
    "msisdn": "9718275017100",
    "nationality_country_iso_code": null,
    "nativename": null,
    "occupation": null,
    "postal_code": null,
    "province_state": null
  },
  "callback_url": null,
  "creation_date": "2024-06-27T07:30:42Z",
  "credit_party_identifier": {
    "iban": "YY97RSLN70873614666196054205058200"
  },
  "destination": {
    "amount": 1,
    "currency": "EUR"
  },
  "document_reference_number": null,
  "expiration_date": "2024-06-27T08:28:31Z",
  "external_code": null,
  "external_id": "20240612301012",
  "fee": {
    "amount": 22975.4,
    "currency": "IDR"
  },
  "id": 4201353,
  "payer": {
    "country_iso_code": "BGR",
    "currency": "EUR",
    "id": 2827,
    "name": "All Banks Bulgaria / EUR / Payment System: SEPA",
    "service": {
        "id": 2,
        "name": "BankAccount"
    }
  },
  "payer_transaction_code": null,
  "payer_transaction_reference": null,
  "purpose_of_remittance": null,
  "reference": null,
  "retail_fee": null,
  "retail_fee_currency": null,
  "retail_rate": null,
  "sender": {
    "address": "alamat aja",
    "bank_account_number": null,
    "beneficiary_relationship": "FRIEND",
     "city": "city",
    "code": "81273732",
    "country_iso_code": "IDN",
    "country_of_birth_iso_code": null,
    "date_of_birth": "1980-03-01",
    "email": null,
    "firstname": "Alan",
    "gender": "MALE",
    "id_country_iso_code": null,
    "id_delivery_date": null,
    "id_expiration_date": null,
    "id_number": "191829182CT",
    "id_type": null,
    "lastname": "Smith",
    "lastname2": null,
    "middlename": null,
    "msisdn": null,
    "nationality_country_iso_code": null,
    "nativename": null,
    "occupation": "Pegawai negeri sipil",
    "postal_code": null,
    "province_state": null,
    "source_of_funds": "CASH"
  },
  "sent_amount": {
    "amount": 17586.67,
    "currency": "IDR"
  },
  "source": {
    "amount": 17586.67,
    "country_iso_code": "IDN",
    "currency": "IDR"
  },
  "status": "50000",
  "status_class": "5",
  "status_class_message": "SUBMITTED",
  "status_message": "SUBMITTED",
  "transaction_type": "C2C",
  "wholesale_fx_rate": 0.0000568612554177702
}
                
            

PARAMETERS

FieldTypeDescription
external_idStringexternal_id from quotation

RETURNS

FieldTypeDescription
idIntID of transaction
statusStringID of transaction
status_messageStringID of transaction
status_classStringID of transaction
status_class_messageStringID of transaction
beneficiaryObjectID of transaction
senderObjectDestination Amount & Currency
sending_businessObjectExpired date of quotation
receiving_businessObjectExternal id
credit_party_identifierStringFee
external_idStringID of transaction
transaction_typeStringID of transaction
creation_dateStringID of transaction
expiration_dateStringID of transaction
sourceStringID of transaction
destinationStringID of transaction
sent_amountStringID of transaction
wholesale_fx_rateStringID of transaction
feeStringID of transaction
purpose_of_remittanceStringID of transaction
document_reference_numberStringID of transaction


STATUS

ParameterDescription
10000CREATED
20000CONFIRMED
20110CONFIRMED-UNDER-REVIEW-SLS
30000REJECTED
40000CANCELLED
50000SUBMITTED
60000AVAILABLE
70000COMPLETED
80000REVERSED
90000DECLINED
90200DECLINED-INVALID-BENEFICIARY
90211DECLINED-INVALID-SENDER-DETAILS
90330DECLINED-LIMITATIONS-ON-ACCOUNT-VALUE
90392DECLINED-COMPLIANCE-REASON

Payers



POST /api/transaction/payers 

                
            

Request JSON example :
{
  "iso_code": "BEL"
}

            

Result example :
[
  {
    "country_iso_code": "BEL",
    "currency": "EUR",
    "id": 2006,
    "increment": 0.01,
    "name": "All Banks | LOCAL",
    "precision": 2,
    "service": 
    {
        "id": 2,
        "name": "BankAccount"
       
    },
    "transaction_types": {
        "B2B": 
            {
                 "credit_party_identifiers_accepted": 
                [
                    [
                        "iban"
                    ]
                ],
                "credit_party_information": 
                {
                    "credit_party_identifiers_accepted": 
                    [
                            []
                    ]
                },
                "credit_party_verification": 
                {
                    "credit_party_identifiers_accepted": 
                    [
                        []
                    ],
                    "required_receiving_entity_fields": 
                    [
                        []
                    ]
                },
                "maximum_transaction_amount": null,
                "minimum_transaction_amount": "0.00000000",
                "purpose_of_remittance_values_accepted": [],
                "required_documents": 
                    [
                        []
                    ],
                        "required_receiving_entity_fields": 
                        [
                            [
                                "registered_name",
                                "country_iso_code"
                            ]
                        ],
                    "required_sending_entity_fields": 
                        [
                            [
                                "registered_name",
                                "country_iso_code",
                                "registration_number"
                            ]
                        ]
                },
        "B2C": {
                    "credit_party_identifiers_accepted": 
                        [
                            [
                                "iban"
                            ]
                        ],
        "credit_party_information": 
        {
            "credit_party_identifiers_accepted": 
            [
                []
            ]
        },
        "credit_party_verification": 
        {
            "credit_party_identifiers_accepted": 
            [
                []
            ],
            "required_receiving_entity_fields": 
            [
                []
            ]
        },
        "maximum_transaction_amount": null,
        "minimum_transaction_amount": "0.00000000",
        "purpose_of_remittance_values_accepted": [],
        "required_documents": [
          []
        ],
        "required_receiving_entity_fields": [
          [
            "lastname",
            "firstname",
            "country_iso_code"
          ]
        ],
        "required_sending_entity_fields": [
          [
            "registered_name",
            "country_iso_code",
            "registration_number"
          ]
        ]
      },
      "C2B": {
        "credit_party_identifiers_accepted": [
          [
            "iban"
          ]
        ],
        "credit_party_information": 
        {
            "credit_party_identifiers_accepted": 
            [
                []
            ]
        },
        "credit_party_verification": 
        {
            "credit_party_identifiers_accepted": 
            [
                []
            ],
            "required_receiving_entity_fields": 
            [
                []
            ]
        },
        "maximum_transaction_amount": null,
        "minimum_transaction_amount": "0.00000000",
         "purpose_of_remittance_values_accepted": [],
         "required_documents": [
          []
        ],
        "required_receiving_entity_fields": [
          [
            "registered_name"
          ]
        ],
        "required_sending_entity_fields": [
          [
            "lastname",
            "firstname",
            "code",
            "id_number",
            "address",
            "city",
            "country_iso_code"
          ]
        ]
      },
      "C2C": {
        "credit_party_identifiers_accepted": [
          [
            "iban"
          ]
        ],
        "credit_party_information": {
            "credit_party_identifiers_accepted": [
            []
          ]
        },
         "credit_party_verification": 
        {
            "credit_party_identifiers_accepted": 
            [
                []
            ],
          "required_receiving_entity_fields": 
            [
                []
            ]
        },
        "maximum_transaction_amount": null,
        "minimum_transaction_amount": "0.00000000",
        "purpose_of_remittance_values_accepted": [],
        "required_documents": [
          []
        ],
        "required_receiving_entity_fields": [
          [
            "lastname",
            "firstname"
          ]
        ],
        "required_sending_entity_fields": [
          [
            "lastname",
             "firstname",
            "code",
            "id_number",
            "address",
            "city",
            "country_iso_code"
          ]
        ]
      }
    }
  }
]
                
            

Retrieve list of available payers:
POST /api/transaction/payers


            

PARAMETERS

FieldTypeDescription
iso_codeStringCountry is code

RETURNS

FieldTypeDescription
country_iso_codeStringCountry Code
currencyStringCurrency of transaction
idStringID of payer
incrementStringIncrement
nameStringName of payers
precisionStringPrecision of payers
serviceObjectService: id & name
transaction_typesObjectArray of transaction types

Payers Detail



POST /api/transaction/payers-detail

                
            

Request JSON example :
{
  "id": 2006
}

            

Result example :

  {
    "country_iso_code": "BEL",
    "currency": "EUR",
    "id": 2006,
    "increment": 0.01,
    "name": "All Banks | LOCAL",
    "precision": 2,
    "service": 
    {
        "id": 2,
        "name": "BankAccount"
       
    },
    "transaction_types": {
        "B2B": 
            {
                 "credit_party_identifiers_accepted": 
                [
                    [
                        "iban"
                    ]
                ],
                "credit_party_information": 
                {
                    "credit_party_identifiers_accepted": 
                    [
                            []
                    ]
                },
                "credit_party_verification": 
                {
                    "credit_party_identifiers_accepted": 
                    [
                        []
                    ],
                    "required_receiving_entity_fields": 
                    [
                        []
                    ]
                },
                "maximum_transaction_amount": null,
                "minimum_transaction_amount": "0.00000000",
                "purpose_of_remittance_values_accepted": [],
                "required_documents": 
                    [
                        []
                    ],
                        "required_receiving_entity_fields": 
                        [
                            [
                                "registered_name",
                                "country_iso_code"
                            ]
                        ],
                    "required_sending_entity_fields": 
                        [
                            [
                                "registered_name",
                                "country_iso_code",
                                "registration_number"
                            ]
                        ]
                },
        "B2C": {
                    "credit_party_identifiers_accepted": 
                        [
                            [
                                "iban"
                            ]
                        ],
        "credit_party_information": 
        {
            "credit_party_identifiers_accepted": 
            [
                []
            ]
        },
        "credit_party_verification": 
        {
            "credit_party_identifiers_accepted": 
            [
                []
            ],
            "required_receiving_entity_fields": 
            [
                []
            ]
        },
        "maximum_transaction_amount": null,
        "minimum_transaction_amount": "0.00000000",
        "purpose_of_remittance_values_accepted": [[
                    "{{'IR001','Transfer to own account'},{'IR002','Family Maintenance'},{'IR003','Education-related student expenses'},{'IR004','Medical Treatment'},{'IR005','Hotel Accommodation'},{'IR006','Travel'},{'IR007','Utility Bills'},{'IR008','Repayment of Loans'},{'IR009','Tax Payment'},{'IR010','Purchase of Residential Property'},{'IR011','Payment of Property Rental'},{'IR012','Insurance Premium'},{'IR013','Product Indemnity Insurance'},{'IR014','Insurance Claims Payment'},{'IR015','Mutual Fund Investment'},{'IR016','Investment in Shares'},{'IR020','Salary'},{'IR01801','Information Service Charges'},{'IR01802','Advertising & Public relations-related expenses'},{'IR01803','Royalty fees, trademark fees, patent fees, and copyright fees'},{'IR01804','Fees for brokers, front end fee, commitment fee, guarantee fee and custodian fee'},{'IR01805','Fees for advisors, technical assistance and academic knowledge, including remuneration for specialists'},{'IR01806','Representative office expenses'},{'IR01807','Construction costs/expenses'},{'IR01808','Transportation fees for goods'},{'IR01809','For payment of exported goods'},{'IR01810','Delivery fees for goods'},{'IR01811','General Goods Trades - Offline trade'}}"
                ]],
        "required_documents": [
          []
        ],
        "required_receiving_entity_fields": [
          [
            "lastname",
            "firstname",
            "country_iso_code"
          ]
        ],
        "required_sending_entity_fields": [
          [
            "registered_name",
            "country_iso_code",
            "registration_number"
          ]
        ]
      },
      "C2B": {
        "credit_party_identifiers_accepted": [
          [
            "iban"
          ]
        ],
        "credit_party_information": 
        {
            "credit_party_identifiers_accepted": 
            [
                []
            ]
        },
        "credit_party_verification": 
        {
            "credit_party_identifiers_accepted": 
            [
                []
            ],
            "required_receiving_entity_fields": 
            [
                []
            ]
        },
        "maximum_transaction_amount": null,
        "minimum_transaction_amount": "0.00000000",
         "purpose_of_remittance_values_accepted": [[
                    "{{'IR001','Transfer to own account'},{'IR002','Family Maintenance'},{'IR003','Education-related student expenses'},{'IR004','Medical Treatment'},{'IR005','Hotel Accommodation'},{'IR006','Travel'},{'IR007','Utility Bills'},{'IR008','Repayment of Loans'},{'IR009','Tax Payment'},{'IR010','Purchase of Residential Property'},{'IR011','Payment of Property Rental'},{'IR012','Insurance Premium'},{'IR013','Product Indemnity Insurance'},{'IR014','Insurance Claims Payment'},{'IR015','Mutual Fund Investment'},{'IR016','Investment in Shares'},{'IR020','Salary'},{'IR01801','Information Service Charges'},{'IR01802','Advertising & Public relations-related expenses'},{'IR01803','Royalty fees, trademark fees, patent fees, and copyright fees'},{'IR01804','Fees for brokers, front end fee, commitment fee, guarantee fee and custodian fee'},{'IR01805','Fees for advisors, technical assistance and academic knowledge, including remuneration for specialists'},{'IR01806','Representative office expenses'},{'IR01807','Construction costs/expenses'},{'IR01808','Transportation fees for goods'},{'IR01809','For payment of exported goods'},{'IR01810','Delivery fees for goods'},{'IR01811','General Goods Trades - Offline trade'}}"
                ]],
         "required_documents": [
          []
        ],
        "required_receiving_entity_fields": [
          [
            "registered_name"
          ]
        ],
        "required_sending_entity_fields": [
          [
            "lastname",
            "firstname",
            "code",
            "id_number",
            "address",
            "city",
            "country_iso_code"
          ]
        ]
      },
      "C2C": {
        "credit_party_identifiers_accepted": [
          [
            "iban"
          ]
        ],
        "credit_party_information": {
            "credit_party_identifiers_accepted": [
            []
          ]
        },
         "credit_party_verification": 
        {
            "credit_party_identifiers_accepted": 
            [
                []
            ],
          "required_receiving_entity_fields": 
            [
                []
            ]
        },
        "maximum_transaction_amount": null,
        "minimum_transaction_amount": "0.00000000",
        "purpose_of_remittance_values_accepted": [[
                    "{{'IR001','Transfer to own account'},{'IR002','Family Maintenance'},{'IR003','Education-related student expenses'},{'IR004','Medical Treatment'},{'IR005','Hotel Accommodation'},{'IR006','Travel'},{'IR007','Utility Bills'},{'IR008','Repayment of Loans'},{'IR009','Tax Payment'},{'IR010','Purchase of Residential Property'},{'IR011','Payment of Property Rental'},{'IR012','Insurance Premium'},{'IR013','Product Indemnity Insurance'},{'IR014','Insurance Claims Payment'},{'IR015','Mutual Fund Investment'},{'IR016','Investment in Shares'},{'IR020','Salary'},{'IR01801','Information Service Charges'},{'IR01802','Advertising & Public relations-related expenses'},{'IR01803','Royalty fees, trademark fees, patent fees, and copyright fees'},{'IR01804','Fees for brokers, front end fee, commitment fee, guarantee fee and custodian fee'},{'IR01805','Fees for advisors, technical assistance and academic knowledge, including remuneration for specialists'},{'IR01806','Representative office expenses'},{'IR01807','Construction costs/expenses'},{'IR01808','Transportation fees for goods'},{'IR01809','For payment of exported goods'},{'IR01810','Delivery fees for goods'},{'IR01811','General Goods Trades - Offline trade'}}"
                ]],
        "required_documents": [
          []
        ],
        "required_receiving_entity_fields": [
          [
            "lastname",
            "firstname"
          ]
        ],
        "required_sending_entity_fields": [
          [
            "lastname",
             "firstname",
            "code",
            "id_number",
            "address",
            "city",
            "country_iso_code"
          ]
        ]
      }
    }
  }

                
            

Get detail payers:
POST /api/transaction/payers-detail


            

PARAMETERS

FieldTypeDescription
iso_codeStringCountry is code

RETURNS

FieldTypeDescription
country_iso_codeStringCountry Code
currencyStringCurrency of transaction
idStringID of payer
incrementStringIncrement
nameStringName of payers
precisionStringPrecision of payers
serviceObjectService: id & name
transaction_typesObjectArray of transaction types

Rates



POST /api/transaction/rates 

                
            

Request JSON example :
{
  "id": 2007
}

            

Result example :
{
  "destination_currency":"EUR",
  "rates": {
    "B2B": {
        "IDR": [
        {
            "source_amount_max": null,
            "source_amount_min": 0,
            "wholesale_fx_rate": 0.0000567787378741616
        }
      ]
      
    },
    "B2C": {
        "IDR": [
        {
            "source_amount_max": null,
            "source_amount_min": 0,
            "wholesale_fx_rate": 0.0000568354032812216
        }
      ]
      
    },
    "C2B": {
        "IDR": [
        {
             "source_amount_max": null,
             "source_amount_min": 0,
            "wholesale_fx_rate": 0.0000567787378741616
        }
      ]
     
    },
    "C2C": {
        "IDR": [
        {
          "source_amount_max": null,
         "source_amount_min": 0,
         "wholesale_fx_rate": 0.0000568354032812216
        }
      ]
      
    }
  }
}
                
            

Retrieve rates based on payer id:
POST /api/transaction/rates


            

PARAMETERS

FieldTypeDescription
idIntPayer ID

RETURNS

FieldTypeDescription
destination_currencyStringCurrency
ratesObjectRates for B2B,B2C,C2C,C2B

Services



POST /api/transaction/services 

                
            

Request JSON example :
{
  "iso_code": "BEL"
}

            

Result example :
[
    {
        "id": 1,
        "name": MobileWallet
    }
    {
        "id": 2,
        "name": BankAccount
    }
    {
        "id": 3,
        "name": CashPickup
    }
]
                
            

Retrieve list of available services:
POST /api/transaction/services


            

PARAMETERS

FieldTypeDescription
iso_codeStringCountry iso code

RETURNS

FieldTypeDescription
idIntID Services
nameObjectName of services

Countries



GET /api/transaction/countries 

                
            

Result example :
[
    {
        "iso_code": "ARE",
        "name": United Arab Emirates
    }
    {
        "iso_code": "AUS",
        "name": Australia
    }
    {
        "iso_code": "AUT",
        "name": Austria
    }
]
                
            

Retrieve list of available countries:
GET /api/transaction/countries


            

PARAMETERS

FieldTypeDescription
pageIntPage number
limitIntNumber of results per page

RETURNS

FieldTypeDescription
iso_codeStringCountry Code
nameObjectName of country

Error

HTTP Response

Dhanapatra uses standard HTTP Response

Code Meaning
200 OK
400 Bad Request
401 Unauthorized: Credentials missing or invalid
404 Not Found: Resource doesn’t exist
500 Server error: internal server error