Brankas menu
×

Disbursement API v1.0.0

Provides disbursement operations on the disbursement resource.

  • Host https://docs.brank.as

  • Base Path v1

Inquiry about the details of the account.

Inquire about the details of the account to a bank.

curl -X POST \
	https://docs.brank.as/v1/disbursements/account-inquiry \
	-H 'Authorization: Bearer USE_YOUR_TOKEN' \
	-d '{
		"bank_account": {
			"bank": "BankCode",
			"number": "string",
			"holder_name": "string",
			"type": "BankAccountType"
		}
	}'

HTTP Request

POST https://docs.brank.as/v1/disbursements/account-inquiry

Body Parameters

NameTypeDescription
bank_accountBankAccountInfobank_account is account information to validate
Objects
BankAccountInfo
NameTypeDescription
bankBankCodebank is which bank the bank account is for
numberstringnumber is the bank account number
holder_namestringholder_name is the name of the owner of the bank account
typeBankAccountTypetype is the type of bank account
Enums
BankCode
ValueDescription
UNKNOWN_BANK
MANDIRI
BCA
BNI
BRI
DUMMY_BANK
BDO
BPI
ACEH
AGRIS
AGRONIAGA
AMAR_INDONESIA
ANDARA
ANTARDAERAH
ANZ_INDONESIA
ARTHAGRAHA
ARTOS
BANGKOK_INDONESIA
BARCLAYS_INDONESIA
BCA_SYARIAH
BI
BISNIS_INTERNASIONAL
BNI_SYARIAH
BRI_SYARIAH
BTPN
BTPN_SYARIAH
BUKOPIN
BUKOPIN_SYARIAH
BUMI_ARTA
CAPITAL_INDONESIA
CENTRATAMA_NASIONAL
CTBC_INDONESIA
DANAMON
DANPAC
DINAR_INDONESIA
DKI
DKI_SYARIAH
EKONOMI_RAHARJA
FAMA
GANESHA
HARDA
ICBC_INDONESIA
INA_PERDANA
INDEX_SELINDO
JABAR
JABAR_SYARIAH
JASA_JAKARTA
JATIM
JATIM_SYARIAH
KEB_HANA
KESEJAHTERAAN_EKONOMI
MANDIRI_SYARIAH
MASPION_INDONESIA
MAYAPADA
MAYBANK
MAYBANK_SYARIAH_INDONESIA
MAYORA
MEGA
MEGA_SYARIAH
MESTIKA_DHARMA
METRO_EXPRESS
MITRANIAGA
MIZUHO_INDONESIA
MNC_INTERNATIONAL
MUAMALAT_INDONESIA
MULTI_ARTA
MUTIARA
NUSANTARA_PARAHYANGAN
OCBC_NISP
OCBC_NISP_SYARIAH
BANK_OF_AMERICA_INDONESIA
BANK_OF_CHINA_INDONESIA
BANK_OF_INDIA_INDONESIA
PIKKO
PRIMA_MASTER
PUNDI_INDONESIA
QNB_INDONESIA
ROYAL_INDONESIA
SAHABAT_SAMPOERNA
SBI_INDONESIA
SINAR_HARAPAN
SINARMAS
BTN
BTN_SYARIAH
UOB_INDONESIA
VICTORIA
VICTORIA_SYARIAH
WINDU_KENTJANA
WOORI_SAUDARA_INDONESIA
YUDHA_BAKTI
BNP_PARIBAS_INDONESIA
BPD_ACEH_SYARIAH
BPD_BALI
BPD_BENGKULU
BPD_JAMBI
BPD_JAWA_TENGAH
BPD_KALIMANTAN_BARAT
BPD_KALIMANTAN_BARAT_SYARIAH
BPD_KALIMANTAN_TENGAH
BPD_KALIMANTAN_TIMUR
BPD_KALIMANTAN_TIMUR_SYARIAH
BPD_KALIMANTAN_SELATAN
BPD_KALIMANTAN_SELATAN_SYARIAH
BPD_LAMPUNG
BPD_MALUKU
BPD_NTB
BPD_NTT
BPD_PAPUA
BPD_RIAU_KEPRI
BPD_SULAWESI_SELATAN_BARAT
BPD_SULAWESI_TENGAH
BPD_SULAWESI_TENGGARA
BPD_SULAWESI_UTARA
BPD_SUMATERA_BARAT
BPD_SUMATERA_BARAT_SYARIAH
BPD_SUMATERA_SELATAN
BPD_SUMATERA_SELATAN_BABEL
BPD_SUMATERA_SELATAN_SYARIAH
BPD_SUMATERA_SELATAN_UUS
BPD_SUMATERA_UTARA
BPD_SUMATERA_UTARA_SYARIAH
BPD_YOGYAKARTA
BPD_YOGYAKARTA_SYARIAH
CIMB_NIAGA
CIMB_NIAGA_SYARIAH
CITIBANK_INDONESIA
COMMONWEALTH_INDONESIA
DANAMON_SYARIAH
DBS_INDONESIA
DEUTSCHE_AG_INDONESIA
NOBU_INDONESIA
PANIN
PANIN_SYARIAH
RABO_INDONESIA
RESONA_PERDANIA
STANDARD_CHARTERED_INDONESIA
SUMITOMO_MITSUI_INDONESIA
BANK_OF_TOKYO_INDONESIA
ROYAL_BANK_OF_SCOTLAND_INDONESIA
PERMATA
PERMATA_SYARIAH
SINARMAS_SYARIAH
MANDIRI_TASPEN
BANTEN
BEI
CHASE_INDONESIA
CCB_INDONESIA
JTRUST_INDONESIA
TRANSFERWISE
UNION_BANK_PHILIPPINES
BankAccountType

BankAccountType indicates which account to use

ValueDescription
UNKNOWN_BANK_ACCOUNT
CHECKINGS
SAVINGS

Responses

Response body

