Brankas Brankas

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": {
			"account_id": "string",
			"bank": "DestinationBank",
			"number": "string",
			"holder_name": "string",
			"type": "BankAccountType",
			"address": {
				"line1": "string",
				"line2": "string",
				"city": "string",
				"province": "string",
				"zip_code": "string",
				"country": "string"
			}
		}
	}'

HTTP Request

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

Body Parameters

NameTypeDescription
bank_accountDestinationBankAccountBankAccount is account information to validate
Objects
DestinationBankAccount
NameTypeDescription
account_idstringAccountID is the ID of bank stored in database
bankDestinationBankBank is the destination bank code
numberstringNumber is the account number of the destination account.
holder_namestringHolderName is the name on the destination account.
typeBankAccountTypeType is the type of bank account
addressAddressAddress is the registered address for the destination account owner, used by some integrations.
Address
NameTypeDescription
line1stringLine1 is the first line of the address.
line2stringLine2 is the second line of the address.
citystringCity is the city this address is situated in.
provincestringProvince is the more specific area this address is situated in.
zip_codestringZipCode of the address.
countrystringCountry of the destination account.
Enums
DestinationBank
ValueDescription
UNKNOWN_DESTINATION_BANK
DUMMY_DESTINATION_BANK
ID_MANDIRI
ID_BCA
ID_BNI
ID_BRI
PH_BDO
PH_BPI
ID_ACEH
ID_AGRIS
ID_BRI_AGRO
ID_AMAR
ID_ANDARA
ID_ANTARDAERAH
ID_ANZ
ID_ARTHAGRAHA
ID_ARTOS
ID_BBL
ID_BARCLAYS
ID_BCA_SYR
ID_BI
ID_BISNIS_INTL
ID_BNI_SYR
ID_BRI_SYR
ID_BTPN
ID_BTPN_SYR
ID_BKP
ID_BKP_SYR
ID_BUMI_ARTA
ID_CAPITAL
ID_CENTRATAMA_NTL
ID_CTBCID
ID_DNMN
ID_DANPAC
ID_DINAR
ID_DKI
ID_DKI_SYR
ID_EKONOMI_RAHARJA
ID_FAMA
ID_GANESHA
ID_HARDA
ID_ICBC
ID_INA_PERDANA
ID_INDEX_SELINDO
ID_BJB
ID_BJB_SYR
ID_JASA_JAKARTA
ID_JATIM
ID_JATIM_SYR
ID_KEB_HANA
ID_KESEJAHTERAAN_EKONOMI
ID_MANDIRI_SYR
ID_MASPION
ID_MAYAPADA
ID_MAYBANK
ID_MAYBANK_SYR
ID_MAYORA
ID_MEGA
ID_MEGA_SYR
ID_MESTIKA_DHARMA
ID_METRO_EXP
ID_MITRANIAGA
ID_MIZUHO
ID_MNC_INTL
ID_MUAMALAT
ID_MULTI_ARTA
ID_MUTIARA
ID_NUSANTARA_PARAHYANGAN
ID_OCBC
ID_OCBC_SYR
ID_BOA
ID_CHINA
ID_INDIA
ID_PIKKO
ID_PRIMA_MASTER
ID_PUNDI
ID_QNB
ID_ROYAL
ID_SAHABAT_SAMPEORNA
ID_SBI
ID_SINAR_HARAPAN
ID_SINARMAS
ID_BTN
ID_BTN_SYR
ID_UOB
ID_VICTORIA
ID_VICTORIA_SYR
ID_WINDU_KENTJANA
ID_WOORI_SAUDARA
ID_YUDHA_BHAKTI
ID_BNP_PARIBAS
ID_ACEH_SYR
ID_BPD_BALI
ID_BENGKULU
ID_JAMBI
ID_JAWA_TENGAH
ID_KALIMANTAN_BARAT
ID_KALIMANTAN_BARAT_SYR
ID_KALIMANTAN_TENGAH
ID_KALIMANTAN_TIMUR
ID_KALIMANTAN_TIMUR_SYR
ID_KALIMANTAN_SELATAN
ID_KALIMANTAN_SELATAN_SYR
ID_LAMPUNG
ID_MALUKU
ID_NTB
ID_NTT
ID_PAPUA
ID_RIAU_KEPRI
ID_SULAWESI_SELATAN_BARAT
ID_SULAWESI_TENGAH
ID_SULAWESI_TENGGARA
ID_SULAWESI_UTARA
ID_SUMATERA_BARAT
ID_SUMATERA_BARAT_SYR
ID_SUMATERA_SELATAN
ID_SUMATERA_SELATAN_BABEL
ID_SUMATERA_SELATAN_SYR
ID_SUMATERA_SELATAN_UUS
ID_SUMATERA_UTARA
ID_SUMATERA_UTARA_SYR
ID_YOGYAKARTA
ID_YOGYAKARTA_SYR
ID_CIMB
ID_CIMB_SYR
ID_CITI
ID_COMMONWEALTH
ID_DNMN_SYR
ID_DBS
ID_DBS_AG
ID_NOBU
ID_PAN
ID_PAN_SYR
ID_RABOBANK
ID_RESONA_PERDANIA
ID_STAN
ID_SUMITOMO_MITSUI
ID_TOKYO
ID_RBS
ID_PERMATA
ID_PERMATA_SYR
ID_SINARMAS_SYR
ID_MANDIRI_TASPEN
ID_BANTEN
ID_BEI
ID_CHASE
ID_CCB
ID_JTRUST
UN_TRANSFERWISE
PH_BPIF
PH_METRO
PH_PNB
PH_PNBS
PH_RCBC
PH_RCBCS
PH_SB
PH_SBS
PH_UB
PH_CLRB
PH_GXI
PH_GBY
PH_LBP
PH_PMP
PH_PSB
PH_RSB
PH_CB
PH_CBS
TH_KBANK
DUMMY_INTERBANK
PH_ALLBANK
PH_SUNSB
PH_STERLING
PH_MBSMB
PH_AUB
PH_BOC
PH_MAYBANK
PH_PBCOM
PH_CTBC
PH_EWB
PH_EQB
PH_OMNIPAY
PH_UCPB
PH_PHILTRUST
PH_WDB
PH_DUNGGANUN
PH_UCPBSB
PH_ISLA
PH_PRBC
PH_PBB
PH_PVB
PH_YSBP
PH_MABUHAY
PH_CTBCPH
PH_ING
PH_QCRB
PH_BDONB
PH_EWBRB
ID_DOKU
ID_HSBC
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_accountDestinationBankAccountBankAccount is the bank account information
Objects
Result
NameTypeDescription
successbool
error[]Error
messagestring
DestinationBankAccount
NameTypeDescription
account_idstringAccountID is the ID of bank stored in database
bankDestinationBankBank is the destination bank code
numberstringNumber is the account number of the destination account.
holder_namestringHolderName is the name on the destination account.
typeBankAccountTypeType is the type of bank account
addressAddressAddress is the registered address for the destination account owner, used by some integrations.
Error
NameTypeDescription
codestring
messagestring
Address
NameTypeDescription
line1stringLine1 is the first line of the address.
line2stringLine2 is the second line of the address.
citystringCity is the city this address is situated in.
provincestringProvince is the more specific area this address is situated in.
zip_codestringZipCode of the address.
countrystringCountry of the destination account.
Enums
DestinationBank
ValueDescription
UNKNOWN_DESTINATION_BANK
DUMMY_DESTINATION_BANK
ID_MANDIRI
ID_BCA
ID_BNI
ID_BRI
PH_BDO
PH_BPI
ID_ACEH
ID_AGRIS
ID_BRI_AGRO
ID_AMAR
ID_ANDARA
ID_ANTARDAERAH
ID_ANZ
ID_ARTHAGRAHA
ID_ARTOS
ID_BBL
ID_BARCLAYS
ID_BCA_SYR
ID_BI
ID_BISNIS_INTL
ID_BNI_SYR
ID_BRI_SYR
ID_BTPN
ID_BTPN_SYR
ID_BKP
ID_BKP_SYR
ID_BUMI_ARTA
ID_CAPITAL
ID_CENTRATAMA_NTL
ID_CTBCID
ID_DNMN
ID_DANPAC
ID_DINAR
ID_DKI
ID_DKI_SYR
ID_EKONOMI_RAHARJA
ID_FAMA
ID_GANESHA
ID_HARDA
ID_ICBC
ID_INA_PERDANA
ID_INDEX_SELINDO
ID_BJB
ID_BJB_SYR
ID_JASA_JAKARTA
ID_JATIM
ID_JATIM_SYR
ID_KEB_HANA
ID_KESEJAHTERAAN_EKONOMI
ID_MANDIRI_SYR
ID_MASPION
ID_MAYAPADA
ID_MAYBANK
ID_MAYBANK_SYR
ID_MAYORA
ID_MEGA
ID_MEGA_SYR
ID_MESTIKA_DHARMA
ID_METRO_EXP
ID_MITRANIAGA
ID_MIZUHO
ID_MNC_INTL
ID_MUAMALAT
ID_MULTI_ARTA
ID_MUTIARA
ID_NUSANTARA_PARAHYANGAN
ID_OCBC
ID_OCBC_SYR
ID_BOA
ID_CHINA
ID_INDIA
ID_PIKKO
ID_PRIMA_MASTER
ID_PUNDI
ID_QNB
ID_ROYAL
ID_SAHABAT_SAMPEORNA
ID_SBI
ID_SINAR_HARAPAN
ID_SINARMAS
ID_BTN
ID_BTN_SYR
ID_UOB
ID_VICTORIA
ID_VICTORIA_SYR
ID_WINDU_KENTJANA
ID_WOORI_SAUDARA
ID_YUDHA_BHAKTI
ID_BNP_PARIBAS
ID_ACEH_SYR
ID_BPD_BALI
ID_BENGKULU
ID_JAMBI
ID_JAWA_TENGAH
ID_KALIMANTAN_BARAT
ID_KALIMANTAN_BARAT_SYR
ID_KALIMANTAN_TENGAH
ID_KALIMANTAN_TIMUR
ID_KALIMANTAN_TIMUR_SYR
ID_KALIMANTAN_SELATAN
ID_KALIMANTAN_SELATAN_SYR
ID_LAMPUNG
ID_MALUKU
ID_NTB
ID_NTT
ID_PAPUA
ID_RIAU_KEPRI
ID_SULAWESI_SELATAN_BARAT
ID_SULAWESI_TENGAH
ID_SULAWESI_TENGGARA
ID_SULAWESI_UTARA
ID_SUMATERA_BARAT
ID_SUMATERA_BARAT_SYR
ID_SUMATERA_SELATAN
ID_SUMATERA_SELATAN_BABEL
ID_SUMATERA_SELATAN_SYR
ID_SUMATERA_SELATAN_UUS
ID_SUMATERA_UTARA
ID_SUMATERA_UTARA_SYR
ID_YOGYAKARTA
ID_YOGYAKARTA_SYR
ID_CIMB
ID_CIMB_SYR
ID_CITI
ID_COMMONWEALTH
ID_DNMN_SYR
ID_DBS
ID_DBS_AG
ID_NOBU
ID_PAN
ID_PAN_SYR
ID_RABOBANK
ID_RESONA_PERDANIA
ID_STAN
ID_SUMITOMO_MITSUI
ID_TOKYO
ID_RBS
ID_PERMATA
ID_PERMATA_SYR
ID_SINARMAS_SYR
ID_MANDIRI_TASPEN
ID_BANTEN
ID_BEI
ID_CHASE
ID_CCB
ID_JTRUST
UN_TRANSFERWISE
PH_BPIF
PH_METRO
PH_PNB
PH_PNBS
PH_RCBC
PH_RCBCS
PH_SB
PH_SBS
PH_UB
PH_CLRB
PH_GXI
PH_GBY
PH_LBP
PH_PMP
PH_PSB
PH_RSB
PH_CB
PH_CBS
TH_KBANK
DUMMY_INTERBANK
PH_ALLBANK
PH_SUNSB
PH_STERLING
PH_MBSMB
PH_AUB
PH_BOC
PH_MAYBANK
PH_PBCOM
PH_CTBC
PH_EWB
PH_EQB
PH_OMNIPAY
PH_UCPB
PH_PHILTRUST
PH_WDB
PH_DUNGGANUN
PH_UCPBSB
PH_ISLA
PH_PRBC
PH_PBB
PH_PVB
PH_YSBP
PH_MABUHAY
PH_CTBCPH
PH_ING
PH_QCRB
PH_BDONB
PH_EWBRB
ID_DOKU
ID_HSBC
BankAccountType

