Create Payment

Creates a payment. Use the selector to choose the payment method and channel. Each option shows the fields required for that combination. If channel is omitted, the default is API.

This service facilitates the creation of a new order within the system. Depending on the specified flow and payment method, the request initiates one of the following processes:

  • Direct Charge: Immediate processing of the collection.
  • Debt Posting: Registration of a pending obligation for future settlement.
  • Payment Link: Generation of a unique URL for customer checkout.
  • SDK Execution: Initialization of an order to be processed via the KOIN SDK.

This endpoint serves as the primary entry point for the transaction lifecycle, capturing all essential sales metadata and establishing the foundation for the subsequent collection workflow.


Body Params

Pix · API payment. If channel is omitted, the default is API.

store
object

Store information

transaction
object
required

Transaction details

string
required

Transaction country code (two-letter ISO 3166 country code)

string
enum
Defaults to API

Integration channel. If omitted, the default is API.

Allowed:
payment_method
object
required

Payment method for Pix payments.

payer
object

Payer information.

buyer
object

Buyer information.

items
array

Purchase items.

items
shipping
object

Shipping information. When sent, address is required.

redirect_url
object

URLs the payer is redirected to when the payment uses a hosted flow.

device
object

Device used to initiate the payment.

boolean

Indicates you want a mobile checkout experience.

string
length ≤ 25

Description sent to recipient of payment (Max. 25 characters)

notification_url
array of strings

List of urls to which notifications will be sent

notification_url
split
array of objects

Optional payment split configuration (list of sellers).

split
Responses

404

Not Found

409

Conflict

500

Internal Server Error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json