API Reference
Go to payrails.com

Create an instrument

post
https://api.staging.payrails.io/payment/instruments

Create a payment instrument.

Body Params
uuid

Unique identifier of the Holder in Payrails. At least one of holderId or holderReference values have to be provided in the request.

string

Merchant-provided reference for the transaction counterparty, i.e. the paying consumer. At least one of holderReference or holderId values have to be provided in the request.

string
enum
required

Represents the payment method type.

Allowed:
string
enum

Represents the future usage to define the payment flows that the stored instrument will be used for.

Allowed:
string

Human-friendly description of the Instrument.

string

Merchant-provided reference for the instrument.

string

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

boolean

True if the holder wants to store the instrument for future use when payment is completed.

boolean | null

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

boolean

True if the merchant wants to provision a network token for this instrument.

data

Type-specific information about the instrument.

token
object | null

Token-specific information about the instrument. Required when creating an instrument from a tokenization tool like the Payrails SDK.

encryptedDataAttributes
object

Additional attributes for the instrument tokenization.

Headers
uuid
required

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

Responses

Updated 4 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Choose an example:
application/json

Updated 4 days ago