SchemaCard PaymentsPayments

Create payment

View as MarkdownOpen in Claude
Use this method to run a sale or a pre-authorization with a customer's payment card. In the response, our gateway returns information about the card payment and a paymentId, which you need for the following methods: - [Retrieve payment](https://docs.payroc.com/api/schema/card-payments/payments/retrieve) - View the details of the card payment. - [Adjust payment](https://docs.payroc.com/api/schema/card-payments/payments/adjust) - Update the details of the card payment. - [Capture payment](https://docs.payroc.com/api/schema/card-payments/payments/capture) - Capture the pre-authorization. - [Reverse payment](https://docs.payroc.com/api/schema/card-payments/refunds/reverse) - Cancel the card payment if it's in an open batch. - [Refund payment](https://docs.payroc.com/api/schema/card-payments/refunds/create-referenced-refund) - Run a referenced refund to return funds to the payment card. **Payment methods** - **Cards** - Credit, debit, and EBT - **Digital wallets** - [Apple Pay®](https://docs.payroc.com/guides/take-payments/apple-pay) and [Google Pay®](https://docs.payroc.com/guides/take-payments/google-pay) - **Tokens** - Secure tokens and single-use tokens **Features** Our Create Payment method also supports the following features: - [Repeat payments](https://docs.payroc.com/guides/take-payments/repeat-payments/use-your-own-software) - Run multiple payments as part of a payment schedule that you manage with your own software. - **Offline sales** - Run a sale or a pre-authorization if the terminal loses its connection to our gateway. - [Tokenization](https://docs.payroc.com/guides/take-payments/save-payment-details) - Save card details to use in future transactions. - [3-D Secure](https://docs.payroc.com/guides/take-payments/3-d-secure) - Verify the identity of the cardholder. - [Custom fields](https://docs.payroc.com/guides/take-payments/add-custom-fields) - Add your own data to a payment. - **Tips** - Add tips to the card payment. - **Taxes** - Add local taxes to the card payment. - **Surcharging** - Add a surcharge to the card payment. - **Dual pricing** - Offer different prices based on payment method, for example, if you use our RewardPay Choice pricing program.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Idempotency-KeystringRequiredformat: "uuid"
Unique identifier that you generate for each request. You must use the [UUID v4 format](https://www.rfc-editor.org/rfc/rfc4122) for the identifier. For more information about the idempotency key, go to [Idempotency](https://docs.payroc.com/api/idempotency).

Request

This endpoint expects an object.
channelenumRequired
Channel that the merchant used to receive the payment details.
Allowed values:
processingTerminalIdstringRequired4-50 characters
Unique identifier that we assigned to the terminal.
orderobjectRequired
Object that contains information about the payment.
paymentMethodobjectRequired

Polymorphic object that contains payment details.

The value of the type parameter determines which variant you should use:

  • card - Payment card details
  • secureToken - Secure token details
  • digitalWallet - Digital wallet details
  • singleUseToken - Single-use token details
operatorstringOptional0-50 characters
Operator who ran the transaction.
customerobjectOptional
Object that contains the customer's contact details and address information.
ipAddressobjectOptional
Object that contains the IP address of the device that sent the request.
threeDSecureobjectOptional

Polymorphic object that contains authentication information from 3-D Secure.

The value of the serviceProvider parameter determines which variant you should use:

  • gateway - Use our gateway to run a 3-D Secure check.
  • thirdParty - Use a third party to run a 3-D Secure check.
credentialOnFileobjectOptional

Object that contains information about saving the customer’s payment details.

offlineProcessingobjectOptional
Object that contains information about the transaction if the merchant ran it when the terminal was offline.
autoCapturebooleanOptionalDefaults to true

Indicates if we should automatically capture the payment amount.

  • true - Run a sale and automatically capture the transaction.
  • false- Run a pre-authorization and capture the transaction later.

Note: If you send false and the terminal doesn’t support pre-authorization, we set the transaction’s status to pending. The merchant must capture the transaction to take payment from the customer.

processAsSalebooleanOptionalDefaults to false

Indicates if we should immediately settle the sale transaction. The merchant cannot adjust the transaction if we immediately settle it.
Note: If the value for processAsSale is true, the gateway ignores the value in autoCapture.

customFieldslist of objectsOptional
Array of customField objects.

Response headers

locationstring
URI reference to created resource.

Response

Successful request. We processed the transaction.
paymentIdstring=10 characters
Unique identifier that our gateway assigned to the transaction.
processingTerminalIdstring4-50 characters
Unique identifier of the terminal that initiated the transaction.
orderobject
Object that contains information about the payment.
cardobject
Object that contains the details of the payment card.
transactionResultobject
Object that contains information about the transaction response details.
operatorstring0-50 characters
Operator who initiated the request.
customerobject
Object that contains the customer's contact details and address information.
refundslist of objects
Array of refundSummary objects. Each object contains information about refunds linked to the transaction.
supportedOperationslist of enums

Array of operations that you can perform on the transaction.

  • capture - Capture the payment.
  • refund - Refund the payment.
  • fullyReverse - Fully reverse the transaction.
  • partiallyReverse - Partially reverse the payment.
  • incrementAuthorization - Increase the amount of the authorization.
  • adjustTip - Adjust the tip post-payment.
  • addSignature - Add a signature to the payment.
  • setAsReady - Set the transaction’s status to ready.
  • setAsPending - Set the transaction’s status to pending.
customFieldslist of objects
Array of customField objects.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
500
Internal Server Error