NameTypeDescription
resultResultresult will return a success or error type for the response
bank_accountBankAccountInfobank_account is the bank account information
Objects
Result
NameTypeDescription
successbool
error[]Error
BankAccountInfo
NameTypeDescription
bankBankCodebank is which bank the bank account is for
numberstringnumber is the bank account number
holder_namestringholder_name is the name of the owner of the bank account
typeBankAccountTypetype is the type of bank account
Error
NameTypeDescription
codestring
messagestring
Enums
BankCode
ValueDescription
UNKNOWN_BANK
MANDIRI
BCA
BNI
BRI
DUMMY_BANK
BDO
BPI
ACEH
AGRIS
AGRONIAGA
AMAR_INDONESIA
ANDARA
ANTARDAERAH
ANZ_INDONESIA
ARTHAGRAHA
ARTOS
BANGKOK_INDONESIA
BARCLAYS_INDONESIA
BCA_SYARIAH
BI
BISNIS_INTERNASIONAL
BNI_SYARIAH
BRI_SYARIAH
BTPN
BTPN_SYARIAH
BUKOPIN
BUKOPIN_SYARIAH
BUMI_ARTA
CAPITAL_INDONESIA
CENTRATAMA_NASIONAL
CTBC_INDONESIA
DANAMON
DANPAC
DINAR_INDONESIA
DKI
DKI_SYARIAH
EKONOMI_RAHARJA
FAMA
GANESHA
HARDA
ICBC_INDONESIA
INA_PERDANA
INDEX_SELINDO
JABAR
JABAR_SYARIAH
JASA_JAKARTA
JATIM
JATIM_SYARIAH
KEB_HANA
KESEJAHTERAAN_EKONOMI
MANDIRI_SYARIAH
MASPION_INDONESIA
MAYAPADA
MAYBANK
MAYBANK_SYARIAH_INDONESIA
MAYORA
MEGA
MEGA_SYARIAH
MESTIKA_DHARMA
METRO_EXPRESS
MITRANIAGA
MIZUHO_INDONESIA
MNC_INTERNATIONAL
MUAMALAT_INDONESIA
MULTI_ARTA
MUTIARA
NUSANTARA_PARAHYANGAN
OCBC_NISP
OCBC_NISP_SYARIAH
BANK_OF_AMERICA_INDONESIA
BANK_OF_CHINA_INDONESIA
BANK_OF_INDIA_INDONESIA
PIKKO
PRIMA_MASTER
PUNDI_INDONESIA
QNB_INDONESIA
ROYAL_INDONESIA
SAHABAT_SAMPOERNA
SBI_INDONESIA
SINAR_HARAPAN
SINARMAS
BTN
BTN_SYARIAH
UOB_INDONESIA
VICTORIA
VICTORIA_SYARIAH
WINDU_KENTJANA
WOORI_SAUDARA_INDONESIA
YUDHA_BAKTI
BNP_PARIBAS_INDONESIA
BPD_ACEH_SYARIAH
BPD_BALI
BPD_BENGKULU
BPD_JAMBI
BPD_JAWA_TENGAH
BPD_KALIMANTAN_BARAT
BPD_KALIMANTAN_BARAT_SYARIAH
BPD_KALIMANTAN_TENGAH
BPD_KALIMANTAN_TIMUR
BPD_KALIMANTAN_TIMUR_SYARIAH
BPD_KALIMANTAN_SELATAN
BPD_KALIMANTAN_SELATAN_SYARIAH
BPD_LAMPUNG
BPD_MALUKU
BPD_NTB
BPD_NTT
BPD_PAPUA
BPD_RIAU_KEPRI
BPD_SULAWESI_SELATAN_BARAT
BPD_SULAWESI_TENGAH
BPD_SULAWESI_TENGGARA
BPD_SULAWESI_UTARA
BPD_SUMATERA_BARAT
BPD_SUMATERA_BARAT_SYARIAH
BPD_SUMATERA_SELATAN
BPD_SUMATERA_SELATAN_BABEL
BPD_SUMATERA_SELATAN_SYARIAH
BPD_SUMATERA_SELATAN_UUS
BPD_SUMATERA_UTARA
BPD_SUMATERA_UTARA_SYARIAH
BPD_YOGYAKARTA
BPD_YOGYAKARTA_SYARIAH
CIMB_NIAGA
CIMB_NIAGA_SYARIAH
CITIBANK_INDONESIA
COMMONWEALTH_INDONESIA
DANAMON_SYARIAH
DBS_INDONESIA
DEUTSCHE_AG_INDONESIA
NOBU_INDONESIA
PANIN
PANIN_SYARIAH
RABO_INDONESIA
RESONA_PERDANIA
STANDARD_CHARTERED_INDONESIA
SUMITOMO_MITSUI_INDONESIA
BANK_OF_TOKYO_INDONESIA
ROYAL_BANK_OF_SCOTLAND_INDONESIA
PERMATA
PERMATA_SYARIAH
SINARMAS_SYARIAH
MANDIRI_TASPEN
BANTEN
BEI
CHASE_INDONESIA
CCB_INDONESIA
JTRUST_INDONESIA
TRANSFERWISE
UNION_BANK_PHILIPPINES
BankAccountType

BankAccountType indicates which account to use

ValueDescription
UNKNOWN_BANK_ACCOUNT
CHECKINGS
SAVINGS

Example:

{
  "result": {
    "success": "bool",
    "error": [
      {
        "code": "string",
        "message": "string"
      }
    ]
  },
  "bank_account": {
    "bank": "BankCode",
    "number": "string",
    "holder_name": "string",
    "type": "BankAccountType"
  }
}

Response codes

StatusDescription
200Request executed successfully.
404Returned when the resource is not found.
400Returned when the request body is malformatted or does not match the expected request.
401Returned when the request does not contains the user’s credentials.
403Returned when the user does not have permission to access the resource.
500Returned when an unexpected error occurred on the server side.

Create disbursement request

Create a task to create disbursement request.

curl -X POST \
	https://docs.brank.as/v1/disbursements \
	-H 'Authorization: Bearer USE_YOUR_TOKEN' \
	-d '{
		"disbursements": [
			{
				"corporate_id": "string",
				"reference_id": "string",
				"type": "DisbursementType",
				"source_account": {
					"bank": "BankCode",
					"number": "string",
					"holder_name": "string",
					"type": "BankAccountType"
				},
				"destination_account": {
					"bank": "BankCode",
					"number": "string",
					"holder_name": "string",
					"type": "BankAccountType"
				},
				"source_amount": {
					"cur": "CurrencyISO4217",
					"num": "string"
				},
				"destination_amount": {
					"cur": "CurrencyISO4217",
					"num": "string"
				},
				"description": "string",
				"exchange_rate": "string",
				"fees": {
					"fee": [
						{
							"name": "string",
							"amount": "string",
							"cur": "string"
						}
					]
				},
				"disbursement_id": "string",
				"external": {
					"reference_id": "string",
					"status": "string",
					"error": [
						{
							"code": "string",
							"message": "string"
						}
					]
				},
				"status": "Status",
				"created": {
					"seconds": "int64",
					"nanos": "int32"
				},
				"updated": {
					"seconds": "int64",
					"nanos": "int32"
				},
				"processed": {
					"seconds": "int64",
					"nanos": "int32"
				},
				"batch_id": "string"
			}
		],
		"": "map[string]BankCredential"
	}'

HTTP Request

POST https://docs.brank.as/v1/disbursements

Body Parameters

