Connect Treasury API

API reference

Connect Treasury — API Reference

Base URL: https://api.goldrail.xyz (also https://api.openconnect.cc, where /connect/* = /api/connect/*).

Every route below also answers under the train alias /api/genesis/.... Generated from the Official Postman collection (goldrail-api/postman/official-connect-treasury.collection.json), itself built from the route inventory of the code. The Auth column gives the expected credential.

Guides: Connect Treasury.

accounts / core

MethodPathOperationAuth
GET/api/connect/treasury/accounts/core/accountsList accountsSub-Platform key
POST/api/connect/treasury/accounts/core/transfersTransferSub-Platform key

customer-portal / billing

MethodPathOperationAuth
GET/api/connect/treasury/customer-portal/billing/subscriptionsList subscriptionsBearer

customer-portal / portal

MethodPathOperationAuth
GET/api/connect/treasury/customer-portal/portal/public/platformsPublic platformsPublic
POST/api/connect/treasury/customer-portal/portal/self-registerSelf-registerBearer

payment-requests

MethodPathOperationAuth
POST/api/connect/treasury/payment-requests/coreCreate payment requestAPI key
GET/api/connect/treasury/payment-requests/core?role=requesterList payment requestsAPI key
POST/api/connect/treasury/payment-requests/core/{pr_id}/confirmConfirm payment request (Fintech B)API key
POST/api/connect/treasury/payment-requests/core/{pr_id}/payPay payment request from customer account (Fintech B)API key
POST/api/connect/treasury/payment-requests/core/{pr_id}/rejectReject payment request (Fintech B)API key
POST/api/connect/treasury/payment-requests/core/groupsCreate payment request groupAPI key
GET/api/connect/treasury/payment-requests/core/groups/{paymentRequestGroupId}Get payment request groupAPI key
POST/api/connect/treasury/payment-requests/core/groups/{paymentRequestGroupId}/cancelCancel payment request groupAPI key
POST/api/connect/treasury/payment-requests/public/from-hostPR from-hostPublishable key
POST/api/connect/treasury/payment-requests/public/{pr_id}/stripe-expressPR Stripe ExpressPublishable key
GET/api/connect/treasury/payment-requests/public/{pr_id}/hosted?sig={pr_sig}PR hosted GETPublic
POST/api/connect/treasury/payment-requests/public/{pr_id}/confirmPR SoftShell confirmPublic

payment-requests / core

MethodPathOperationAuth
POST/api/connect/treasury/payment-requests/core/payment-linksCreate payment linkAPI key
POST/api/connect/treasury/payment-requests/coreCreate payment request (Sub-Platform key)Sub-Platform key
GET/api/connect/treasury/payment-requests/core/{paymentRequestId}Get payment request (Sub-Platform key)Sub-Platform key
POST/api/connect/treasury/payment-requests/core/{paymentRequestId}/cancelCancel payment request (Sub-Platform key)Sub-Platform key

payment-requests / public

MethodPathOperationAuth
GET/api/connect/treasury/payment-requests/public/payment-links/{paymentLinkCode}Resolve payment linkPublic

send / core

MethodPathOperationAuth
POST/api/connect/treasury/send/core/quotesQuote sendAPI key
POST/api/connect/treasury/send/coreExecute sendAPI key
GET/api/connect/treasury/send/core/{sendId}Get sendAPI key
GET/api/connect/treasury/send/core/beneficiaries?payer_customer_id={customerId}List beneficiariesAPI key
POST/api/connect/treasury/send/core/beneficiariesAdd beneficiaryAPI key
DELETE/api/connect/treasury/send/core/beneficiaries/{beneficiaryId}Delete beneficiaryAPI key

subscriptions / core

MethodPathOperationAuth
POST/api/connect/treasury/subscriptions/coreCreate subscription requestAPI key

transfers / core

MethodPathOperationAuth
POST/api/connect/treasury/transfers/corePlan transferAPI key
POST/api/connect/treasury/transfers/core/executeExecute transferAPI key

More endpoints (from code) / accounts

