Payment outcome intents

Create a payment outcome intent

Changed on

Record the business outcome (e.g. run payroll) separate from payee/transfer drafts. Outcome text and requester are immutable.

post/v1/customers/{customerId}/payment-outcome-intents

Request

Path parameters

customerIdstring required

Customer id (cus_…).

Headers

X-API-Keystring

API key

Request body

outcomeTextstring required

Recorded outcome the customer or agent is trying to achieve.

Example request

{
  "outcomeText": "Run March payroll for ACME contractors"
}

Response

idstring required
organizationIdstring required
customerIdstring required
outcomeTextstring required
requesterIdstring required
status'OPEN' | 'APPROVED' | 'REJECTED' required
sealedPlanHashstring nullable required
sealedPlanSignaturestring nullable required

HMAC-SHA256 hex over sealedPlanHash. Set when Infinite approves (ENG-2002).

sealedAtstring date-time nullable required
sealedBystring nullable required
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": "oint_abc123",
  "sealedPlan": {
    "v": 1
  }
}

Changes