Get Payment

GET 
/v2/pwf/:bill_id/payment

An endpoint to get all payment transaction(s) from a specific bill link.

Request

Path Parameters

bill_id stringrequired

Flip’s bill link id

Query Parameters

start_date string

Starting date of the data. Example "2020-01-01"

end_date string

Ending date of the data. Example "2020-12-12". End date must be greater than start_date.

pagination integer

Pagination of the data.

page integer

The desired page of the data pagination.

sort_by string

Possible values: [id, bill_link, bill_title, sender_bank, amout, created_at]

Sort the result by the attribute. You can sort by

sort_type string

Possible values: [sort_desc, sort_asc]

You can sort in

Header Parameters

Content-Type stringrequired

Request content type application/x-www-form-urlencoded

Responses

200

Get Payment response

application/json

Schema

Schema

link_id integer
total_data integer
data_per_page integer
total_page integer
page integer

data

object[]

Array [

id string

link_id string

bill_link string

bill_title string

sender_name string

sender_bank string

sender_bank_type string

virtual_account_number string

amount integer

status string

settlement_status string

reference_id string

payment_url string

created_at string

completed_at string

settlement_date string

]

Example (from schema)

{
  "link_id": 11,
  "total_data": 2,
  "data_per_page": 2,
  "total_page": 1,
  "page": 1,
  "data": [
    {
      "id": "PGPWF3453271107384587",
      "link_id": "12345",
      "bill_link": "flip.id/$companyname/#coffeetable",
      "bill_title": "Coffee Table",
      "sender_name": "John Smith",
      "sender_bank": "mandiri",
      "sender_bank_type": "virtual_account",
      "virtual_account_number": "8902290270097932",
      "amount": 900000,
      "status": "PENDING",
      "settlement_status": "Pending",
      "reference_id": "null",
      "payment_url": "https://flip.id/pwf/transaction/consolidated?redirected_from=internal&id=1236",
      "created_at": "2021-02-03 14:57:44",
      "completed_at": "null",
      "settlement_date": "null"
    }
  ]
}

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

Expected 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": "id",
      "code": 1050,
      "message": "Product Bill Link ID Not Found"
    }
  ]
}

Mising Required Fields

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "id",
      "code": 1043,
      "message": "Product Bill Link ID Not Found"
    },
    {
      "attribute": "expired_date",
      "code": 1047,
      "message": "Param expired_date is invalid"
    }
  ]
}

Mising id Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "id",
      "code": 1043,
      "message": "Param Bill Link ID is Not Found"
    }
  ]
}

Mising expired_date Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "expired_date",
      "code": 1047,
      "message": "Param expired_date is invalid"
    }
  ]
}

Loading...