Create Authentication Token

API Version: 3.0.0

Generate an API key for Payouts by navigating to Payouts → API Keys → Add new API key.

This token is required for all subsequent Payout API calls. Ensure you store it securely and refresh it before expiration.

Payout APIs are live-only. Test/sandbox API keys are rejected with code E0402.

Endpoint

Method	URL
GET	`https://payout.payorc.com/v1/token`

Headers

Header	Type	Required	Description
`merchant-key`	String	Yes	Your merchant key (e.g., `live-PYOOZ10UEW28S7`)
`merchant-secret`	String	Yes	Your merchant secret (e.g., `sec-CJ10EFH281M`)

Code Examples

curl -X GET "https://payout.payorc.com/v1/token" \
-H "merchant-key: {{payout-key}}" \
-H "merchant-secret: {{payout-secret}}"

Response — Success (200)

{
    "data": {
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    },
    "message": "Token generated successfully",
    "status": "success",
    "code": "00"
}

Response Fields

Field	Type	Description
`data`	Object	Contains token data
`data.token`	String	JWT Bearer token (valid for 24 hours)
`message`	String	`Token generated successfully`
`status`	String	`success`
`code`	String	`00`

Response — Error (4xx)

{
    "message": "Invalid credentials",
    "status": "fail",
    "code": "E0401"
}

Common Error Codes

Code	Meaning
`E0401`	Invalid `merchant-key` or `merchant-secret`
`E0402`	Test API key not allowed (live only)
`E0403`	Inactive API key
`E0404`	Deleted API key
`E0001`	Missing required headers

Create Authentication Token

On this page