PaymentIntent
A payment intent.
Operations
Every route this entity exposes. Each route links to its own reference on this page.
| Method | Route | SDK operation | Returns |
|---|---|---|---|
GET |
/settlement/allocations/{allocationId}/payment-intents/{paymentIntentId} |
load |
Payment intent details retrieved successfully |
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_intent, err := client.PaymentIntent(nil).Load(map[string]any{"allocation_id": "example", "id": "example_id"}, nil)
if err != nil {
panic(err)
}
fmt.Println(payment_intent)
Lua
Construct client as shown in the Lua setup, then call the operations:
local payment_intent, err = client:PaymentIntent():load({ allocation_id = "example", id = "example_id" })
PHP
Construct client as shown in the PHP setup, then call the operations:
$payment_intent = $client->PaymentIntent()->load(["allocation_id" => "example", "id" => "example_id"]);
Python
Construct client as shown in the Python setup, then call the operations:
payment_intent = client.PaymentIntent().load({"allocation_id": "example", "id": "example_id"})
Ruby
Construct client as shown in the Ruby setup, then call the operations:
payment_intent = client.PaymentIntent.load({ "allocation_id" => "example", "id" => "example_id" })
TypeScript
Construct client as shown in the TypeScript setup, then call the operations:
const payment_intent = await client.PaymentIntent().load({ allocation_id: "example", id: "example_id" })
Fields
| Field | Type | Required | Description |
|---|---|---|---|
allocationId |
string |
No | Unique identifier of the associated settlement allocation. |
allocationType |
string |
No | Type of allocation. |
createdAt |
string |
No | Timestamp when the payment intent was created. |
fundingSource |
string |
No | Source of funding for the payment. |
id |
string |
No | Unique identifier of the payment intent. |
partnerEntityId |
string |
No | Partner entity identifier. |
paymentReference |
string |
No | Payment reference. |
profileId |
string |
No | Profile identifier. |
reason |
string |
No | Reason for the payment. |
recipientType |
string |
No | Type of recipient. |
sourceAmount |
number |
No | Source amount of the payment. |
sourceCurrency |
string |
No | Source currency code (ISO 4217). |
state |
string |
No | Current state of the payment intent. |
targetAmount |
number |
No | Target amount of the payment. |
targetCurrency |
string |
No | Target currency code (ISO 4217). |
updatedAt |
string |
No | Timestamp when the payment intent was last updated. |
load
GET /settlement/allocations/{allocationId}/payment-intents/{paymentIntentId}
Operation ID: GetPaymentIntent.
Authentication: bearer token (ClientCredentialsToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
allocationId |
path |
string |
Yes | Unique identifier of the settlement allocation. |
paymentIntentId |
path |
string |
Yes | Unique identifier of the payment intent. |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Responses
200: Payment intent details retrieved successfully
application/json
| Property | Type | Required | Description |
|---|---|---|---|
allocationId |
string |
No | Unique identifier of the associated settlement allocation. |
allocationType |
enum: CREDIT, DEBIT |
No | Type of allocation. |
createdAt |
string (date-time) |
No | Timestamp when the payment intent was created. |
fundingSource |
enum: WISE_COLLECTION_ACCOUNT, PARTNER_DEFICIT_ACCOUNT, SPLIT, UNDETERMINED |
No | Source of funding for the payment. |
id |
string |
No | Unique identifier of the payment intent. |
partnerEntityId |
string |
No | Partner entity identifier. |
paymentReference |
string |
No | Payment reference. |
profileId |
string |
No | Profile identifier. |
reason |
string |
No | Reason for the payment. |
recipientType |
enum: SELLER, PARTNER_FEE |
No | Type of recipient. |
sourceAmount |
number (decimal) |
No | Source amount of the payment. |
sourceCurrency |
string |
No | Source currency code (ISO 4217). |
state |
enum: NEW, PARTIALLY_LEDGERED, LEDGERED, PARTIALLY_SETTLED, SETTLED, CANCELLED |
No | Current state of the payment intent. |
targetAmount |
number (decimal) |
No | Target amount of the payment. |
targetCurrency |
string |
No | Target currency code (ISO 4217). |
updatedAt |
string (date-time) |
No | Timestamp when the payment intent was last updated. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.