Set ATM Pin for Payment Instrument

put

https://example.com/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}

Set and Reset an ATM Pin This endpoint gives the partner the ability to update the ATM pin data of a payment instrument.

Path Params

programCode

string

required

The program code associated with the account.

accountIdentifier

string

required

Unique identifier (UID or GUID) for the account.

paymentInstrumentIdentifier

string

required

Unique identifier (UID or GUID) for the payment instrument.

Body Params

The request object containing the encrypted PIN and related data.

encryptedPin

object

Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.

channel

string | null

enum

The channel through which the PIN set request is initiated (e.g., IVR, Mobile, Web).

Allowed:

Headers

X-GD-RequestId

string

required

A unique identifier for tracking the request, provided in the X-GD-RequestId header.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

text/json

200OK

403Forbidden

500Internal Server Error

503Service Unavailable