BankAccountType indicates which account to use.

ValueDescription
UNKNOWN_BANK_ACCOUNT
CHECKINGS
SAVINGS

Example:

{
  "result": {
    "success": "bool",
    "error": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "message": "string"
  },
  "bank_account": {
    "account_id": "string",
    "bank": "DestinationBank",
    "number": "string",
    "holder_name": "string",
    "type": "BankAccountType",
    "address": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "province": "string",
      "zip_code": "string",
      "country": "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.

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": {
					"account_id": "string",
					"bank": "BankCode",
					"number": "string",
					"holder_name": "string",
					"type": "BankAccountType"
				},
				"destination_account": {
					"account_id": "string",
					"bank": "DestinationBank",
					"number": "string",
					"holder_name": "string",
					"type": "BankAccountType",
					"address": {
						"line1": "string",
						"line2": "string",
						"city": "string",
						"province": "string",
						"zip_code": "string",
						"country": "string"
					}
				},
				"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",
				"note": "string",
				"is_selected": "bool"
			}
		],
		"": "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_idstringCorporateID is the banks unique id for the organization
reference_idstringReferenceID 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_accountBankAccountInfoSourceAccount is the account to send payment from
destination_accountDestinationBankAccountDestinationAccount is the account to send payment to
source_amountAmountSourceAmount 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_amountAmountDestinationAmount 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_idstringDisbursementID 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_idstringBatchID is the batch id for the processed disbursement request
notestringNote is a reasons that cause disbursement invalid
is_selectedboolIsSelected is an indicator of selected disbursement
BankAccountInfo
NameTypeDescription
account_idstringAccountID is the ID of bank stored in database
bankBankCodeBank is which bank the bank account is for
numberstringNumber is the bank account number
holder_namestringHolderName is the name of the owner of the bank account
typeBankAccountTypeType is the type of bank account
DestinationBankAccount
NameTypeDescription
account_idstringAccountID is the ID of bank stored in database
bankDestinationBankBank is the destination bank code
numberstringNumber is the account number of the destination account.
holder_namestringHolderName is the name on the destination account.
typeBankAccountTypeType is the type of bank account
addressAddressAddress is the registered address for the destination account owner, used by some integrations.
Amount
NameTypeDescription
curCurrencyISO4217cur is the currency value.
numstringnum is the numeric value.
Fees
NameTypeDescription
fee[]Fee
External
NameTypeDescription
reference_idstringReferenceID 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
Address
NameTypeDescription
line1stringLine1 is the first line of the address.
line2stringLine2 is the second line of the address.
citystringCity is the city this address is situated in.
provincestringProvince is the more specific area this address is situated in.
zip_codestringZipCode of the address.
countrystringCountry of the destination account.
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