NameTypeDescription
disbursements[]Disbursementdisbursements is the disbursements to attempt to create
map[string]BankCredentialcredentials is the credentials to use when attempting to access the banks API. Because disbursements may need to be sent from one or more banks, all the appropriate bank credentials should be in this map. The map key should be the stringified case-sensitive enum value, eg: ‘BCA_CLIENT’ or ‘BCA_API’
Objects
Disbursement
NameTypeDescription
corporate_idstringcorporate_id is the banks unique id for the organization
reference_idstringreference_id is a reference from the merchant to uniquely identify a disbursement transaction, this should be an idempotent value
typeDisbursementTypetype is the type of disbursement being created
source_accountBankAccountInfosource_account is the account to send payment from
destination_accountBankAccountInfodestination_account is the account to send payment to
source_amountAmountsource_amount is the amount to send from the source account to destination account, ‘source_amount.num’ should be in the lowest denomination for a currency. This will be generated by Brankas system.
destination_amountAmountdestination_amount is the amount to be received by the destination account owner, after calculating the appropriate foreign exchange rate. ‘destination_amount.num’ should be in the lowest denomination for a currency
descriptionstringdescription is what the destination account will see for the disbursement transaction
exchange_ratestringThe following are generated / populated by brankas exchange_rate is the foreign exchange rate (if applicable) of the disbursement. Set exchange_rate to be 1.0 if the source and destination currency are the same.
feesFeesfees are the associated fees for the disbursement
disbursement_idstringdisbursement_id is an id brankas uniquely generates for this disbursement
externalExternalexternal is a field for all the information returned by the bank’s api regarding a disbursement
statusStatusstatus defines the result of the request.
createdTimestampcreated is a timestamp indicating when the disbursement was created
updatedTimestampupdated is a timestamp indicating when the disbursement was last updated
processedTimestampprocessed is a timestamp indicating when the disbursement was sent to the bank, this will be used to determine what disbursements should be returned from the RetrieveDisbursements request
batch_idstringbatch_id is the batch id for the processed disbursement request
BankAccountInfo
NameTypeDescription
bankBankCodebank is which bank the bank account is for
numberstringnumber is the bank account number
holder_namestringholder_name is the name of the owner of the bank account
typeBankAccountTypetype is the type of bank account
Amount
NameTypeDescription
curCurrencyISO4217cur is the currency value.
numstringnum is the numeric value.
Fees
NameTypeDescription
fee[]Fee
External
NameTypeDescription
reference_idstringreference_id is the reference id returned from the bank’s api to uniquely identify a disbursement in their system.
statusstringstatus is the transfer status returned from the bank’s api
error[]Errorerror is the error information returned by the bank’s api
Timestamp
NameTypeDescription
secondsint64
nanosint32
Fee
NameTypeDescription
namestringname is the name of the fee
amountstringamount is the amount of the fee
curstringcur is the currency of the fee
Error
NameTypeDescription
codestring
messagestring
Enums
DisbursementType
ValueDescription
UNKNOWN_TYPE
ON_DEMAND
FUTURE
Status

AccountType is the account type enum.

ValueDescription
UNKNOWN_STATUS
CREATED
PENDING
SUCCESS
FAILED
BankCode
ValueDescription
UNKNOWN_BANK
MANDIRI
BCA
BNI
BRI
DUMMY_BANK
BDO
BPI
ACEH
AGRIS
AGRONIAGA
AMAR_INDONESIA
ANDARA
ANTARDAERAH
ANZ_INDONESIA
ARTHAGRAHA
ARTOS
BANGKOK_INDONESIA
BARCLAYS_INDONESIA
BCA_SYARIAH
BI
BISNIS_INTERNASIONAL
BNI_SYARIAH
BRI_SYARIAH
BTPN
BTPN_SYARIAH
BUKOPIN
BUKOPIN_SYARIAH
BUMI_ARTA
CAPITAL_INDONESIA
CENTRATAMA_NASIONAL
CTBC_INDONESIA
DANAMON
DANPAC
DINAR_INDONESIA
DKI
DKI_SYARIAH
EKONOMI_RAHARJA
FAMA
GANESHA
HARDA
ICBC_INDONESIA
INA_PERDANA
INDEX_SELINDO
JABAR
JABAR_SYARIAH
JASA_JAKARTA
JATIM
JATIM_SYARIAH
KEB_HANA
KESEJAHTERAAN_EKONOMI
MANDIRI_SYARIAH
MASPION_INDONESIA
MAYAPADA
MAYBANK
MAYBANK_SYARIAH_INDONESIA
MAYORA
MEGA
MEGA_SYARIAH
MESTIKA_DHARMA
METRO_EXPRESS
MITRANIAGA
MIZUHO_INDONESIA
MNC_INTERNATIONAL
MUAMALAT_INDONESIA
MULTI_ARTA
MUTIARA
NUSANTARA_PARAHYANGAN
OCBC_NISP
OCBC_NISP_SYARIAH
BANK_OF_AMERICA_INDONESIA
BANK_OF_CHINA_INDONESIA
BANK_OF_INDIA_INDONESIA
PIKKO
PRIMA_MASTER
PUNDI_INDONESIA
QNB_INDONESIA
ROYAL_INDONESIA
SAHABAT_SAMPOERNA
SBI_INDONESIA
SINAR_HARAPAN
SINARMAS
BTN
BTN_SYARIAH
UOB_INDONESIA
VICTORIA
VICTORIA_SYARIAH
WINDU_KENTJANA
WOORI_SAUDARA_INDONESIA
YUDHA_BAKTI
BNP_PARIBAS_INDONESIA
BPD_ACEH_SYARIAH
BPD_BALI
BPD_BENGKULU
BPD_JAMBI
BPD_JAWA_TENGAH
BPD_KALIMANTAN_BARAT
BPD_KALIMANTAN_BARAT_SYARIAH
BPD_KALIMANTAN_TENGAH
BPD_KALIMANTAN_TIMUR
BPD_KALIMANTAN_TIMUR_SYARIAH
BPD_KALIMANTAN_SELATAN
BPD_KALIMANTAN_SELATAN_SYARIAH
BPD_LAMPUNG
BPD_MALUKU
BPD_NTB
BPD_NTT
BPD_PAPUA
BPD_RIAU_KEPRI
BPD_SULAWESI_SELATAN_BARAT
BPD_SULAWESI_TENGAH
BPD_SULAWESI_TENGGARA
BPD_SULAWESI_UTARA
BPD_SUMATERA_BARAT
BPD_SUMATERA_BARAT_SYARIAH
BPD_SUMATERA_SELATAN
BPD_SUMATERA_SELATAN_BABEL
BPD_SUMATERA_SELATAN_SYARIAH
BPD_SUMATERA_SELATAN_UUS
BPD_SUMATERA_UTARA
BPD_SUMATERA_UTARA_SYARIAH
BPD_YOGYAKARTA
BPD_YOGYAKARTA_SYARIAH
CIMB_NIAGA
CIMB_NIAGA_SYARIAH
CITIBANK_INDONESIA
COMMONWEALTH_INDONESIA
DANAMON_SYARIAH
DBS_INDONESIA
DEUTSCHE_AG_INDONESIA
NOBU_INDONESIA
PANIN
PANIN_SYARIAH
RABO_INDONESIA
RESONA_PERDANIA
STANDARD_CHARTERED_INDONESIA
SUMITOMO_MITSUI_INDONESIA
BANK_OF_TOKYO_INDONESIA
ROYAL_BANK_OF_SCOTLAND_INDONESIA
PERMATA
PERMATA_SYARIAH
SINARMAS_SYARIAH
MANDIRI_TASPEN
BANTEN
BEI
CHASE_INDONESIA
CCB_INDONESIA
JTRUST_INDONESIA
TRANSFERWISE
UNION_BANK_PHILIPPINES
BankAccountType

BankAccountType indicates which account to use

ValueDescription
UNKNOWN_BANK_ACCOUNT
CHECKINGS
SAVINGS
CurrencyISO4217

Currency following format specified on ISO 4217

