Ponto API.postman_collection.json

{
	"info": {
		"_postman_id": "efd2e987-a334-4345-a124-355c2291f168",
		"name": "Ponto API",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "1. Authorization",
			"item": [
				{
					"name": "1. Access Token",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"var jsonData = JSON.parse(responseBody);",
									"pm.environment.set(\"ponto-access-token\", jsonData.access_token);"
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"auth": {
							"type": "basic",
							"basic": [
								{
									"key": "password",
									"value": "{{ponto-client-secret}}",
									"type": "string"
								},
								{
									"key": "username",
									"value": "{{ponto-client-id}}",
									"type": "string"
								}
							]
						},
						"method": "POST",
						"header": [],
						"body": {
							"mode": "urlencoded",
							"urlencoded": [
								{
									"key": "grant_type",
									"value": "client_credentials",
									"type": "default"
								}
							]
						},
						"url": {
							"raw": "https://{{ponto-hostname}}/oauth2/token",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"oauth2",
								"token"
							]
						}
					},
					"response": []
				}
			]
		},
		{
			"name": "2. Financial Institutions",
			"item": [
				{
					"name": "2.1: List Financial Institutions",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"var jsonData = JSON.parse(responseBody);",
									"pm.environment.set(\"ponto-financial-institution-id\", jsonData.data[0].id);"
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/financial-institutions",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"financial-institutions"
							]
						}
					},
					"response": []
				},
				{
					"name": "2.2: Get Financial Institution",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									""
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/financial-institutions/{{ponto-financial-institution-id}}",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"financial-institutions",
								"{{ponto-financial-institution-id}}"
							]
						}
					},
					"response": []
				}
			]
		},
		{
			"name": "3. Sandbox",
			"item": [
				{
					"name": "3.1: List Sandbox Financial Institutions",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"var jsonData = JSON.parse(responseBody);",
									"pm.environment.set(\"ponto-sandbox-financial-institution-id\", jsonData.data[0].id);"
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/sandbox/financial-institutions",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"sandbox",
								"financial-institutions"
							]
						}
					},
					"response": []
				},
				{
					"name": "3.2: Get Sandbox Financial Institution",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"var jsonData = JSON.parse(responseBody);",
									"pm.environment.set(\"ponto-financial-institution-id\", jsonData.data[0].id);"
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/sandbox/financial-institutions/{{ponto-sandbox-financial-institution-id}}",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"sandbox",
								"financial-institutions",
								"{{ponto-sandbox-financial-institution-id}}"
							]
						}
					},
					"response": []
				}
			]
		},
		{
			"name": "4. Accounts and Transactions",
			"item": [
				{
					"name": "4.1: List Accounts",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"var jsonData = JSON.parse(responseBody);",
									"pm.environment.set(\"ponto-account-id\", jsonData.data[0].id);"
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/accounts",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"accounts"
							]
						}
					},
					"response": []
				},
				{
					"name": "4.2: Get Account",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									""
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/accounts/{{ponto-account-id}}",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"accounts",
								"{{ponto-account-id}}"
							]
						}
					},
					"response": []
				},
				{
					"name": "4.3: List Transactions",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"var jsonData = JSON.parse(responseBody);",
									"pm.environment.set(\"ponto-transaction-id\", jsonData.data[0].id);"
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/accounts/{{ponto-account-id}}/transactions",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"accounts",
								"{{ponto-account-id}}",
								"transactions"
							]
						}
					},
					"response": []
				},
				{
					"name": "4.4: Get Transaction",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									""
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/accounts/{{ponto-account-id}}/transactions/{{ponto-transaction-id}}",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"accounts",
								"{{ponto-account-id}}",
								"transactions",
								"{{ponto-transaction-id}}"
							]
						}
					},
					"response": []
				},
				{
					"name": "4.4: List Updated Transactions for Synchronization",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"var jsonData = JSON.parse(responseBody);",
									"pm.environment.set(\"ponto-transaction-id\", jsonData.data[0].id);"
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/synchronizations/{{ponto-synchronization-id}}/updated-transactions",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"synchronizations",
								"{{ponto-synchronization-id}}",
								"updated-transactions"
							]
						}
					},
					"response": []
				}
			]
		},
		{
			"name": "5. Synchronizations",
			"item": [
				{
					"name": "5.1: Create Synchronization",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"var jsonData = JSON.parse(responseBody);",
									"pm.environment.set(\"ponto-synchronization-id\", jsonData.data.id);",
									""
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "POST",
						"header": [],
						"body": {
							"mode": "raw",
							"raw": "{\n  \"data\": {\n    \"type\": \"synchronization\",\n    \"attributes\": {\n      \"resourceType\": \"account\",\n      \"resourceId\": \"{{ponto-account-id}}\",\n      \"subtype\": \"accountTransactions\",\n      \"customerIpAddress\": \"1.2.3.4\"\n    }\n  }\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": {
							"raw": "https://{{ponto-hostname}}/synchronizations",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"synchronizations"
							]
						}
					},
					"response": []
				},
				{
					"name": "5.2: Get Synchronization",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									""
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/synchronizations/{{ponto-synchronization-id}}",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"synchronizations",
								"{{ponto-synchronization-id}}"
							]
						}
					},
					"response": []
				}
			]
		},
		{
			"name": "6. Payment",
			"item": [
				{
					"name": "6.1: Create Payment",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"var jsonData = JSON.parse(responseBody);",
									"pm.environment.set(\"ponto-payment-id\", jsonData.data.id);",
									""
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "POST",
						"header": [],
						"body": {
							"mode": "raw",
							"raw": "{\n  \"data\": {\n    \"type\": \"synchronization\",\n    \"attributes\": {\n      \"remittanceInformation\": \"payment\",\n      \"remittanceInformationType\": \"unstructured\",\n      \"requestedExecutionDate\": \"2024-02-05\",\n      \"currency\": \"EUR\",\n      \"amount\": 0.01,\n      \"creditorName\": \"Alex Creditor\",\n      \"creditorAccountReference\": \"BE55732022998044\",\n      \"creditorAccountReferenceType\": \"IBAN\",\n      \"creditorAgent\": \"NBBEBEBB203\",\n      \"creditorAgentType\": \"BIC\",\n      \"redirectUri\": \"https://fake-tpp.com/payment-confirmation?payment=123\"\n    }\n  }\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": {
							"raw": "https://{{ponto-hostname}}/accounts/{{ponto-account-id}}/payments",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"accounts",
								"{{ponto-account-id}}",
								"payments"
							]
						}
					},
					"response": []
				},
				{
					"name": "6.2: Get Payment",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									""
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/accounts/{{ponto-account-id}}/payments/{{ponto-payment-id}}",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"accounts",
								"{{ponto-account-id}}",
								"payments",
								"{{ponto-payment-id}}"
							]
						}
					},
					"response": []
				},
				{
					"name": "6.3: Delete Payment",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									""
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "DELETE",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/accounts/{{ponto-account-id}}/payments/{{ponto-payment-id}}",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"accounts",
								"{{ponto-account-id}}",
								"payments",
								"{{ponto-payment-id}}"
							]
						}
					},
					"response": []
				}
			]
		},
		{
			"name": "7. Bulk Payment",
			"item": [
				{
					"name": "7.1: Create Bulk Payment",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"var jsonData = JSON.parse(responseBody);",
									"pm.environment.set(\"ponto-bulk-payment-id\", jsonData.data.id);",
									""
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "POST",
						"header": [],
						"body": {
							"mode": "raw",
							"raw": "{\n  \"data\": {\n    \"type\": \"synchronization\",\n    \"attributes\": {\n      \"reference\": \"Invoice Payments\",\n      \"redirectUri\": \"https://fake-tpp.com/payment-confirmation?payment=123\",\n      \"requestedExecutionDate\": \"2024-02-05\",\n      \"batchBookingPreferred\": true,\n      \"payments\": [\n        {\n          \"remittanceInformation\": \"payment 1\",\n          \"remittanceInformationType\": \"unstructured\",\n          \"currency\": \"EUR\",\n          \"amount\": 0.01,\n          \"creditorName\": \"Alex Creditor\",\n          \"creditorAccountReference\": \"BE55732022998044\",\n          \"creditorAccountReferenceType\": \"IBAN\",\n          \"creditorAgent\": \"NBBEBEBB203\",\n          \"creditorAgentType\": \"BIC\"\n        },\n        {\n          \"remittanceInformation\": \"payment 2\",\n          \"remittanceInformationType\": \"unstructured\",\n          \"currency\": \"EUR\",\n          \"amount\": 0.02,\n          \"creditorName\": \"Pat Smith\",\n          \"creditorAccountReference\": \"BE73055155935764\",\n          \"creditorAccountReferenceType\": \"IBAN\",\n          \"creditorAgent\": \"NBBEBEBB203\",\n          \"creditorAgentType\": \"BIC\"\n        }\n      ]\n    }\n  }\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": {
							"raw": "https://{{ponto-hostname}}/accounts/{{ponto-account-id}}/bulk-payments",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"accounts",
								"{{ponto-account-id}}",
								"bulk-payments"
							]
						}
					},
					"response": []
				},
				{
					"name": "7.2: Get Bulk Payment",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									""
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/accounts/{{ponto-account-id}}/bulk-payments/{{ponto-bulk-payment-id}}",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"accounts",
								"{{ponto-account-id}}",
								"bulk-payments",
								"{{ponto-bulk-payment-id}}"
							]
						}
					},
					"response": []
				},
				{
					"name": "7.3: Delete Bulk Payment",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									""
								],
								"type": "text/javascript"
							}
						}
					],
					"request": {
						"method": "DELETE",
						"header": [],
						"url": {
							"raw": "https://{{ponto-hostname}}/accounts/{{ponto-account-id}}/bulk-payments/{{ponto-bulk-payment-id}}",
							"protocol": "https",
							"host": [
								"{{ponto-hostname}}"
							],
							"path": [
								"accounts",
								"{{ponto-account-id}}",
								"bulk-payments",
								"{{ponto-bulk-payment-id}}"
							]
						}
					},
					"response": []
				}
			]
		}
	],
	"auth": {
		"type": "bearer",
		"bearer": [
			{
				"key": "token",
				"value": "{{ponto-access-token}}",
				"type": "string"
			}
		]
	},
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		}
	]
}