{
  "info": {
    "name": "PayStar API — profile-specific templates",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "description": "Integration templates. Choose one assigned profile and test-mode key. Empty credentials and placeholder card values must not be sent. Owner-provided ECOM examples are sanitized templates, not runnable payment fixtures or approved full schemas. Keep all secrets, PAN/CVV and one-time URLs out of saved collections, environments, exports, sync and logs. P2P and ECOM H2H share POST https://secure.paystar.uk/api/v1/integration/deposit-order/. They are distinct flow/profile variants: use the credentials, request body and response handling assigned to the selected profile. The P2P example is not an ECOM request template."
  },
  "item": [
    {
      "name": "Create P2P Deposit",
      "request": {
        "method": "POST",
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{p2pToken}}",
              "type": "string"
            }
          ]
        },
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": "https://secure.paystar.uk/api/v1/integration/deposit-order/",
        "description": "Template only. Confirm the exact profile, test mode and required fields. Do not retry an unresolved create with a new ID. P2P and ECOM H2H share POST https://secure.paystar.uk/api/v1/integration/deposit-order/. They are distinct flow/profile variants: use the credentials, request body and response handling assigned to the selected profile. The P2P example is not an ECOM request template.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"amount\": 100.00,\n  \"currency\": \"RUB\",\n  \"externalTransactionId\": \"{{merchantOrderId}}\",\n  \"callbackUrl\": \"https://merchant.example/paystar/callback\",\n  \"processingRedirectUrl\": \"https://merchant.example/payment/processing\",\n  \"failedRedirectUrl\": \"https://merchant.example/payment/failed\",\n  \"successRedirectUrl\": \"https://merchant.example/payment/success\",\n  \"additionalFields\": [\n    {\n      \"key\": \"payeerIdentifier\",\n      \"value\": \"Merch-Customer-12345\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Create ECOM H2H Deposit — owner-provided template",
      "request": {
        "method": "POST",
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{ecomToken}}",
              "type": "string"
            }
          ]
        },
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json; charset=utf-8"
          }
        ],
        "url": "https://secure.paystar.uk/api/v1/integration/deposit-order",
        "description": "Integration templates. Choose one assigned profile and test-mode key. Empty credentials and placeholder card values must not be sent. Owner-provided ECOM examples are sanitized templates, not runnable payment fixtures or approved full schemas. Keep all secrets, PAN/CVV and one-time URLs out of saved collections, environments, exports, sync and logs. P2P and ECOM H2H share POST https://secure.paystar.uk/api/v1/integration/deposit-order/. They are distinct flow/profile variants: use the credentials, request body and response handling assigned to the selected profile. The P2P example is not an ECOM request template. The H2H owner example uses the secure host without a final slash; this does not establish redirect or alias behavior. Card expiration strings are illustrative, not universal format constraints. Use a unique merchantOrderId for each create; it is used directly as externalTransactionId. Retain it after an uncertain response. For status, set depositStatusToken to the credential assigned to that order. Do not run the whole collection or send unresolved placeholders. Request/response examples: https://paystar.uk/api/deposits#ecom-h2h-owner-example",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"amount\": 20.00,\n  \"currency\": \"AZN\",\n  \"externalTransactionId\": \"{{merchantOrderId}}\",\n  \"failedRedirectUrl\": \"https://merchant.example/failed\",\n  \"processingRedirectUrl\": \"https://merchant.example/processing\",\n  \"successRedirectUrl\": \"https://merchant.example/success\",\n  \"callbackUrl\": \"https://merchant.example/callback\",\n  \"additionalFields\": [\n    {\n      \"key\": \"PayeerIdentifier\",\n      \"value\": \"MERCHANT_CUSTOMER_ID\"\n    },\n    {\n      \"key\": \"CardNumber\",\n      \"value\": \"<APPROVED_CARD_NUMBER>\"\n    },\n    {\n      \"key\": \"CardExpireYear\",\n      \"value\": \"30\"\n    },\n    {\n      \"key\": \"CardExpireMonth\",\n      \"value\": \"06\"\n    },\n    {\n      \"key\": \"CardCvv\",\n      \"value\": \"<APPROVED_CARD_CVV>\"\n    },\n    {\n      \"key\": \"CardHolder\",\n      \"value\": \"<CARDHOLDER_NAME>\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Create ECOM H2C Deposit — owner-provided template",
      "request": {
        "method": "POST",
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{ecomH2cToken}}",
              "type": "string"
            }
          ]
        },
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json; charset=utf-8"
          }
        ],
        "url": "https://init.paystar.uk/api/v1/integration/deposit-order/",
        "description": "Integration templates. Choose one assigned profile and test-mode key. Empty credentials and placeholder card values must not be sent. Owner-provided ECOM examples are sanitized templates, not runnable payment fixtures or approved full schemas. Keep all secrets, PAN/CVV and one-time URLs out of saved collections, environments, exports, sync and logs. P2P and ECOM H2H share POST https://secure.paystar.uk/api/v1/integration/deposit-order/. They are distinct flow/profile variants: use the credentials, request body and response handling assigned to the selected profile. The P2P example is not an ECOM request template. The ECOM H2C owner example uses its own init-host profile and ecomH2cToken; the older FirstName profile template is retained separately. Use a unique merchantOrderId for each create; it is used directly as externalTransactionId. Retain it after an uncertain response. For status, set depositStatusToken to the credential assigned to that order. Do not run the whole collection or send unresolved placeholders. Request/response examples: https://paystar.uk/api/deposits#ecom-h2c-owner-example",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"amount\": 50.00,\n  \"currency\": \"AZN\",\n  \"externalTransactionId\": \"{{merchantOrderId}}\",\n  \"failedRedirectUrl\": \"https://merchant.example/failed\",\n  \"processingRedirectUrl\": \"https://merchant.example/processing\",\n  \"successRedirectUrl\": \"https://merchant.example/success\",\n  \"callbackUrl\": \"https://merchant.example/callback\",\n  \"additionalFields\": [\n    {\n      \"key\": \"PayeerIdentifier\",\n      \"value\": \"MERCHANT_CUSTOMER_ID\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Create Hosted H2C Deposit — illustrative configured firstName",
      "request": {
        "method": "POST",
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{h2cToken}}",
              "type": "string"
            }
          ]
        },
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": "https://init.paystar.uk/api/v1/integration/deposit-order/",
        "description": "Template only. Confirm the exact profile, test mode and required fields. Do not retry an unresolved create with a new ID.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"amount\": 100.00,\n  \"currency\": \"USD\",\n  \"externalTransactionId\": \"{{merchantOrderId}}\",\n  \"additionalFields\": [\n    {\n      \"key\": \"firstName\",\n      \"value\": \"Example\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Create Tokenized Deposit — onboarding pending",
      "request": {
        "method": "POST",
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{tokenizedToken}}",
              "type": "string"
            }
          ]
        },
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": "https://token.paystar.uk/api/v1/integration/deposit-order/",
        "description": "Template only. Confirm the exact profile, test mode and required fields. Do not retry an unresolved create with a new ID.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"amount\": 100.00,\n  \"currency\": \"USD\",\n  \"externalTransactionId\": \"{{merchantOrderId}}\",\n  \"additionalFields\": [\n    {\n      \"key\": \"cardStorageToken\",\n      \"value\": \"<APPROVED_STORED_TOKEN>\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Get Deposit Status by merchant ID",
      "request": {
        "method": "GET",
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{depositStatusToken}}",
              "type": "string"
            }
          ]
        },
        "header": [],
        "url": "https://secure.paystar.uk/api/v1/integration/deposit-order/{{merchantOrderId}}/status-by-external-transaction-id",
        "description": "Template only. Confirm the exact profile, test mode and required fields. Do not retry an unresolved create with a new ID."
      }
    },
    {
      "name": "Get Deposit Status by PayStar ID",
      "request": {
        "method": "GET",
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{depositStatusToken}}",
              "type": "string"
            }
          ]
        },
        "header": [],
        "url": "https://secure.paystar.uk/api/v1/integration/deposit-order/{{paystarOrderId}}/status",
        "description": "Template only. Confirm the exact profile, test mode and required fields. Do not retry an unresolved create with a new ID."
      }
    },
    {
      "name": "Get Payout Status by merchant ID",
      "request": {
        "method": "GET",
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{payoutToken}}",
              "type": "string"
            }
          ]
        },
        "header": [],
        "url": "https://secure.paystar.uk/api/v1/integration/withdrawal-order/{{merchantOrderId}}/status-by-external-transaction-id",
        "description": "Template only. Confirm the exact profile, test mode and required fields. Do not retry an unresolved create with a new ID."
      }
    },
    {
      "name": "Get Payout Status by PayStar ID",
      "request": {
        "method": "GET",
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{payoutToken}}",
              "type": "string"
            }
          ]
        },
        "header": [],
        "url": "https://secure.paystar.uk/api/v1/integration/withdrawal-order/{{paystarOrderId}}/status",
        "description": "Template only. Confirm the exact profile, test mode and required fields. Do not retry an unresolved create with a new ID."
      }
    },
    {
      "name": "Get Merchant Balance",
      "request": {
        "method": "GET",
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{balanceToken}}",
              "type": "string"
            }
          ]
        },
        "header": [],
        "url": "https://secure.paystar.uk/api/v1/balance/merchant?currency={{currency}}",
        "description": "Template only. Confirm the exact profile, test mode and required fields. Do not retry an unresolved create with a new ID."
      }
    },
    {
      "name": "Create Payout — approved destination fixture required",
      "request": {
        "method": "POST",
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{payoutToken}}",
              "type": "string"
            }
          ]
        },
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": "https://secure.paystar.uk/api/v1/integration/withdrawal-order/",
        "description": "Template only. Confirm the exact profile, test mode and required fields. Do not retry an unresolved create with a new ID.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"amount\": 100.00,\n  \"currency\": \"RUB\",\n  \"externalTransactionId\": \"{{merchantOrderId}}\",\n  \"additionalFields\": [\n    {\n      \"key\": \"cardNumber\",\n      \"value\": \"<APPROVED_TEST_FIXTURE>\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    }
  ]
}