ValueDescription
UNKNOWN_CURRENCY
AFN
EUR
ALL
DZD
USD
AOA
XCD
ARS
AMD
AWG
AUD
AZN
BSD
BHD
BDT
BYR
BZD
XOF
BMD
BTN
BOV
BAM
BWP
NOK
BRL
SGD
BGN
BIF
KHR
XAF
CAD
CVE
KYD
CLP
CNY
COP
KMF
CDF
NZD
CRC
HRK
CUC
CZK
DKK
DJF
DOP
EGP
ERN
ETB
FKP
FJD
XPF
GMD
GEL
GHS
GIP
GTQ
GBP
GNF
GYD
HNL
HKD
HUF
ISK
INR
IDR
IRR
IQD
IMP
ILS
JMD
JPY
JEP
JOD
KZT
KES
KPW
KRW
KWD
KGS
LAK
LBP
LSL
LRD
LYD
CHF
MKD
MGA
MWK
MYR
MVR
MRO
MUR
MXN
MDL
MNT
MAD
MZN
MMK
NAD
NPR
ANG
NIO
NGN
OMR
PKR
PGK
PYG
PEN
PHP
PLN
QAR
RON
RUB
RWF
WST
STD
SAR
RSD
SCR
SLL
SBD
SOS
ZAR
SSP
LKR
SHP
SDG
SRD
SZL
SEK
SYP
TWD
TJS
TZS
THB
TOP
TTD
TND
TRY
TMT
UGX
UAH
ARE
UYU
UZS
VUV
VEF
VND
YER
ZRN
ZMW

Responses

Response body

NameTypeDescription
result[]DisbursementResultresult will return a success or error type for the response for each disbursement
Objects
DisbursementResult
NameTypeDescription
disbursementDisbursementdisbursement is the disbursement that was created with the bank
resultResultresult is the repsonse from the bank when trying to create the disbursement
Disbursement
NameTypeDescription
corporate_idstringcorporate_id is the banks unique id for the organization
reference_idstringreference_id is a reference from the merchant to uniquely identify a disbursement transaction, this should be an idempotent value
typeDisbursementTypetype is the type of disbursement being created
source_accountBankAccountInfosource_account is the account to send payment from
destination_accountBankAccountInfodestination_account is the account to send payment to
source_amountAmountsource_amount is the amount to send from the source account to destination account, ‘source_amount.num’ should be in the lowest denomination for a currency. This will be generated by Brankas system.
destination_amountAmountdestination_amount is the amount to be received by the destination account owner, after calculating the appropriate foreign exchange rate. ‘destination_amount.num’ should be in the lowest denomination for a currency
descriptionstringdescription is what the destination account will see for the disbursement transaction
exchange_ratestringThe following are generated / populated by brankas exchange_rate is the foreign exchange rate (if applicable) of the disbursement. Set exchange_rate to be 1.0 if the source and destination currency are the same.
feesFeesfees are the associated fees for the disbursement
disbursement_idstringdisbursement_id is an id brankas uniquely generates for this disbursement
externalExternalexternal is a field for all the information returned by the bank’s api regarding a disbursement
statusStatusstatus defines the result of the request.
createdTimestampcreated is a timestamp indicating when the disbursement was created
updatedTimestampupdated is a timestamp indicating when the disbursement was last updated
processedTimestampprocessed is a timestamp indicating when the disbursement was sent to the bank, this will be used to determine what disbursements should be returned from the RetrieveDisbursements request
batch_idstringbatch_id is the batch id for the processed disbursement request
Result
NameTypeDescription
successbool
error[]Error
BankAccountInfo
NameTypeDescription
bankBankCodebank is which bank the bank account is for
numberstringnumber is the bank account number
holder_namestringholder_name is the name of the owner of the bank account
typeBankAccountTypetype is the type of bank account
Amount
NameTypeDescription
curCurrencyISO4217cur is the currency value.
numstringnum is the numeric value.
Fees
NameTypeDescription
fee[]Fee
External
NameTypeDescription
reference_idstringreference_id is the reference id returned from the bank’s api to uniquely identify a disbursement in their system.
statusstringstatus is the transfer status returned from the bank’s api
error[]Errorerror is the error information returned by the bank’s api
Timestamp
NameTypeDescription
secondsint64
nanosint32
Error
NameTypeDescription
codestring
messagestring
Fee
NameTypeDescription
namestringname is the name of the fee
amountstringamount is the amount of the fee
curstringcur is the currency of the fee
Enums
DisbursementType
ValueDescription
UNKNOWN_TYPE
ON_DEMAND
FUTURE
Status

AccountType is the account type enum.

ValueDescription
UNKNOWN_STATUS
CREATED
PENDING
SUCCESS
FAILED
BankCode
ValueDescription
UNKNOWN_BANK
MANDIRI
BCA
BNI
BRI
DUMMY_BANK
BDO
BPI
ACEH
AGRIS
AGRONIAGA
AMAR_INDONESIA
ANDARA
ANTARDAERAH
ANZ_INDONESIA
ARTHAGRAHA
ARTOS
BANGKOK_INDONESIA
BARCLAYS_INDONESIA
BCA_SYARIAH
BI
BISNIS_INTERNASIONAL
BNI_SYARIAH
BRI_SYARIAH
BTPN
BTPN_SYARIAH
BUKOPIN
BUKOPIN_SYARIAH
BUMI_ARTA
CAPITAL_INDONESIA
CENTRATAMA_NASIONAL
CTBC_INDONESIA
DANAMON
DANPAC
DINAR_INDONESIA
DKI
DKI_SYARIAH
EKONOMI_RAHARJA
FAMA
GANESHA
HARDA
ICBC_INDONESIA
INA_PERDANA
INDEX_SELINDO
JABAR
JABAR_SYARIAH
JASA_JAKARTA
JATIM
JATIM_SYARIAH
KEB_HANA
KESEJAHTERAAN_EKONOMI
MANDIRI_SYARIAH
MASPION_INDONESIA
MAYAPADA
MAYBANK
MAYBANK_SYARIAH_INDONESIA
MAYORA
MEGA
MEGA_SYARIAH
MESTIKA_DHARMA
METRO_EXPRESS
MITRANIAGA
MIZUHO_INDONESIA
MNC_INTERNATIONAL
MUAMALAT_INDONESIA
MULTI_ARTA
MUTIARA
NUSANTARA_PARAHYANGAN
OCBC_NISP
OCBC_NISP_SYARIAH
BANK_OF_AMERICA_INDONESIA
BANK_OF_CHINA_INDONESIA
BANK_OF_INDIA_INDONESIA
PIKKO
PRIMA_MASTER
PUNDI_INDONESIA
QNB_INDONESIA
ROYAL_INDONESIA
SAHABAT_SAMPOERNA
SBI_INDONESIA
SINAR_HARAPAN
SINARMAS
BTN
BTN_SYARIAH
UOB_INDONESIA
VICTORIA
VICTORIA_SYARIAH
WINDU_KENTJANA
WOORI_SAUDARA_INDONESIA
YUDHA_BAKTI
BNP_PARIBAS_INDONESIA
BPD_ACEH_SYARIAH
BPD_BALI
BPD_BENGKULU
BPD_JAMBI
BPD_JAWA_TENGAH
BPD_KALIMANTAN_BARAT
BPD_KALIMANTAN_BARAT_SYARIAH
BPD_KALIMANTAN_TENGAH
BPD_KALIMANTAN_TIMUR
BPD_KALIMANTAN_TIMUR_SYARIAH
BPD_KALIMANTAN_SELATAN
BPD_KALIMANTAN_SELATAN_SYARIAH
BPD_LAMPUNG
BPD_MALUKU
BPD_NTB
BPD_NTT
BPD_PAPUA
BPD_RIAU_KEPRI
BPD_SULAWESI_SELATAN_BARAT
BPD_SULAWESI_TENGAH
BPD_SULAWESI_TENGGARA
BPD_SULAWESI_UTARA
BPD_SUMATERA_BARAT
BPD_SUMATERA_BARAT_SYARIAH
BPD_SUMATERA_SELATAN
BPD_SUMATERA_SELATAN_BABEL
BPD_SUMATERA_SELATAN_SYARIAH
BPD_SUMATERA_SELATAN_UUS
BPD_SUMATERA_UTARA
BPD_SUMATERA_UTARA_SYARIAH
BPD_YOGYAKARTA
BPD_YOGYAKARTA_SYARIAH
CIMB_NIAGA
CIMB_NIAGA_SYARIAH
CITIBANK_INDONESIA
COMMONWEALTH_INDONESIA
DANAMON_SYARIAH
DBS_INDONESIA
DEUTSCHE_AG_INDONESIA
NOBU_INDONESIA
PANIN
PANIN_SYARIAH
RABO_INDONESIA
RESONA_PERDANIA
STANDARD_CHARTERED_INDONESIA
SUMITOMO_MITSUI_INDONESIA
BANK_OF_TOKYO_INDONESIA
ROYAL_BANK_OF_SCOTLAND_INDONESIA
PERMATA
PERMATA_SYARIAH
SINARMAS_SYARIAH
MANDIRI_TASPEN
BANTEN
BEI
CHASE_INDONESIA
CCB_INDONESIA
JTRUST_INDONESIA
TRANSFERWISE
UNION_BANK_PHILIPPINES
BankAccountType

