Sign in

v4

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-04-277127123.7 KB
Payins

Create payin

Creates a payin (payment intent) for an order. Requires order_id and either type or gateway_id.

For card payments, the response includes a direct_link to the payment page. For bank wire payments, the response includes bank transfer details in provider.

post/payins

Request body

order_idinteger required

ID of the order to pay.

typestring required

Payment method type. Valid values include BANKWIRE, WALLET, and any registered gateway type for the account (e.g. REDSYS_V2, ADDON, ADDON_V2, ADDON_ICE, ADDON_HPP, ADDON_APPLE_PAY, AZUPAY, DCP, EPX, REDSYS_APPLE_PAY, REDSYS_AUTH, STRIPE, DOCOMO, SIBS_MBWAY, SIBS_MULTIBANCO, SEQURA, UNNAX, PAYPAL, BIZUM, INESPAY).

gateway_idinteger

Gateway ID to use. Alternative to type.

card_idinteger

Saved card ID to charge (for recurring or one-click payments).

wallet_idinteger

Wallet ID to debit. Required when type is WALLET.

save_card0 | 1

Set to 1 to tokenize and save the card for future use.

Example request

{
  "order_id": 4950,
  "type": "REDSYS_V2",
  "save_card": 1
}

Response

Payin created

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"
}