Approve Payment Instructions

The API authorizes one or more forthcoming payment instructions by specifying their IDs. It also enables you to transfer funds to the registered beneficiaries.

PATCH /payments/payments/approve?id=<payment_id>

Body Parameters - Request

Name	Location	Type	Format / Values	Description	Required
id	url parameter	string	true/false	the payment id to approve	Yes

Body Parameters - Response

Name	Type	Format / Values	Description
items	array	object	List of items affected
items[]	object
items[].type	string		type of entity (payment)
items[].id	string		id of payment
items[].correlation_id	string		correlation_id is an external identifier that you provide to track payments within your own platform or system. it must be unique identifier else the API request will fail
items[].result	string		Action result

Request Example

PATCH /payments/payments/approve?id=pbM_VHmEQy6-ez_SrZiaDA&id=awrJqByRRdmEBXSWRr_elg

Response Examples

200 - OK

{
   "items": [
      {
         "result": "Approved Successfully",
         "id": "pbM_VHmEQy6-ez_SrZiaDA",
         "type": "payment"
      },
      {
         "result": "Approved Successfully",
         "id": "awrJqByRRdmEBXSWRr_elg",
         "type": "payment"
      }
   ]
}

400 - Bad Request

{
  "error": "bad_request",
  "description": "Validation errors: {\"type\":\"INDIVIDUAL\",\"id\":\"5SYjAkHqXHW0Z2cqBRW4JAAA\",\"cou... at root failed with \"Missing property org_id\"",
  "error_code": 400
}