Create Order Payment

Creates a order payment

SecurityBearer

Request

path Parameters

order_id

required

string

Order identifier

header Parameters

x-merchant required	string non-empty Merchant identifier. Example: norce
x-channel required	string non-empty Channel identifier Example: 1

Request Body schema: application/json

Payment

adapterId	string Adapter ID
name	string Payment service provider name
merchant	string Merchant identifier.
channel	string Merchant channel.
currency	string^[A-Za-z]{3,3}$ Currency of the purchase. ISO 4217 alpha-3.
type	string Type of payment. Enum: "default" "prepaid" "voucher"
orderId	string ID of the order.
amount	number <double> The amount to be covered by the payment. Amount in major unit currency.
upperLimitAmount	number <double> The upper limit to be used by this payment. For example the amount available on a voucher. Amount in major unit currency.
state	string The state of the payment. Enum: "intent" "removed" "processing" "failed" "confirmed" "pending" "declined" "reserved" "credited" "captured" "cancelled" "refunded"
reference	string External reference to payment service provider.
	object Allows you to store any custom attributes for the payment.
	Array of objects (PaymentAction) After payment actions
	object Information about a recurring payment used for processing repeated purchases.

Responses

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/api/v0/checkout/orders/{order_id}/payments

Request samples

Payload
curl

application/json

{"adapterId": "klarna-checkout",
"name": "string",
"merchant": "norce",
"channel": "string",
"currency": "SEK",
"type": "default",
"orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
"amount": 10,
"upperLimitAmount": 100,
"state": "Intent",
"reference": "7d31e2cf-2d46-4db0-b87d-d65dfaae298f",
"attributes": {"property1": null,
"property2": null
},
"actions": [{"adapterId": "string",
"type": "string",
"url": "string"
}
],
"recurring": {"token": "string",
"description": "string",
"attributes": {"property1": null,
"property2": null
}
}
}

Response samples

application/json

{"id": "string"
}