Create C2C / C2B International Transfer

POST 
/v2/international-disbursement

An endpoint to create the international transfer C2C/C2B transaction.

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.

application/x-www-form-urlencoded

Body

required

id_number string

Id number.

id_expiration_date string

ID expiration date using YYYY-MM-DD format.

amount stringrequired

Amount of money that wants to be disbursed to the beneficiary (in beneficiary currency). Maximum 2 decimal places, for Japan there can be no decimal. Must be within the minimum and maximum amount based on transaction currency.

source_country stringrequired

Source country code using ISO 3166 (Alpha-3). Currently possible value is IDN

destination_country stringrequired

Source country code using ISO 3166 (Alpha-3). Currently possible value is IDN.

transaction_type stringrequired

Possible values: [C2C, C2B]

Transaction type information.

beneficiary_full_name stringrequired

Full name of the beneficiary

beneficiary_account_number stringrequired

Account number of the beneficiary bank

beneficiary_bank_id string

ID of beneficiary bank

beneficiary_bank_name string

Name of beneficiary bank. Can be used for destination countries AUS and GBR

beneficiary_email string

Email of beneficiary

beneficiary_msisdn string

A number used to identify a phone number internationally

beneficiary_nationality stringrequired

Country code using ISO 3166 (Alpha-3) of beneficiary nationality

beneficiary_province stringrequired

Province or state of the beneficiary

beneficiary_city stringrequired

City of the beneficiary

beneficiary_address stringrequired

Address of the beneficiary

beneficiary_postal_code string

Postal code of the beneficiary

beneficiary_relationships string

Relationship of beneficiary

beneficiary_source_of_funds string

Source of funds

beneficiary_remittance_purposes stringrequired

Purpose of remittance

beneficiary_iban string

Identifier of individual account involved in the international transaction

beneficiary_swift_bic_code string

Identifier of specific bank during an international transaction

beneficiary_sort_code string

Digits of code which is used by British and Irish banks

beneficiary_ifs_code string

Indian financial system code

beneficiary_ach_code string

Ach code of the beneficiary

beneficiary_bsb_number string

Identifier of banks and branches across Australia

beneficiary_branch_number string

Identifier of banks and branches across Japan

beneficiary_document_reference_number string

Reference number of document related to the transaction

beneficiary_registration_number string

Registration number

beneficiary_region string

Required for destination country China code.

sender_name stringrequired

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

sender_country integerrequired

Country code of the sender’s residence. Available value can be retrieved from country list.

sender_place_of_birth integerrequired

City/country code of the sender’s place of birth. Use city code if the sender’s place of birth is in Indonesia, and country code if outside Indonesia. Available value can be retrieved from city/country list.

sender_date_of_birth stringrequired

Sender’s date of birth with YYYY-MM-DD format

sender_address stringrequired

Sender’s address

sender_identity_type stringrequired

Possible values: [nat_id, passport]

Sender’s ID type

sender_identity_number stringrequired

Sender’s ID number

sender_job stringrequired

Possible values: [housewife, entrepreneur, private_employee, government_employee, foundation_board, indonesian_migrant_worker, company, others]

Sender’s job.

sender_email stringrequired

Sender’s email. Only accept one email.

sender_city stringrequired

Sender’s city.

sender_phone_number stringrequired

Sender’s phone number. Start with country phone code.

Responses

200

Create International Disbursement response

application/json; charset=UTF-8

Schema

Schema

id integer
user_id integer
company_id integer
exchange_rate integer
fee integer
amount integer
source_country string
destination_country string
beneficiary_amount integer
beneficiary_currency_code string
status string
timestamp string
time_served string
created_from string
receipt string
transaction_type string
idempotency_key string

beneficiary

object

id_number string

id_expiration_date string

full_name string

bank_account_number string

bank string

email string

msisdn string

nationality string

country string

province string

city string

address string

postal_code string

relationship string

source_of_funds string

remittance_purpose string

iban string

swift_bic_code string

sort_code string

ifs_code string

bsb_number string

branch_number string

document_reference_number string

registration_number string

sender

object

name string

place_of_birth integer

date_of_birth string

address string

identity_type string

identity_number string

country integer

job string

email string

city string

phone_number string
reason string

Example (from schema)

