Create B2C / B2B International Transfer

POST 
/v2/international-disbursement/create-with-attachment

An endpoint to create the international transfer B2C/B2B 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

destination_country stringrequired

Destination country code using ISO 3166 (Alpha-3). See supported Destination Countries.

source_country stringrequired

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

transaction_type stringrequired

Possible values: [B2B, B2C]

Transaction type information.

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.

attachment_data binary

File of invoice for Malaysia B2B. Accepted extensions txt, pdf, doc, docx, jpg, jpeg, png, bmp, rtf, xls, xlsx

attachment_type string

Currently possible value is invoice for MYS

beneficiary_account_number stringrequired

Account number of the beneficiary bank

beneficiary_ach_code string

Ach code of the beneficiary

beneficiary_address string

Address of the beneficiary

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_branch_number string

Identifier of banks and branches across Japan

beneficiary_bsb_number string

Identifier of banks and branches across Australia

beneficiary_city stringrequired

City of the beneficiary

beneficiary_document_reference_number string

Reference number of document related to the transaction

beneficiary_email string

Email of beneficiary

beneficiary_full_name string

Full name of the beneficiary

beneficiary_iban string

Identifier of individual account involved in the international transaction

beneficiary_id_expiration_date string

ID expiration date using YYYY-MM-DD format

beneficiary_ifs_code string

Indian financial system code

beneficiary_id_number string

ID Number

beneficiary_msisdn string

A number used to identify a phone number internationally

beneficiary_nationality string

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

beneficiary_postal_code string

Postal code of the beneficiary

beneficiary_province string

Province or state of the beneficiary

beneficiary_relationship string

Relationship of beneficiary

beneficiary_remittance_purposes string

Purpose of remittance

beneficiary_sort_code string

Digits of code which is used by British and Irish banks

beneficiary_source_of_funds string

Source of funds

Responses

200

Create B2B 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

full_name string

bank_account_number string

email string

bank 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

id_number string

id_expiration_date string

ach_code string
sender 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": {
    "full_name": "Jane Doe",
    "bank_account_number": "1187710200",
    "email": null,
    "bank": "AFFIN INVESTMENT BANK BERHAD",
    "msisdn": "",
    "nationality": "",
    "country": "MYS",
    "province": "",
    "city": "",
    "address": "",
    "postal_code": null,
    "relationship": "",
    "source_of_funds": "",
    "remittance_purpose": "TRAVEL",
    "iban": null,
    "swift_bic_code": null,
    "sort_code": null,
    "ifs_code": null,
    "bsb_number": null,
    "branch_number": null,
    "document_reference_number": "doc_reference_123456",
    "registration_number": null,
    "id_number": "",
    "id_expiration_date": "",
    "ach_code": ""
  },
  "sender": null,
  "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": "destination_country",
      "code": 1001,
      "message": "Destination 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": "beneficiary_postal_code",
      "code": 1001,
      "message": "Beneficiary postal code cannot be empty"
    },
    {
      "attribute": "beneficiary_ach_code",
      "code": 1001,
      "message": "Beneficiary ach code cannot be empty"
    },
    {
      "attribute": "beneficiary_address",
      "code": 1001,
      "message": "Beneficiary address cannot be empty"
    },
    {
      "attribute": "beneficiary_city",
      "code": 1001,
      "message": "Beneficiary city cannot be empty"
    },
    {
      "attribute": "beneficiary_msisdn",
      "code": 1001,
      "message": "Beneficiary msisdn cannot be empty"
    },
    {
      "attribute": "attachment_type",
      "code": 1001,
      "message": "Attachment type cannot be empty"
    },
    {
      "attribute": "attachment_data",
      "code": 1001,
      "message": "Attachment data cannot be empty"
    }
  ]
}

Mising amount Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "amount",
      "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 beneficiary_postal_code field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "beneficiary_postal_code",
      "code": 1001,
      "message": "Beneficiary postal code cannot be empty"
    }
  ]
}

Missing beneficiary_ach_code field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "beneficiary_ach_code",
      "code": 1001,
      "message": "Beneficiary ach code cannot be empty"
    }
  ]
}

Missing beneficiary_address field

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

Missing beneficiary_city field

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

Missing beneficiary_msisdn field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "beneficiary_msisdn",
      "code": 1001,
      "message": "Beneficiary msisdn cannot be empty"
    }
  ]
}

Missing attachment_type field

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

Missing attachment_data field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "attachment_data",
      "code": 1001,
      "message": "Attachment data cannot be empty"
    }
  ]
}

Loading...