InvoiceApi

You can use the APIs below to interface with Xendit's InvoiceApi. To start using the API, you need to configure the secret key and initiate the client instance.

package main

import (
    "context"
    "fmt"
    "os"
    xendit "github.com/xendit/xendit-go/v6"
)

func main() {
    xenditClient := xendit.NewClient("API-KEY")
}

All URIs are relative to https://api.xendit.co

Method	HTTP request	Description
CreateInvoice	Post /v2/invoices/	Create an invoice
GetInvoiceById	Get /v2/invoices/{invoice_id}	Get invoice by invoice id
GetInvoices	Get /v2/invoices	Get all Invoices
ExpireInvoice	Post /invoices/{invoice_id}/expire!	Manually expire an invoice

`CreateInvoice()` Function

Create an invoice

Name	Value
Function Name	`CreateInvoice`
Path Parameters	CreateInvoicePathParams
Request Parameters	CreateInvoiceRequestParams
Return Type	Invoice

Path Parameters - CreateInvoicePathParams

This endpoint does not need any path parameter.

Request Parameters - CreateInvoiceRequestParams

Parameters that are passed through a pointer to a apiCreateInvoiceRequest struct via the builder pattern

Name	Type	Required	Default
createInvoiceRequest	CreateInvoiceRequest	☑️
forUserId	string

Usage Example

package main

import (
    "context"
    "fmt"
    "os"
    xendit "github.com/xendit/xendit-go/v6"
    invoice "github.com/xendit/xendit-go/v6/invoice"
)

func main() {
    
    createInvoiceRequest := *invoice.NewCreateInvoiceRequest("ExternalId_example", float64(123)) // [REQUIRED] | CreateInvoiceRequest

    // Business ID of the sub-account merchant (XP feature)
    forUserId := "62efe4c33e45694d63f585f0" // [OPTIONAL] | string

    xenditClient := xendit.NewClient("API-KEY")

    resp, r, err := xenditClient.InvoiceApi.CreateInvoice(context.Background()).
        CreateInvoiceRequest(createInvoiceRequest).
        ForUserId(forUserId). // [OPTIONAL]
        Execute()

    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InvoiceApi.CreateInvoice``: %v\n", err.Error())

        b, _ := json.Marshal(err.FullError())
        fmt.Fprintf(os.Stderr, "Full Error Struct: %v\n", string(b))

        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateInvoice`: Invoice
    fmt.Fprintf(os.Stdout, "Response from `InvoiceApi.CreateInvoice`: %v\n", resp)
}

`GetInvoiceById()` Function

Get invoice by invoice id

Name	Value
Function Name	`GetInvoiceById`
Path Parameters	GetInvoiceByIdPathParams
Request Parameters	GetInvoiceByIdRequestParams
Return Type	Invoice

Path Parameters - GetInvoiceByIdPathParams

Name	Type	Description	Required	Default
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.	☑️
invoiceId	string	Invoice ID	☑️

Request Parameters - GetInvoiceByIdRequestParams

Parameters that are passed through a pointer to a apiGetInvoiceByIdRequest struct via the builder pattern

Name	Type	Required	Default

Usage Example

package main

import (
    "context"
    "fmt"
    "os"
    xendit "github.com/xendit/xendit-go/v6"
    invoice "github.com/xendit/xendit-go/v6/invoice"
)

func main() {
    
    // Invoice ID
    invoiceId := "62efe4c33e45294d63f585f2" // [REQUIRED] | string

    // Business ID of the sub-account merchant (XP feature)
    forUserId := "62efe4c33e45694d63f585f0" // [OPTIONAL] | string

    xenditClient := xendit.NewClient("API-KEY")

    resp, r, err := xenditClient.InvoiceApi.GetInvoiceById(context.Background(), invoiceId).
        ForUserId(forUserId). // [OPTIONAL]
        Execute()

    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InvoiceApi.GetInvoiceById``: %v\n", err.Error())

        b, _ := json.Marshal(err.FullError())
        fmt.Fprintf(os.Stderr, "Full Error Struct: %v\n", string(b))

        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetInvoiceById`: Invoice
    fmt.Fprintf(os.Stdout, "Response from `InvoiceApi.GetInvoiceById`: %v\n", resp)
}

`GetInvoices()` Function

Get all Invoices

Name	Value
Function Name	`GetInvoices`
Path Parameters	GetInvoicesPathParams
Request Parameters	GetInvoicesRequestParams
Return Type	[]Invoice

