Posteering
Reference

Archive or rename a counterparty (soft state only).

PATCH
/api/v1/bankrail/counterparties/{id}

Authorization

X-Bankrail-Key-Id<token>

Partner-visible credential identifier issued by bank-rail at credential provisioning time. Names which credential signed the request; the corresponding signing secret never appears in any request.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/api/v1/bankrail/counterparties/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty

Get one counterparty and its external accounts. GET

Previous Page

Create a payment intent (partner perimeter). POST

Creates a payment intent attributed to the authenticated partner. The partner identity (req.user.partnerId from PartnerHmacGuard) is recorded on bankrail.payment_intents.consumer_partner_id; the callback dispatcher will sign the credit-confirmed callback with the partner's active callback-signing credential when one exists. Returns 200 OK with the allocated virtual account details (synchronous creation — bankrail calls Providus DCS during the request).