v1

latestOpenAPI 3.0.02026-07-246335313.6 KB

Payment APIs

Add PSP Credentials

Add the credentials of Payment Channel in PortOne. In response you'll get the maskedData of the credentials.

post/api/merchant/{key}/add-pay-channel/{pckey}

Path parameters

keystring required

pckeystring required

Headers

X-Portone-Client-Keystring

Authorizationstring

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token <a href="/docs/jwt-authentication" target="_blank">in this guide</a>

Request body

credsobject required

The credentials JSON consisting of the data required by PSP

countrystring required

The country of the PSP. e.g. - GLOBAL, VN, TH, ID

environment'live' | 'sandbox' required

The environment of the transaction is either live OR sandbox

Example request

{
  "creds": {
    "accessKey": "TestKey",
    "partnerCode": "TestCode",
    "secretKey": "TestSecretKey"
  },
  "country": "VN",
  "environment": "sandbox"
}

Response

Successful response

messagestring

The description of the API request execution result

status_codestring

The status_code for API request execution result

status_reasonstring

The status_reason for API request execution result