DisbursementType is the type of disbursement.

ValueDescription
UNKNOWN_TYPE
ON_DEMAND
FUTURE
APPROVER
Status

Status is the status for disbursement request and disbursement type enum.

ValueDescription
UNKNOWN_STATUS
AWAITING_APPROVAL
APPROVED
REJECTED
CREATED
PENDING
SUCCESS
FAILED
PROCESSED
INVALID
CANCELED
BankCode
ValueDescription
UNKNOWN_BANK
DUMMY_BANK_CORPORATE
BCA_CORPORATE
BNI_CORPORATE
BRI_CORPORATE
PERMATA_CORPORATE
TRANSFERWISE
UNIONBANK_CORPORATE
BDO_CORPORATEDeprecated banks
CIMB_CORPORATE
BankAccountType

BankAccountType indicates which account to use.

ValueDescription
UNKNOWN_BANK_ACCOUNT
CHECKINGS
SAVINGS
DestinationBank
ValueDescription
UNKNOWN_DESTINATION_BANK
DUMMY_DESTINATION_BANK
ID_MANDIRI
ID_BCA
ID_BNI
ID_BRI
PH_BDO
PH_BPI
ID_ACEH
ID_AGRIS
ID_BRI_AGRO
ID_AMAR
ID_ANDARA
ID_ANTARDAERAH
ID_ANZ
ID_ARTHAGRAHA
ID_ARTOS
ID_BBL
ID_BARCLAYS
ID_BCA_SYR
ID_BI
ID_BISNIS_INTL
ID_BNI_SYR
ID_BRI_SYR
ID_BTPN
ID_BTPN_SYR
ID_BKP
ID_BKP_SYR
ID_BUMI_ARTA
ID_CAPITAL
ID_CENTRATAMA_NTL
ID_CTBCID
ID_DNMN
ID_DANPAC
ID_DINAR
ID_DKI
ID_DKI_SYR
ID_EKONOMI_RAHARJA
ID_FAMA
ID_GANESHA
ID_HARDA
ID_ICBC
ID_INA_PERDANA
ID_INDEX_SELINDO
ID_BJB
ID_BJB_SYR
ID_JASA_JAKARTA
ID_JATIM
ID_JATIM_SYR
ID_KEB_HANA
ID_KESEJAHTERAAN_EKONOMI
ID_MANDIRI_SYR
ID_MASPION
ID_MAYAPADA
ID_MAYBANK
ID_MAYBANK_SYR
ID_MAYORA
ID_MEGA
ID_MEGA_SYR
ID_MESTIKA_DHARMA
ID_METRO_EXP
ID_MITRANIAGA
ID_MIZUHO
ID_MNC_INTL
ID_MUAMALAT
ID_MULTI_ARTA
ID_MUTIARA
ID_NUSANTARA_PARAHYANGAN
ID_OCBC
ID_OCBC_SYR
ID_BOA
ID_CHINA
ID_INDIA
ID_PIKKO
ID_PRIMA_MASTER
ID_PUNDI
ID_QNB
ID_ROYAL
ID_SAHABAT_SAMPEORNA
ID_SBI
ID_SINAR_HARAPAN
ID_SINARMAS
ID_BTN
ID_BTN_SYR
ID_UOB
ID_VICTORIA
ID_VICTORIA_SYR
ID_WINDU_KENTJANA
ID_WOORI_SAUDARA
ID_YUDHA_BHAKTI
ID_BNP_PARIBAS
ID_ACEH_SYR
ID_BPD_BALI
ID_BENGKULU
ID_JAMBI
ID_JAWA_TENGAH
ID_KALIMANTAN_BARAT
ID_KALIMANTAN_BARAT_SYR
ID_KALIMANTAN_TENGAH
ID_KALIMANTAN_TIMUR
ID_KALIMANTAN_TIMUR_SYR
ID_KALIMANTAN_SELATAN
ID_KALIMANTAN_SELATAN_SYR
ID_LAMPUNG
ID_MALUKU
ID_NTB
ID_NTT
ID_PAPUA
ID_RIAU_KEPRI
ID_SULAWESI_SELATAN_BARAT
ID_SULAWESI_TENGAH
ID_SULAWESI_TENGGARA
ID_SULAWESI_UTARA
ID_SUMATERA_BARAT
ID_SUMATERA_BARAT_SYR
ID_SUMATERA_SELATAN
ID_SUMATERA_SELATAN_BABEL
ID_SUMATERA_SELATAN_SYR
ID_SUMATERA_SELATAN_UUS
ID_SUMATERA_UTARA
ID_SUMATERA_UTARA_SYR
ID_YOGYAKARTA
ID_YOGYAKARTA_SYR
ID_CIMB
ID_CIMB_SYR
ID_CITI
ID_COMMONWEALTH
ID_DNMN_SYR
ID_DBS
ID_DBS_AG
ID_NOBU
ID_PAN
ID_PAN_SYR
ID_RABOBANK
ID_RESONA_PERDANIA
ID_STAN
ID_SUMITOMO_MITSUI
ID_TOKYO
ID_RBS
ID_PERMATA
ID_PERMATA_SYR
ID_SINARMAS_SYR
ID_MANDIRI_TASPEN
ID_BANTEN
ID_BEI
ID_CHASE
ID_CCB
ID_JTRUST
UN_TRANSFERWISE
PH_BPIF
PH_METRO
PH_PNB
PH_PNBS
PH_RCBC
PH_RCBCS
PH_SB
PH_SBS
PH_UB
PH_CLRB
PH_GXI
PH_GBY
PH_LBP
PH_PMP
PH_PSB
PH_RSB
PH_CB
PH_CBS
TH_KBANK
DUMMY_INTERBANK
PH_ALLBANK
PH_SUNSB
PH_STERLING
PH_MBSMB
PH_AUB
PH_BOC
PH_MAYBANK
PH_PBCOM
PH_CTBC
PH_EWB
PH_EQB
PH_OMNIPAY
PH_UCPB
PH_PHILTRUST
PH_WDB
PH_DUNGGANUN
PH_UCPBSB
PH_ISLA
PH_PRBC
PH_PBB
PH_PVB
PH_YSBP
PH_MABUHAY
PH_CTBCPH
PH_ING
PH_QCRB
PH_BDONB
PH_EWBRB
ID_DOKU
ID_HSBC
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_idstringCorporateID is the banks unique id for the organization
reference_idstringReferenceID 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_accountBankAccountInfoSourceAccount is the account to send payment from
destination_accountDestinationBankAccountDestinationAccount is the account to send payment to
source_amountAmountSourceAmount 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_amountAmountDestinationAmount 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_idstringDisbursementID 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_idstringBatchID is the batch id for the processed disbursement request
notestringNote is a reasons that cause disbursement invalid
is_selectedboolIsSelected is an indicator of selected disbursement
Result
NameTypeDescription
successbool
error[]Error
messagestring
BankAccountInfo
NameTypeDescription
account_idstringAccountID is the ID of bank stored in database
bankBankCodeBank is which bank the bank account is for
numberstringNumber is the bank account number
holder_namestringHolderName is the name of the owner of the bank account
typeBankAccountTypeType is the type of bank account
DestinationBankAccount
NameTypeDescription
account_idstringAccountID is the ID of bank stored in database
bankDestinationBankBank is the destination bank code
numberstringNumber is the account number of the destination account.
holder_namestringHolderName is the name on the destination account.
typeBankAccountTypeType is the type of bank account
addressAddressAddress is the registered address for the destination account owner, used by some integrations.
Amount
NameTypeDescription
curCurrencyISO4217cur is the currency value.
numstringnum is the numeric value.
Fees
NameTypeDescription
fee[]Fee
External
NameTypeDescription
reference_idstringReferenceID 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
Address
NameTypeDescription
line1stringLine1 is the first line of the address.
line2stringLine2 is the second line of the address.
citystringCity is the city this address is situated in.
provincestringProvince is the more specific area this address is situated in.
zip_codestringZipCode of the address.
countrystringCountry of the destination account.
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