{
  "id": 11,
  "user_id": 12345,
  "company_id": 123456,
  "exchange_rate": 19000.55,
  "fee": 88888,
  "amount": 1000000,
  "source_country": "IDN",
  "destination_country": "GBR",
  "beneficiary_amount": 52.63,
  "beneficiary_currency_code": "GBP",
  "status": "PENDING",
  "timestamp": "2021-12-02 15:27:24",
  "time_served": "(not set)",
  "created_from": "API",
  "receipt": "someurl.png",
  "transaction_type": "C2C",
  "idempotency_key": "idem-1",
  "beneficiary": {
    "id_number": "44943733088",
    "id_expiration_date": "2022-11-29",
    "full_name": "John Smith",
    "bank_account_number": "1122333300",
    "bank": "Allica Bank",
    "email": "emial@email.com",
    "msisdn": "09584008222",
    "nationality": "IDN",
    "country": "GBR",
    "province": "United Kingdom",
    "city": "Manchester",
    "address": "Mosley St Manchester",
    "postal_code": "M2",
    "relationship": "SON",
    "source_of_funds": "BUSINESS",
    "remittance_purpose": "EDUCATION",
    "iban": null,
    "swift_bic_code": null,
    "sort_code": "506967",
    "ifs_code": null,
    "bsb_number": null,
    "branch_number": null,
    "document_reference_number": null,
    "registration_number": null
  },
  "sender": {
    "name": "John Doe",
    "place_of_birth": 100230,
    "date_of_birth": "1963-12-01",
    "address": "Some Address Street 123",
    "identity_type": "nat_id",
    "identity_number": "1234789012347890",
    "country": 100252,
    "job": "entrepreneur",
    "email": "sender@mail.com",
    "city": "Sender City",
    "phone_number": "+628123456789\""
  },
  "reason": ""
}

401

Sample response when Your Flip api secret key value for Authorization is missing or invalid

application/json; charset=UTF-8

Schema

Schema

name string
message string
status integer

Example (from schema)

{
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials.",
  "status": 401
}

422

Sample error response

application/json; charset=UTF-8

Schema

Schema

code string

errors

object[]

Array [

attribute string

code integer

message string

]

Example (from schema)

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "source_country",
      "code": 1001,
      "message": "Source country cannot be empty"
    }
  ]
}

Mising Required Fields

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "amount",
      "code": 1001,
      "message": "Amount cannot be emptyy"
    },
    {
      "attribute": "source_country",
      "code": 1001,
      "message": "Source country cannot be empty"
    },
    {
      "attribute": "destination_country",
      "code": 1001,
      "message": "Destination country cannot be empty"
    },
    {
      "attribute": "beneficiary_full_name",
      "code": 1001,
      "message": "Beneficiary full name cannot be empty"
    },
    {
      "attribute": "beneficiary_bank_account_number",
      "code": 1001,
      "message": "Beneficiary bank account number cannot be empty"
    },
    {
      "attribute": "beneficiary_bank_id",
      "code": 1001,
      "message": "Beneficiary bank id cannot be empty"
    },
    {
      "attribute": "beneficiary_remittance_purpose",
      "code": 1001,
      "message": "Beneficiary remittance purpose cannot be empty"
    },
    {
      "attribute": "beneficiary_beneficiary_relationship",
      "code": 1001,
      "message": "Beneficiary beneficiary relationship cannot be empty"
    },
    {
      "attribute": "beneficiary_source_of_funds",
      "code": 1001,
      "message": "Beneficiary source of funds cannot be empty"
    },
    {
      "attribute": "sender_address",
      "code": 1001,
      "message": "Sender address cannot be empty"
    },
    {
      "attribute": "sender_identity_type",
      "code": 1001,
      "message": "Sender identity type cannot be empty"
    },
    {
      "attribute": "sender_identity_number",
      "code": 1001,
      "message": "Sender identity number cannot be empty"
    },
    {
      "attribute": "sender_job",
      "code": 1001,
      "message": "Sender job cannot be empty"
    },
    {
      "attribute": "sender_email",
      "code": 1001,
      "message": "Sender email cannot be empty"
    },
    {
      "attribute": "sender_city",
      "code": 1001,
      "message": "Sender city cannot be empty"
    },
    {
      "attribute": "sender_phone_number",
      "code": 1001,
      "message": "Sender phone number cannot be empty"
    }
  ]
}

Mising amount Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "type",
      "code": 1001,
      "message": "Amount cannot be empty"
    }
  ]
}

Mising source_country Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "source_country",
      "code": 1001,
      "message": "Destination country cannot be empty"
    }
  ]
}

Missing destination_country field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "destination_country",
      "code": 1001,
      "message": "Destination country cannot be empty"
    }
  ]
}

