API Reference

Create Payment

post
https://api-sandbox.koin.com.br/v1/payment/orders

Create payment service. Required fields are validated first, then business rules are applied.

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
store
object
transaction
object
required
string
required

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

string
enum

Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration.

Allowed:
payment_method
object
required
payer
object
string

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

notification_url
array of strings

Optional list of URLs to which payment status notifications will be sent

notification_url
device
object
Responses

404

Not Found

409

Conflict

500

Internal Server Error

Updated 12 days ago

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

Updated 12 days ago