Path Parameters - GetInvoicesPathParams

This endpoint does not need any path parameter.

Request Parameters - GetInvoicesRequestParams

Parameters that are passed through a pointer to a apiGetInvoicesRequest struct via the builder pattern

Name	Type	Required	Default
forUserId	string
externalId	string
statuses	InvoiceStatus[]
limit	float32
createdAfter	time.Time
createdBefore	time.Time
paidAfter	time.Time
paidBefore	time.Time
expiredAfter	time.Time
expiredBefore	time.Time
lastInvoice	string
clientTypes	InvoiceClientType[]
paymentChannels	string[]
onDemandLink	string
recurringPaymentId	string

Usage Example

package main

import (
    "context"
    "fmt"
    "os"
        "time"
    xendit "github.com/xendit/xendit-go/v6"
    invoice "github.com/xendit/xendit-go/v6/invoice"
)

func main() {
    
    // Business ID of the sub-account merchant (XP feature)
    forUserId := "62efe4c33e45694d63f585f0" // [OPTIONAL] | string

    externalId := "test-external" // [OPTIONAL] | string

    statuses := []invoice.InvoiceStatus{invoice.InvoiceStatus("PENDING")} // [OPTIONAL] | []InvoiceStatus

    limit := float32(10) // [OPTIONAL] | float32

    createdAfter := time.Now() // [OPTIONAL] | time.Time

    createdBefore := time.Now() // [OPTIONAL] | time.Time

    paidAfter := time.Now() // [OPTIONAL] | time.Time

    paidBefore := time.Now() // [OPTIONAL] | time.Time

    expiredAfter := time.Now() // [OPTIONAL] | time.Time

    expiredBefore := time.Now() // [OPTIONAL] | time.Time

    lastInvoice := "62efe4c33e45294d63f585f2" // [OPTIONAL] | string

    clientTypes := []invoice.InvoiceClientType{invoice.InvoiceClientType("DASHBOARD")} // [OPTIONAL] | []InvoiceClientType

    paymentChannels := []string{"Inner_example"} // [OPTIONAL] | []string

    onDemandLink := "test-link" // [OPTIONAL] | string

    recurringPaymentId := "62efe4c33e45294d63f585f2" // [OPTIONAL] | string

    xenditClient := xendit.NewClient("API-KEY")

    resp, r, err := xenditClient.InvoiceApi.GetInvoices(context.Background()).
        ForUserId(forUserId).
        ExternalId(externalId).
        Statuses(statuses).
        Limit(limit).
        CreatedAfter(createdAfter).
        CreatedBefore(createdBefore).
        PaidAfter(paidAfter).
        PaidBefore(paidBefore).
        ExpiredAfter(expiredAfter).
        ExpiredBefore(expiredBefore).
        LastInvoice(lastInvoice).
        ClientTypes(clientTypes).
        PaymentChannels(paymentChannels).
        OnDemandLink(onDemandLink).
        RecurringPaymentId(recurringPaymentId). // [OPTIONAL]
        Execute()

    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InvoiceApi.GetInvoices``: %v\n", err.Error())

        b, _ := json.Marshal(err.FullError())
        fmt.Fprintf(os.Stderr, "Full Error Struct: %v\n", string(b))

        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetInvoices`: []Invoice
    fmt.Fprintf(os.Stdout, "Response from `InvoiceApi.GetInvoices`: %v\n", resp)
}

`ExpireInvoice()` Function

Manually expire an invoice

Name	Value
Function Name	`ExpireInvoice`
Path Parameters	ExpireInvoicePathParams
Request Parameters	ExpireInvoiceRequestParams
Return Type	Invoice

Path Parameters - ExpireInvoicePathParams

Name	Type	Description	Required	Default
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.	☑️
invoiceId	string	Invoice ID to be expired	☑️

Request Parameters - ExpireInvoiceRequestParams

Parameters that are passed through a pointer to a apiExpireInvoiceRequest struct via the builder pattern

Name	Type	Required	Default

Usage Example

package main

import (
    "context"
    "fmt"
    "os"
    xendit "github.com/xendit/xendit-go/v6"
    invoice "github.com/xendit/xendit-go/v6/invoice"
)

func main() {
    
    // Invoice ID to be expired
    invoiceId := "5f4708b7bd394b0400b96276" // [REQUIRED] | string

    // Business ID of the sub-account merchant (XP feature)
    forUserId := "62efe4c33e45694d63f585f0" // [OPTIONAL] | string

    xenditClient := xendit.NewClient("API-KEY")

    resp, r, err := xenditClient.InvoiceApi.ExpireInvoice(context.Background(), invoiceId).
        ForUserId(forUserId). // [OPTIONAL]
        Execute()

    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InvoiceApi.ExpireInvoice``: %v\n", err.Error())

        b, _ := json.Marshal(err.FullError())
        fmt.Fprintf(os.Stderr, "Full Error Struct: %v\n", string(b))

        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ExpireInvoice`: Invoice
    fmt.Fprintf(os.Stdout, "Response from `InvoiceApi.ExpireInvoice`: %v\n", resp)
}

