Payins

Send payment request

Sends a payment request notification to the buyer for open-banking or request-to-pay type payins.

post/payins/{id}/request

Request

  • Base URL
    https://your-subdomain.truust.io/2.0
  • URL
    https://your-subdomain.truust.io/2.0/payins/{id}/request
  • Auth
    HTTP bearer

Path parameters

idinteger required

Payin ID.

Response

Payment request sent

idinteger
selfstring
referencestring nullable

Provider's payment reference ID.

typestring

Payment method type (e.g. CARD, BANKWIRE, WALLET).

subtypestring nullable
status'CREATED' | 'AUTHORIZED' | 'CONFIRMED' | 'DENIED' | 'REFUNDED' | 'CANCELLED'
providerobject

Raw provider response data.

tagstring nullable
direct_linkstring uri nullable

Payment page URL. Only present when status is CREATED or AUTHORIZED.

created_atstring date-time nullable
confirmed_atstring date-time nullable
denied_atstring date-time nullable
connectionsConnections

Hypermedia links to related resources.

Example response

{
  "self": "/2.0/payins/456"
}

Changes

No recorded changes to this operation across all 8 revisions of this API.