PApayrails
Instruments

Provision a Network Token

Provision a network token for a given payment instrument.

post/payment/instruments/{instrumentId}/provisionNetworkToken

Request

Path parameters

instrumentIdstring uuid required

Identifier of the resource in Payrails.

Headers

x-idempotency-keystring uuid required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Request body

providerConfigIdstring uuid

Optional. The ID of the network token provider config to use for provisioning. When provided, the network token will be provisioned using the specified provider config. When omitted, the default network token provider config is used.

Example request

{
  "providerConfigId": "11111111-1111-1111-1111-111111111111"
}

Response

Success.

successboolean

Whether or not a network token was successfully provisioned.

resultstring

Result of the operation according to Payrails mapping from the provider response.

resultDetailstring

Additional details of the operation result according to Payrails mapping from the provider response.

errorsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.