Callback Objects

Use the following callback objects provided by Xendit to receive callbacks (also known as webhooks) that Xendit sends you on events, such as successful payments. Note that the example is meant to illustrate the contents of the callback object -- you will not need to instantiate these objects in practice

InvoiceCallback Object

Invoice Callback Object

Model Documentation: InvoiceCallback

Usage Example

Note that the example is meant to illustrate the contents of the callback object -- you will not need to instantiate these objects in practice

InvoiceCallbackJson := `{
  "id" : "593f4ed1c3d3bb7f39733d83",
  "external_id" : "testing-invoice",
  "user_id" : "5848fdf860053555135587e7",
  "payment_method" : "RETAIL_OUTLET",
  "status" : "PAID",
  "merchant_name" : "Xendit",
  "amount" : 2000000,
  "paid_amount" : 2000000,
  "paid_at" : "2020-01-14T02:32:50.912Z",
  "payer_email" : "test@xendit.co",
  "description" : "Invoice webhook test",
  "created" : "2020-01-13T02:32:49.827Z",
  "updated" : "2020-01-13T02:32:50.912Z",
  "currency" : "IDR",
  "payment_channel" : "ALFAMART",
  "payment_destination" : "TEST815"
}`

You may then use the callback object in your webhook or callback handler like so,

package main

import (
    "encoding/json"
    "fmt"
    "os"
    xendit "github.com/xendit/xendit-go/v6"
    invoice "github.com/xendit/xendit-go/v6/invoice"
)

func main() {
    // get callback object here
    // define jsonData

    // unmarshal callback object jsonData
    var InvoiceCallback invoice.InvoiceCallback
    err := json.Unmarshal([]byte(InvoiceCallbackJson), &InvoiceCallback)
    if err == nil {
        fmt.Fprintf(os.Stdout, "Callback Object ID: %v\n", InvoiceCallback.GetId())
        // do things here with the callback
    }
}

[Back to README]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

InvoiceApi.md

InvoiceApi.md

InvoiceApi

`CreateInvoice()` Function

Path Parameters - CreateInvoicePathParams

Request Parameters - CreateInvoiceRequestParams

Usage Example

`GetInvoiceById()` Function

Path Parameters - GetInvoiceByIdPathParams

Request Parameters - GetInvoiceByIdRequestParams

Usage Example

`GetInvoices()` Function

Path Parameters - GetInvoicesPathParams

Request Parameters - GetInvoicesRequestParams

Usage Example

`ExpireInvoice()` Function

Path Parameters - ExpireInvoicePathParams

Request Parameters - ExpireInvoiceRequestParams

Usage Example

Callback Objects

InvoiceCallback Object

Usage Example

Files

InvoiceApi.md

Latest commit

History

InvoiceApi.md

File metadata and controls

InvoiceApi

CreateInvoice() Function

Path Parameters - CreateInvoicePathParams

Request Parameters - CreateInvoiceRequestParams

Usage Example

GetInvoiceById() Function

Path Parameters - GetInvoiceByIdPathParams

Request Parameters - GetInvoiceByIdRequestParams

Usage Example

GetInvoices() Function

Path Parameters - GetInvoicesPathParams

Request Parameters - GetInvoicesRequestParams

Usage Example

ExpireInvoice() Function

Path Parameters - ExpireInvoicePathParams

Request Parameters - ExpireInvoiceRequestParams

Usage Example

Callback Objects

InvoiceCallback Object

Usage Example

`CreateInvoice()` Function

`GetInvoiceById()` Function

`GetInvoices()` Function

`ExpireInvoice()` Function