Edit Bill / Payment Link

PUT 
/v2/pwf/:bill_id/bill

An endpoint to edit a payment/bill link

Request

Path Parameters

bill_id stringrequired

Flip’s bill link id

application/x-www-form-urlencoded

Body

required

title string

The title of the bill.

type string

Possible values: [SINGLE, MULTIPLE]

Bill type. For bill created with step 3 only SINGLE is permissible.

amount integer

Payment amount.

expired_date date-time

Bill expiry date. The bill can’t be used any more beyond the expiry date. Format YYYY-MM-DD HH:mm.

redirect_url string

Redirect URL after payment is success.

status string

Possible values: [ACTIVE, INACTIVE]

Bill activation status

is_address_required integer

A flag if user needs to input their address when creating payment. 0 is false (default), 1 is true

is_phone_number_required integer

A flag if user needs to input their phone number when creating payment. 0 is false (default), 1 is true

Responses

200

Expected Get All bill Response

application/json

Schema

Schema

link_id integer
link_url string
title string
type string
amount integer
redirect_url string
expired_date date-time
created_from string
status string
is_address_required integer
is_phone_number_required integer
step integer

Example (from schema)

{
  "link_id": 11,
  "link_url": "flip.id/$companyname/#coffeetable",
  "title": "Coffee Table",
  "type": "SINGLE",
  "amount": 900000,
  "redirect_url": "https://someurl.com",
  "expired_date": "2022-12-30 15:50",
  "created_from": "API",
  "status": "ACTIVE",
  "is_address_required": 0,
  "is_phone_number_required": 0,
  "step": 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

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...