Copy PageCreate an instrumentpost https://api.staging.payrails.io/payment/instrumentsCreate a payment instrument.Body ParamsholderIduuidUnique identifier of the Holder in Payrails. At least one of holderId or holderReference values have to be provided in the request.holderReferencestringMerchant-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.paymentMethodstringenumrequiredRepresents the payment method type.googlePayapplePaycardpayPalbankAccountiDealbancontactAllowed:googlePayapplePaycardpayPalbankAccountiDealbancontactfutureUsagestringenumRepresents the future usage to define the payment flows that the stored instrument will be used for.CardOnFileSubscriptionCardOnFileUnscheduledCardOnFileAllowed:SubscriptionCardOnFileUnscheduledCardOnFiledescriptionstringHuman-friendly description of the Instrument.merchantReferencestringMerchant-provided reference for the instrument.networkTransactionReferencestringIdentifier of the initial payment made with this instrument on the Networks, e.g. Mastercard Trace ID or Visa Transaction ID.transactionLinkIdstringMastercard Transaction Link Identifier (TLID) of the transaction series this instrument belongs to. Returned by the card network on the initial cardholder-initiated transaction and required on economically related merchant-initiated transactions, such as recurring payments and installments, when the series spans payment providers.storeInstrumentbooleanTrue if the holder wants to store the instrument for future use when payment is completed.truetruefalsedefaultboolean | nullTrue if the holder wants to make this instrument as default.truefalseworkspaceIduuidWorkspace identifier. When a merchant has multiple network token provider configs, this determines which workspace-scoped config is used for network token provisioning.provisionNetworkTokenbooleanTrue if the merchant wants to provision a network token for this instrument.truefalsedataCard | EncryptedCard | BankAccount | PayPal | DCB | ApplePay | GooglePayType-specific information about the instrument.data Card | EncryptedCard | BankAccount | PayPal | DCB | ApplePay | GooglePaytokenobject | nullToken-specific information about the instrument. Required when creating an instrument from a tokenization tool like the Payrails SDK.token object | nullencryptedDataAttributesobjectAdditional attributes for the instrument tokenization.encryptedDataAttributes objectHeadersx-idempotency-keyuuidrequiredIdempotency key to be used. Sending again the same key would return the same result without re-executing the update.Responses 201Created. 400Bad Request. 401Unauthorized. 403Insufficient Scope. 404Not Found. 429Too Many Requests.Updated 5 months ago Search & list instrumentsGet an instrument by IDDid this page help you?YesNo
