支払いを作成する


エラー

すべての API エンドポイントに当てはまる エラー に加えて、以下は支払いの作成時にのみ返されるエラーです。

ステータスコード エラーコード 説明
404 order.not-found orderId と API キーを使用してください。テストモードのオブジェクトには、テストキーを使用してのみアクセスすることができ、ライブモードのオブジェクトには、ライブキーを使用してのみアクセスできます。
409 order.cannot-capture 支払いを作成できません。エラーメッセージにその理由が含まれます。よくある理由は、注文が既にキャプチャされていた、注文が失効したなどです。
409 payment.excessive-amount 指定された金額がこの注文でキャプチャできる金額を超えています。
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create Payment

number
required
≥ 0

The amount to be captured.

string
enum

Whether to cancel remaining amount in case of a partial capture. Defaults to automatic, which means only a single capture is allowed and any remaining, uncaptured amount is cancelled. Set to manual if you would like to create multiple partial captures.

Allowed:
string
required

Three-letter ISO currency code, in uppercase. Must be a supported currency.

string
length between 1 and 80

An arbitrary - ideally descriptive - long form explanation of the Payment, meant to be displayed to the customer.

lineItems
array of objects

A list of the IDs of the Line Items of the original order this Payment captures.

lineItems
metadata
object

Set of up to 20 key-value pairs that you can attach to the object.

string
required

The unique identifier for the Payment object.

string
length between 1 and 40

A - ideally unique - string to reference the Payment (e.g. a customer ID, a cart ID, etc.) which can be used to reconcile the Payment with your internal systems.

Responses

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