Create a payment intent
Create a continuous (default) or transient payment intent. Continuous payment intents are created by default. To create a transient payment intent, the type field must be explicitly set to transient.
purposeOfTransfer is conditionally required: it must be supplied when the entity’s legal entity is Circle SG (CIRCLE_SG), Circle Inc (CIRCLE_INC) with Managed Payments enabled, or Circle SAS (CIRCLE_FR); it is optional for other legal entities. PMT006 is not allowed.
For transient payment intents, expiresOn must be a future UTC timestamp no more than 24 hours after creation. It is required for Circle SG (CIRCLE_SG) merchants and optional for Circle Inc (CIRCLE_INC) merchants.
Eligible Circle SG (CIRCLE_SG) merchants can link a transient payment intent to a Travel Rule customer wallet by supplying customerWalletId.
Authorizations
Body
- Option 1
- Option 2
Payment reason code describing the purpose of the transfer for the payment intent.
Conditionally required: it must be supplied when the entity's legal entity is Circle SG (CIRCLE_SG), or Circle Inc (CIRCLE_INC) with Managed Payments enabled. It is optional for all other legal entities.
PMT006 (Transfer to own account) is not allowed for payment intents. A missing value (when required) or a disallowed/invalid value returns error code INVALID_PURPOSE_OF_TRANSFER.
PMT000, PMT001, PMT002, PMT003, PMT004, PMT005, PMT007, PMT008, PMT009, PMT010, PMT011, PMT012, PMT013, PMT014, PMT015, PMT016, PMT017, PMT018, PMT019, PMT020, PMT021, PMT022, PMT023, PMT024, PMT025, PMT026, PMT027, PMT028, PMT029, PMT030 "PMT001"