Update an instrument

patch

https://api.staging.payrails.io/payment/instruments/{instrumentId}

Update an instrument.

Path Params

instrumentId

uuid

required

Identifier of the resource in Payrails.

Body Params

status

string

enum

New status of the Instrument. If you want to change to "deleted", you should use the DELETE endpoint instead. Also, note that some status are internal and cannot be changed via API, e.g. transient, etc. Status update requests can also be rejected if an instrument status cannot be changed to the desired one, e.g. deleted instruments.

Allowed:

networkTransactionReference

string

Identifier of the initial payment made with this instrument on the Networks, e.g. Mastercard Trace ID or Visa Transaction ID.

merchantReference

string

Merchant-provided reference for the instrument.

paymentMethod

string

enum

New payment method of the instrument. Only the methods supporting instruments are accepted.

Allowed:

default

boolean | null

True if the holder wants to make this instrument as default.

Headers

x-idempotency-key

uuid

required

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

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Choose an example:

application/json

200Success.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

404Not Found.

429Too Many Requests.