BankAccountType indicates which account to use

ValueDescription
UNKNOWN_BANK_ACCOUNT
CHECKINGS
SAVINGS
CurrencyISO4217

Currency following format specified on ISO 4217

ValueDescription
UNKNOWN_CURRENCY
AFN
EUR
ALL
DZD
USD
AOA
XCD
ARS
AMD
AWG
AUD
AZN
BSD
BHD
BDT
BYR
BZD
XOF
BMD
BTN
BOV
BAM
BWP
NOK
BRL
SGD
BGN
BIF
KHR
XAF
CAD
CVE
KYD
CLP
CNY
COP
KMF
CDF
NZD
CRC
HRK
CUC
CZK
DKK
DJF
DOP
EGP
ERN
ETB
FKP
FJD
XPF
GMD
GEL
GHS
GIP
GTQ
GBP
GNF
GYD
HNL
HKD
HUF
ISK
INR
IDR
IRR
IQD
IMP
ILS
JMD
JPY
JEP
JOD
KZT
KES
KPW
KRW
KWD
KGS
LAK
LBP
LSL
LRD
LYD
CHF
MKD
MGA
MWK
MYR
MVR
MRO
MUR
MXN
MDL
MNT
MAD
MZN
MMK
NAD
NPR
ANG
NIO
NGN
OMR
PKR
PGK
PYG
PEN
PHP
PLN
QAR
RON
RUB
RWF
WST
STD
SAR
RSD
SCR
SLL
SBD
SOS
ZAR
SSP
LKR
SHP
SDG
SRD
SZL
SEK
SYP
TWD
TJS
TZS
THB
TOP
TTD
TND
TRY
TMT
UGX
UAH
ARE
UYU
UZS
VUV
VEF
VND
YER
ZRN
ZMW

Example:

{
  "result": [
    {
      "disbursement": {
        "corporate_id": "string",
        "reference_id": "string",
        "type": "DisbursementType",
        "source_account": {
          "bank": "BankCode",
          "number": "string",
          "holder_name": "string",
          "type": "BankAccountType"
        },
        "destination_account": {
          "bank": "BankCode",
          "number": "string",
          "holder_name": "string",
          "type": "BankAccountType"
        },
        "source_amount": {
          "cur": "CurrencyISO4217",
          "num": "string"
        },
        "destination_amount": {
          "cur": "CurrencyISO4217",
          "num": "string"
        },
        "description": "string",
        "exchange_rate": "string",
        "fees": {
          "fee": [
            {
              "name": "string",
              "amount": "string",
              "cur": "string"
            }
          ]
        },
        "disbursement_id": "string",
        "external": {
          "reference_id": "string",
          "status": "string",
          "error": [
            {
              "code": "string",
              "message": "string"
            }
          ]
        },
        "status": "Status",
        "created": {
          "seconds": "int64",
          "nanos": "int32"
        },
        "updated": {
          "seconds": "int64",
          "nanos": "int32"
        },
        "processed": {
          "seconds": "int64",
          "nanos": "int32"
        },
        "batch_id": "string"
      },
      "result": {
        "success": "bool",
        "error": [
          {
            "code": "string",
            "message": "string"
          }
        ]
      }
    }
  ]
}

Response codes

StatusDescription
200Request executed successfully.
404Returned when the resource is not found.
400Returned when the request body is malformatted or does not match the expected request.
401Returned when the request does not contains the user’s credentials.
403Returned when the user does not have permission to access the resource.
500Returned when an unexpected error occurred on the server side.

Send all saved future disbursements.

Send All saved future disbursements for a client to the bank.

curl -X POST \
	https://docs.brank.as/v1/disbursements/process \
	-H 'Authorization: Bearer USE_YOUR_TOKEN' \
	-d '{
		"disbursement_ids": "[]string",
		"": "map[string]BankCredential"
	}'

HTTP Request

POST https://docs.brank.as/v1/disbursements/process

Body Parameters

NameTypeDescription
disbursement_ids[]stringdisbursement_ids are a list of future disbursements that should be processed now
map[string]BankCredentialcredentials is the credentials to use when attempting to access the banks API. Because disbursements may need to be sent from one or more banks, all the appropriate bank credentials should be in this map. The map key should be the stringified case-sensitive enum value, eg: ‘BCA_CLIENT’ or ‘BCA_API’

Responses

Response body

