PaymentApi.md

\PaymentApi

All URIs are relative to https://api.clever-cloud.com/v2

Method	HTTP request	Description
CheckVat	Get /vat_check
EndPaymentWithStripe	Post /payments/{bid}/end/stripe
GetAvailablePaymentProviders	Get /payments/providers
GetCoupon	Get /payments/coupons/{name}
GetInvoiceStatusButton	Get /payments/assets/pay_button/{token}/button.png
GetStripeToken	Get /payments/tokens/stripe
StripeSepaWebhook	Post /payments/webhooks/stripe/sepa
UpdateStripePayment	Put /payments/{bid}/end/stripe
Validate	Get /validation/vat/{key}

CheckVat

VatResult CheckVat(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*CheckVatOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CheckVatOpts struct

Name	Type	Description	Notes
country	optional.String
vat	optional.String

Return type

VatResult

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EndPaymentWithStripe

InvoiceRendering EndPaymentWithStripe(ctx, bid, paymentData)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
bid	string
paymentData	PaymentData

Return type

InvoiceRendering

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAvailablePaymentProviders

[]PaymentProviderView GetAvailablePaymentProviders(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]PaymentProviderView

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCoupon

CouponView GetCoupon(ctx, name)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string

Return type

CouponView

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInvoiceStatusButton

GetInvoiceStatusButton(ctx, token)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
token	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: image/png

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStripeToken

BraintreeToken GetStripeToken(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

BraintreeToken

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StripeSepaWebhook

StripeSepaWebhook(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*StripeSepaWebhookOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a StripeSepaWebhookOpts struct

Name	Type	Description	Notes
stripeSignature	optional.String
body	optional.String

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateStripePayment

InvoiceRendering UpdateStripePayment(ctx, bid, setupIntentView)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
bid	string
setupIntentView	SetupIntentView

Return type

InvoiceRendering

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Validate

Message Validate(ctx, key, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
key	string
optional	*ValidateOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ValidateOpts struct

Name	Type	Description	Notes

action | optional.String| |

Return type

Message

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]