Get Agent Disbursement data by ID

GET 
/v2/agent-disbursements/:transaction_id

An endpoint for obtaining the Agent’s disbursement data by it’s ID.

Request

Path Parameters

transaction_id stringrequired

Flip’s transaction id

Responses

200

Expected Response

application/json; charset=UTF-8

Schema

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 string
fee integer
beneficiary_email string
idempotency_key string

Example (from schema)

{
  "id": 10,
  "user_id": 20,
  "amount": 10000,
  "status": "PENDING",
  "reason": "asd",
  "timestamp": "2017-08-28T14:32:47Z",
  "bank_code": "bni",
  "account_number": "1122333300",
  "recipient_name": "John Doe",
  "sender_bank": "bri",
  "remark": "some remark",
  "receipt": "asdasdasdsa",
  "time_served": "0000-00-00T00:00:00Z",
  "bundle_id": 0,
  "company_id": 7,
  "recipient_city": 391,
  "created_from": "API",
  "direction": "DOMESTIC_TRANSFER",
  "sender": "null",
  "fee": 1500,
  "beneficiary_email": "test@mail.com,user@mail.com",
  "idempotency_key": "idem-key-1"
}

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
}

404

Response when the agent Id is invalid

application/json; charset=UTF-8

Schema

Schema

name string
status integer
message string

Example (from schema)

{
  "name": "Not Found",
  "status": 404,
  "message": "Agent disbursement not found"
}

422

Response for the Get Agent Disbursement API is the same with Money Transfer V3 response.

application/json; charset=UTF-8

Schema

Schema

code string

errors

object[]

Array [

attribute string

code integer

message string

]

Example (from schema)

{
  "code": "disbursement_id_not_found",
  "errors": [
    {
      "attribute": "id",
      "code": 1072,
      "message": "Disbursement not found"
    }
  ]
}

Loading...