NameTypeDescription
result[]DisbursementResultresult will return a success or error type for the response for each disbursement
Objects
DisbursementResult
NameTypeDescription
disbursementDisbursementdisbursement is the disbursement that was created with the bank
resultResultresult is the repsonse from the bank when trying to create the disbursement
Disbursement
NameTypeDescription
corporate_idstringcorporate_id is the banks unique id for the organization
reference_idstringreference_id is a reference from the merchant to uniquely identify a disbursement transaction, this should be an idempotent value
typeDisbursementTypetype is the type of disbursement being created
source_accountBankAccountInfosource_account is the account to send payment from
destination_accountBankAccountInfodestination_account is the account to send payment to
source_amountAmountsource_amount is the amount to send from the source account to destination account, ‘source_amount.num’ should be in the lowest denomination for a currency. This will be generated by Brankas system.
destination_amountAmountdestination_amount is the amount to be received by the destination account owner, after calculating the appropriate foreign exchange rate. ‘destination_amount.num’ should be in the lowest denomination for a currency
descriptionstringdescription is what the destination account will see for the disbursement transaction
exchange_ratestringThe following are generated / populated by brankas exchange_rate is the foreign exchange rate (if applicable) of the disbursement. Set exchange_rate to be 1.0 if the source and destination currency are the same.
feesFeesfees are the associated fees for the disbursement
disbursement_idstringdisbursement_id is an id brankas uniquely generates for this disbursement
externalExternalexternal is a field for all the information returned by the bank’s api regarding a disbursement
statusStatusstatus defines the result of the request.
createdTimestampcreated is a timestamp indicating when the disbursement was created
updatedTimestampupdated is a timestamp indicating when the disbursement was last updated
processedTimestampprocessed is a timestamp indicating when the disbursement was sent to the bank, this will be used to determine what disbursements should be returned from the RetrieveDisbursements request
batch_idstringbatch_id is the batch id for the processed disbursement request
Result
NameTypeDescription
successbool
error[]Error
BankAccountInfo
NameTypeDescription
bankBankCodebank is which bank the bank account is for
numberstringnumber is the bank account number
holder_namestringholder_name is the name of the owner of the bank account
typeBankAccountTypetype is the type of bank account
Amount
NameTypeDescription
curCurrencyISO4217cur is the currency value.
numstringnum is the numeric value.
Fees
NameTypeDescription
fee[]Fee
External
NameTypeDescription
reference_idstringreference_id is the reference id returned from the bank’s api to uniquely identify a disbursement in their system.
statusstringstatus is the transfer status returned from the bank’s api
error[]Errorerror is the error information returned by the bank’s api
Timestamp
NameTypeDescription
secondsint64
nanosint32
Error
NameTypeDescription
codestring
messagestring
Fee
NameTypeDescription
namestringname is the name of the fee
amountstringamount is the amount of the fee
curstringcur is the currency of the fee
Enums
DisbursementType
ValueDescription
UNKNOWN_TYPE
ON_DEMAND
FUTURE
Status

AccountType is the account type enum.

ValueDescription
UNKNOWN_STATUS
CREATED
PENDING
SUCCESS
FAILED
BankCode
ValueDescription
UNKNOWN_BANK
MANDIRI
BCA
BNI
BRI
DUMMY_BANK
BDO
BPI
ACEH
AGRIS
AGRONIAGA
AMAR_INDONESIA
ANDARA
ANTARDAERAH
ANZ_INDONESIA
ARTHAGRAHA
ARTOS
BANGKOK_INDONESIA
BARCLAYS_INDONESIA
BCA_SYARIAH
BI
BISNIS_INTERNASIONAL
BNI_SYARIAH
BRI_SYARIAH
BTPN
BTPN_SYARIAH
BUKOPIN
BUKOPIN_SYARIAH
BUMI_ARTA
CAPITAL_INDONESIA
CENTRATAMA_NASIONAL
CTBC_INDONESIA
DANAMON
DANPAC
DINAR_INDONESIA
DKI
DKI_SYARIAH
EKONOMI_RAHARJA
FAMA
GANESHA
HARDA
ICBC_INDONESIA
INA_PERDANA
INDEX_SELINDO
JABAR
JABAR_SYARIAH
JASA_JAKARTA
JATIM
JATIM_SYARIAH
KEB_HANA
KESEJAHTERAAN_EKONOMI
MANDIRI_SYARIAH
MASPION_INDONESIA
MAYAPADA
MAYBANK
MAYBANK_SYARIAH_INDONESIA
MAYORA
MEGA
MEGA_SYARIAH
MESTIKA_DHARMA
METRO_EXPRESS
MITRANIAGA
MIZUHO_INDONESIA
MNC_INTERNATIONAL
MUAMALAT_INDONESIA
MULTI_ARTA
MUTIARA
NUSANTARA_PARAHYANGAN
OCBC_NISP
OCBC_NISP_SYARIAH
BANK_OF_AMERICA_INDONESIA
BANK_OF_CHINA_INDONESIA
BANK_OF_INDIA_INDONESIA
PIKKO
PRIMA_MASTER
PUNDI_INDONESIA
QNB_INDONESIA
ROYAL_INDONESIA
SAHABAT_SAMPOERNA
SBI_INDONESIA
SINAR_HARAPAN
SINARMAS
BTN
BTN_SYARIAH
UOB_INDONESIA
VICTORIA
VICTORIA_SYARIAH
WINDU_KENTJANA
WOORI_SAUDARA_INDONESIA
YUDHA_BAKTI
BNP_PARIBAS_INDONESIA
BPD_ACEH_SYARIAH
BPD_BALI
BPD_BENGKULU
BPD_JAMBI
BPD_JAWA_TENGAH
BPD_KALIMANTAN_BARAT
BPD_KALIMANTAN_BARAT_SYARIAH
BPD_KALIMANTAN_TENGAH
BPD_KALIMANTAN_TIMUR
BPD_KALIMANTAN_TIMUR_SYARIAH
BPD_KALIMANTAN_SELATAN
BPD_KALIMANTAN_SELATAN_SYARIAH
BPD_LAMPUNG
BPD_MALUKU
BPD_NTB
BPD_NTT
BPD_PAPUA
BPD_RIAU_KEPRI
BPD_SULAWESI_SELATAN_BARAT
BPD_SULAWESI_TENGAH
BPD_SULAWESI_TENGGARA
BPD_SULAWESI_UTARA
BPD_SUMATERA_BARAT
BPD_SUMATERA_BARAT_SYARIAH
BPD_SUMATERA_SELATAN
BPD_SUMATERA_SELATAN_BABEL
BPD_SUMATERA_SELATAN_SYARIAH
BPD_SUMATERA_SELATAN_UUS
BPD_SUMATERA_UTARA
BPD_SUMATERA_UTARA_SYARIAH
BPD_YOGYAKARTA
BPD_YOGYAKARTA_SYARIAH
CIMB_NIAGA
CIMB_NIAGA_SYARIAH
CITIBANK_INDONESIA
COMMONWEALTH_INDONESIA
DANAMON_SYARIAH
DBS_INDONESIA
DEUTSCHE_AG_INDONESIA
NOBU_INDONESIA
PANIN
PANIN_SYARIAH
RABO_INDONESIA
RESONA_PERDANIA
STANDARD_CHARTERED_INDONESIA
SUMITOMO_MITSUI_INDONESIA
BANK_OF_TOKYO_INDONESIA
ROYAL_BANK_OF_SCOTLAND_INDONESIA
PERMATA
PERMATA_SYARIAH
SINARMAS_SYARIAH
MANDIRI_TASPEN
BANTEN
BEI
CHASE_INDONESIA
CCB_INDONESIA
JTRUST_INDONESIA
TRANSFERWISE
UNION_BANK_PHILIPPINES
BankAccountType

BankAccountType indicates which account to use

ValueDescription
UNKNOWN_BANK_ACCOUNT
CHECKINGS
SAVINGS
CurrencyISO4217

Currency following format specified on ISO 4217

