{ "info": { "_postman_id": "bcd7ae92-9565-5689-aa7a-bcf6c1ed9841", "name": "Monato · Billpay", "description": "Monato's API 1.0.0. Generated from `products/billpay/billpay-v1.yaml`.\n\nSelect the Monato Sandbox environment and fill in your credentials, then send any request.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Create a Payment", "request": { "method": "POST", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/payments?payee_id=1234567&payer_account=U0000-19&amount=1000¤cy=MXN", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "payments" ], "query": [ { "key": "payee_id", "value": "1234567", "description": "Finch Payee ID", "disabled": false }, { "key": "payer_account", "value": "U0000-19", "description": "The Payee Reference to be paid", "disabled": false }, { "key": "amount", "value": "1000", "description": "The amount to be paid", "disabled": false }, { "key": "currency", "value": "MXN", "description": "Currency in which the amount is going to be paid", "disabled": false }, { "key": "idempotency_key", "value": "client_side_idempotency_key", "description": "Unique value generated by the client which we uses to recognize from subsequent requests", "disabled": true } ] }, "description": "Endpoint to create a Payment in Monato Billpay.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{finAccessToken}}", "type": "string" } ] } }, "response": [ { "name": "201 Successfully Payment created", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/payments?payee_id=1234567&payer_account=U0000-19&amount=1000¤cy=MXN", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "payments" ], "query": [ { "key": "payee_id", "value": "1234567", "description": "Finch Payee ID", "disabled": false }, { "key": "payer_account", "value": "U0000-19", "description": "The Payee Reference to be paid", "disabled": false }, { "key": "amount", "value": "1000", "description": "The amount to be paid", "disabled": false }, { "key": "currency", "value": "MXN", "description": "Currency in which the amount is going to be paid", "disabled": false }, { "key": "idempotency_key", "value": "client_side_idempotency_key", "description": "Unique value generated by the client which we uses to recognize from subsequent requests", "disabled": true } ] } }, "code": 201, "status": "Successfully Payment created", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"payment_id\": \"0fcbe1fb-b61b-44c3-a258-6a9d6e801804\",\n \"payer_account\": \"U0000-19\",\n \"amount\": 1000,\n \"currency\": \"MXN\",\n \"payee_id\": \"0d93acf6-b63d-46e8-aa5f-6f2520462608\",\n \"status\": \"completed\",\n \"metadata\": {},\n \"created_at\": \"2024-04-10T19:48:43.222Z\",\n \"auth_number\": \"8459344721\"\n}" }, { "name": "422 Unprocesable Entity", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/payments?payee_id=1234567&payer_account=U0000-19&amount=1000¤cy=MXN", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "payments" ], "query": [ { "key": "payee_id", "value": "1234567", "description": "Finch Payee ID", "disabled": false }, { "key": "payer_account", "value": "U0000-19", "description": "The Payee Reference to be paid", "disabled": false }, { "key": "amount", "value": "1000", "description": "The amount to be paid", "disabled": false }, { "key": "currency", "value": "MXN", "description": "Currency in which the amount is going to be paid", "disabled": false }, { "key": "idempotency_key", "value": "client_side_idempotency_key", "description": "Unique value generated by the client which we uses to recognize from subsequent requests", "disabled": true } ] } }, "code": 422, "status": "Unprocesable Entity", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"error_type\": \"INTERNAL_ERROR\",\n \"error_message\": \"There was an error while processing your request\"\n}" } ] }, { "name": "Retrieve Payment", "request": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/payments/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "payments", ":id" ], "variable": [ { "key": "id", "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "description": "ID of the Payment to retrieve" } ] }, "description": "Endpoint to retrieve a Payment by Id.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{finAccessToken}}", "type": "string" } ] } }, "response": [ { "name": "200 Successfully return the Payment found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/payments/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "payments", ":id" ], "variable": [ { "key": "id", "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "description": "ID of the Payment to retrieve" } ] } }, "code": 200, "status": "Successfully return the Payment found", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"payment_id\": \"429ee7cb-6eee-4fd2-8bb3-ad22f7f3c88e\",\n \"amount\": \"373.0\",\n \"currency\": \"MXN\",\n \"payer_account\": \"055810100345\",\n \"payee_id\": \"0d93acf6-b63d-46e8-aa5f-6f2520462608\",\n \"status\": \"completed\",\n \"metadata\": {},\n \"created_at\": \"2024-04-10T20:12:52.356Z\"\n}" }, { "name": "404 Payment not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/payments/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "payments", ":id" ], "variable": [ { "key": "id", "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "description": "ID of the Payment to retrieve" } ] } }, "code": 404, "status": "Payment not found", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"error_type\": \"INTERNAL_ERROR\",\n \"error_message\": \"There was an error while processing your request\"\n}" } ] }, { "name": "Create a Balance", "request": { "method": "POST", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/balances?payer_account=U0000-20&payee_id=2bd7cf7f-4138-4d7a-ae28-b9888bc6f756", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "balances" ], "query": [ { "key": "payer_account", "value": "U0000-20", "description": "The Payee user id to pay or to check information regarding the user account", "disabled": false }, { "key": "payee_id", "value": "2bd7cf7f-4138-4d7a-ae28-b9888bc6f756", "description": "Unique ID from Monato to identify the Payee", "disabled": false } ] }, "description": "Endpoint to create a Balance in Monato Billpay.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{finAccessToken}}", "type": "string" } ] } }, "response": [ { "name": "201 Successfully Balance created", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/balances?payer_account=U0000-20&payee_id=2bd7cf7f-4138-4d7a-ae28-b9888bc6f756", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "balances" ], "query": [ { "key": "payer_account", "value": "U0000-20", "description": "The Payee user id to pay or to check information regarding the user account", "disabled": false }, { "key": "payee_id", "value": "2bd7cf7f-4138-4d7a-ae28-b9888bc6f756", "description": "Unique ID from Monato to identify the Payee", "disabled": false } ] } }, "code": 201, "status": "Successfully Balance created", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"balance_id\": \"4rsie1fb-b61b-44c3-a258-6a9d6e8572849\",\n \"payee_id\": \"0d93acf6-b63d-46e8-aa5f-6f2520462608\",\n \"payee_name\": \"AGUA DE CDMX (SACMEX)\",\n \"amount\": \"36.67\",\n \"payer_account\": \"041837057079959114\",\n \"currency\": \"MXN\",\n \"invoice_date\": \"2024-04-10T19:21:13.380Z\",\n \"due_date\": \"2024-04-20T19:21:13.380Z\",\n \"status\": \"completed\",\n \"metadata\": {\n \"payer_name\": \"PAYER\",\n \"payer_address\": \"PAYER ADDRESS\"\n },\n \"created_at\": \"2024-04-10T19:21:13.387Z\"\n}" } ] }, { "name": "Retrieve Balance", "request": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/balances/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "balances", ":id" ], "variable": [ { "key": "id", "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "description": "Balance transaction id already created." } ] }, "description": "Endpoint to retrieve a Balance in Monato Billpay.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{finAccessToken}}", "type": "string" } ] } }, "response": [ { "name": "200 Successfully return the Balance found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/balances/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "balances", ":id" ], "variable": [ { "key": "id", "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "description": "Balance transaction id already created." } ] } }, "code": 200, "status": "Successfully return the Balance found.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"balance_id\": \"0214aa11-be93-4fc8-954b-d45b6fc60882\",\n \"payee_name\": \"CFE\",\n \"payee_id\": \"792fe14f-4592-4974-90b9-573bbc29c5df\",\n \"amount\": \"9148.62\",\n \"payer_account\": \"821970704543\",\n \"currency\": \"MXN\",\n \"invoice_date\": \"2025-05-21T13:52:19.000Z\",\n \"due_date\": \"2025-05-21T13:52:19.000Z\",\n \"status\": \"completed\",\n \"metadata\": {},\n \"created_at\": \"2025-05-21T19:52:19.231Z\"\n}" }, { "name": "404 Balance not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/balances/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "balances", ":id" ], "variable": [ { "key": "id", "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "description": "Balance transaction id already created." } ] } }, "code": 404, "status": "Balance not found", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"error_type\": \"INTERNAL_ERROR\",\n \"error_message\": \"There was an error while processing your request\"\n}" } ] }, { "name": "Retrieve Account", "request": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/client/account", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "client", "account" ] }, "description": "Endpoint to retrieve an Account in Monato Billpay", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{finAccessToken}}", "type": "string" } ] } }, "response": [ { "name": "200 Successfully return client account found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/client/account", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "client", "account" ] } }, "code": 200, "status": "Successfully return client account found.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"name\": \"Client\",\n \"email\": \"client@monato.com\",\n \"accounts\": {\n \"account_id\": \"77f58655-4345-41aa-80de-6647a21c471a\",\n \"account_name\": \"Bill\",\n \"virtual_clabe\": \"\",\n \"status\": \"enable\",\n \"pre_balance\": 0,\n \"post_balance\": 0,\n \"available_balance\": 0,\n \"reserved_balance\": 0\n }\n}" }, { "name": "404 Account not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/client/account", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "client", "account" ] } }, "code": 404, "status": "Account not found", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"error_type\": \"INTERNAL_ERROR\",\n \"error_message\": \"There was an error while processing your request\"\n}" } ] }, { "name": "Create Topup", "request": { "method": "POST", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/topups?payee_id=2bd7cf7f-4138-4d7a-ae28-b9888bc6f756&amount=0&phone_number=9991234567", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "topups" ], "query": [ { "key": "payee_id", "value": "2bd7cf7f-4138-4d7a-ae28-b9888bc6f756", "description": "Payee Monato ID", "disabled": false }, { "key": "amount", "value": "0", "description": "The amount due including cents from the payer to the payee service", "disabled": false }, { "key": "phone_number", "value": "9991234567", "description": "The phone number of the user where will be applied", "disabled": false }, { "key": "idempotency_key", "value": "client_side_idempotency_key", "description": "Unique value generated by the client which we uses to recognize from subsequent requests", "disabled": true } ] }, "description": "Endpoint to create Topups in Monato Billpay", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{finAccessToken}}", "type": "string" } ] } }, "response": [ { "name": "201 Successfully Topup created.", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/topups?payee_id=2bd7cf7f-4138-4d7a-ae28-b9888bc6f756&amount=0&phone_number=9991234567", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "topups" ], "query": [ { "key": "payee_id", "value": "2bd7cf7f-4138-4d7a-ae28-b9888bc6f756", "description": "Payee Monato ID", "disabled": false }, { "key": "amount", "value": "0", "description": "The amount due including cents from the payer to the payee service", "disabled": false }, { "key": "phone_number", "value": "9991234567", "description": "The phone number of the user where will be applied", "disabled": false }, { "key": "idempotency_key", "value": "client_side_idempotency_key", "description": "Unique value generated by the client which we uses to recognize from subsequent requests", "disabled": true } ] } }, "code": 201, "status": "Successfully Topup created.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"topup_id\": \"9fadc949-fd1a-45f7-8733-69866655f36c\",\n \"amount\": \"40.0\",\n \"phone_number\": \"0094097929\",\n \"payee_id\": \"0b9e75c3-d4c1-4c7c-b9d4-b4b80be1a483\",\n \"status\": \"completed\",\n \"created_at\": \"2024-04-10T20:15:30.633Z\"\n}" }, { "name": "422 Unprocesable Entity", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/topups?payee_id=2bd7cf7f-4138-4d7a-ae28-b9888bc6f756&amount=0&phone_number=9991234567", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "topups" ], "query": [ { "key": "payee_id", "value": "2bd7cf7f-4138-4d7a-ae28-b9888bc6f756", "description": "Payee Monato ID", "disabled": false }, { "key": "amount", "value": "0", "description": "The amount due including cents from the payer to the payee service", "disabled": false }, { "key": "phone_number", "value": "9991234567", "description": "The phone number of the user where will be applied", "disabled": false }, { "key": "idempotency_key", "value": "client_side_idempotency_key", "description": "Unique value generated by the client which we uses to recognize from subsequent requests", "disabled": true } ] } }, "code": 422, "status": "Unprocesable Entity", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"error_type\": \"INTERNAL_ERROR\",\n \"error_message\": \"There was an error while processing your request\"\n}" } ] }, { "name": "Verify Payment", "request": { "method": "POST", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/verify-payment?payee_id=ac1e14e3-46a7-4010-b6ca-36090efc4f69&payer_account=821970704543&amount=1000¤cy=MXN&idempotency_key=your_api_key", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "verify-payment" ], "query": [ { "key": "payee_id", "value": "ac1e14e3-46a7-4010-b6ca-36090efc4f69", "description": "Monato Payee ID", "disabled": false }, { "key": "payer_account", "value": "821970704543", "description": "The payee reference to be paid", "disabled": false }, { "key": "amount", "value": "1000", "description": "The amount to be paid", "disabled": false }, { "key": "currency", "value": "MXN", "description": "Currency in which the amount is going to be paid", "disabled": false }, { "key": "idempotency_key", "value": "your_api_key", "description": "Unique value generated by the client which we use to recognize from subsequent requests", "disabled": false } ] }, "description": "Endpoint to verify Payments in Monato Billpay", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{finAccessToken}}", "type": "string" } ] } }, "response": [ { "name": "200 Successfully Payment verification", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/verify-payment?payee_id=ac1e14e3-46a7-4010-b6ca-36090efc4f69&payer_account=821970704543&amount=1000¤cy=MXN&idempotency_key=your_api_key", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "verify-payment" ], "query": [ { "key": "payee_id", "value": "ac1e14e3-46a7-4010-b6ca-36090efc4f69", "description": "Monato Payee ID", "disabled": false }, { "key": "payer_account", "value": "821970704543", "description": "The payee reference to be paid", "disabled": false }, { "key": "amount", "value": "1000", "description": "The amount to be paid", "disabled": false }, { "key": "currency", "value": "MXN", "description": "Currency in which the amount is going to be paid", "disabled": false }, { "key": "idempotency_key", "value": "your_api_key", "description": "Unique value generated by the client which we use to recognize from subsequent requests", "disabled": false } ] } }, "code": 200, "status": "Successfully Payment verification", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"payment_id\": \"68af20e7-f369-4764-a9bf-508684a2caa5\",\n \"amount\": \"1000.0\",\n \"currency\": \"MXN\",\n \"payer_account\": \"821970704543\",\n \"payee_id\": \"ac1e14e3-46a7-4010-b6ca-36090efc4f69\",\n \"status\": \"completed\",\n \"metadata\": {},\n \"created_at\": \"2025-05-21T19:18:58.838Z\"\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{finBaseUrl}}/v1/verify-payment?payee_id=ac1e14e3-46a7-4010-b6ca-36090efc4f69&payer_account=821970704543&amount=1000¤cy=MXN&idempotency_key=your_api_key", "host": [ "{{finBaseUrl}}" ], "path": [ "v1", "verify-payment" ], "query": [ { "key": "payee_id", "value": "ac1e14e3-46a7-4010-b6ca-36090efc4f69", "description": "Monato Payee ID", "disabled": false }, { "key": "payer_account", "value": "821970704543", "description": "The payee reference to be paid", "disabled": false }, { "key": "amount", "value": "1000", "description": "The amount to be paid", "disabled": false }, { "key": "currency", "value": "MXN", "description": "Currency in which the amount is going to be paid", "disabled": false }, { "key": "idempotency_key", "value": "your_api_key", "description": "Unique value generated by the client which we use to recognize from subsequent requests", "disabled": false } ] } }, "code": 404, "status": "Not Found", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"error_type\": \"INTERNAL_ERROR\",\n \"error_message\": \"There was an error while processing your request\"\n}" } ] }, { "name": "List Payees", "request": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees" ], "query": [ { "key": "page", "value": "1", "description": "Page number (starts at 1).", "disabled": true }, { "key": "name", "value": "Movistar", "description": "Case-insensitive partial match on the payee display name.", "disabled": true }, { "key": "category", "value": "Telecommunications", "description": "Exact match on payee industry/category.", "disabled": true }, { "key": "connection_mode", "value": "online", "description": "Filter by integration connection mode.", "disabled": true }, { "key": "has_balance", "value": "true", "description": "Filter payees that support balance inquiry (`true`) or that do not (`false`).", "disabled": true }, { "key": "accepts_expired", "value": "false", "description": "Filter payees that allow payments on expired bills (`true`) or not (`false`).", "disabled": true } ] }, "description": "Returns a paginated list of payees in alphabetical order by display name.\n\nOptional query parameters filter the result set. When multiple filters are supplied,\n**all** of them apply together (logical **AND**).\n\n**Filters**\n\n- **name** — Case-insensitive match anywhere in the payee display name (not prefix-only).\n- **category** — Exact match on the payee industry/category.\n- **connection_mode** — How the service is connected (`online` or `batch`).\n- **has_balance** — Whether balance inquiry is supported for that payee.\n- **accepts_expired** — Whether payments on expired bills are allowed for that payee.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{finAccessToken}}", "type": "string" } ] } }, "response": [ { "name": "200 Successful response with payees", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees" ], "query": [ { "key": "page", "value": "1", "description": "Page number (starts at 1).", "disabled": true }, { "key": "name", "value": "Movistar", "description": "Case-insensitive partial match on the payee display name.", "disabled": true }, { "key": "category", "value": "Telecommunications", "description": "Exact match on payee industry/category.", "disabled": true }, { "key": "connection_mode", "value": "online", "description": "Filter by integration connection mode.", "disabled": true }, { "key": "has_balance", "value": "true", "description": "Filter payees that support balance inquiry (`true`) or that do not (`false`).", "disabled": true }, { "key": "accepts_expired", "value": "false", "description": "Filter payees that allow payments on expired bills (`true`) or not (`false`).", "disabled": true } ] } }, "code": 200, "status": "Payee list retrieved successfully.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"meta\": {\n \"current_page\": 1,\n \"next_page\": 2,\n \"prev_page\": null,\n \"total_pages\": 3,\n \"total_count\": 45\n },\n \"payees\": [\n {\n \"payee_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"AVON\",\n \"category\": \"Beauty\",\n \"type\": \"Bill\",\n \"reference_config\": {\n \"regex\": \"^[0-9]{20}$\"\n },\n \"financial_rules\": {\n \"minimum_amount\": \"0\",\n \"maximum_amount\": \"8000\",\n \"payment_type\": \"totals\",\n \"accepts_expired\": true\n },\n \"capabilities\": {\n \"has_balance\": false,\n \"connection_mode\": \"online\"\n }\n },\n {\n \"payee_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"name\": \"CFE\",\n \"category\": \"Electricity\",\n \"type\": \"Bill\",\n \"reference_config\": {\n \"regex\": \"^[0-9]{10,12}$\"\n },\n \"financial_rules\": {\n \"minimum_amount\": \"1\",\n \"maximum_amount\": \"50000\",\n \"payment_type\": \"totals\",\n \"accepts_expired\": false\n },\n \"capabilities\": {\n \"has_balance\": true,\n \"connection_mode\": \"batch\"\n }\n }\n ]\n}" }, { "name": "200 Topup payee in a list", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees" ], "query": [ { "key": "page", "value": "1", "description": "Page number (starts at 1).", "disabled": true }, { "key": "name", "value": "Movistar", "description": "Case-insensitive partial match on the payee display name.", "disabled": true }, { "key": "category", "value": "Telecommunications", "description": "Exact match on payee industry/category.", "disabled": true }, { "key": "connection_mode", "value": "online", "description": "Filter by integration connection mode.", "disabled": true }, { "key": "has_balance", "value": "true", "description": "Filter payees that support balance inquiry (`true`) or that do not (`false`).", "disabled": true }, { "key": "accepts_expired", "value": "false", "description": "Filter payees that allow payments on expired bills (`true`) or not (`false`).", "disabled": true } ] } }, "code": 200, "status": "Payee list retrieved successfully.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"meta\": {\n \"current_page\": 1,\n \"next_page\": null,\n \"prev_page\": null,\n \"total_pages\": 1,\n \"total_count\": 1\n },\n \"payees\": [\n {\n \"payee_id\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"MOVISTAR RECARGAS\",\n \"category\": \"Telephone\",\n \"type\": \"Topup\",\n \"reference_config\": {\n \"regex\": \"^[0-9]{10}$\"\n },\n \"bundles\": [\n \"10.00\",\n \"20.00\",\n \"50.00\",\n \"100.00\"\n ]\n }\n ]\n}" }, { "name": "200 Giftcard payee in a list", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees" ], "query": [ { "key": "page", "value": "1", "description": "Page number (starts at 1).", "disabled": true }, { "key": "name", "value": "Movistar", "description": "Case-insensitive partial match on the payee display name.", "disabled": true }, { "key": "category", "value": "Telecommunications", "description": "Exact match on payee industry/category.", "disabled": true }, { "key": "connection_mode", "value": "online", "description": "Filter by integration connection mode.", "disabled": true }, { "key": "has_balance", "value": "true", "description": "Filter payees that support balance inquiry (`true`) or that do not (`false`).", "disabled": true }, { "key": "accepts_expired", "value": "false", "description": "Filter payees that allow payments on expired bills (`true`) or not (`false`).", "disabled": true } ] } }, "code": 200, "status": "Payee list retrieved successfully.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"meta\": {\n \"current_page\": 1,\n \"next_page\": null,\n \"prev_page\": null,\n \"total_pages\": 1,\n \"total_count\": 1\n },\n \"payees\": [\n {\n \"payee_id\": \"1a079e9a-2bee-46e0-a993-32b714cf0c09\",\n \"name\": \"DIGITAL FRC 02: 409 CARD NOT FOUND - MEX\",\n \"category\": \"Giftcard\",\n \"type\": \"EGift\",\n \"currency\": \"MXN\",\n \"reference_config\": {\n \"regex\": null\n },\n \"images\": {\n \"small\": {\n \"id\": \"MEDIUM\",\n \"url\": \"https://content.blackhawknetwork.com/gcmimages/product/medium/YDV96K0A246SWSYB20LVLAK5AC_0911202501:56:11.PNG\"\n },\n \"large\": {\n \"id\": \"EXTRA_LARGE\",\n \"url\": \"https://content.blackhawknetwork.com/gcmimages/product/xlarge/YDV96K0A246SWSYB20LVLAK5AC_0911202501:56:11.PNG\"\n }\n },\n \"redemption_info\": \"\",\n \"price\": \"5.0\"\n }\n ]\n}" }, { "name": "200 Empty result set", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees" ], "query": [ { "key": "page", "value": "1", "description": "Page number (starts at 1).", "disabled": true }, { "key": "name", "value": "Movistar", "description": "Case-insensitive partial match on the payee display name.", "disabled": true }, { "key": "category", "value": "Telecommunications", "description": "Exact match on payee industry/category.", "disabled": true }, { "key": "connection_mode", "value": "online", "description": "Filter by integration connection mode.", "disabled": true }, { "key": "has_balance", "value": "true", "description": "Filter payees that support balance inquiry (`true`) or that do not (`false`).", "disabled": true }, { "key": "accepts_expired", "value": "false", "description": "Filter payees that allow payments on expired bills (`true`) or not (`false`).", "disabled": true } ] } }, "code": 200, "status": "Payee list retrieved successfully.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"meta\": {\n \"current_page\": 1,\n \"next_page\": null,\n \"prev_page\": null,\n \"total_pages\": 0,\n \"total_count\": 0\n },\n \"payees\": []\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees" ], "query": [ { "key": "page", "value": "1", "description": "Page number (starts at 1).", "disabled": true }, { "key": "name", "value": "Movistar", "description": "Case-insensitive partial match on the payee display name.", "disabled": true }, { "key": "category", "value": "Telecommunications", "description": "Exact match on payee industry/category.", "disabled": true }, { "key": "connection_mode", "value": "online", "description": "Filter by integration connection mode.", "disabled": true }, { "key": "has_balance", "value": "true", "description": "Filter payees that support balance inquiry (`true`) or that do not (`false`).", "disabled": true }, { "key": "accepts_expired", "value": "false", "description": "Filter payees that allow payments on expired bills (`true`) or not (`false`).", "disabled": true } ] } }, "code": 401, "status": "Unauthorized", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"errors\": [\n \"Access denied\"\n ]\n}" } ] }, { "name": "Get Payee Details", "request": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees", ":id" ], "variable": [ { "key": "id", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "description": "Unique payee identifier (UUID)." } ] }, "description": "Returns a single payee by identifier. The payload uses the same shape as items in the\nlist endpoint: **Bill** payees usually include `financial_rules` and `capabilities`;\n**Topup** payees usually include `bundles`.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{finAccessToken}}", "type": "string" } ] } }, "response": [ { "name": "200 Bill payee", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees", ":id" ], "variable": [ { "key": "id", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "description": "Unique payee identifier (UUID)." } ] } }, "code": 200, "status": "Payee details retrieved successfully.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"payee_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"AVON\",\n \"category\": \"Beauty\",\n \"type\": \"Bill\",\n \"reference_config\": {\n \"regex\": \"^[0-9]{20}$\"\n },\n \"financial_rules\": {\n \"minimum_amount\": \"0\",\n \"maximum_amount\": \"8000\",\n \"payment_type\": \"totals\",\n \"accepts_expired\": true\n },\n \"capabilities\": {\n \"has_balance\": false,\n \"connection_mode\": \"online\"\n }\n}" }, { "name": "200 Topup payee", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees", ":id" ], "variable": [ { "key": "id", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "description": "Unique payee identifier (UUID)." } ] } }, "code": 200, "status": "Payee details retrieved successfully.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"payee_id\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"MOVISTAR RECARGAS\",\n \"category\": \"Telephone\",\n \"type\": \"Topup\",\n \"reference_config\": {\n \"regex\": \"^[0-9]{10}$\"\n },\n \"bundles\": [\n \"10.00\",\n \"20.00\",\n \"30.00\",\n \"50.00\",\n \"100.00\"\n ]\n}" }, { "name": "200 Giftcard payee", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees", ":id" ], "variable": [ { "key": "id", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "description": "Unique payee identifier (UUID)." } ] } }, "code": 200, "status": "Payee details retrieved successfully.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"payee_id\": \"1a079e9a-2bee-46e0-a993-32b714cf0c09\",\n \"name\": \"DIGITAL FRC 02: 409 CARD NOT FOUND - MEX\",\n \"category\": \"Giftcard\",\n \"type\": \"EGift\",\n \"currency\": \"MXN\",\n \"reference_config\": {\n \"regex\": null\n },\n \"images\": {\n \"small\": {\n \"id\": \"MEDIUM\",\n \"url\": \"https://content.blackhawknetwork.com/gcmimages/product/medium/YDV96K0A246SWSYB20LVLAK5AC_0911202501:56:11.PNG\"\n },\n \"large\": {\n \"id\": \"EXTRA_LARGE\",\n \"url\": \"https://content.blackhawknetwork.com/gcmimages/product/xlarge/YDV96K0A246SWSYB20LVLAK5AC_0911202501:56:11.PNG\"\n }\n },\n \"redemption_info\": \"\",\n \"price\": \"5.0\"\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees", ":id" ], "variable": [ { "key": "id", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "description": "Unique payee identifier (UUID)." } ] } }, "code": 401, "status": "Unauthorized", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"errors\": [\n \"Access denied\"\n ]\n}" }, { "name": "404 Payee not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{finBaseUrl}}/api/v1/payees/:id", "host": [ "{{finBaseUrl}}" ], "path": [ "api", "v1", "payees", ":id" ], "variable": [ { "key": "id", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "description": "Unique payee identifier (UUID)." } ] } }, "code": 404, "status": "Payee not found", "header": [ { "key": "Content-Type", "value": "application/json" } ], "_postman_previewlanguage": "json", "body": "{\n \"error\": \"Couldn't find Payee with 'id'=00000000-0000-0000-0000-000000000000\"\n}" } ] } ] }