MethodPathOperationAuth
GET/api/connect/treasury/accounts/core/accounts/{label_key}GET /api/connect/treasury/accounts/core/accounts/:label_keySub-Platform key
GET/api/connect/treasury/accounts/core/accounts/{label_key}/fundingGET /api/connect/treasury/accounts/core/accounts/:label_key/fundingSub-Platform key
GET/api/connect/treasury/accounts/core/accounts/{label_key}/transactionsGET /api/connect/treasury/accounts/core/accounts/:label_key/transactionsSub-Platform key
POST/api/connect/treasury/accounts/core/offramp/fiatPOST /api/connect/treasury/accounts/core/offramp/fiatSub-Platform key
POST/api/connect/treasury/accounts/core/onramp/fiatPOST /api/connect/treasury/accounts/core/onramp/fiatSub-Platform key
GET/api/connect/treasury/accounts/core/transactionsGET /api/connect/treasury/accounts/core/transactionsSub-Platform key
POST/api/connect/treasury/accounts/core/transactionsPOST /api/connect/treasury/accounts/core/transactionsSub-Platform key
GET/api/connect/treasury/accounts/core/transactions/{id}GET /api/connect/treasury/accounts/core/transactions/:idSub-Platform key
GET/api/connect/treasury/accounts/protocol/accountsGET /api/connect/treasury/accounts/protocol/accountsSub-Platform key
GET/api/connect/treasury/accounts/protocol/accounts/{label_key}/fundingGET /api/connect/treasury/accounts/protocol/accounts/:label_key/fundingSub-Platform key

More endpoints (from code) / billing

