{
    "info": {
        "name": "Payzoff Payment Gateway API",
        "description": "Payzoff Payment Gateway API enables merchants to integrate payment processing, payouts, refunds, and transaction management into their systems.",
        "_postman_id": "f0a3667b-84a8-418b-39b9-3901b948203d",
        "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
    },
    "auth": {
        "type": "apikey",
        "apikey": [
            {
                "key": "key",
                "value": "X-Api-Key",
                "type": "string"
            },
            {
                "key": "value",
                "value": "{{api_key}}",
                "type": "string"
            },
            {
                "key": "in",
                "value": "header",
                "type": "string"
            }
        ]
    },
    "variable": [
        {
            "key": "base_url",
            "value": "https://www.payzoff.com"
        },
        {
            "key": "api_key",
            "value": ""
        },
        {
            "key": "signature_key",
            "value": ""
        },
        {
            "key": "api_version",
            "value": "1.7.1"
        }
    ],
    "item": [
        {
            "name": "Deposits",
            "item": [
                {
                    "name": "Create Deposit Transaction",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{base_url}}/api/payment",
                            "host": [
                                "{{base_url}}"
                            ],
                            "path": [
                                "api",
                                "payment"
                            ]
                        },
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"api_key\": \"A8J017C7286E2604C7A349B1D71D0200\",\n    \"action\": \"payment\",\n    \"amount\": \"100.00\",\n    \"currency\": \"EUR\",\n    \"seller_transaction_id\": \"504818687\",\n    \"signature\": \"f350f7da9580a8610488c7c608332ec3\",\n    \"description\": \"Payment for services\",\n    \"return_url\": \"https://billing.domain.com/payment-redirect/success\",\n    \"result_url\": \"https://billing.domain.com/status/?gate_id=218\",\n    \"fail_url\": \"https://billing.domain.com/payment-redirect/failed\",\n    \"name\": \"John Doe\",\n    \"method\": \"1010\",\n    \"country\": \"de\",\n    \"transaction_mode\": \"1\",\n    \"customer_id\": \"586R78G\",\n    \"api_version\": \"1.7.1\"\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    },
                    "response": [
                        {
                            "name": "Successful payment creation",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"ok\",\n    \"response_code\": 0,\n    \"result\": {\n        \"secret_code\": \"cdxbdjnGRv33LkLbtc0pN0qqVAM7xmtzzlNXGAwf\",\n        \"transaction_id\": \"8439901933860\",\n        \"redirect_url\": \"https://www.payzoff.com/payment/confirm/8439901933860\"\n    },\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        },
                        {
                            "name": "Validation error",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"fail\",\n    \"response_code\": 4,\n    \"result\": \"No Amount\",\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        },
                        {
                            "name": "Validation error after the transaction was created",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"fail\",\n    \"response_code\": 13,\n    \"result\": \"no_country\",\n    \"response_number\": \"8439901933860\",\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Status",
            "item": [
                {
                    "name": "Check Transaction Status",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{base_url}}/api/get_tx_status",
                            "host": [
                                "{{base_url}}"
                            ],
                            "path": [
                                "api",
                                "get_tx_status"
                            ]
                        },
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"api_key\": \"A8CF017C7286E2603C7A349B1D71D030\",\n    \"action\": \"get_tx_status\",\n    \"transaction_id\": \"1234567898\",\n    \"api_version\": \"1.7.1\"\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    },
                    "response": [
                        {
                            "name": "Transaction found",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"ok\",\n    \"response_code\": 0,\n    \"result\": {\n        \"transaction_id\": \"11212121212\",\n        \"seller_transaction_id\": \"38207372\",\n        \"amount\": \"4.99\",\n        \"currency\": \"USD\",\n        \"transaction_status\": \"Complete\",\n        \"tran_status_code\": \"0012\"\n    },\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        },
                        {
                            "name": "Transaction not found",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"fail\",\n    \"response_code\": 100,\n    \"result\": \"Transaction not found\",\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        },
                        {
                            "name": "Validation error",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"fail\",\n    \"response_code\": 13,\n    \"result\": \"no_transaction_id\",\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Payouts",
            "item": [
                {
                    "name": "Bank Transfer Payout",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{base_url}}/api/payout",
                            "host": [
                                "{{base_url}}"
                            ],
                            "path": [
                                "api",
                                "payout"
                            ]
                        },
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"api_key\": \"D78CD7DAF172B2F1B55E19D9DDCE6514\",\n    \"action\": \"payout\",\n    \"amount\": \"50.00\",\n    \"currency\": \"EUR\",\n    \"seller_transaction_id\": \"PAYOUT-12345\",\n    \"signature\": \"\",\n    \"description\": \"Payout for services\",\n    \"result_url\": \"https://merchant.example.com/payout/callback\",\n    \"name\": \"John Doe\",\n    \"method\": \"1580\",\n    \"country\": \"de\",\n    \"customer_id\": \"4G8751F\",\n    \"transaction_mode\": \"0\",\n    \"provider\": \"\",\n    \"api_version\": \"1.7.1\",\n    \"iban\": \"DE91100000000123456789\",\n    \"bic\": \"DEUTDEFF\",\n    \"email\": \"\",\n    \"acc_name\": \"DepositAccountName\",\n    \"acc_number\": \"12345678\",\n    \"province\": \"Bali\",\n    \"city\": \"Denpasar\"\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    },
                    "response": [
                        {
                            "name": "Payout executed",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"ok\",\n    \"response_code\": 0,\n    \"result\": {\n        \"payout_status\": \"success\",\n        \"tran_status_code\": \"0021\",\n        \"transaction_id\": \"1234567898\",\n        \"callback\": 0\n    },\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        },
                        {
                            "name": "Validation error",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"fail\",\n    \"response_code\": 13,\n    \"result\": \"no_method\",\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        },
                        {
                            "name": "Error after the payout transaction was created",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"fail\",\n    \"response_code\": 13,\n    \"result\": \"Method unavailable\",\n    \"response_number\": \"1234567898\",\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        },
                        {
                            "name": "Internal error on the payout path",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"fail\",\n    \"response_code\": 999,\n    \"result\": \"internal error\",\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Refunds",
            "item": [
                {
                    "name": "Refund Transaction",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{base_url}}/api/refund",
                            "host": [
                                "{{base_url}}"
                            ],
                            "path": [
                                "api",
                                "refund"
                            ]
                        },
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"api_key\": \"D78CD7DAF172B2F1B55E19D9DDCE6514\",\n    \"action\": \"refund\",\n    \"amount\": \"12.23\",\n    \"currency\": \"USD\",\n    \"payzoff_transaction_id\": \"123433434\",\n    \"signature\": \"\",\n    \"api_version\": \"1.7.1\"\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    },
                    "response": [
                        {
                            "name": "Refund successful",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"ok\",\n    \"response_code\": 0,\n    \"result\": {\n        \"refund_status\": \"success\",\n        \"tran_status_code\": \"0015\",\n        \"ref_id\": \"4586\"\n    },\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        },
                        {
                            "name": "Validation error",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"fail\",\n    \"response_code\": 13,\n    \"result\": \"Invalid Payment Method\",\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        },
                        {
                            "name": "Operational error",
                            "originalRequest": null,
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                },
                                {
                                    "key": "X-Trace-Id",
                                    "value": "018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10"
                                }
                            ],
                            "body": "{\n    \"status\": \"fail\",\n    \"response_code\": 500,\n    \"result\": \"Invalid Transaction\",\n    \"trace_id\": \"018eebf2-7c3e-7a95-8f3d-0ef93a3e5f10\"\n}"
                        }
                    ]
                }
            ]
        }
    ]
}