PaymentInstrument

A payment instrument: create, get or confirm one, or list its payins.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

payment_instruments, err := client.PaymentInstrument(nil).List(map[string]any{"id": "example_id", "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(payment_instruments)
payment_instrument, err := client.PaymentInstrument(nil).Load(map[string]any{"id": "example_id", "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(payment_instrument)
created, err := client.PaymentInstrument(nil).Create(map[string]any{"profile_id": 1, "accountNumber": "example", "type": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

Construct client as shown in the Lua setup, then call the operations:

local payment_instruments, err = client:PaymentInstrument():list({ id = "example_id", profile_id = 1 })
local payment_instrument, err = client:PaymentInstrument():load({ id = "example_id", profile_id = 1 })
local created, err = client:PaymentInstrument():create({ profile_id = 1, accountNumber = "example", type = "example" })

PHP

Construct client as shown in the PHP setup, then call the operations:

$payment_instruments = $client->PaymentInstrument()->list(["id" => "example_id", "profile_id" => 1]);
$payment_instrument = $client->PaymentInstrument()->load(["id" => "example_id", "profile_id" => 1]);
$created = $client->PaymentInstrument()->create(["profile_id" => 1, "accountNumber" => "example", "type" => "example"]);

Python

Construct client as shown in the Python setup, then call the operations:

payment_instruments = client.PaymentInstrument().list({"id": "example_id", "profile_id": 1})
payment_instrument = client.PaymentInstrument().load({"id": "example_id", "profile_id": 1})
created = client.PaymentInstrument().create({ "profile_id": 1, "accountNumber": "example", "type": "example" })

Ruby

Construct client as shown in the Ruby setup, then call the operations:

payment_instruments = client.PaymentInstrument.list({ "id" => "example_id", "profile_id" => 1 })
payment_instrument = client.PaymentInstrument.load({ "id" => "example_id", "profile_id" => 1 })
created = client.PaymentInstrument.create({ "profile_id" => 1, "accountNumber" => "example", "type" => "example" })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const payment_instruments = await client.PaymentInstrument().list({ id: "example_id", profile_id: 1 })
const payment_instrument = await client.PaymentInstrument().load({ id: "example_id", profile_id: 1 })
const created = await client.PaymentInstrument().create({ profile_id: 1, accountNumber: "example", type: "example" })

Fields

create

POST /profiles/{profileId}/payment-instruments/{paymentInstrumentId}/manual-confirmation

Operation ID: paymentInstrumentConfirm.

Authentication: bearer token (UserToken).

Parameters

Responses

200: OK

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

POST /profiles/{profileId}/payment-instruments

Operation ID: paymentInstrumentsCreate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Responses

200: OK

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

list

GET /profiles/{profileId}/payment-instruments/{paymentInstrumentId}/payins

Operation ID: paymentInstrumentGetAllPayins.

Authentication: bearer token (UserToken).

Parameters

Responses

200: OK

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /profiles/{profileId}/payment-instruments/{paymentInstrumentId}

Operation ID: paymentInstrumentsGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: OK

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.