Get Agent Disbursement List

GET 
/v2/agent-disbursements

Use this endpoint for obtaining all Agent’s disbursement data

Request

Query Parameters

agent_id integer

The agent ID that wants to be retrieved. If not provided, will return all agent disbursement for the company instead

pagination integer

The pagination of the result. Default value is 20

page integer

The page number of the result to be viewed.

sort string

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.

id string

Flip's transaction ID

amount integer

Amount of the transaction

status string

Transaction status

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
}

422

Response if there's a validation error

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": "pagination",
      "code": 1032,
      "message": "Pagination should be a number and more than 0"
    }
  ]
}

Loading...