Missing beneficiary_full_name field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "beneficiary_full_name",
      "code": 1001,
      "message": "Beneficiary full name cannot be empty"
    }
  ]
}

Missing beneficiary_bank_account_number field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "beneficiary_bank_account_number",
      "code": 1001,
      "message": "Beneficiary bank account number cannot be empty"
    }
  ]
}

Missing beneficiary_bank_id field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "beneficiary_bank_id",
      "code": 1001,
      "message": "Beneficiary bank id cannot be empty"
    }
  ]
}

Missing beneficiary_remittance_purpose field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "beneficiary_remittance_purpose",
      "code": 1001,
      "message": "Beneficiary remittance purpose cannot be empty"
    }
  ]
}

Missing beneficiary_beneficiary_relationship field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "beneficiary_beneficiary_relationship",
      "code": 1001,
      "message": "Beneficiary beneficiary relationship cannot be empty"
    }
  ]
}

Missing beneficiary_source_of_funds field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "beneficiary_source_of_funds",
      "code": 1001,
      "message": "Beneficiary source of funds cannot be empty"
    }
  ]
}

Missing sender_address field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "sender_address",
      "code": 1001,
      "message": "Sender address cannot be empty"
    }
  ]
}

Missing sender_identity_type field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "sender_identity_type",
      "code": 1001,
      "message": "Sender identity type cannot be empty"
    }
  ]
}

Missing sender_identity_number field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "sender_identity_number",
      "code": 1001,
      "message": "Sender identity number cannot be empty"
    }
  ]
}

Missing sender_job field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "sender_job",
      "code": 1001,
      "message": "Sender job cannot be empty"
    }
  ]
}

Missing sender_email field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "sender_email",
      "code": 1001,
      "message": "Sender email cannot be empty"
    }
  ]
}

Missing sender_city field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "sender_city",
      "code": 1001,
      "message": "Sender city cannot be empty"
    }
  ]
}

Missing sender_phone_number field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "sender_phone_number",
      "code": 1001,
      "message": "Sender phone number cannot be empty"
    }
  ]
}

Callbacks

POST createInternationalDisbursementCallback

POST 
/your-callback-url

International transfer callback will be sent to you if you transaction status is changed. Please make sure that you have set the International Transfer callback URL on the Flip for Business dashboard.

application/x-www-form-urlencoded

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

company_id string

Id of company

exchange_rate integer

The country exchange rates to IDR

fee integer

Transfer fee to the country

amount integer

Transfer amount in IDR

source_country string

Source country code using ISO 3166 (Alpha-3)

destination_country string

Destination country code using ISO 3166 (Alpha-3)

beneficiary_amount integer

Amount to be received by beneficiary

beneficiary_currency_code string

Currency code of the beneficiary

status string

Possible values: [PENDING, SUCCESSFUL, CANCELLED]

Transaction status

timestamp string

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

time_served string

The time when the disbursement is finished

created_from string

The channel of which the transaction was created.

receipt string

URL of the transfer receipt

transaction_type string

Possible values: [C2C, C2B, B2B, B2C]

Transaction type information

idempotency_key string

Idempotency key information

beneficiary

object

id_number string

Id number

id_expiration_date string

ID expiration date using YYYY-MM-DD format

full_name string

Full name of the beneficiary

bank_account_number string

Account number of the beneficiary bank

bank string

Bank name of beneficiary bank

email string

Email of beneficiary

msisdn string

A number used to identify a phone number internationally

nationality integer

Country code using ISO 3166 (Alpha-3) of beneficiary nationality

country integer

Country code using ISO 3166 (Alpha-3) of the beneficiary’s country

province string

Province or state of the beneficiary

city string

City of the beneficiary

address string

Address of the beneficiary

postal_code string

Postal code of the beneficiary

relationship string

Relationship of sender and beneficiary

source_of_funds string

Source of funds

remittance_purpose string

Purpose of remittance

iban string

Identifier of individual account involved in the international transaction

swift_bic_code string

Identifier of specific bank during an international transaction

sort_code string

Digits of code which is used by British and Irish banks

ifs_code string

Indian financial system code

bsb_number string

Identifier of banks and branches across Australia

branch_number string

Identifier of bank for Japan

document_reference_number string

Reference number of document related to the transaction

registration_number string

Registration number

sender

object

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

identity_type string

Sender’s identity type

identity_number string

Sender’s identity number

country integer

Country code of the Sender’s country

job string

Sender’s job

email string

Sender’s email

city string

Sender’s city

phone_number string

Sender’s phone number

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

200

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...