MethodPathOperationAuth
GET/api/connect/treasury/billing/chargesGET /api/connect/treasury/billing/chargesAPI key
POST/api/connect/treasury/billing/chargesPOST /api/connect/treasury/billing/chargesAPI key
GET/api/connect/treasury/billing/charges/{id}GET /api/connect/treasury/billing/charges/:idAPI key
POST/api/connect/treasury/billing/charges/{id}/cancelPOST /api/connect/treasury/billing/charges/:id/cancelAPI key
GET/api/connect/treasury/billing/core/chargesGET /api/connect/treasury/billing/core/chargesAPI key
POST/api/connect/treasury/billing/core/chargesPOST /api/connect/treasury/billing/core/chargesAPI key
GET/api/connect/treasury/billing/core/charges/{id}GET /api/connect/treasury/billing/core/charges/:idAPI key
POST/api/connect/treasury/billing/core/charges/{id}/cancelPOST /api/connect/treasury/billing/core/charges/:id/cancelAPI key
GET/api/connect/treasury/billing/core/mandatesGET /api/connect/treasury/billing/core/mandatesAPI key
POST/api/connect/treasury/billing/core/mandatesPOST /api/connect/treasury/billing/core/mandatesAPI key
GET/api/connect/treasury/billing/core/mandates/{id}GET /api/connect/treasury/billing/core/mandates/:idAPI key
POST/api/connect/treasury/billing/core/mandates/{id}/revokePOST /api/connect/treasury/billing/core/mandates/:id/revokeAPI key
POST/api/connect/treasury/billing/core/sessions/portal-sessionsPOST /api/connect/treasury/billing/core/sessions/portal-sessionsAPI key
POST/api/connect/treasury/billing/core/sessions/subscribe-sessionsPOST /api/connect/treasury/billing/core/sessions/subscribe-sessionsAPI key
GET/api/connect/treasury/billing/core/subscriptionsGET /api/connect/treasury/billing/core/subscriptionsAPI key
POST/api/connect/treasury/billing/core/subscriptionsPOST /api/connect/treasury/billing/core/subscriptionsAPI key
GET/api/connect/treasury/billing/core/subscriptions/{id}GET /api/connect/treasury/billing/core/subscriptions/:idAPI key
POST/api/connect/treasury/billing/core/subscriptions/{id}/cancelPOST /api/connect/treasury/billing/core/subscriptions/:id/cancelAPI key
POST/api/connect/treasury/billing/core/subscriptions/{id}/pausePOST /api/connect/treasury/billing/core/subscriptions/:id/pauseAPI key
POST/api/connect/treasury/billing/core/subscriptions/{id}/resumePOST /api/connect/treasury/billing/core/subscriptions/:id/resumeAPI key
GET/api/connect/treasury/billing/core/usage-eventsGET /api/connect/treasury/billing/core/usage-eventsAPI key
POST/api/connect/treasury/billing/core/usage-eventsPOST /api/connect/treasury/billing/core/usage-eventsAPI key
POST/api/connect/treasury/billing/core/usage-events/batchPOST /api/connect/treasury/billing/core/usage-events/batchAPI key
GET/api/connect/treasury/billing/mandatesGET /api/connect/treasury/billing/mandatesAPI key
POST/api/connect/treasury/billing/mandatesPOST /api/connect/treasury/billing/mandatesAPI key
GET/api/connect/treasury/billing/mandates/{id}GET /api/connect/treasury/billing/mandates/:idAPI key
POST/api/connect/treasury/billing/mandates/{id}/revokePOST /api/connect/treasury/billing/mandates/:id/revokeAPI key
GET/api/connect/treasury/billing/plansGET /api/connect/treasury/billing/plansAPI key
POST/api/connect/treasury/billing/plansPOST /api/connect/treasury/billing/plansAPI key
GET/api/connect/treasury/billing/plans/{id}GET /api/connect/treasury/billing/plans/:idAPI key
PATCH/api/connect/treasury/billing/plans/{id}PATCH /api/connect/treasury/billing/plans/:idAPI key
POST/api/connect/treasury/billing/plans/{id}/archivePOST /api/connect/treasury/billing/plans/:id/archiveAPI key
GET/api/connect/treasury/billing/protocol/plansGET /api/connect/treasury/billing/protocol/plansPublic
POST/api/connect/treasury/billing/protocol/plansPOST /api/connect/treasury/billing/protocol/plansPublic
GET/api/connect/treasury/billing/protocol/plans/{id}GET /api/connect/treasury/billing/protocol/plans/:idPublic
PATCH/api/connect/treasury/billing/protocol/plans/{id}PATCH /api/connect/treasury/billing/protocol/plans/:idPublic
POST/api/connect/treasury/billing/protocol/plans/{id}/archivePOST /api/connect/treasury/billing/protocol/plans/:id/archivePublic
GET/api/connect/treasury/billing/protocol/settings/retriesGET /api/connect/treasury/billing/protocol/settings/retriesPublic
PATCH/api/connect/treasury/billing/protocol/settings/retriesPATCH /api/connect/treasury/billing/protocol/settings/retriesPublic
GET/api/connect/treasury/billing/settings/retriesGET /api/connect/treasury/billing/settings/retriesAPI key
PATCH/api/connect/treasury/billing/settings/retriesPATCH /api/connect/treasury/billing/settings/retriesAPI key
GET/api/connect/treasury/billing/subscriptionsGET /api/connect/treasury/billing/subscriptionsAPI key
POST/api/connect/treasury/billing/subscriptionsPOST /api/connect/treasury/billing/subscriptionsAPI key
GET/api/connect/treasury/billing/subscriptions/{id}GET /api/connect/treasury/billing/subscriptions/:idAPI key
POST/api/connect/treasury/billing/subscriptions/{id}/cancelPOST /api/connect/treasury/billing/subscriptions/:id/cancelAPI key
POST/api/connect/treasury/billing/subscriptions/{id}/pausePOST /api/connect/treasury/billing/subscriptions/:id/pauseAPI key
POST/api/connect/treasury/billing/subscriptions/{id}/payPOST /api/connect/treasury/billing/subscriptions/:id/payAPI key
POST/api/connect/treasury/billing/subscriptions/{id}/resumePOST /api/connect/treasury/billing/subscriptions/:id/resumeAPI key
GET/api/connect/treasury/billing/tax/statusGET /api/connect/treasury/billing/tax/statusPublic
GET/api/connect/treasury/billing/usage-eventsGET /api/connect/treasury/billing/usage-eventsAPI key
POST/api/connect/treasury/billing/usage-eventsPOST /api/connect/treasury/billing/usage-eventsAPI key
POST/api/connect/treasury/billing/usage-events/batchPOST /api/connect/treasury/billing/usage-events/batchAPI key

More endpoints (from code) / convert

MethodPathOperationAuth
POST/api/connect/treasury/convert/core/executePOST /api/connect/treasury/convert/core/executeAPI key
POST/api/connect/treasury/convert/core/quotesPOST /api/connect/treasury/convert/core/quotesAPI key
POST/api/connect/treasury/convert/core/sweepPOST /api/connect/treasury/convert/core/sweepAPI key

More endpoints (from code) / customer-portal