ValueDescription
UNKNOWN_CURRENCY
AFN
EUR
ALL
DZD
USD
AOA
XCD
ARS
AMD
AWG
AUD
AZN
BSD
BHD
BDT
BYR
BZD
XOF
BMD
BTN
BOV
BAM
BWP
NOK
BRL
SGD
BGN
BIF
KHR
XAF
CAD
CVE
KYD
CLP
CNY
COP
KMF
CDF
NZD
CRC
HRK
CUC
CZK
DKK
DJF
DOP
EGP
ERN
ETB
FKP
FJD
XPF
GMD
GEL
GHS
GIP
GTQ
GBP
GNF
GYD
HNL
HKD
HUF
ISK
INR
IDR
IRR
IQD
IMP
ILS
JMD
JPY
JEP
JOD
KZT
KES
KPW
KRW
KWD
KGS
LAK
LBP
LSL
LRD
LYD
CHF
MKD
MGA
MWK
MYR
MVR
MRO
MUR
MXN
MDL
MNT
MAD
MZN
MMK
NAD
NPR
ANG
NIO
NGN
OMR
PKR
PGK
PYG
PEN
PHP
PLN
QAR
RON
RUB
RWF
WST
STD
SAR
RSD
SCR
SLL
SBD
SOS
ZAR
SSP
LKR
SHP
SDG
SRD
SZL
SEK
SYP
TWD
TJS
TZS
THB
TOP
TTD
TND
TRY
TMT
UGX
UAH
ARE
UYU
UZS
VUV
VEF
VND
YER
ZRN
ZMW

Example:

{
  "result": [
    {
      "disbursement": {
        "corporate_id": "string",
        "reference_id": "string",
        "type": "DisbursementType",
        "source_account": {
          "bank": "BankCode",
          "number": "string",
          "holder_name": "string",
          "type": "BankAccountType"
        },
        "destination_account": {
          "bank": "BankCode",
          "number": "string",
          "holder_name": "string",
          "type": "BankAccountType"
        },
        "source_amount": {
          "cur": "CurrencyISO4217",
          "num": "string"
        },
        "destination_amount": {
          "cur": "CurrencyISO4217",
          "num": "string"
        },
        "description": "string",
        "exchange_rate": "string",
        "fees": {
          "fee": [
            {
              "name": "string",
              "amount": "string",
              "cur": "string"
            }
          ]
        },
        "disbursement_id": "string",
        "external": {
          "reference_id": "string",
          "status": "string",
          "error": [
            {
              "code": "string",
              "message": "string"
            }
          ]
        },
        "status": "Status",
        "created": {
          "seconds": "int64",
          "nanos": "int32"
        },
        "updated": {
          "seconds": "int64",
          "nanos": "int32"
        },
        "processed": {
          "seconds": "int64",
          "nanos": "int32"
        },
        "batch_id": "string"
      },
      "result": {
        "success": "bool",
        "error": [
          {
            "code": "string",
            "message": "string"
          }
        ]
      }
    }
  ]
}

Response codes

StatusDescription
200Request executed successfully.
404Returned when the resource is not found.
400Returned when the request body is malformatted or does not match the expected request.
401Returned when the request does not contains the user’s credentials.
403Returned when the user does not have permission to access the resource.
500Returned when an unexpected error occurred on the server side.

Retrieve all disbursements.

Retrieve all the disbursements for a given date range.

curl -X GET \
	https://docs.brank.as/v1/disbursements \
	-H 'Authorization: Bearer USE_YOUR_TOKEN'

HTTP Request

GET https://docs.brank.as/v1/disbursements

Responses

Response body

NameTypeDescription
resultResultresult will return a success or error type for the response
disbursements[]Disbursementdisbursements are the disbursements that fall within the specified date range
Objects
Result
NameTypeDescription
successbool
error[]Error
Disbursement
NameTypeDescription
corporate_idstringcorporate_id is the banks unique id for the organization
reference_idstringreference_id is a reference from the merchant to uniquely identify a disbursement transaction, this should be an idempotent value
typeDisbursementTypetype is the type of disbursement being created
source_accountBankAccountInfosource_account is the account to send payment from
destination_accountBankAccountInfodestination_account is the account to send payment to
source_amountAmountsource_amount is the amount to send from the source account to destination account, ‘source_amount.num’ should be in the lowest denomination for a currency. This will be generated by Brankas system.
destination_amountAmountdestination_amount is the amount to be received by the destination account owner, after calculating the appropriate foreign exchange rate. ‘destination_amount.num’ should be in the lowest denomination for a currency
descriptionstringdescription is what the destination account will see for the disbursement transaction
exchange_ratestringThe following are generated / populated by brankas exchange_rate is the foreign exchange rate (if applicable) of the disbursement. Set exchange_rate to be 1.0 if the source and destination currency are the same.
feesFeesfees are the associated fees for the disbursement
disbursement_idstringdisbursement_id is an id brankas uniquely generates for this disbursement
externalExternalexternal is a field for all the information returned by the bank’s api regarding a disbursement
statusStatusstatus defines the result of the request.
createdTimestampcreated is a timestamp indicating when the disbursement was created
updatedTimestampupdated is a timestamp indicating when the disbursement was last updated
processedTimestampprocessed is a timestamp indicating when the disbursement was sent to the bank, this will be used to determine what disbursements should be returned from the RetrieveDisbursements request
batch_idstringbatch_id is the batch id for the processed disbursement request
Error
NameTypeDescription
codestring
messagestring
BankAccountInfo
NameTypeDescription
bankBankCodebank is which bank the bank account is for
numberstringnumber is the bank account number
holder_namestringholder_name is the name of the owner of the bank account
typeBankAccountTypetype is the type of bank account
Amount
NameTypeDescription
curCurrencyISO4217cur is the currency value.
numstringnum is the numeric value.
Fees
NameTypeDescription
fee[]Fee
External
NameTypeDescription
reference_idstringreference_id is the reference id returned from the bank’s api to uniquely identify a disbursement in their system.
statusstringstatus is the transfer status returned from the bank’s api
error[]Errorerror is the error information returned by the bank’s api
Timestamp
NameTypeDescription
secondsint64
nanosint32
Fee
NameTypeDescription
namestringname is the name of the fee
amountstringamount is the amount of the fee
curstringcur is the currency of the fee
Enums
DisbursementType
ValueDescription
UNKNOWN_TYPE
ON_DEMAND
FUTURE
Status

AccountType is the account type enum.

