Get All International Transfer

GET 
/v2/international-disbursement

An endpoint to get all international transfer

Request

Query Parameters

pagination string

The pagination of the result. Default value is 20.

page string

The page number of the result to be viewed. Default value is 1.

sort_by string

Possible values: [id, amount, source_country, destination_country, status]

Sort the result by the attribute. Use the attribute name (e.g sort=id) to sort in ascending order or dash+attribute name (e.g sort=-id) to sort in descending order

Responses

200

Get All International response

application/json

Schema

Schema

total_data integer
data_per_page integer
total_page integer
page integer

data

object[]

Array [

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)

{
  "total_data": 5,
  "data_per_page": 5,
  "total_page": 1,
  "page": 1,
  "data": [
    {
      "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

Validation 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": "page",
      "code": 1052,
      "message": "Param page should be a number and more than 0"
    }
  ]
}

Loading...