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-key | String |
| Api-secret | String |
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
| Field | Type | Description |
status | String | Api 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
| Field | Type | Description |
page | Int | Page number |
limit | Int | Number of results per page |
RETURNS
| Field | Type | Description |
id | String | ID of transaction |
firstname | String | Firstname of sender |
external_id | String | Reference number of transaction |
partner_id | String | Partner id of payer |
status | String | Status |
payer | String | Payer of transaction |
destination_country | String | Destination country |
send_amount | String | Send amount |
receive_amount | String | Receive amount |
currency | String | Currency |
createdAt | String | Created 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
| Field | Type | Description |
destination | Object | Destination Amount & Currency |
email | String | Sender's email |
external_id | String | External id for transaction |
mode | String | DESTINATION_AMOUNT |
payer_id | String | Payer id from response list of payers |
source | Object | Source of country: Country iso code & Currency. |
type | String | Type of transaction: Business to business: B2B Business to customer: B2C Customer to Customer: C2C Customer to Business: C2B |
RETURNS
| Field | Type | Description |
creation_date | String | ID of transaction |
destination | Object | Destination Amount & Currency |
expiration_date | String | Expired date of quotation |
external_id | String | External id |
fee | String | Fee |
id | String | ID of transaction |
mode | String | DESTINATION_AMOUNT |
payer | Object | Payer information |
sent_amount | Object | Send amount: amount & currency |
source | Object | Source: amount, country iso code, & currency |
transaction_type | String | Type of transaction |
wholesale_fx_rate | String | FX 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
| Field | Type | Description |
beneficiary | Object | Beneficiary details |
sender | Object | sender details |
sending_business | Object | Sender business details |
receiving_business | Object | Beneficiary business details |
credit_party_identifier | Object | Credit party identifier from quotation response |
external_id | String | External id for transaction |
purpose_of_remittance | String | Purpose of transaction |
document_reference_number | String | Document reference number. Required for B2B transaction |
RETURNS
| Field | Type | Description |
id | Int | ID of transaction |
status | String | ID of transaction |
status_message | String | ID of transaction |
status_class | String | ID of transaction |
status_class_message | String | ID of transaction |
beneficiary | Object | ID of transaction |
sender | Object | Destination Amount & Currency |
sending_business | Object | Expired date of quotation |
receiving_business | Object | External id |
credit_party_identifier | String | Fee |
external_id | String | ID of transaction |
transaction_type | String | ID of transaction |
creation_date | String | ID of transaction |
expiration_date | String | ID of transaction |
source | String | ID of transaction |
destination | String | ID of transaction |
sent_amount | String | ID of transaction |
wholesale_fx_rate | String | ID of transaction |
fee | String | ID of transaction |
purpose_of_remittance | String | ID of transaction |
document_reference_number | String | ID of transaction |
PURPOSE OF REMMITANCE
| Parameter | Description |
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
| Parameter | Description |
AUNT | Aunt |
BROTHER | Brother |
BROTHER_IN_LAW | Brother-in-law |
COUSIN | Cousin |
DAUGHTER | Daughter |
FATHER | Father |
FATHER_IN_LAW | Father-in-law |
FRIEND | Friend |
GRAND_FATHER | Grandfather |
GRAND_MOTHER | Grandmother |
HUSBAND | Husband |
MOTHER | Mother |
MOTHER_IN_LAW | Mother-in-law |
NEPHEW | Nephew |
NIECE | Niece |
SELF | Self |
SISTER | Sister |
SISTER_IN_LAW | Sister-in-law |
SON | Son |
UNCLE | Uncle |
WIFE | Wife |
SOURCE OF FUNDS
| Parameter | Description |
CASH | Cash |
BUSINESS | Business |
GIFT | Gift |
SALARY | Salary |
SAVINGS | Savings |
BUSINESS RELATIONSHIP
| Parameter | Description |
BUSINESS_PARTNER | Business Partner |
CUSTOMER | Customer |
EMPLOYEE | Employee |
PROVIDER | Provider |
INVESTOR | Investor |
VENDOR_SERVICE | Vendor 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
| Field | Type | Description |
external_id | String | external_id from quotation |
RETURNS
| Field | Type | Description |
id | Int | ID of transaction |
status | String | ID of transaction |
status_message | String | ID of transaction |
status_class | String | ID of transaction |
status_class_message | String | ID of transaction |
beneficiary | Object | ID of transaction |
sender | Object | Destination Amount & Currency |
sending_business | Object | Expired date of quotation |
receiving_business | Object | External id |
credit_party_identifier | String | Fee |
external_id | String | ID of transaction |
transaction_type | String | ID of transaction |
creation_date | String | ID of transaction |
expiration_date | String | ID of transaction |
source | String | ID of transaction |
destination | String | ID of transaction |
sent_amount | String | ID of transaction |
wholesale_fx_rate | String | ID of transaction |
fee | String | ID of transaction |
purpose_of_remittance | String | ID of transaction |
document_reference_number | String | ID 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
| Field | Type | Description |
name | String | file name |
type | String | type depend on response form required document in payer |
file | File | File PDF / Image only |
external_id | String | external_id from quotation |
RETURNS
| Field | Type | Description |
id | Int | ID of attachment file |
name | String | File name |
content_type | String | Type of file |
type | String | type of uploaded document |
transaction_id | String | ID 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
| Field | Type | Description |
external_id | String | external_id from quotation |
RETURNS
| Field | Type | Description |
id | Int | ID of transaction |
status | String | ID of transaction |
status_message | String | ID of transaction |
status_class | String | ID of transaction |
status_class_message | String | ID of transaction |
beneficiary | Object | ID of transaction |
sender | Object | Destination Amount & Currency |
sending_business | Object | Expired date of quotation |
receiving_business | Object | External id |
credit_party_identifier | String | Fee |
external_id | String | ID of transaction |
transaction_type | String | ID of transaction |
creation_date | String | ID of transaction |
expiration_date | String | ID of transaction |
source | String | ID of transaction |
destination | String | ID of transaction |
sent_amount | String | ID of transaction |
wholesale_fx_rate | String | ID of transaction |
fee | String | ID of transaction |
purpose_of_remittance | String | ID of transaction |
document_reference_number | String | ID of transaction |
STATUS
| Parameter | Description |
10000 | CREATED |
20000 | CONFIRMED |
20110 | CONFIRMED-UNDER-REVIEW-SLS |
30000 | REJECTED |
40000 | CANCELLED |
50000 | SUBMITTED |
60000 | AVAILABLE |
70000 | COMPLETED |
80000 | REVERSED |
90000 | DECLINED |
90200 | DECLINED-INVALID-BENEFICIARY |
90211 | DECLINED-INVALID-SENDER-DETAILS |
90330 | DECLINED-LIMITATIONS-ON-ACCOUNT-VALUE |
90392 | DECLINED-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
| Field | Type | Description |
iso_code | String | Country is code |
RETURNS
| Field | Type | Description |
country_iso_code | String | Country Code |
currency | String | Currency of transaction |
id | String | ID of payer |
increment | String | Increment |
name | String | Name of payers |
precision | String | Precision of payers |
service | Object | Service: id & name |
transaction_types | Object | Array 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
| Field | Type | Description |
iso_code | String | Country is code |
RETURNS
| Field | Type | Description |
country_iso_code | String | Country Code |
currency | String | Currency of transaction |
id | String | ID of payer |
increment | String | Increment |
name | String | Name of payers |
precision | String | Precision of payers |
service | Object | Service: id & name |
transaction_types | Object | Array 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
| Field | Type | Description |
id | Int | Payer ID |
RETURNS
| Field | Type | Description |
destination_currency | String | Currency |
rates | Object | Rates 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
| Field | Type | Description |
iso_code | String | Country iso code |
RETURNS
| Field | Type | Description |
id | Int | ID Services |
name | Object | Name 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
| Field | Type | Description |
page | Int | Page number |
limit | Int | Number of results per page |
RETURNS
| Field | Type | Description |
iso_code | String | Country Code |
name | Object | Name 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
|