ValueDescription
UNKNOWN_STATUS
CREATED
PENDING
SUCCESS
FAILED
BankCode
ValueDescription
UNKNOWN_BANK
MANDIRI
BCA
BNI
BRI
DUMMY_BANK
BDO
BPI
ACEH
AGRIS
AGRONIAGA
AMAR_INDONESIA
ANDARA
ANTARDAERAH
ANZ_INDONESIA
ARTHAGRAHA
ARTOS
BANGKOK_INDONESIA
BARCLAYS_INDONESIA
BCA_SYARIAH
BI
BISNIS_INTERNASIONAL
BNI_SYARIAH
BRI_SYARIAH
BTPN
BTPN_SYARIAH
BUKOPIN
BUKOPIN_SYARIAH
BUMI_ARTA
CAPITAL_INDONESIA
CENTRATAMA_NASIONAL
CTBC_INDONESIA
DANAMON
DANPAC
DINAR_INDONESIA
DKI
DKI_SYARIAH
EKONOMI_RAHARJA
FAMA
GANESHA
HARDA
ICBC_INDONESIA
INA_PERDANA
INDEX_SELINDO
JABAR
JABAR_SYARIAH
JASA_JAKARTA
JATIM
JATIM_SYARIAH
KEB_HANA
KESEJAHTERAAN_EKONOMI
MANDIRI_SYARIAH
MASPION_INDONESIA
MAYAPADA
MAYBANK
MAYBANK_SYARIAH_INDONESIA
MAYORA
MEGA
MEGA_SYARIAH
MESTIKA_DHARMA
METRO_EXPRESS
MITRANIAGA
MIZUHO_INDONESIA
MNC_INTERNATIONAL
MUAMALAT_INDONESIA
MULTI_ARTA
MUTIARA
NUSANTARA_PARAHYANGAN
OCBC_NISP
OCBC_NISP_SYARIAH
BANK_OF_AMERICA_INDONESIA
BANK_OF_CHINA_INDONESIA
BANK_OF_INDIA_INDONESIA
PIKKO
PRIMA_MASTER
PUNDI_INDONESIA
QNB_INDONESIA
ROYAL_INDONESIA
SAHABAT_SAMPOERNA
SBI_INDONESIA
SINAR_HARAPAN
SINARMAS
BTN
BTN_SYARIAH
UOB_INDONESIA
VICTORIA
VICTORIA_SYARIAH
WINDU_KENTJANA
WOORI_SAUDARA_INDONESIA
YUDHA_BAKTI
BNP_PARIBAS_INDONESIA
BPD_ACEH_SYARIAH
BPD_BALI
BPD_BENGKULU
BPD_JAMBI
BPD_JAWA_TENGAH
BPD_KALIMANTAN_BARAT
BPD_KALIMANTAN_BARAT_SYARIAH
BPD_KALIMANTAN_TENGAH
BPD_KALIMANTAN_TIMUR
BPD_KALIMANTAN_TIMUR_SYARIAH
BPD_KALIMANTAN_SELATAN
BPD_KALIMANTAN_SELATAN_SYARIAH
BPD_LAMPUNG
BPD_MALUKU
BPD_NTB
BPD_NTT
BPD_PAPUA
BPD_RIAU_KEPRI
BPD_SULAWESI_SELATAN_BARAT
BPD_SULAWESI_TENGAH
BPD_SULAWESI_TENGGARA
BPD_SULAWESI_UTARA
BPD_SUMATERA_BARAT
BPD_SUMATERA_BARAT_SYARIAH
BPD_SUMATERA_SELATAN
BPD_SUMATERA_SELATAN_BABEL
BPD_SUMATERA_SELATAN_SYARIAH
BPD_SUMATERA_SELATAN_UUS
BPD_SUMATERA_UTARA
BPD_SUMATERA_UTARA_SYARIAH
BPD_YOGYAKARTA
BPD_YOGYAKARTA_SYARIAH
CIMB_NIAGA
CIMB_NIAGA_SYARIAH
CITIBANK_INDONESIA
COMMONWEALTH_INDONESIA
DANAMON_SYARIAH
DBS_INDONESIA
DEUTSCHE_AG_INDONESIA
NOBU_INDONESIA
PANIN
PANIN_SYARIAH
RABO_INDONESIA
RESONA_PERDANIA
STANDARD_CHARTERED_INDONESIA
SUMITOMO_MITSUI_INDONESIA
BANK_OF_TOKYO_INDONESIA
ROYAL_BANK_OF_SCOTLAND_INDONESIA
PERMATA
PERMATA_SYARIAH
SINARMAS_SYARIAH
MANDIRI_TASPEN
BANTEN
BEI
CHASE_INDONESIA
CCB_INDONESIA
JTRUST_INDONESIA
TRANSFERWISE
UNION_BANK_PHILIPPINES
BankAccountType

BankAccountType indicates which account to use

ValueDescription
UNKNOWN_BANK_ACCOUNT
CHECKINGS
SAVINGS
CurrencyISO4217

Currency following format specified on ISO 4217

ValueDescription
UNKNOWN_CURRENCY
AFN
EUR
ALL
DZD
USD
AOA
XCD
ARS
AMD
AWG
AUD
AZN
BSD
BHD
BDT
BYR
BZD
XOF
BMD
BTN
BOV
BAM
BWP
NOK
BRL
SGD
BGN
BIF
KHR
XAF
CAD
CVE
KYD
CLP
CNY
COP
KMF
CDF
NZD
CRC
HRK
CUC
CZK
DKK
DJF
DOP
EGP
ERN
ETB
FKP
FJD
XPF
GMD
GEL
GHS
GIP
GTQ
GBP
GNF
GYD
HNL
HKD
HUF
ISK
INR
IDR
IRR
IQD
IMP
ILS
JMD
JPY
JEP
JOD
KZT
KES
KPW
KRW
KWD
KGS
LAK
LBP
LSL
LRD
LYD
CHF
MKD
MGA
MWK
MYR
MVR
MRO
MUR
MXN
MDL
MNT
MAD
MZN
MMK
NAD
NPR
ANG
NIO
NGN
OMR
PKR
PGK
PYG
PEN
PHP
PLN
QAR
RON
RUB
RWF
WST
STD
SAR
RSD
SCR
SLL
SBD
SOS
ZAR
SSP
LKR
SHP
SDG
SRD
SZL
SEK
SYP
TWD
TJS
TZS
THB
TOP
TTD
TND
TRY
TMT
UGX
UAH
ARE
UYU
UZS
VUV
VEF
VND
YER
ZRN
ZMW

Example:

{
  "result": {
    "success": "bool",
    "error": [
      {
        "code": "string",
        "message": "string"
      }
    ]
  },
  "disbursements": [
    {
      "corporate_id": "string",
      "reference_id": "string",
      "type": "DisbursementType",
      "source_account": {
        "bank": "BankCode",
        "number": "string",
        "holder_name": "string",
        "type": "BankAccountType"
      },
      "destination_account": {
        "bank": "BankCode",
        "number": "string",
        "holder_name": "string",
        "type": "BankAccountType"
      },
      "source_amount": {
        "cur": "CurrencyISO4217",
        "num": "string"
      },
      "destination_amount": {
        "cur": "CurrencyISO4217",
        "num": "string"
      },
      "description": "string",
      "exchange_rate": "string",
      "fees": {
        "fee": [
          {
            "name": "string",
            "amount": "string",
            "cur": "string"
          }
        ]
      },
      "disbursement_id": "string",
      "external": {
        "reference_id": "string",
        "status": "string",
        "error": [
          {
            "code": "string",
            "message": "string"
          }
        ]
      },
      "status": "Status",
      "created": {
        "seconds": "int64",
        "nanos": "int32"
      },
      "updated": {
        "seconds": "int64",
        "nanos": "int32"
      },
      "processed": {
        "seconds": "int64",
        "nanos": "int32"
      },
      "batch_id": "string"
    }
  ]
}

Response codes

StatusDescription
200Request executed successfully.
404Returned when the resource is not found.
400Returned when the request body is malformatted or does not match the expected request.
401Returned when the request does not contains the user’s credentials.
403Returned when the user does not have permission to access the resource.
500Returned when an unexpected error occurred on the server side.