Skip to content

Latest commit

 

History

History
229 lines (146 loc) · 7.58 KB

PaymentsApi.md

File metadata and controls

229 lines (146 loc) · 7.58 KB
Raw

BillaBear{{classname}}

All URIs are relative to https://{customerId}.billabear.cloud/api/v1

Method HTTP request Description
ChargeInvoice Post /invoice/{invoiceId}/charge Charge Invoice
DownloadInvoice Get /invoice/{invoiceId}/download Download Invoice
DownloadReceipt Get /receipt/{receiptId}/download Download Receipt
GetInvoicesForCustomer Get /customer/{customerId}/invoices List Customer Invoices
GetPaymentsForCustomer Get /customer/{customerId}/payment List Customer Payments
ListPayment Get /payment List
RefundPayment Post /payment/{paymentId}/refund Refund Payment

ChargeInvoice

InlineResponse20012 ChargeInvoice(ctx, invoiceId) Charge Invoice

Attempts to charge a card that is on file for the invoice amount

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
invoiceId string The id of the invoice

Return type

InlineResponse20012

Authorization

ApiKeyAuth

HTTP request headers

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

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

DownloadInvoice

*os.File DownloadInvoice(ctx, invoiceId) Download Invoice

Returns the pdf blob for the invoice

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
invoiceId string The id of the invoice

Return type

*os.File

Authorization

ApiKeyAuth

HTTP request headers

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

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

DownloadReceipt

*os.File DownloadReceipt(ctx, receipt) Download Receipt

Returns the pdf blob for the Receipt

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
receipt string The id of the receipt

Return type

*os.File

Authorization

ApiKeyAuth

HTTP request headers

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

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

GetInvoicesForCustomer

InlineResponse2004 GetInvoicesForCustomer(ctx, customerId) List Customer Invoices

List Customer Invoices

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

InlineResponse2004

Authorization

ApiKeyAuth

HTTP request headers

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

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

GetPaymentsForCustomer

InlineResponse2003 GetPaymentsForCustomer(ctx, customerId, optional) List Customer Payments

List Customer Payment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve
optional *PaymentsApiGetPaymentsForCustomerOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PaymentsApiGetPaymentsForCustomerOpts struct

Name Type Description Notes

limit | optional.Int32| How many items to return at one time (max 100) | lastKey | optional.String| The key to be used in pagination to say what the last key of the previous page was | name | optional.String| The name to search for |

Return type

InlineResponse2003

Authorization

ApiKeyAuth

HTTP request headers

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

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

ListPayment

InlineResponse2007 ListPayment(ctx, optional) List

List all payment

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a PaymentsApiListPaymentOpts struct

Name Type Description Notes
limit optional.Int32 How many items to return at one time (max 100)
lastKey optional.String The key to be used in pagination to say what the last key of the previous page was
name optional.String The name to search for

Return type

InlineResponse2007

Authorization

ApiKeyAuth

HTTP request headers

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

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

RefundPayment

string RefundPayment(ctx, body, paymentId) Refund Payment

Issue a refund for payment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body IssueRefundPayment
paymentId string The id of the payment

Return type

string

Authorization

ApiKeyAuth

HTTP request headers

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

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