Get Form Data

GET 
/v2/international-disbursement/form-data

An endpoint to get form with all required fields to be completed to create the transactions, such as remittance purpose, source of fund, relationship with beneficiary, and the beneficiary’s bank account details

Request

Query Parameters

country_iso_code string

Country code using ISO 3166 (Alpha-3). You can choose multiple countries separate by comma. See supported Country ISO Codes.

transaction_type stringrequired

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

Transaction type information. Possible values are

Responses

200

Get Form Data response

application/json

Schema

Schema

country_iso_code string
currency_code string

beneficiary_relationships

object

SELF string

BROTHER string

SISTER string

SON string

DAUGHTER string

NEPHEW string

NIECE string

FATHER string

MOTHER string

UNCLE string

AUNT string

COUSIN string

FATHER_IN_LAW string

MOTHER_IN_LAW string

BROTHER_IN_LAW string

SISTER_IN_LAW string

GRAND_FATHER string

GRAND_MOTHER string

HUSBAND string

WIFE string

FRIEND string

source_of_funds

object

BUSINESS string

SALARY string

SAVINGS string

GIFT string

remittance_purposes

object

FAMILY_SUPPORT string

SALARY_PAYMENT string

banks

object

101 string

102 string

special_identifiers

object

sort_code string
regions object

nationality_countries

object

iso_code string

name string

country_code string

Example (from schema)

{
  "country_iso_code": "GBR",
  "currency_code": "GBP",
  "beneficiary_relationships": {
    "SELF": "Diri sendiri",
    "BROTHER": "Saudara laki-laki",
    "SISTER": "Saudara perempuan",
    "SON": "Anak laki-laki",
    "DAUGHTER": "Anak perempuan",
    "NEPHEW": "Keponakan laki-laki",
    "NIECE": "Keponakan perempuan",
    "FATHER": "Ayah",
    "MOTHER": "Ibu",
    "UNCLE": "Paman",
    "AUNT": "Bibi",
    "COUSIN": "Sepupu",
    "FATHER_IN_LAW": "Bapak mertua",
    "MOTHER_IN_LAW": "Ibu mertua",
    "BROTHER_IN_LAW": "Ipar laki-laki",
    "SISTER_IN_LAW": "Ipar perempuan",
    "GRAND_FATHER": "Kakek",
    "GRAND_MOTHER": "Nenek",
    "HUSBAND": "Suami",
    "WIFE": "Istri",
    "FRIEND": "Teman"
  },
  "source_of_funds": {
    "BUSINESS": "Bisnis",
    "SALARY": "Gaji",
    "SAVINGS": "Tabungan",
    "GIFT": "Hadiah"
  },
  "remittance_purposes": {
    "FAMILY_SUPPORT": "Bantuan keluarga",
    "SALARY_PAYMENT": "Pembayaran gaji"
  },
  "banks": {
    "101": "Standard Chartered Bank",
    "102": "Bank Something"
  },
  "special_identifiers": {
    "sort_code": "string"
  },
  "regions": {},
  "nationality_countries": {
    "iso_code": "AFG",
    "name": "Afghanistan",
    "country_code": "AF"
  }
}

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 when transaction_type is invalid

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": "transaction_type",
      "code": 1069,
      "message": "Param transaction_type is invalid"
    }
  ]
}

Loading...