Synswi
  1. Invoice
Synswi
  • Invoice
    • Get invoice by id
      GET
    • Get invoices
      GET
    • Create an invoice
      POST
    • Pay an invoice
      POST
    • Send Invoice
      POST
    • Update an invoice
      POST
  • Payment instruments
    • Create a payment instrument
    • Get payment instruments
      GET
    • Get a payment instrument by id
      GET
  • Transactions
    • Get a transaction by id
      GET
    • Get transactions
      GET
    • Create a transaction
      POST
  1. Invoice

Pay an invoice

POST
https://api-sandbox.synswi.com/v1/invoices/pay

Request

Body Params application/json
invoiceId
string 
required
paymentInstrumentId
string 
required
method
enum<string> 
required
Allowed values:
cardach
Example
{
    "paymentInstrumentId": "payment-instrument-75359708-3227-4466-8809-146f60bbbf60",
    "invoiceId": "invoice-67c28842-39e1-48a0-97d9-ccafa20914bd",
    "method": "card"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-sandbox.synswi.com/v1/invoices/pay' \
--header 'Content-Type: application/json' \
--data-raw '{
    "paymentInstrumentId": "payment-instrument-75359708-3227-4466-8809-146f60bbbf60",
    "invoiceId": "invoice-67c28842-39e1-48a0-97d9-ccafa20914bd",
    "method": "card"
}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Previous
Create an invoice
Next
Send Invoice
Built with