This API is primarily a utility API. We will periodically keep updating the list of branches available for a specific receiving instituion but you are recommended to allow the user to enter information manually, if a specific branch is not available from the APIs.
This API serves as a utility API which you can use to help fetch branches for a recieving instutition selected by user as part of the dynamic beneficiary forms to be display to your users while creating a Payout recipient. Learn more about beneficiary forms.
Header Parameters
Authorizationstring
Query Parameters
namestring
Branch name
citystring
Branch city
pageinteger
Page number
Default value
1
records_per_pageinteger
Number of records per page
Maximum
100
Default value
10
sort_fieldsstring
Comma separated values to sort response data
Default value
name
Enum values:
name
sort_orderstring
Sorting order
Default value
ASC
Enum values:
ASCDESC
Path Parameters
receiving_institution_typestring Required
Receiving institution type
Enum values:
BANKCARDSCASH_PICKUPMOBILE_WALLET
receiving_institution_idstring Required
Receiving institution ID
Response
200
Object
OK
Response Attributes
paginationobject
Show child attributes
dataarray
Represents array of receiving institution branches
Show child attributes
400
Object
Bad Request
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| invalid_user_id | Invalid User ID | User does not exist. Please provide a valid user id. |
| invalid_institution | Invalid Institution | Invalid institution id. |
| invalid_query_param | Invalid Query Parameter | Invalid query parameters. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
401
Object
Unauthorized
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| token_required | Token Required | Access denied due to invalid token on header. |
| invalid_tenant | Invalid Tenant | Access denied due to invalid tenant code. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
403
Object
Forbidden
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| restricted_resource | Restricted Resource | Access denied to the resource. If your access key and source IP is correct, it would be because of `X-Auth-User-ID` is not passed on header. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
404
Object
Not Found
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| resource_not_found | Resource Not Found | The requested URL was not found. |
| no_records_found | No Records Found | No records found. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
500
Object
Internal Server Error
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| generic_error | General Error | General application error. |
