Skip to main content
POST
/
v1
/
issuing
/
cards
/
pin
Reset Card PIN
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/issuing/cards/pin \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "card_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
  "pin": "123456"
}
'
{
  "request_status": "SUCCESS"
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

​
x-idempotency-key
string<uuid>
required

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Body

application/json
​
card_id
string<uuid>
required

Unique identifier for card.

Example:

"5135e6cc-28b6-4889-81dc-3b86a09e1395"

​
pin
string
required

New PIN for the card, must be a 6-digit numeric value.

Example:

"123456"

Response

Set card pin successfully.

​
request_status
enum<string>
required

Request status.

Available options:
SUCCESS