DisbursementType is the type of disbursement.

ValueDescription
UNKNOWN_TYPE
ON_DEMAND
FUTURE
APPROVER
Status

Status is the status for disbursement request and disbursement type enum.

ValueDescription
UNKNOWN_STATUS
AWAITING_APPROVAL
APPROVED
REJECTED
CREATED
PENDING
SUCCESS
FAILED
PROCESSED
INVALID
CANCELED
BankCode
ValueDescription
UNKNOWN_BANK
DUMMY_BANK_CORPORATE
BCA_CORPORATE
BNI_CORPORATE
BRI_CORPORATE
PERMATA_CORPORATE
TRANSFERWISE
UNIONBANK_CORPORATE
BDO_CORPORATEDeprecated banks
CIMB_CORPORATE
BankAccountType

BankAccountType indicates which account to use.

ValueDescription
UNKNOWN_BANK_ACCOUNT
CHECKINGS
SAVINGS
DestinationBank
ValueDescription
UNKNOWN_DESTINATION_BANK
DUMMY_DESTINATION_BANK
ID_MANDIRI
ID_BCA
ID_BNI
ID_BRI
PH_BDO
PH_BPI
ID_ACEH
ID_AGRIS
ID_BRI_AGRO
ID_AMAR
ID_ANDARA
ID_ANTARDAERAH
ID_ANZ
ID_ARTHAGRAHA
ID_ARTOS
ID_BBL
ID_BARCLAYS
ID_BCA_SYR
ID_BI
ID_BISNIS_INTL
ID_BNI_SYR
ID_BRI_SYR
ID_BTPN
ID_BTPN_SYR
ID_BKP
ID_BKP_SYR
ID_BUMI_ARTA
ID_CAPITAL
ID_CENTRATAMA_NTL
ID_CTBCID
ID_DNMN
ID_DANPAC
ID_DINAR
ID_DKI
ID_DKI_SYR
ID_EKONOMI_RAHARJA
ID_FAMA
ID_GANESHA
ID_HARDA
ID_ICBC
ID_INA_PERDANA
ID_INDEX_SELINDO
ID_BJB
ID_BJB_SYR
ID_JASA_JAKARTA
ID_JATIM
ID_JATIM_SYR
ID_KEB_HANA
ID_KESEJAHTERAAN_EKONOMI
ID_MANDIRI_SYR
ID_MASPION
ID_MAYAPADA
ID_MAYBANK
ID_MAYBANK_SYR
ID_MAYORA
ID_MEGA
ID_MEGA_SYR
ID_MESTIKA_DHARMA
ID_METRO_EXP
ID_MITRANIAGA
ID_MIZUHO
ID_MNC_INTL
ID_MUAMALAT
ID_MULTI_ARTA
ID_MUTIARA
ID_NUSANTARA_PARAHYANGAN
ID_OCBC
ID_OCBC_SYR
ID_BOA
ID_CHINA
ID_INDIA
ID_PIKKO
ID_PRIMA_MASTER
ID_PUNDI
ID_QNB
ID_ROYAL
ID_SAHABAT_SAMPEORNA
ID_SBI
ID_SINAR_HARAPAN
ID_SINARMAS
ID_BTN
ID_BTN_SYR
ID_UOB
ID_VICTORIA
ID_VICTORIA_SYR
ID_WINDU_KENTJANA
ID_WOORI_SAUDARA
ID_YUDHA_BHAKTI
ID_BNP_PARIBAS
ID_ACEH_SYR
ID_BPD_BALI
ID_BENGKULU
ID_JAMBI
ID_JAWA_TENGAH
ID_KALIMANTAN_BARAT
ID_KALIMANTAN_BARAT_SYR
ID_KALIMANTAN_TENGAH
ID_KALIMANTAN_TIMUR
ID_KALIMANTAN_TIMUR_SYR
ID_KALIMANTAN_SELATAN
ID_KALIMANTAN_SELATAN_SYR
ID_LAMPUNG
ID_MALUKU
ID_NTB
ID_NTT
ID_PAPUA
ID_RIAU_KEPRI
ID_SULAWESI_SELATAN_BARAT
ID_SULAWESI_TENGAH
ID_SULAWESI_TENGGARA
ID_SULAWESI_UTARA
ID_SUMATERA_BARAT
ID_SUMATERA_BARAT_SYR
ID_SUMATERA_SELATAN
ID_SUMATERA_SELATAN_BABEL
ID_SUMATERA_SELATAN_SYR
ID_SUMATERA_SELATAN_UUS
ID_SUMATERA_UTARA
ID_SUMATERA_UTARA_SYR
ID_YOGYAKARTA
ID_YOGYAKARTA_SYR
ID_CIMB
ID_CIMB_SYR
ID_CITI
ID_COMMONWEALTH
ID_DNMN_SYR
ID_DBS
ID_DBS_AG
ID_NOBU
ID_PAN
ID_PAN_SYR
ID_RABOBANK
ID_RESONA_PERDANIA
ID_STAN
ID_SUMITOMO_MITSUI
ID_TOKYO
ID_RBS
ID_PERMATA
ID_PERMATA_SYR
ID_SINARMAS_SYR
ID_MANDIRI_TASPEN
ID_BANTEN
ID_BEI
ID_CHASE
ID_CCB
ID_JTRUST
UN_TRANSFERWISE
PH_BPIF
PH_METRO
PH_PNB
PH_PNBS
PH_RCBC
PH_RCBCS
PH_SB
PH_SBS
PH_UB
PH_CLRB
PH_GXI
PH_GBY
PH_LBP
PH_PMP
PH_PSB
PH_RSB
PH_CB
PH_CBS
TH_KBANK
DUMMY_INTERBANK
PH_ALLBANK
PH_SUNSB
PH_STERLING
PH_MBSMB
PH_AUB
PH_BOC
PH_MAYBANK
PH_PBCOM
PH_CTBC
PH_EWB
PH_EQB
PH_OMNIPAY
PH_UCPB
PH_PHILTRUST
PH_WDB
PH_DUNGGANUN
PH_UCPBSB
PH_ISLA
PH_PRBC
PH_PBB
PH_PVB
PH_YSBP
PH_MABUHAY
PH_CTBCPH
PH_ING
PH_QCRB
PH_BDONB
PH_EWBRB
ID_DOKU
ID_HSBC
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": {
          "account_id": "string",
          "bank": "BankCode",
          "number": "string",
          "holder_name": "string",
          "type": "BankAccountType"
        },
        "destination_account": {
          "account_id": "string",
          "bank": "DestinationBank",
          "number": "string",
          "holder_name": "string",
          "type": "BankAccountType",
          "address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "province": "string",
            "zip_code": "string",
            "country": "string"
          }
        },
        "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",
        "note": "string",
        "is_selected": "bool"
      },
      "result": {
        "success": "bool",
        "error": [
          {
            "code": "string",
            "message": "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[]stringDisbursementIDs 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_idstringCorporateID is the banks unique id for the organization
reference_idstringReferenceID 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_accountBankAccountInfoSourceAccount is the account to send payment from
destination_accountDestinationBankAccountDestinationAccount is the account to send payment to
source_amountAmountSourceAmount 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_amountAmountDestinationAmount 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_idstringDisbursementID 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_idstringBatchID is the batch id for the processed disbursement request
notestringNote is a reasons that cause disbursement invalid
is_selectedboolIsSelected is an indicator of selected disbursement
Result
NameTypeDescription
successbool
error[]Error
messagestring
BankAccountInfo
NameTypeDescription
account_idstringAccountID is the ID of bank stored in database
bankBankCodeBank is which bank the bank account is for
numberstringNumber is the bank account number
holder_namestringHolderName is the name of the owner of the bank account
typeBankAccountTypeType is the type of bank account
DestinationBankAccount
NameTypeDescription
account_idstringAccountID is the ID of bank stored in database
bankDestinationBankBank is the destination bank code
numberstringNumber is the account number of the destination account.
holder_namestringHolderName is the name on the destination account.
typeBankAccountTypeType is the type of bank account
addressAddressAddress is the registered address for the destination account owner, used by some integrations.
Amount
NameTypeDescription
curCurrencyISO4217cur is the currency value.
numstringnum is the numeric value.
Fees
NameTypeDescription
fee[]Fee
External
NameTypeDescription
reference_idstringReferenceID 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
Address
NameTypeDescription
line1stringLine1 is the first line of the address.
line2stringLine2 is the second line of the address.
citystringCity is the city this address is situated in.
provincestringProvince is the more specific area this address is situated in.
zip_codestringZipCode of the address.
countrystringCountry of the destination account.
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

DisbursementType is the type of disbursement.

ValueDescription
UNKNOWN_TYPE
ON_DEMAND
FUTURE
APPROVER
Status

Status is the status for disbursement request and disbursement type enum.

ValueDescription
UNKNOWN_STATUS
AWAITING_APPROVAL
APPROVED
REJECTED
CREATED
PENDING
SUCCESS
FAILED
PROCESSED
INVALID
CANCELED
BankCode
ValueDescription
UNKNOWN_BANK
DUMMY_BANK_CORPORATE
BCA_CORPORATE
BNI_CORPORATE
BRI_CORPORATE
PERMATA_CORPORATE
TRANSFERWISE
UNIONBANK_CORPORATE
BDO_CORPORATEDeprecated banks
CIMB_CORPORATE
BankAccountType

BankAccountType indicates which account to use.

ValueDescription
UNKNOWN_BANK_ACCOUNT
CHECKINGS
SAVINGS
DestinationBank
ValueDescription
UNKNOWN_DESTINATION_BANK
DUMMY_DESTINATION_BANK
ID_MANDIRI
ID_BCA
ID_BNI
ID_BRI
PH_BDO
PH_BPI
ID_ACEH
ID_AGRIS
ID_BRI_AGRO
ID_AMAR
ID_ANDARA
ID_ANTARDAERAH
ID_ANZ
ID_ARTHAGRAHA
ID_ARTOS
ID_BBL
ID_BARCLAYS
ID_BCA_SYR
ID_BI
ID_BISNIS_INTL
ID_BNI_SYR
ID_BRI_SYR
ID_BTPN
ID_BTPN_SYR
ID_BKP
ID_BKP_SYR
ID_BUMI_ARTA
ID_CAPITAL
ID_CENTRATAMA_NTL
ID_CTBCID
ID_DNMN
ID_DANPAC
ID_DINAR
ID_DKI
ID_DKI_SYR
ID_EKONOMI_RAHARJA
ID_FAMA
ID_GANESHA
ID_HARDA
ID_ICBC
ID_INA_PERDANA
ID_INDEX_SELINDO
ID_BJB
ID_BJB_SYR
ID_JASA_JAKARTA
ID_JATIM
ID_JATIM_SYR
ID_KEB_HANA
ID_KESEJAHTERAAN_EKONOMI
ID_MANDIRI_SYR
ID_MASPION
ID_MAYAPADA
ID_MAYBANK
ID_MAYBANK_SYR
ID_MAYORA
ID_MEGA
ID_MEGA_SYR
ID_MESTIKA_DHARMA
ID_METRO_EXP
ID_MITRANIAGA
ID_MIZUHO
ID_MNC_INTL
ID_MUAMALAT
ID_MULTI_ARTA
ID_MUTIARA
ID_NUSANTARA_PARAHYANGAN
ID_OCBC
ID_OCBC_SYR
ID_BOA
ID_CHINA
ID_INDIA
ID_PIKKO
ID_PRIMA_MASTER
ID_PUNDI
ID_QNB
ID_ROYAL
ID_SAHABAT_SAMPEORNA
ID_SBI
ID_SINAR_HARAPAN
ID_SINARMAS
ID_BTN
ID_BTN_SYR
ID_UOB
ID_VICTORIA
ID_VICTORIA_SYR
ID_WINDU_KENTJANA
ID_WOORI_SAUDARA
ID_YUDHA_BHAKTI
ID_BNP_PARIBAS
ID_ACEH_SYR
ID_BPD_BALI
ID_BENGKULU
ID_JAMBI
ID_JAWA_TENGAH
ID_KALIMANTAN_BARAT
ID_KALIMANTAN_BARAT_SYR
ID_KALIMANTAN_TENGAH
ID_KALIMANTAN_TIMUR
ID_KALIMANTAN_TIMUR_SYR
ID_KALIMANTAN_SELATAN
ID_KALIMANTAN_SELATAN_SYR
ID_LAMPUNG
ID_MALUKU
ID_NTB
ID_NTT
ID_PAPUA
ID_RIAU_KEPRI
ID_SULAWESI_SELATAN_BARAT
ID_SULAWESI_TENGAH
ID_SULAWESI_TENGGARA
ID_SULAWESI_UTARA
ID_SUMATERA_BARAT
ID_SUMATERA_BARAT_SYR
ID_SUMATERA_SELATAN
ID_SUMATERA_SELATAN_BABEL
ID_SUMATERA_SELATAN_SYR
ID_SUMATERA_SELATAN_UUS
ID_SUMATERA_UTARA
ID_SUMATERA_UTARA_SYR
ID_YOGYAKARTA
ID_YOGYAKARTA_SYR
ID_CIMB
ID_CIMB_SYR
ID_CITI
ID_COMMONWEALTH
ID_DNMN_SYR
ID_DBS
ID_DBS_AG
ID_NOBU
ID_PAN
ID_PAN_SYR
ID_RABOBANK
ID_RESONA_PERDANIA
ID_STAN
ID_SUMITOMO_MITSUI
ID_TOKYO
ID_RBS
ID_PERMATA
ID_PERMATA_SYR
ID_SINARMAS_SYR
ID_MANDIRI_TASPEN
ID_BANTEN
ID_BEI
ID_CHASE
ID_CCB
ID_JTRUST
UN_TRANSFERWISE
PH_BPIF
PH_METRO
PH_PNB
PH_PNBS
PH_RCBC
PH_RCBCS
PH_SB
PH_SBS
PH_UB
PH_CLRB
PH_GXI
PH_GBY
PH_LBP
PH_PMP
PH_PSB
PH_RSB
PH_CB
PH_CBS
TH_KBANK
DUMMY_INTERBANK
PH_ALLBANK
PH_SUNSB
PH_STERLING
PH_MBSMB
PH_AUB
PH_BOC
PH_MAYBANK
PH_PBCOM
PH_CTBC
PH_EWB
PH_EQB
PH_OMNIPAY
PH_UCPB
PH_PHILTRUST
PH_WDB
PH_DUNGGANUN
PH_UCPBSB
PH_ISLA
PH_PRBC
PH_PBB
PH_PVB
PH_YSBP
PH_MABUHAY
PH_CTBCPH
PH_ING
PH_QCRB
PH_BDONB
PH_EWBRB
ID_DOKU
ID_HSBC
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": {
          "account_id": "string",
          "bank": "BankCode",
          "number": "string",
          "holder_name": "string",
          "type": "BankAccountType"
        },
        "destination_account": {
          "account_id": "string",
          "bank": "DestinationBank",
          "number": "string",
          "holder_name": "string",
          "type": "BankAccountType",
          "address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "province": "string",
            "zip_code": "string",
            "country": "string"
          }
        },
        "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",
        "note": "string",
        "is_selected": "bool"
      },
      "result": {
        "success": "bool",
        "error": [
          {
            "code": "string",
            "message": "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
disbursements[]DisbursementDisbursements are the disbursements that fall within the specified date range
total_recordint32TotalRecord is the number of record return by database match filters.
Objects
Disbursement
NameTypeDescription
corporate_idstringCorporateID is the banks unique id for the organization
reference_idstringReferenceID 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_accountBankAccountInfoSourceAccount is the account to send payment from
destination_accountDestinationBankAccountDestinationAccount is the account to send payment to
source_amountAmountSourceAmount 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_amountAmountDestinationAmount 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_idstringDisbursementID 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_idstringBatchID is the batch id for the processed disbursement request
notestringNote is a reasons that cause disbursement invalid
is_selectedboolIsSelected is an indicator of selected disbursement
BankAccountInfo
NameTypeDescription
account_idstringAccountID is the ID of bank stored in database
bankBankCodeBank is which bank the bank account is for
numberstringNumber is the bank account number
holder_namestringHolderName is the name of the owner of the bank account
typeBankAccountTypeType is the type of bank account
DestinationBankAccount
NameTypeDescription
account_idstringAccountID is the ID of bank stored in database
bankDestinationBankBank is the destination bank code
numberstringNumber is the account number of the destination account.
holder_namestringHolderName is the name on the destination account.
typeBankAccountTypeType is the type of bank account
addressAddressAddress is the registered address for the destination account owner, used by some integrations.
Amount
NameTypeDescription
curCurrencyISO4217cur is the currency value.
numstringnum is the numeric value.
Fees
NameTypeDescription
fee[]Fee
External
NameTypeDescription
reference_idstringReferenceID 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
Address
NameTypeDescription
line1stringLine1 is the first line of the address.
line2stringLine2 is the second line of the address.
citystringCity is the city this address is situated in.
provincestringProvince is the more specific area this address is situated in.
zip_codestringZipCode of the address.
countrystringCountry of the destination account.
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

DisbursementType is the type of disbursement.

ValueDescription
UNKNOWN_TYPE
ON_DEMAND
FUTURE
APPROVER
Status

Status is the status for disbursement request and disbursement type enum.

ValueDescription
UNKNOWN_STATUS
AWAITING_APPROVAL
APPROVED
REJECTED
CREATED
PENDING
SUCCESS
FAILED
PROCESSED
INVALID
CANCELED
BankCode
ValueDescription
UNKNOWN_BANK
DUMMY_BANK_CORPORATE
BCA_CORPORATE
BNI_CORPORATE
BRI_CORPORATE
PERMATA_CORPORATE
TRANSFERWISE
UNIONBANK_CORPORATE
BDO_CORPORATEDeprecated banks
CIMB_CORPORATE
BankAccountType

BankAccountType indicates which account to use.

ValueDescription
UNKNOWN_BANK_ACCOUNT
CHECKINGS
SAVINGS
DestinationBank
ValueDescription
UNKNOWN_DESTINATION_BANK
DUMMY_DESTINATION_BANK
ID_MANDIRI
ID_BCA
ID_BNI
ID_BRI
PH_BDO
PH_BPI
ID_ACEH
ID_AGRIS
ID_BRI_AGRO
ID_AMAR
ID_ANDARA
ID_ANTARDAERAH
ID_ANZ
ID_ARTHAGRAHA
ID_ARTOS
ID_BBL
ID_BARCLAYS
ID_BCA_SYR
ID_BI
ID_BISNIS_INTL
ID_BNI_SYR
ID_BRI_SYR
ID_BTPN
ID_BTPN_SYR
ID_BKP
ID_BKP_SYR
ID_BUMI_ARTA
ID_CAPITAL
ID_CENTRATAMA_NTL
ID_CTBCID
ID_DNMN
ID_DANPAC
ID_DINAR
ID_DKI
ID_DKI_SYR
ID_EKONOMI_RAHARJA
ID_FAMA
ID_GANESHA
ID_HARDA
ID_ICBC
ID_INA_PERDANA
ID_INDEX_SELINDO
ID_BJB
ID_BJB_SYR
ID_JASA_JAKARTA
ID_JATIM
ID_JATIM_SYR
ID_KEB_HANA
ID_KESEJAHTERAAN_EKONOMI
ID_MANDIRI_SYR
ID_MASPION
ID_MAYAPADA
ID_MAYBANK
ID_MAYBANK_SYR
ID_MAYORA
ID_MEGA
ID_MEGA_SYR
ID_MESTIKA_DHARMA
ID_METRO_EXP
ID_MITRANIAGA
ID_MIZUHO
ID_MNC_INTL
ID_MUAMALAT
ID_MULTI_ARTA
ID_MUTIARA
ID_NUSANTARA_PARAHYANGAN
ID_OCBC
ID_OCBC_SYR
ID_BOA
ID_CHINA
ID_INDIA
ID_PIKKO
ID_PRIMA_MASTER
ID_PUNDI
ID_QNB
ID_ROYAL
ID_SAHABAT_SAMPEORNA
ID_SBI
ID_SINAR_HARAPAN
ID_SINARMAS
ID_BTN
ID_BTN_SYR
ID_UOB
ID_VICTORIA
ID_VICTORIA_SYR
ID_WINDU_KENTJANA
ID_WOORI_SAUDARA
ID_YUDHA_BHAKTI
ID_BNP_PARIBAS
ID_ACEH_SYR
ID_BPD_BALI
ID_BENGKULU
ID_JAMBI
ID_JAWA_TENGAH
ID_KALIMANTAN_BARAT
ID_KALIMANTAN_BARAT_SYR
ID_KALIMANTAN_TENGAH
ID_KALIMANTAN_TIMUR
ID_KALIMANTAN_TIMUR_SYR
ID_KALIMANTAN_SELATAN
ID_KALIMANTAN_SELATAN_SYR
ID_LAMPUNG
ID_MALUKU
ID_NTB
ID_NTT
ID_PAPUA
ID_RIAU_KEPRI
ID_SULAWESI_SELATAN_BARAT
ID_SULAWESI_TENGAH
ID_SULAWESI_TENGGARA
ID_SULAWESI_UTARA
ID_SUMATERA_BARAT
ID_SUMATERA_BARAT_SYR
ID_SUMATERA_SELATAN
ID_SUMATERA_SELATAN_BABEL
ID_SUMATERA_SELATAN_SYR
ID_SUMATERA_SELATAN_UUS
ID_SUMATERA_UTARA
ID_SUMATERA_UTARA_SYR
ID_YOGYAKARTA
ID_YOGYAKARTA_SYR
ID_CIMB
ID_CIMB_SYR
ID_CITI
ID_COMMONWEALTH
ID_DNMN_SYR
ID_DBS
ID_DBS_AG
ID_NOBU
ID_PAN
ID_PAN_SYR
ID_RABOBANK
ID_RESONA_PERDANIA
ID_STAN
ID_SUMITOMO_MITSUI
ID_TOKYO
ID_RBS
ID_PERMATA
ID_PERMATA_SYR
ID_SINARMAS_SYR
ID_MANDIRI_TASPEN
ID_BANTEN
ID_BEI
ID_CHASE
ID_CCB
ID_JTRUST
UN_TRANSFERWISE
PH_BPIF
PH_METRO
PH_PNB
PH_PNBS
PH_RCBC
PH_RCBCS
PH_SB
PH_SBS
PH_UB
PH_CLRB
PH_GXI
PH_GBY
PH_LBP
PH_PMP
PH_PSB
PH_RSB
PH_CB
PH_CBS
TH_KBANK
DUMMY_INTERBANK
PH_ALLBANK
PH_SUNSB
PH_STERLING
PH_MBSMB
PH_AUB
PH_BOC
PH_MAYBANK
PH_PBCOM
PH_CTBC
PH_EWB
PH_EQB
PH_OMNIPAY
PH_UCPB
PH_PHILTRUST
PH_WDB
PH_DUNGGANUN
PH_UCPBSB
PH_ISLA
PH_PRBC
PH_PBB
PH_PVB
PH_YSBP
PH_MABUHAY
PH_CTBCPH
PH_ING
PH_QCRB
PH_BDONB
PH_EWBRB
ID_DOKU
ID_HSBC
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:

{
  "disbursements": [
    {
      "corporate_id": "string",
      "reference_id": "string",
      "type": "DisbursementType",
      "source_account": {
        "account_id": "string",
        "bank": "BankCode",
        "number": "string",
        "holder_name": "string",
        "type": "BankAccountType"
      },
      "destination_account": {
        "account_id": "string",
        "bank": "DestinationBank",
        "number": "string",
        "holder_name": "string",
        "type": "BankAccountType",
        "address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "province": "string",
          "zip_code": "string",
          "country": "string"
        }
      },
      "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",
      "note": "string",
      "is_selected": "bool"
    }
  ],
  "total_record": "int32"
}

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.