Skip to main content

Create Agent Disbursement

POST 
/v2/agent-disbursements

This is the endpoint for creating disbursement for Agent that has been verified.

Request​

Header Parameters

    Content-Type stringrequired

    Request content type application/x-www-form-urlencoded

    idempotency-key stringrequired

    Idempotency key. Please see more detail on Idempotent Request section

    X-TIMESTAMP string

    Request timestamp. The format will follow the ISO8601 format.

Body

required

    agent_id integerrequired

    Agent’s ID from Agent Verificcation API.

    account_number integerrequired

    The account number of the recipient.

    amount integerrequired

    The amount of money to be disbursed

    bank_code stringrequired

    Bank code of the recipient bank.

    direction stringrequired

    Possible values: [DOMESTIC_SPECIAL_TRANSFER, FOREIGN_INBOUND_SPECIAL_TRANSFER]

    The direction of the transaction.

    remark string

    Remark to be included in the transfer made to the recipient. Usually will appear as berita transfer or remark in the transfer receipt

    beneficiary_email string

    List of the recipient emails.

Responses​

Create Special Disbursement Response

Schema

    id integer
    user_id integer
    amount integer
    status string
    reason string
    timestamp date-time
    bank_code string
    account_number string
    recipient_name string
    sender_bank string
    remark string
    receipt string
    time_served date-time
    bundle_id integer
    company_id integer
    recipient_city integer
    created_from string
    direction string

    sender

    object

    sender_name string
    place_of_birth integer
    date_of_birth string
    address string
    sender_identity_type string
    sender_identity_number string
    sender_country integer
    job string
    fee integer
    beneficiary_email string
    idempotency_key string

Callbacks​

POST 
/your-callback-url

Agent Disbursement callback will be sent to you if you transaction status is changed to DONE or CANCELLED. This callback is used for the V2 and V3 Disbursement. Please make sure that you have set the Transaction callback URL on the Flip for Business dashboard.

Body

    data

    object

    JSON array string with content exactly the same as the response of disbursement or bank account inquiry.

    id string

    Flip’s transaction id

    user_id string

    Your account user id in our system

    amount string

    The amount of money to be disbursed in IDR

    status string

    Possible values: [DONE, CANCELLED]

    Transaction status

    • PENDING: Disbursement is still in process
    • CANCELLED: The transaction is cancelled and the amount of the transaction plus the transaction fee will be credited to your balance. This will happen if the transfer process are failed for reason such as inactive recipient account, wrong account number, etc
    • DONE: Disbursement process is finished and the money have been sent to the recipient
    reason string

    The reason value will be given if the transaction status is CANCELLED.

    • INACTIVE_ACCOUNT: Inactive account / Nomor rekening tidak aktif
    • NOT_REGISTERED_ACCOUNT: Not registered account / Nomor rekening tidak terdaftar
    • CANT_RECEIVE_TRANSFER: Can’t receive transfer / Rekening tujuan tidak dapat menerima transfer
    • INTERMITTENT_DISTURBANCE_ON_BENEFICIARY_BANK: Intermittent disturbance on destination bank / Bank tujuan sementara mengalami gangguan
    • BENEFICIARY_ACCOUNT_NOT_VERIFIED: Account is not verified / Rekening tujuan belum terverifikasi
    • INSUFFICIENT_BALANCE: Insufficient deposit balance / Deposit tidak cukup
    • EXCEEDED_TRANSACTION_AMOUNT_LIMIT Exceeded amount transaction limit / Batas transaksi melebihi jumlah
    timestamp string

    The time when the disbursement request created. Time will be in GMT+7 with yyyy-mm-dd hh:mm:ss format

    bank_code string

    Bank code of the recipient bank

    account_number string

    The account number of the recipient

    recipient_name string

    The name of the recipient account holder. If the account number haven’t cached by Flip yet, this attribute will show - (dash) instead

    sender_bank string

    The default sender bank in your account

    remark string

    Remark to be included in the transfer made to the recipient

    receipt string

    Url of the transfer receipt. The receipt will be a screenshot taken from the internet banking interface of each bank. This attribute will only show the url when the status is DONE

    time_served string

    The time when the transaction is finished. Will only show valid value when the status is DONE

    bundle_id integer

    The bundle id of the transaction made from Flip for Business Dashboard (csv upload or manual input). For the transaction created from API, the value will always be 0

    company_id integer

    Your Flip for Business account user id in our system

    recipient_city integer

    The channel of which the transaction was created

    created_from string
    direction string

    The direction of the transactions.

    • DOMESTIC_TRANSFER: Common Disbursement from Indonesia to Indonesian recipient
    • DOMESTIC_SPECIAL_TRANSFER: Special disbursement from the user of a Money Transfer Company residing in Indonesia to Indonesian recipient
    • FOREIGN_INBOUND_SPECIAL_TRANSFER: Special disbursement from the user of a Money Transfer Company residing in a foreign country to Indonesian recipient

    sender

    object

    Possible values are null if the transaction is a common disbursement, and sender object if the transaction is a special disbursment.

    sender_name string

    The name of the user of the Money Transfer Company that act as a sender

    place_of_birth integer

    City/country code of the Sender’s place of birth

    date_of_birth string

    Sender’s date of birth

    address string

    Sender’s address

    sender_identity_type string

    Sender’s identity type

    sender_identity_number string

    Sender’s identity number

    sender_country integer

    Country code of the Sender’s country

    job string

    Sender’s job

    fee integer

    The fee of the transaction

    beneficiary_email string

    List of the recipient emails

    idempotency_key string

    The idempotency key used to create the disbursement

    token string

    Validation token to ensure that the callback is coming from our server. You can get your token in your Flip for Business dashboard.

Callbacks Responses​

URL must return a 200 HTTP Status Code. If the URL returns another HTTP Status Code or if our system doesn’t receive any response within 30 seconds (timeout), our system will retry the request 5 times, with a 2-minute interval for the transaction callback (Money Transfer, Accept Payment, International Transfer).

Loading...
Last updated on