MethodPathOperationAuth
GET/api/connect/treasury/customer-portal/billing/invoicesGET /api/connect/treasury/customer-portal/billing/invoicesBearer
GET/api/connect/treasury/customer-portal/billing/invoices/{id}GET /api/connect/treasury/customer-portal/billing/invoices/:idBearer
GET/api/connect/treasury/customer-portal/billing/mandatesGET /api/connect/treasury/customer-portal/billing/mandatesBearer
POST/api/connect/treasury/customer-portal/billing/mandates/{id}/revokePOST /api/connect/treasury/customer-portal/billing/mandates/:id/revokeBearer
GET/api/connect/treasury/customer-portal/billing/payment-methodsGET /api/connect/treasury/customer-portal/billing/payment-methodsBearer
POST/api/connect/treasury/customer-portal/billing/payment-methodsPOST /api/connect/treasury/customer-portal/billing/payment-methodsBearer
GET/api/connect/treasury/customer-portal/billing/subscribe-sessions/{token}GET /api/connect/treasury/customer-portal/billing/subscribe-sessions/:tokenPublic
POST/api/connect/treasury/customer-portal/billing/subscribe/completePOST /api/connect/treasury/customer-portal/billing/subscribe/completePublic
GET/api/connect/treasury/customer-portal/billing/subscriptions/{id}GET /api/connect/treasury/customer-portal/billing/subscriptions/:idBearer
POST/api/connect/treasury/customer-portal/billing/subscriptions/{id}/cancelPOST /api/connect/treasury/customer-portal/billing/subscriptions/:id/cancelBearer
POST/api/connect/treasury/customer-portal/billing/subscriptions/{id}/pausePOST /api/connect/treasury/customer-portal/billing/subscriptions/:id/pauseBearer
POST/api/connect/treasury/customer-portal/billing/subscriptions/{id}/resumePOST /api/connect/treasury/customer-portal/billing/subscriptions/:id/resumeBearer
GET/api/connect/treasury/customer-portal/billing/usageGET /api/connect/treasury/customer-portal/billing/usageBearer

More endpoints (from code) / payment-requests

MethodPathOperationAuth
GET/api/connect/treasury/payment-requests/core/payment-linksGET /api/connect/treasury/payment-requests/core/payment-linksAPI key
GET/api/connect/treasury/payment-requests/core/payment-links/{code}GET /api/connect/treasury/payment-requests/core/payment-links/:codeAPI key
PATCH/api/connect/treasury/payment-requests/core/payment-links/{code}/revokePATCH /api/connect/treasury/payment-requests/core/payment-links/:code/revokeAPI key
POST/api/connect/treasury/payment-requests/public/{id}/policyPOST /api/connect/treasury/payment-requests/public/:id/policyPublic
POST/api/connect/treasury/payment-requests/public/{id}/rejectPOST /api/connect/treasury/payment-requests/public/:id/rejectPublic

More endpoints (from code) / send

MethodPathOperationAuth
POST/api/connect/treasury/send/core/resolvePOST /api/connect/treasury/send/core/resolveAPI key

More endpoints (from code) / subscriptions

MethodPathOperationAuth
GET/api/connect/treasury/subscriptions/core/{id}GET /api/connect/treasury/subscriptions/core/:idAPI key
POST/api/connect/treasury/subscriptions/core/{id}/cancelPOST /api/connect/treasury/subscriptions/core/:id/cancelAPI key
POST/api/connect/treasury/subscriptions/core/{id}/confirmPOST /api/connect/treasury/subscriptions/core/:id/confirmAPI key
POST/api/connect/treasury/subscriptions/core/{id}/rejectPOST /api/connect/treasury/subscriptions/core/:id/rejectAPI key
POST/api/connect/treasury/subscriptions/public/{id}/confirmPOST /api/connect/treasury/subscriptions/public/:id/confirmPublic
GET/api/connect/treasury/subscriptions/public/{id}/hostedGET /api/connect/treasury/subscriptions/public/:id/hostedPublic
POST/api/connect/treasury/subscriptions/public/{id}/policyPOST /api/connect/treasury/subscriptions/public/:id/policyPublic
POST/api/connect/treasury/subscriptions/public/{id}/rejectPOST /api/connect/treasury/subscriptions/public/:id/rejectPublic

More endpoints (from code) / transfers

MethodPathOperationAuth
POST/api/connect/treasury/transfers/core/treasury/creditPOST /api/connect/treasury/transfers/core/treasury/creditAPI key
POST/api/connect/treasury/transfers/core/treasury/returnPOST /api/connect/treasury/transfers/core/treasury/returnAPI key

On this page